Class AiKnowledgeBaseReference

A reference to an AI knowledge base.

Index

Methods

delete deleteContext deleteContexts downloadContext getContext getKnowledgeBase listContexts listKnowledgeBases search 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.

getContext

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

getKnowledgeBase

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

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

listContexts

listContexts(): Promise<AiKnowledgeBaseContext[]>
Lists all contexts associated with the knowledge base.

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.
Parameters
- options: AiKnowledgeBaseChatOptions & { prompt: string }
Returns Promise<AiKnowledgeBaseSearchResultChunk[]>

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<AiKnowledgeBaseWithOptionalChatModel, "id">,
): Promise<void>
Upserts the AI knowledge base.
Parameters
- knowledgeBase: Omit<AiKnowledgeBaseWithOptionalChatModel, "id">
Returns Promise<void>