SearchIndexerClient class

Balíček:

@azure/search-documents

Třída pro provádění operací pro správu (vytvoření, aktualizace, výpis/odstranění) indexerů, zdrojů dat & sad dovedností.

Konstruktory

SearchIndexerClient(string, KeyCredential | TokenCredential, SearchIndexerClientOptions)

Vytvoří instanci SearchIndexerClient. Příklad použití: const { SearchIndexerClient, AzureKeyCredential } = require("@azure/search-documents"); const client = new SearchIndexerClient( "<endpoint>", new AzureKeyCredential("<Admin Key>"); );

Vlastnosti

apiVersion	Verze rozhraní API, která se má použít při komunikaci se službou
endpoint	Koncový bod vyhledávací služby
serviceVersion	Verze rozhraní API, která se má použít při komunikaci se službou

Metody

createDataSourceConnection(SearchIndexerDataSourceConnection, OperationOptions)	Vytvoří nový zdroj dat ve vyhledávací službě.
createIndexer(SearchIndexer, OperationOptions)	Vytvoří nový indexer ve vyhledávací službě.
createOrUpdateDataSourceConnection(SearchIndexerDataSourceConnection, CreateorUpdateDataSourceConnectionOptions)	Vytvoří nový zdroj dat nebo upraví existující zdroj dat.
createOrUpdateIndexer(SearchIndexer, CreateorUpdateIndexerOptions)	Vytvoří nový indexer nebo upraví existující indexer.
createOrUpdateSkillset(SearchIndexerSkillset, CreateOrUpdateSkillsetOptions)	Vytvoří novou sadu dovedností nebo upraví existující sadu dovedností.
createSkillset(SearchIndexerSkillset, OperationOptions)	Vytvoří novou sadu dovedností ve vyhledávací službě.
deleteDataSourceConnection(string | SearchIndexerDataSourceConnection, DeleteDataSourceConnectionOptions)	Odstraní existující zdroj dat.
deleteIndexer(string | SearchIndexer, DeleteIndexerOptions)	Odstraní existující indexer.
deleteSkillset(string | SearchIndexerSkillset, DeleteSkillsetOptions)	Odstraní existující sadu dovedností.
getDataSourceConnection(string, OperationOptions)	Načte informace o zdroji dat.
getIndexer(string, OperationOptions)	Načte informace o indexeru.
getIndexerStatus(string, OperationOptions)	Vrátí aktuální stav a historii provádění indexeru.
getSkillset(string, OperationOptions)	Načte informace o sadě dovedností.
listDataSourceConnections(OperationOptions)	Načte seznam existujících zdrojů dat ve službě.
listDataSourceConnectionsNames(OperationOptions)	Načte seznam názvů existujících zdrojů dat ve službě.
listIndexers(OperationOptions)	Načte seznam existujících indexerů ve službě.
listIndexersNames(OperationOptions)	Načte seznam názvů existujících indexerů ve službě.
listSkillsets(OperationOptions)	Načte seznam existujících sad dovedností ve službě.
listSkillsetsNames(OperationOptions)	Načte seznam názvů existujících sad dovedností ve službě.
resetIndexer(string, OperationOptions)	Obnoví stav sledování změn přidružený k indexeru.
runIndexer(string, OperationOptions)	Spustí indexer na vyžádání.

Podrobnosti konstruktoru

SearchIndexerClient(string, KeyCredential | TokenCredential, SearchIndexerClientOptions)

Vytvoří instanci SearchIndexerClient.

Příklad použití:

const { SearchIndexerClient, AzureKeyCredential } = require("@azure/search-documents");

const client = new SearchIndexerClient(
  "<endpoint>",
  new AzureKeyCredential("<Admin Key>");
);

new SearchIndexerClient(endpoint: string, credential: KeyCredential | TokenCredential, options?: SearchIndexerClientOptions)

Parametry

endpoint

string

Koncový bod vyhledávací služby

credential

KeyCredential | TokenCredential

Používá se k ověřování požadavků na službu.

options

SearchIndexerClientOptions

Slouží ke konfiguraci klienta služby Search.

Podrobnosti vlastnosti

apiVersion

Upozornění

Toto rozhraní API je teď zastaralé.

use {@Link serviceVersion} instead

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

apiVersion: string

Hodnota vlastnosti

string

endpoint

Koncový bod vyhledávací služby

endpoint: string

Hodnota vlastnosti

