KnowledgeRetrievalClient class

Balíček:

@azure/search-documents

Třída používaná k provádění operací proti znalostní bázi.

Konstruktory

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

Vytvoří instanci KnowledgeRetrievalClient. Příklad použití: import { KnowledgeRetrievalClient, AzureKeyCredential } from "@azure/search-documents"; const knowledgeRetrievalClient = new KnowledgeRetrievalClient( "<endpoint>", "<knowledgeBaseName>", new AzureKeyCredential("<apiKey>"), );

Vlastnosti

endpoint	Koncový bod vyhledávací služby
knowledgeBaseName	Název znalostní báze
pipeline	Odkaz na interní kanál HTTP pro použití s nezpracovanými požadavky
serviceVersion	Verze služby, která se má použít při komunikaci se službou.

Metody

retrieveKnowledge(KnowledgeBaseRetrievalRequest, RetrieveKnowledgeOptions)

Podrobnosti konstruktoru

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

Vytvoří instanci KnowledgeRetrievalClient.

Příklad použití:

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

Koncový bod vyhledávací služby

knowledgeBaseName

string

Název znalostní báze

credential

KeyCredential | TokenCredential

Slouží k ověřování požadavků na službu.

options

KnowledgeRetrievalClientOptions

Slouží ke konfiguraci vyhledávacího klienta.

Podrobnosti vlastnosti

endpoint

Koncový bod vyhledávací služby

endpoint: string

Hodnota vlastnosti

string

knowledgeBaseName

Název znalostní báze

knowledgeBaseName: string

Hodnota vlastnosti

string

pipeline

Odkaz na interní kanál HTTP pro použití s nezpracovanými požadavky

pipeline: Pipeline

Hodnota vlastnosti

Pipeline

serviceVersion

Verze služby, která se má použít při komunikaci se službou.

serviceVersion: string

Hodnota vlastnosti

string

Podrobnosti metody

retrieveKnowledge(KnowledgeBaseRetrievalRequest, RetrieveKnowledgeOptions)

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

Parametry

retrievalRequest

KnowledgeBaseRetrievalRequest

options

RetrieveKnowledgeOptions

Návraty

Promise<KnowledgeBaseRetrievalResponse>