Class KnowledgeAssistantsClient

Constructors

constructor

new KnowledgeAssistantsClient(options: ClientOptions): KnowledgeAssistantsClient
Parameters
- options: ClientOptions
Returns KnowledgeAssistantsClient
- Defined in client.ts:74

Methods

createExample

createExample(
req: CreateExampleRequest,
options?: CallOptions,
): Promise<Example>
Creates an example for a Knowledge Assistant.
Parameters
- req: CreateExampleRequest
- Optionaloptions: CallOptions
Returns Promise<Example>
- Defined in client.ts:90

createKnowledgeAssistant

createKnowledgeAssistant(
req: CreateKnowledgeAssistantRequest,
options?: CallOptions,
): Promise<KnowledgeAssistant>
Creates a Knowledge Assistant.
Parameters
- req: CreateKnowledgeAssistantRequest
- Optionaloptions: CallOptions
Returns Promise<KnowledgeAssistant>
- Defined in client.ts:120

createKnowledgeSource

createKnowledgeSource(
req: CreateKnowledgeSourceRequest,
options?: CallOptions,
): Promise<KnowledgeSource>
Creates a Knowledge Source under a Knowledge Assistant.
Parameters
- req: CreateKnowledgeSourceRequest
- Optionaloptions: CallOptions
Returns Promise<KnowledgeSource>
- Defined in client.ts:153

deleteExample

deleteExample(req: DeleteExampleRequest, options?: CallOptions): Promise<void>
Deletes an example from a Knowledge Assistant.
Parameters
- req: DeleteExampleRequest
- Optionaloptions: CallOptions
Returns Promise<void>
- Defined in client.ts:186

deleteKnowledgeAssistant

deleteKnowledgeAssistant(
req: DeleteKnowledgeAssistantRequest,
options?: CallOptions,
): Promise<void>
Deletes a Knowledge Assistant.
Parameters
- req: DeleteKnowledgeAssistantRequest
- Optionaloptions: CallOptions
Returns Promise<void>
- Defined in client.ts:209

deleteKnowledgeSource

deleteKnowledgeSource(
req: DeleteKnowledgeSourceRequest,
options?: CallOptions,
): Promise<void>
Deletes a Knowledge Source.
Parameters
- req: DeleteKnowledgeSourceRequest
- Optionaloptions: CallOptions
Returns Promise<void>
- Defined in client.ts:232

getExample

getExample(req: GetExampleRequest, options?: CallOptions): Promise<Example>
Gets an example from a Knowledge Assistant.
Parameters
- req: GetExampleRequest
- Optionaloptions: CallOptions
Returns Promise<Example>
- Defined in client.ts:255

getKnowledgeAssistant

getKnowledgeAssistant(
req: GetKnowledgeAssistantRequest,
options?: CallOptions,
): Promise<KnowledgeAssistant>
Gets a Knowledge Assistant.
Parameters
- req: GetKnowledgeAssistantRequest
- Optionaloptions: CallOptions
Returns Promise<KnowledgeAssistant>
- Defined in client.ts:284

getKnowledgeSource

getKnowledgeSource(
req: GetKnowledgeSourceRequest,
options?: CallOptions,
): Promise<KnowledgeSource>
Gets a Knowledge Source.
Parameters
- req: GetKnowledgeSourceRequest
- Optionaloptions: CallOptions
Returns Promise<KnowledgeSource>
- Defined in client.ts:313

listExamples

listExamples(
req: ListExamplesRequest,
options?: CallOptions,
): Promise<ListExamplesResponse>
Lists examples under a Knowledge Assistant.
Parameters
- req: ListExamplesRequest
- Optionaloptions: CallOptions
Returns Promise<ListExamplesResponse>
- Defined in client.ts:342

listExamplesIter

listExamplesIter(
req: ListExamplesRequest,
options?: CallOptions,
): AsyncGenerator<Example>
Parameters
- req: ListExamplesRequest
- Optionaloptions: CallOptions
Returns AsyncGenerator<Example>
- Defined in client.ts:379

listKnowledgeAssistants

listKnowledgeAssistants(
req: ListKnowledgeAssistantsRequest,
options?: CallOptions,
): Promise<ListKnowledgeAssistantsResponse>
List Knowledge Assistants
Parameters
- req: ListKnowledgeAssistantsRequest
- Optionaloptions: CallOptions
Returns Promise<ListKnowledgeAssistantsResponse>
- Defined in client.ts:397

listKnowledgeAssistantsIter

listKnowledgeAssistantsIter(
req: ListKnowledgeAssistantsRequest,
options?: CallOptions,
): AsyncGenerator<KnowledgeAssistant>
Parameters
- req: ListKnowledgeAssistantsRequest
- Optionaloptions: CallOptions
Returns AsyncGenerator<KnowledgeAssistant>
- Defined in client.ts:437

listKnowledgeSources

listKnowledgeSources(
req: ListKnowledgeSourcesRequest,
options?: CallOptions,
): Promise<ListKnowledgeSourcesResponse>
Lists Knowledge Sources under a Knowledge Assistant.
Parameters
- req: ListKnowledgeSourcesRequest
- Optionaloptions: CallOptions
Returns Promise<ListKnowledgeSourcesResponse>
- Defined in client.ts:455

listKnowledgeSourcesIter

listKnowledgeSourcesIter(
req: ListKnowledgeSourcesRequest,
options?: CallOptions,
): AsyncGenerator<KnowledgeSource>
Parameters
- req: ListKnowledgeSourcesRequest
- Optionaloptions: CallOptions
Returns AsyncGenerator<KnowledgeSource>
- Defined in client.ts:495

syncKnowledgeSources

syncKnowledgeSources(
req: SyncKnowledgeSourcesRequest,
options?: CallOptions,
): Promise<void>
Sync all non-index Knowledge Sources for a Knowledge Assistant (index sources do not require sync)
Parameters
- req: SyncKnowledgeSourcesRequest
- Optionaloptions: CallOptions
Returns Promise<void>
- Defined in client.ts:513

updateExample

updateExample(
req: UpdateExampleRequest,
options?: CallOptions,
): Promise<Example>
Updates an example in a Knowledge Assistant.
Parameters
- req: UpdateExampleRequest
- Optionaloptions: CallOptions
Returns Promise<Example>
- Defined in client.ts:537

updateKnowledgeAssistant

updateKnowledgeAssistant(
req: UpdateKnowledgeAssistantRequest,
options?: CallOptions,
): Promise<KnowledgeAssistant>
Updates a Knowledge Assistant.
Parameters
- req: UpdateKnowledgeAssistantRequest
- Optionaloptions: CallOptions
Returns Promise<KnowledgeAssistant>
- Defined in client.ts:579

updateKnowledgeSource

updateKnowledgeSource(
req: UpdateKnowledgeSourceRequest,
options?: CallOptions,
): Promise<KnowledgeSource>
Updates a Knowledge Source.
Parameters
- req: UpdateKnowledgeSourceRequest
- Optionaloptions: CallOptions
Returns Promise<KnowledgeSource>
- Defined in client.ts:624