Simple RAG

Set up semantic search with document ingestion and vector-based retrieval.

Install the SDK

Start by installing the TypeGraph SDK. Cloud mode only needs the SDK package. Self-hosted mode also needs a database adapter, an embedder, and an LLM when graph extraction is enabled.

terminal

npm install @typegraph-ai/sdk

Initialize TypeGraph

TypeGraph Cloud API keys resolve your Cloud organization and schema. Your application tenant is still supplied as tenantId during initialization. In self-hosted mode, vectorStore + embedding + searchEmbedding + llm is enough for document search, graph extraction, graph APIs, and memory APIs.

Initialize TypeGraph example

import { TenantId, typegraphInit } from '@typegraph-ai/sdk'

const typegraph = await typegraphInit({
  apiKey: process.env.TYPEGRAPH_API_KEY!,
  tenantId: TenantId('tenant_acme'),
})

Ingest Documents

Documents are durable long-form content. Use document.ingest() for one document or an array of documents. The default bucket is created automatically; pass bucketId when you want a named collection.

Document ingest example

const result = await typegraph.document.ingest(
  [{
    id: 'docs:getting-started',
    name: 'Getting Started',
    description: 'Introductory setup guide for TypeGraph.',
    content: 'TypeGraph is a unified RAG pipeline SDK...',
    metadata: { product: 'typegraph' },
  }],
  {
    graphExtraction: false,
  },
)

console.log('Ingested:', result)

Search Documents

typegraph.search() separates what to search (resources) from how to score (weights). Use promptBuilder when you want TypeGraph to assemble the top results into an LLM-ready prompt string on the response.

Search example

const response = await typegraph.search('How do I get started?', {
  resources: ['documents'],
  weights: { semantic: 1, bm25: 0.7, graph: false, recency: 0.3 },
  limit: 5,
  promptBuilder: { format: 'xml' },
})

for (const hit of response.hits) {
  console.log(hit.scores.fused, hit.content)
}

console.log(response.prompt)

Example: Feed the Prompt to an LLM

Example only. TypeGraph does not require an LLM for vector-only RAG. If you want grounded answer generation, pass response.prompt to any model in your application.

rag-example

import { generateText } from 'ai'
import { openai } from '@ai-sdk/openai'

const { text } = await generateText({
  model: openai('gpt-5.4-mini'),
  prompt: `Answer the question based on the following context:

${response.prompt}

Question: How do I get started?
`,
})

console.log(text)

Back to All Guides

const result = await typegraph.document.ingest( [{ id: 'docs:getting-started', name: 'Getting Started', description: 'Introductory setup guide for TypeGraph.', content: 'TypeGraph is a unified RAG pipeline SDK...', metadata: { product: 'typegraph' }, }], { graphExtraction: false, }, ) console.log('Ingested:', result)

const response = await typegraph.search('How do I get started?', { resources: ['documents'], weights: { semantic: 1, bm25: 0.7, graph: false, recency: 0.3 }, limit: 5, promptBuilder: { format: 'xml' }, }) for (const hit of response.hits) { console.log(hit.scores.fused, hit.content) } console.log(response.prompt)

import { generateText } from 'ai' import { openai } from '@ai-sdk/openai' const { text } = await generateText({ model: openai('gpt-5.4-mini'), prompt: `Answer the question based on the following context: ${response.prompt} Question: How do I get started? `, }) console.log(text)