KnowledgeRetrievalClient class

Paquete:

@azure/search-documents

Clase utilizada para realizar operaciones contra una base de conocimiento.

Constructores

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

Crea una instancia de KnowledgeRetrievalClient. Uso de ejemplo: import { KnowledgeRetrievalClient, AzureKeyCredential } from "@azure/search-documents"; const knowledgeRetrievalClient = new KnowledgeRetrievalClient( "<endpoint>", "<knowledgeBaseName>", new AzureKeyCredential("<apiKey>"), );

Propiedades

endpoint	Punto de conexión del servicio de búsqueda
knowledgeBaseName	El nombre de la base de conocimiento
pipeline	Una referencia a la canalización HTTP interna para su uso con solicitudes sin procesar
serviceVersion	La versión del servicio que se va a usar al comunicarse con el servicio.

Métodos

retrieveKnowledge(KnowledgeBaseRetrievalRequest, RetrieveKnowledgeOptions)

Detalles del constructor

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

Crea una instancia de KnowledgeRetrievalClient.

Uso de ejemplo:

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)

Parámetros

endpoint

string

Punto de conexión del servicio de búsqueda

knowledgeBaseName

string

El nombre de la base de conocimiento

credential

KeyCredential | TokenCredential

Se usa para autenticar solicitudes al servicio.

options

KnowledgeRetrievalClientOptions

Se utiliza para configurar el cliente de búsqueda.

Detalles de las propiedades

endpoint

Punto de conexión del servicio de búsqueda

endpoint: string

Valor de propiedad

string

knowledgeBaseName

El nombre de la base de conocimiento

knowledgeBaseName: string

Valor de propiedad

string

pipeline

Una referencia a la canalización HTTP interna para su uso con solicitudes sin procesar

pipeline: Pipeline

Valor de propiedad

Pipeline

serviceVersion

La versión del servicio que se va a usar al comunicarse con el servicio.

serviceVersion: string

Valor de propiedad

string

Detalles del método

retrieveKnowledge(KnowledgeBaseRetrievalRequest, RetrieveKnowledgeOptions)

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

Parámetros

retrievalRequest

KnowledgeBaseRetrievalRequest

options

RetrieveKnowledgeOptions

Devoluciones

Promise<KnowledgeBaseRetrievalResponse>