string

serviceVersion

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

serviceVersion: string

Hodnota vlastnosti

string

Podrobnosti metody

createDataSourceConnection(SearchIndexerDataSourceConnection, OperationOptions)

Vytvoří nový zdroj dat ve vyhledávací službě.

function createDataSourceConnection(dataSourceConnection: SearchIndexerDataSourceConnection, options?: OperationOptions): Promise<SearchIndexerDataSourceConnection>

Parametry

dataSourceConnection

SearchIndexerDataSourceConnection

Definice dataSource, která se má vytvořit ve vyhledávací službě.

options

OperationOptions

Další volitelné argumenty

Návraty

Promise<SearchIndexerDataSourceConnection>

createIndexer(SearchIndexer, OperationOptions)

Vytvoří nový indexer ve vyhledávací službě.

function createIndexer(indexer: SearchIndexer, options?: OperationOptions): Promise<SearchIndexer>

Parametry

indexer

SearchIndexer

Definice indexeru, která se má vytvořit ve vyhledávací službě.

options

OperationOptions

Další volitelné argumenty

Návraty

Promise<SearchIndexer>

createOrUpdateDataSourceConnection(SearchIndexerDataSourceConnection, CreateorUpdateDataSourceConnectionOptions)

Vytvoří nový zdroj dat nebo upraví existující zdroj dat.

function createOrUpdateDataSourceConnection(dataSourceConnection: SearchIndexerDataSourceConnection, options?: CreateorUpdateDataSourceConnectionOptions): Promise<SearchIndexerDataSourceConnection>

Parametry

dataSourceConnection

SearchIndexerDataSourceConnection

Informace popisující zdroj dat, který se má vytvořit nebo aktualizovat.

options

CreateorUpdateDataSourceConnectionOptions

Další volitelné argumenty

Návraty

Promise<SearchIndexerDataSourceConnection>

createOrUpdateIndexer(SearchIndexer, CreateorUpdateIndexerOptions)

Vytvoří nový indexer nebo upraví existující indexer.

function createOrUpdateIndexer(indexer: SearchIndexer, options?: CreateorUpdateIndexerOptions): Promise<SearchIndexer>

Parametry

indexer

SearchIndexer

Informace popisující indexer, který se má vytvořit nebo aktualizovat.

options

CreateorUpdateIndexerOptions

Další volitelné argumenty

Návraty

Promise<SearchIndexer>

createOrUpdateSkillset(SearchIndexerSkillset, CreateOrUpdateSkillsetOptions)

Vytvoří novou sadu dovedností nebo upraví existující sadu dovedností.

function createOrUpdateSkillset(skillset: SearchIndexerSkillset, options?: CreateOrUpdateSkillsetOptions): Promise<SearchIndexerSkillset>

Parametry

skillset

SearchIndexerSkillset

Informace popisující index, který se má vytvořit.

options

CreateOrUpdateSkillsetOptions

Další volitelné argumenty

Návraty

Promise<SearchIndexerSkillset>

createSkillset(SearchIndexerSkillset, OperationOptions)

Vytvoří novou sadu dovedností ve vyhledávací službě.

function createSkillset(skillset: SearchIndexerSkillset, options?: OperationOptions): Promise<SearchIndexerSkillset>

Parametry

skillset

SearchIndexerSkillset

Sada dovedností obsahující jednu nebo více dovedností, které se mají vytvořit ve vyhledávací službě.

options

OperationOptions

Další volitelné argumenty

Návraty

Promise<SearchIndexerSkillset>

deleteDataSourceConnection(string | SearchIndexerDataSourceConnection, DeleteDataSourceConnectionOptions)

Odstraní existující zdroj dat.

function deleteDataSourceConnection(dataSourceConnection: string | SearchIndexerDataSourceConnection, options?: DeleteDataSourceConnectionOptions): Promise<void>

Parametry

dataSourceConnection

string | SearchIndexerDataSourceConnection

options

DeleteDataSourceConnectionOptions

Další volitelné argumenty

Návraty

Promise<void>

deleteIndexer(string | SearchIndexer, DeleteIndexerOptions)

Odstraní existující indexer.

function deleteIndexer(indexer: string | SearchIndexer, options?: DeleteIndexerOptions): Promise<void>

Parametry

indexer

string | SearchIndexer

Indexer / Název indexeru, který chcete odstranit.

options

DeleteIndexerOptions

Další volitelné argumenty

