Vercel AI SDK

1
import { generateText } from 'ai';
2
import { openai } from '@ai-sdk/openai';
3
import { airweaveSearch } from '@airweave/vercel-ai-sdk';
4
5
const { text } = await generateText({
6
  model: openai('gpt-4o'),
7
  prompt: 'What were the key decisions from last week?',
8
  tools: {
9
    search: airweaveSearch({
10
      defaultCollection: 'my-knowledge-base',
11
    }),
12
  },
13
  maxSteps: 3,
14
});
15
16
console.log(text);

1
airweaveSearch({
2
  // API key (defaults to AIRWEAVE_API_KEY env var)
3
  apiKey: 'your-api-key',
4
5
  // Default collection to search
6
  defaultCollection: 'my-collection',
7
8
  // Max results per search (default: 10)
9
  defaultLimit: 20,
10
11
  // Generate AI answer from results (default: false)
12
  generateAnswer: true,
13
14
  // Query expansion for better recall (default: true)
15
  expandQuery: true,
16
17
  // Rerank for relevance (default: true)
18
  rerank: true,
19
20
  // Base URL for self-hosted instances
21
  baseUrl: 'https://your-instance.airweave.ai',
22
});

1
import {
2
  airweaveSearch,
3
  AirweaveSearchOptions,
4
  AirweaveSearchResult,
5
  AirweaveSearchResultItem
6
} from '@airweave/vercel-ai-sdk';
7
8
const config: AirweaveSearchOptions = {
9
  defaultCollection: 'my-collection',
10
  defaultLimit: 10,
11
};
12
13
const search = airweaveSearch(config);

1
interface AirweaveSearchResultItem {
2
  id: string;                    // Entity ID
3
  score: number;                 // Relevance score
4
  payload: {
5
    entity_id?: string;
6
    name?: string;
7
    created_at?: string;
8
    textual_representation?: string;
9
    breadcrumbs?: AirweaveBreadcrumb[];
10
    airweave_system_metadata?: {
11
      source_name?: string;      // e.g., "notion", "slack"
12
      entity_type?: string;      // e.g., "NotionPageEntity"
13
      sync_id?: string;
14
      chunk_index?: number;
15
    };
16
    // Plus source-specific fields
17
  };
18
}