Class AiKnowledgeBaseReference

A reference to an AI knowledge base.

Index

Methods

delete deleteContext deleteContexts downloadContext generateMetadataFieldDescriptions getContext getKnowledgeBase listContextIds listContexts listKnowledgeBases search searchContextsWithContextId searchContextsWithPrompt upsertContext upsertContexts upsertKnowledgeBase

Methods

delete

delete(): Promise<void>
Deletes the AI knowledge base.

Returns Promise<void>
A promise that resolves when the deletion is complete.

deleteContext

deleteContext(contextId: string): Promise<void>
Deletes a specific context by its ID.
Parameters
- contextId: string
Returns Promise<void>

deleteContexts

deleteContexts(contextIds: string[]): Promise<void>
Deletes multiple contexts.
Parameters
- contextIds: string[]
Returns Promise<void>

downloadContext

downloadContext(
contextId: string,
): Promise<AiKnowledgeBaseDownloadContextResponse>
Gets the download URL for the requested context.
Parameters
- contextId: string
Returns Promise<AiKnowledgeBaseDownloadContextResponse>
Object with temporary URL to download the requested context. Will be undefined if file is unavailable.

generateMetadataFieldDescriptions

generateMetadataFieldDescriptions(
    options?: Omit<
        GenerateMetadataFieldDescriptionsRequest,
        "knowledgeBaseId",
    >,
): Promise<GenerateMetadataFieldDescriptionsResponse>
AI-generates descriptions for this knowledge base's metadata fields and returns them WITHOUT persisting — the caller saves them onto the KB (e.g. via upsertKnowledgeBase). By default only fields with an empty description are generated; pass overwriteExisting to regenerate all.
Parameters
- Optionaloptions: Omit<GenerateMetadataFieldDescriptionsRequest, "knowledgeBaseId">
  Optional fieldNames to limit generation to specific fields, and overwriteExisting.
Returns Promise<GenerateMetadataFieldDescriptionsResponse>
The (re)generated fields with their new descriptions (not yet persisted).

getContext

getContext(contextId: string): Promise<AiKnowledgeBaseContext | undefined>
Retrieves a specific context by its ID.
Parameters
- contextId: string
Returns Promise<AiKnowledgeBaseContext | undefined>

getKnowledgeBase

getKnowledgeBase(): Promise<AiKnowledgeBase | undefined>
Returns the AI knowledge base.

Returns Promise<AiKnowledgeBase | undefined>
A promise that resolves to the AI knowledge base or undefined if not found.

listContextIds

listContextIds(): Promise<string[]>
Lists the ids for all contexts associated with the knowledge base.

Returns Promise<string[]>

listContexts

listContexts(truncateTextAfter?: number): Promise<AiKnowledgeBaseContext[]>
Lists all contexts associated with the knowledge base.
Parameters
- OptionaltruncateTextAfter: number
Returns Promise<AiKnowledgeBaseContext[]>

listKnowledgeBases

listKnowledgeBases(): Promise<AiKnowledgeBase[]>
Returns all AI knowledge bases.

Returns Promise<AiKnowledgeBase[]>
A promise that resolves to an array of AI Knowledge Bases

search

search(
options: AiKnowledgeBaseChatOptions & { prompt: string },
): Promise<AiKnowledgeBaseSearchResultChunk[]>
Performs a semantic search in the knowledge base and returns chunks from the different contexts.
Parameters
- options: AiKnowledgeBaseChatOptions & { prompt: string }
Returns Promise<AiKnowledgeBaseSearchResultChunk[]>

searchContextsWithContextId

searchContextsWithContextId(
    request: Omit<
        AiKnowledgeBaseSearchContextsWithContextIdRequest,
        "knowledgeBaseId",
    >,
): Promise<AiKnowledgeBaseContextWithReasoning[]>
Performs a semantic search in the knowledge base and returns contexts with reasoning. Can be used for matchmaking or similarity search.
Parameters
- request: Omit<AiKnowledgeBaseSearchContextsWithContextIdRequest, "knowledgeBaseId">
Returns Promise<AiKnowledgeBaseContextWithReasoning[]>

searchContextsWithPrompt

searchContextsWithPrompt(
    request: Omit<
        AiKnowledgeBaseSearchContextsWithPromptRequest,
        "knowledgeBaseId",
    >,
): Promise<AiKnowledgeBaseContextWithReasoning[]>
Performs a semantic search in the knowledge base and returns contexts with reasoning. Can be used for matchmaking or similarity search.
Parameters
- request: Omit<AiKnowledgeBaseSearchContextsWithPromptRequest, "knowledgeBaseId">
Returns Promise<AiKnowledgeBaseContextWithReasoning[]>

upsertContext

upsertContext(
contextRequest: AiKnowledgeBaseContextRequest,
file?: File,
): Promise<UpsertKnowledgeBaseContextResponse>
Adds or updates a single context.
Parameters
- contextRequest: AiKnowledgeBaseContextRequest
- Optionalfile: File
Returns Promise<UpsertKnowledgeBaseContextResponse>

upsertContexts

upsertContexts(
contextRequests: AiKnowledgeBaseContextRequest[],
files?: File[],
): Promise<UpsertKnowledgeBaseContextsResponse>
Adds or updates multiple contexts.
Parameters
- contextRequests: AiKnowledgeBaseContextRequest[]
- Optionalfiles: File[]
Returns Promise<UpsertKnowledgeBaseContextsResponse>

upsertKnowledgeBase

upsertKnowledgeBase(
    knowledgeBase: Omit<
        AiEmbeddingsModelWithOptionalFields,
        "id"
        | "appId"
        | "updatedAt",
    >,
): Promise<void>
Upserts the AI knowledge base.
Parameters
- knowledgeBase: Omit<AiEmbeddingsModelWithOptionalFields, "id" | "appId" | "updatedAt">
Returns Promise<void>

Class AiKnowledgeBaseReference

Index

Methods

Methods

delete

Returns Promise<void>

deleteContext

Parameters

Returns Promise<void>

deleteContexts

Parameters

Returns Promise<void>

downloadContext

Parameters

Returns Promise<AiKnowledgeBaseDownloadContextResponse>

generateMetadataFieldDescriptions

Parameters

Returns Promise<GenerateMetadataFieldDescriptionsResponse>

getContext

Parameters

Returns Promise<AiKnowledgeBaseContext | undefined>

getKnowledgeBase

Returns Promise<AiKnowledgeBase | undefined>

listContextIds

Returns Promise<string[]>

listContexts

Parameters

Returns Promise<AiKnowledgeBaseContext[]>

listKnowledgeBases

Returns Promise<AiKnowledgeBase[]>

search

Parameters

Returns Promise<AiKnowledgeBaseSearchResultChunk[]>

searchContextsWithContextId

Parameters

Returns Promise<AiKnowledgeBaseContextWithReasoning[]>

searchContextsWithPrompt

Parameters

Returns Promise<AiKnowledgeBaseContextWithReasoning[]>

upsertContext

Parameters

Returns Promise<UpsertKnowledgeBaseContextResponse>

upsertContexts

Parameters

Returns Promise<UpsertKnowledgeBaseContextsResponse>

upsertKnowledgeBase

Parameters

Returns Promise<void>

Settings

On This Page