Options
All
  • Public
  • Public/Protected
  • All
Menu

Class SearchIndexerClient

Package version

Class to perform operations to manage (create, update, list/delete) indexers, datasources & skillsets.

Hierarchy

  • SearchIndexerClient

Index

Constructors

constructor

  • Creates an instance of SearchIndexerClient.

    Example usage:

    const { SearchIndexerClient, AzureKeyCredential } = require("@azure/search-documents");
    
    const client = new SearchIndexerClient(
      "<endpoint>",
      new AzureKeyCredential("<Admin Key>");
    );

    Parameters

    • endpoint: string

      The endpoint of the search service

    • credential: KeyCredential | TokenCredential

      Used to authenticate requests to the service.

    • Default value options: SearchIndexerClientOptions = {}

      Used to configure the Search client.

    Returns SearchIndexerClient

Properties

apiVersion

apiVersion: string = utils.defaultServiceVersion

The API version to use when communicating with the service.

deprecated

use serviceVersion instead

endpoint

endpoint: string

The endpoint of the search service

serviceVersion

serviceVersion: string = utils.defaultServiceVersion

The API version to use when communicating with the service.

Methods

createDataSourceConnection

createIndexer

  • Creates a new indexer in a search service.

    Parameters

    • indexer: SearchIndexer

      The indexer definition to create in a search service.

    • Default value options: CreateIndexerOptions = {}

      Additional optional arguments.

    Returns Promise<SearchIndexer>

createOrUpdateDataSourceConnection

createOrUpdateIndexer

  • Creates a new indexer or modifies an existing one.

    Parameters

    • indexer: SearchIndexer

      The information describing the indexer to be created/updated.

    • Default value options: CreateorUpdateIndexerOptions = {}

      Additional optional arguments.

    Returns Promise<SearchIndexer>

createOrUpdateSkillset

  • Creates a new Skillset or modifies an existing one.

    Parameters

    • skillset: SearchIndexerSkillset

      The information describing the index to be created.

    • Default value options: CreateOrUpdateSkillsetOptions = {}

      Additional optional arguments.

    Returns Promise<SearchIndexerSkillset>

createSkillset

  • createSkillset(skillset: SearchIndexerSkillset, options?: CreateSkillsetOptions): Promise<SearchIndexerSkillset>
  • Creates a new skillset in a search service.

    Parameters

    • skillset: SearchIndexerSkillset

      The skillset containing one or more skills to create in a search service.

    • Default value options: CreateSkillsetOptions = {}

      Additional optional arguments.

    Returns Promise<SearchIndexerSkillset>

deleteDataSourceConnection

deleteIndexer

  • Deletes an existing indexer.

    Parameters

    • indexer: string | SearchIndexer

      Indexer/Name of the indexer to delete.

    • Default value options: DeleteIndexerOptions = {}

      Additional optional arguments.

    Returns Promise<void>

deleteSkillset

  • deleteSkillset(skillset: string | SearchIndexerSkillset, options?: DeleteSkillsetOptions): Promise<void>
  • Deletes an existing Skillset.

    Parameters

    • skillset: string | SearchIndexerSkillset

      Skillset/Name of the Skillset to delete.

    • Default value options: DeleteSkillsetOptions = {}

      Additional optional arguments.

    Returns Promise<void>

getDataSourceConnection

getIndexer

  • getIndexer(indexerName: string, options?: GetIndexerOptions): Promise<SearchIndexer>
  • Retrieves information about an Indexer.

    Parameters

    • indexerName: string

      The name of the Indexer.

    • Default value options: GetIndexerOptions = {}

      Additional optional arguments.

    Returns Promise<SearchIndexer>

getIndexerStatus

getSkillset

  • getSkillset(skillsetName: string, options?: GetSkillSetOptions): Promise<SearchIndexerSkillset>
  • Retrieves information about an Skillset.

    Parameters

    • skillsetName: string
    • Default value options: GetSkillSetOptions = {}

      Additional optional arguments.

    Returns Promise<SearchIndexerSkillset>

listDataSourceConnections

listDataSourceConnectionsNames

listIndexers

  • Retrieves a list of existing indexers in the service.

    Parameters

    Returns Promise<Array<SearchIndexer>>

listIndexersNames

  • Retrieves a list of names of existing indexers in the service.

    Parameters

    Returns Promise<Array<string>>

listSkillsets

  • Retrieves a list of existing Skillsets in the service.

    Parameters

    Returns Promise<Array<SearchIndexerSkillset>>

listSkillsetsNames

  • Retrieves a list of names of existing Skillsets in the service.

    Parameters

    Returns Promise<Array<string>>

resetDocuments

  • Resets specific documents in the datasource to be selectively re-ingested by the indexer.

    Parameters

    • indexerName: string

      The name of the indexer to reset documents for.

    • Default value options: ResetDocumentsOptions = {}

      Additional optional arguments.

    Returns Promise<void>

resetIndexer

  • Resets the change tracking state associated with an indexer.

    Parameters

    • indexerName: string

      The name of the indexer to reset.

    • Default value options: ResetIndexerOptions = {}

      Additional optional arguments.

    Returns Promise<void>

resetSkills

  • Reset an existing skillset in a search service.

    Parameters

    • skillsetName: string

      The name of the skillset to reset.

    • Default value options: ResetSkillsOptions = {}

      The options parameters.

    Returns Promise<void>

runIndexer

  • Runs an indexer on-demand.

    Parameters

    • indexerName: string

      The name of the indexer to run.

    • Default value options: RunIndexerOptions = {}

      Additional optional arguments.

    Returns Promise<void>

Generated using TypeDoc