KnowledgeRetrievalClient class

Creates an instance of KnowledgeRetrievalClient.

Example usage:

import { KnowledgeRetrievalClient, AzureKeyCredential } from "@azure/search-documents";

const knowledgeRetrievalClient = new KnowledgeRetrievalClient(
  "<endpoint>",
  "<knowledgeBaseName>",
  new AzureKeyCredential("<apiKey>"),
);

new KnowledgeRetrievalClient(endpoint: string, knowledgeBaseName: string, credential: KeyCredential | TokenCredential, options?: KnowledgeRetrievalClientOptions)

Parameters

The endpoint of the search service

endpoint: string

Property Value

The name of the knowledge base

knowledgeBaseName: string

Property Value

A reference to the internal HTTP pipeline for use with raw requests

pipeline: Pipeline

Property Value

The service version to use when communicating with the service.

serviceVersion: string

Property Value

Retrieves relevant data from the backing stores configured by the knowledge base.

function retrieve(retrievalRequest: KnowledgeBaseRetrievalRequest, options?: RetrieveOptions): Promise<KnowledgeBaseRetrievalResponse>

Parameters

Returns

The completed retrieval response.

Retrieves relevant data from the backing stores, streaming progress and results as server-sent events as they become available instead of waiting for the full retrieval to complete.

The returned async iterable yields events until the terminal response.completed event, or an error event if the retrieval fails after the stream has started. Narrow on the event property to access the typed payload.

Example

Iterate typed retrieval events.

import { KnowledgeRetrievalClient, AzureKeyCredential } from "@azure/search-documents";

const client = new KnowledgeRetrievalClient(
  "<endpoint>",
  "<knowledgeBaseName>",
  new AzureKeyCredential("<apiKey>"),
);

for await (const event of await client.retrieveStream({
  intents: [{ type: "semantic", search: "Summarize the indexed information." }],
  includeActivity: true,
})) {
  if (event.event === "activity.completed") {
    console.log(`Activity ${event.data.id} took ${event.data.elapsedInMs}ms`);
  } else if (event.event === "response.completed") {
    console.log(event.data.response.response);
  } else if (event.event === "error") {
    throw new Error(event.data.error.message);
  }
}

function retrieveStream(retrievalRequest: KnowledgeBaseRetrievalRequest, options?: RetrieveStreamOptions): Promise<AsyncIterable<KnowledgeBaseRetrievalStreamEvent>>

Parameters

Returns

An async iterable of typed server-sent events.