KnowledgeRetrievalClient class

Pakiet:

@azure/search-documents

Klasa używana do wykonywania operacji na bazie wiedzy.

Konstruktory

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

Tworzy instancję klasy KnowledgeRetrievalClient. Przykładowe użycie: import { KnowledgeRetrievalClient, AzureKeyCredential } from "@azure/search-documents"; const knowledgeRetrievalClient = new KnowledgeRetrievalClient( "<endpoint>", "<knowledgeBaseName>", new AzureKeyCredential("<apiKey>"), );

Właściwości

endpoint	Punkt końcowy usługi wyszukiwania
knowledgeBaseName	Nazwa bazy wiedzy
pipeline	Odwołanie do wewnętrznego potoku HTTP do użycia z żądaniami nieprzetworzonymi
serviceVersion	Wersja usługi, która ma być używana podczas komunikowania się z usługą.

Metody

retrieveKnowledge(KnowledgeBaseRetrievalRequest, RetrieveKnowledgeOptions)

Szczegóły konstruktora

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

Tworzy instancję klasy KnowledgeRetrievalClient.

Przykładowe użycie:

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)

Parametry

endpoint

string

Punkt końcowy usługi wyszukiwania

knowledgeBaseName

string

Nazwa bazy wiedzy

credential

KeyCredential | TokenCredential

Służy do uwierzytelniania żądań do usługi.

options

KnowledgeRetrievalClientOptions

Służy do konfigurowania klienta wyszukiwania.

Szczegóły właściwości

endpoint

Punkt końcowy usługi wyszukiwania

endpoint: string

Wartość właściwości

string

knowledgeBaseName

Nazwa bazy wiedzy

knowledgeBaseName: string

Wartość właściwości

string

pipeline

Odwołanie do wewnętrznego potoku HTTP do użycia z żądaniami nieprzetworzonymi

pipeline: Pipeline

Wartość właściwości

Pipeline

serviceVersion

Wersja usługi, która ma być używana podczas komunikowania się z usługą.

serviceVersion: string

Wartość właściwości

string

Szczegóły metody

retrieveKnowledge(KnowledgeBaseRetrievalRequest, RetrieveKnowledgeOptions)

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

Parametry

retrievalRequest

KnowledgeBaseRetrievalRequest

options

RetrieveKnowledgeOptions

Zwraca

Promise<KnowledgeBaseRetrievalResponse>