你当前正在访问 Microsoft Azure Global Edition 技术文档网站。 如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站,请访问 https://docs.azure.cn。

KnowledgeRetrievalClient class

类过去用来对知识库执行作。

构造函数

KnowledgeRetrievalClient(string, string, KeyCredential | TokenCredential, KnowledgeRetrievalClientOptions)

创建 KnowledgeRetrievalClient 的实例。

示例用法:

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

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

属性

endpoint

搜索服务的终结点

knowledgeBaseName

知识库名称

pipeline

对用于原始请求的内部 HTTP 管道的引用

serviceVersion

与服务通信时要使用的服务版本。

方法

retrieve(KnowledgeBaseRetrievalRequest, RetrieveOptions)

从知识库配置的后备存储中获取相关数据。

retrieveStream(KnowledgeBaseRetrievalRequest, RetrieveStreamOptions)

从支持存储中获取相关数据,实时传输进度和结果,作为服务器发送的事件,而非等待完整检索完成。

返回的异步迭代过程会持续到终端 response.completed 事件,或者如果检索失败,则在流开始后产生 error 事件。 在物业上收窄 event 以获取类型载荷。

Example

迭代类型检索事件。

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);
  }
}

构造函数详细信息

KnowledgeRetrievalClient(string, string, KeyCredential | TokenCredential, KnowledgeRetrievalClientOptions)

创建 KnowledgeRetrievalClient 的实例。

示例用法:

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)

参数

endpoint

string

搜索服务的终结点

knowledgeBaseName

string

知识库名称

credential

KeyCredential | TokenCredential

用于对服务请求进行身份验证。

options
KnowledgeRetrievalClientOptions

用于配置搜索客户端。

属性详细信息

endpoint

搜索服务的终结点

endpoint: string

属性值

string

knowledgeBaseName

知识库名称

knowledgeBaseName: string

属性值

string

pipeline

对用于原始请求的内部 HTTP 管道的引用

pipeline: Pipeline

属性值

serviceVersion

与服务通信时要使用的服务版本。

serviceVersion: string

属性值

string

方法详细信息

retrieve(KnowledgeBaseRetrievalRequest, RetrieveOptions)

从知识库配置的后备存储中获取相关数据。

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

参数

retrievalRequest
KnowledgeBaseRetrievalRequest

检索请求处理。

options
RetrieveOptions

取回操作的选项。

返回

完成的取回回复。

retrieveStream(KnowledgeBaseRetrievalRequest, RetrieveStreamOptions)

从支持存储中获取相关数据,实时传输进度和结果,作为服务器发送的事件,而非等待完整检索完成。

返回的异步迭代过程会持续到终端 response.completed 事件,或者如果检索失败,则在流开始后产生 error 事件。 在物业上收窄 event 以获取类型载荷。

Example

迭代类型检索事件。

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, any, any>>

参数

retrievalRequest
KnowledgeBaseRetrievalRequest

检索请求处理。

options
RetrieveStreamOptions

检索流操作的选项。

返回

Promise<AsyncIterable<KnowledgeBaseRetrievalStreamEvent, any, any>>

一个由服务器发送的类型事件的异步迭代。