通过

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

KnowledgeRetrievalClient class

包:
@azure/search-documents

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

构造函数

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

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

方法

retrieveKnowledge(KnowledgeBaseRetrievalRequest, RetrieveKnowledgeOptions)

构造函数详细信息

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

属性值

Pipeline

serviceVersion

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

serviceVersion: string

属性值

string

方法详细信息

retrieveKnowledge(KnowledgeBaseRetrievalRequest, RetrieveKnowledgeOptions) 

function retrieveKnowledge(retrievalRequest: KnowledgeBaseRetrievalRequest, options?: RetrieveKnowledgeOptions): Promise<KnowledgeBaseRetrievalResponse>

参数

retrievalRequest
KnowledgeBaseRetrievalRequest
options
RetrieveKnowledgeOptions

返回

Promise<KnowledgeBaseRetrievalResponse>