KnowledgeRetrievalClient class

Paket:

@azure/search-documents

Klass används för att utföra operationer mot en kunskapsbas.

Konstruktorer

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

Skapar en instans av KnowledgeRetrievalClient. Exempel på användning: import { KnowledgeRetrievalClient, AzureKeyCredential } from "@azure/search-documents"; const knowledgeRetrievalClient = new KnowledgeRetrievalClient( "<endpoint>", "<knowledgeBaseName>", new AzureKeyCredential("<apiKey>"), );

Egenskaper

endpoint	Slutpunkten för söktjänsten
knowledgeBaseName	Namnet på kunskapsbasen
pipeline	En referens till den interna HTTP-pipelinen för användning med rådatabegäranden
serviceVersion	Den tjänstversion som ska användas vid kommunikation med tjänsten.

Metoder

retrieveKnowledge(KnowledgeBaseRetrievalRequest, RetrieveKnowledgeOptions)

Konstruktorinformation

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

Skapar en instans av KnowledgeRetrievalClient.

Exempel på användning:

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)

Parametrar

endpoint

string

Slutpunkten för söktjänsten

knowledgeBaseName

string

Namnet på kunskapsbasen

credential

KeyCredential | TokenCredential

Används för att autentisera begäranden till tjänsten.

options

KnowledgeRetrievalClientOptions

Används för att konfigurera sökklienten.

Egenskapsinformation

endpoint

Slutpunkten för söktjänsten

endpoint: string

Egenskapsvärde

string

knowledgeBaseName

Namnet på kunskapsbasen

knowledgeBaseName: string

Egenskapsvärde

string

pipeline

En referens till den interna HTTP-pipelinen för användning med rådatabegäranden

pipeline: Pipeline

Egenskapsvärde

Pipeline

serviceVersion

Den tjänstversion som ska användas vid kommunikation med tjänsten.

serviceVersion: string

Egenskapsvärde

string

Metodinformation

retrieveKnowledge(KnowledgeBaseRetrievalRequest, RetrieveKnowledgeOptions)

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

Parametrar

retrievalRequest

KnowledgeBaseRetrievalRequest

options

RetrieveKnowledgeOptions

Returer

Promise<KnowledgeBaseRetrievalResponse>