Návraty

Promise<void>

deleteSkillset(string | SearchIndexerSkillset, DeleteSkillsetOptions)

Odstraní existující sadu dovedností.

function deleteSkillset(skillset: string | SearchIndexerSkillset, options?: DeleteSkillsetOptions): Promise<void>

Parametry

skillset

string | SearchIndexerSkillset

Sada dovedností / název sady dovedností, která se má odstranit.

options

DeleteSkillsetOptions

Další volitelné argumenty

Návraty

Promise<void>

getDataSourceConnection(string, OperationOptions)

Načte informace o zdroji dat.

function getDataSourceConnection(dataSourceConnectionName: string, options?: OperationOptions): Promise<SearchIndexerDataSourceConnection>

Parametry

dataSourceConnectionName

string

options

OperationOptions

Další volitelné argumenty

Návraty

Promise<SearchIndexerDataSourceConnection>

getIndexer(string, OperationOptions)

Načte informace o indexeru.

function getIndexer(indexerName: string, options?: OperationOptions): Promise<SearchIndexer>

Parametry

indexerName

string

Název indexeru.

options

OperationOptions

Další volitelné argumenty

Návraty

Promise<SearchIndexer>

getIndexerStatus(string, OperationOptions)

Vrátí aktuální stav a historii provádění indexeru.

function getIndexerStatus(indexerName: string, options?: OperationOptions): Promise<SearchIndexerStatus>

Parametry

indexerName

string

Název indexeru.

options

OperationOptions

Další volitelné argumenty

Návraty

Promise<SearchIndexerStatus>

getSkillset(string, OperationOptions)

Načte informace o sadě dovedností.

function getSkillset(skillsetName: string, options?: OperationOptions): Promise<SearchIndexerSkillset>

Parametry

skillsetName

string

options

OperationOptions

Další volitelné argumenty

Návraty

Promise<SearchIndexerSkillset>

listDataSourceConnections(OperationOptions)

Načte seznam existujících zdrojů dat ve službě.

function listDataSourceConnections(options?: OperationOptions): Promise<SearchIndexerDataSourceConnection[]>

Parametry

options

OperationOptions

Možnosti operace indexerů seznamu

Návraty

Promise<SearchIndexerDataSourceConnection[]>

listDataSourceConnectionsNames(OperationOptions)

Načte seznam názvů existujících zdrojů dat ve službě.

function listDataSourceConnectionsNames(options?: OperationOptions): Promise<string[]>

Parametry

options

OperationOptions

Možnosti operace indexerů seznamu

Návraty

Promise<string[]>

listIndexers(OperationOptions)

Načte seznam existujících indexerů ve službě.

function listIndexers(options?: OperationOptions): Promise<SearchIndexer[]>

Parametry

options

OperationOptions

Možnosti operace indexerů seznamu

Návraty

Promise<SearchIndexer[]>

listIndexersNames(OperationOptions)

Načte seznam názvů existujících indexerů ve službě.

function listIndexersNames(options?: OperationOptions): Promise<string[]>

Parametry

options

OperationOptions

Možnosti operace indexerů seznamu

Návraty

Promise<string[]>

listSkillsets(OperationOptions)

Načte seznam existujících sad dovedností ve službě.

function listSkillsets(options?: OperationOptions): Promise<SearchIndexerSkillset[]>

Parametry

options

OperationOptions

Možnosti pro operaci sady dovedností.

Návraty

Promise<SearchIndexerSkillset[]>

listSkillsetsNames(OperationOptions)

Načte seznam názvů existujících sad dovedností ve službě.

function listSkillsetsNames(options?: OperationOptions): Promise<string[]>

Parametry

options

OperationOptions

Možnosti pro operaci sady dovedností.

Návraty

Promise<string[]>

resetIndexer(string, OperationOptions)

Obnoví stav sledování změn přidružený k indexeru.

function resetIndexer(indexerName: string, options?: OperationOptions): Promise<void>

Parametry

indexerName

string

Název indexeru, který se má resetovat.

options

OperationOptions

Další volitelné argumenty

Návraty

Promise<void>

runIndexer(string, OperationOptions)

Spustí indexer na vyžádání.

function runIndexer(indexerName: string, options?: OperationOptions): Promise<void>

Parametry

indexerName

string

Název indexeru, který se má spustit.

options

OperationOptions

Další volitelné argumenty

Návraty

Promise<void>