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

Используется для настройки клиента Search.

Сведения о свойстве

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>