Package version:

Class used to perform operations against a knowledge base.

Constructors

  • Creates an instance of KnowledgeRetrievalClient.

    Example usage:

    import { KnowledgeRetrievalClient, AzureKeyCredential } from "@azure/search-documents";

    const knowledgeRetrievalClient = new KnowledgeRetrievalClient(
    "<endpoint>",
    "<knowledgeBaseName>",
    new AzureKeyCredential("<apiKey>"),
    );

    Parameters

    • endpoint: string

      The endpoint of the search service

    • knowledgeBaseName: string

      The name of the knowledge base

    • credential: any

      Used to authenticate requests to the service.

    • options: KnowledgeRetrievalClientOptions = {}

      Used to configure the Search client.

    Returns KnowledgeRetrievalClient

Properties

endpoint: string

The endpoint of the search service

knowledgeBaseName: string

The name of the knowledge base

pipeline: Pipeline

A reference to the internal HTTP pipeline for use with raw requests

serviceVersion: string = utils.defaultServiceVersion

The service version to use when communicating with the service.

Methods