SearchIndexerClient class

Pakiet:

@azure/search-documents

Klasa do wykonywania operacji zarządzania (tworzeniem, aktualizowaniem, listą/usuwaniem) indeksatorów, źródłami danych & zestawami umiejętności.

Konstruktory

SearchIndexerClient(string, KeyCredential | TokenCredential, SearchIndexerClientOptions)

Tworzy wystąpienie klasy SearchIndexerClient. Przykład użycia: const { SearchIndexerClient, AzureKeyCredential } = require("@azure/search-documents"); const client = new SearchIndexerClient( "<endpoint>", new AzureKeyCredential("<Admin Key>"); );

Właściwości

apiVersion	Wersja interfejsu API do użycia podczas komunikacji z usługą.
endpoint	Punkt końcowy usługi wyszukiwania
serviceVersion	Wersja interfejsu API do użycia podczas komunikacji z usługą.

Metody

createDataSourceConnection(SearchIndexerDataSourceConnection, OperationOptions)	Tworzy nowe źródło danych w usłudze wyszukiwania.
createIndexer(SearchIndexer, OperationOptions)	Tworzy nowy indeksator w usłudze wyszukiwania.
createOrUpdateDataSourceConnection(SearchIndexerDataSourceConnection, CreateorUpdateDataSourceConnectionOptions)	Tworzy nowe źródło danych lub modyfikuje istniejący.
createOrUpdateIndexer(SearchIndexer, CreateorUpdateIndexerOptions)	Tworzy nowy indeksator lub modyfikuje istniejący.
createOrUpdateSkillset(SearchIndexerSkillset, CreateOrUpdateSkillsetOptions)	Tworzy nowy zestaw umiejętności lub modyfikuje istniejący.
createSkillset(SearchIndexerSkillset, OperationOptions)	Tworzy nowy zestaw umiejętności w usłudze wyszukiwania.
deleteDataSourceConnection(string | SearchIndexerDataSourceConnection, DeleteDataSourceConnectionOptions)	Usuwa istniejące źródło danych.
deleteIndexer(string | SearchIndexer, DeleteIndexerOptions)	Usuwa istniejący indeksator.
deleteSkillset(string | SearchIndexerSkillset, DeleteSkillsetOptions)	Usuwa istniejący zestaw umiejętności.
getDataSourceConnection(string, OperationOptions)	Pobiera informacje o źródle danych
getIndexer(string, OperationOptions)	Pobiera informacje o indeksatorze.
getIndexerStatus(string, OperationOptions)	Zwraca bieżący stan i historię wykonywania indeksatora.
getSkillset(string, OperationOptions)	Pobiera informacje o zestawie umiejętności.
listDataSourceConnections(OperationOptions)	Pobiera listę istniejących źródeł danych w usłudze.
listDataSourceConnectionsNames(OperationOptions)	Pobiera listę nazw istniejących źródeł danych w usłudze.
listIndexers(OperationOptions)	Pobiera listę istniejących indeksatorów w usłudze.
listIndexersNames(OperationOptions)	Pobiera listę nazw istniejących indeksatorów w usłudze.
listSkillsets(OperationOptions)	Pobiera listę istniejących zestawów umiejętności w usłudze.
listSkillsetsNames(OperationOptions)	Pobiera listę nazw istniejących zestawów umiejętności w usłudze.
resetIndexer(string, OperationOptions)	Resetuje stan śledzenia zmian skojarzony z indeksatorem.
runIndexer(string, OperationOptions)	Uruchamia indeksator na żądanie.

Szczegóły konstruktora

SearchIndexerClient(string, KeyCredential | TokenCredential, SearchIndexerClientOptions)

Tworzy wystąpienie klasy SearchIndexerClient.

Przykład użycia:

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

Punkt końcowy usługi wyszukiwania

credential

KeyCredential | TokenCredential

Służy do uwierzytelniania żądań w usłudze.

options

SearchIndexerClientOptions

Służy do konfigurowania klienta wyszukiwania.

Szczegóły właściwości

apiVersion

Ostrzeżenie

Ten interfejs API jest już przestarzały.

use {@Link serviceVersion} instead

Wersja interfejsu API do użycia podczas komunikacji z usługą.

apiVersion: string

Wartość właściwości

string

endpoint

Punkt końcowy usługi wyszukiwania

endpoint: string

Wartość właściwości

string

serviceVersion

Wersja interfejsu API do użycia podczas komunikacji z usługą.

serviceVersion: string

Wartość właściwości

string

Szczegóły metody

createDataSourceConnection(SearchIndexerDataSourceConnection, OperationOptions)

Tworzy nowe źródło danych w usłudze wyszukiwania.

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

Parametry

dataSourceConnection

SearchIndexerDataSourceConnection

Definicja źródła danych do utworzenia w usłudze wyszukiwania.

options

OperationOptions

Dodatkowe opcjonalne argumenty.

Zwraca

Promise<SearchIndexerDataSourceConnection>

createIndexer(SearchIndexer, OperationOptions)

Tworzy nowy indeksator w usłudze wyszukiwania.

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

Parametry

indexer

SearchIndexer

Definicja indeksatora do utworzenia w usłudze wyszukiwania.

options

OperationOptions

Dodatkowe opcjonalne argumenty.

Zwraca

Promise<SearchIndexer>

createOrUpdateDataSourceConnection(SearchIndexerDataSourceConnection, CreateorUpdateDataSourceConnectionOptions)

Tworzy nowe źródło danych lub modyfikuje istniejący.

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

Parametry

dataSourceConnection

SearchIndexerDataSourceConnection

Informacje opisujące źródło danych do utworzenia/zaktualizowania.

options

CreateorUpdateDataSourceConnectionOptions

Dodatkowe opcjonalne argumenty.

Zwraca

Promise<SearchIndexerDataSourceConnection>

createOrUpdateIndexer(SearchIndexer, CreateorUpdateIndexerOptions)

Tworzy nowy indeksator lub modyfikuje istniejący.

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

Parametry

indexer

SearchIndexer

Informacje opisujące indeksator do utworzenia/zaktualizowania.

options

CreateorUpdateIndexerOptions

Dodatkowe opcjonalne argumenty.

Zwraca

Promise<SearchIndexer>

createOrUpdateSkillset(SearchIndexerSkillset, CreateOrUpdateSkillsetOptions)

Tworzy nowy zestaw umiejętności lub modyfikuje istniejący.

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

Parametry

skillset

SearchIndexerSkillset

Informacje opisujące indeks do utworzenia.

options

CreateOrUpdateSkillsetOptions

Dodatkowe opcjonalne argumenty.

Zwraca

Promise<SearchIndexerSkillset>

createSkillset(SearchIndexerSkillset, OperationOptions)

Tworzy nowy zestaw umiejętności w usłudze wyszukiwania.

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

Parametry

skillset

SearchIndexerSkillset

Zestaw umiejętności zawierający co najmniej jedną umiejętności do utworzenia w usłudze wyszukiwania.

options

OperationOptions

Dodatkowe opcjonalne argumenty.

Zwraca

Promise<SearchIndexerSkillset>

deleteDataSourceConnection(string | SearchIndexerDataSourceConnection, DeleteDataSourceConnectionOptions)

Usuwa istniejące źródło danych.

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

Parametry

dataSourceConnection

string | SearchIndexerDataSourceConnection

options

DeleteDataSourceConnectionOptions

Dodatkowe opcjonalne argumenty.

Zwraca

Promise<void>

deleteIndexer(string | SearchIndexer, DeleteIndexerOptions)

Usuwa istniejący indeksator.

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

Parametry

indexer

string | SearchIndexer

Indeksator/nazwa indeksatora do usunięcia.

options

DeleteIndexerOptions

Dodatkowe opcjonalne argumenty.

Zwraca

Promise<void>

deleteSkillset(string | SearchIndexerSkillset, DeleteSkillsetOptions)

Usuwa istniejący zestaw umiejętności.

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

Parametry

skillset

string | SearchIndexerSkillset

Zestaw umiejętności/nazwa zestawu umiejętności do usunięcia.

options

DeleteSkillsetOptions

Dodatkowe opcjonalne argumenty.

Zwraca

Promise<void>

getDataSourceConnection(string, OperationOptions)

Pobiera informacje o źródle danych

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

Parametry

dataSourceConnectionName

string

options

OperationOptions

Dodatkowe argumenty opcjonalne

Zwraca

Promise<SearchIndexerDataSourceConnection>

getIndexer(string, OperationOptions)

Pobiera informacje o indeksatorze.

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

Parametry

indexerName

string

Nazwa indeksatora.

options

OperationOptions

Dodatkowe opcjonalne argumenty.

Zwraca

Promise<SearchIndexer>

getIndexerStatus(string, OperationOptions)

Zwraca bieżący stan i historię wykonywania indeksatora.

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

Parametry

indexerName

string

Nazwa indeksatora.

options

OperationOptions

Dodatkowe opcjonalne argumenty.

Zwraca

Promise<SearchIndexerStatus>

getSkillset(string, OperationOptions)

Pobiera informacje o zestawie umiejętności.

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

Parametry

skillsetName

string

options

OperationOptions

Dodatkowe opcjonalne argumenty.

Zwraca

Promise<SearchIndexerSkillset>

listDataSourceConnections(OperationOptions)

Pobiera listę istniejących źródeł danych w usłudze.

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

Parametry

options

OperationOptions

Opcje operacji indeksatorów listy.

Zwraca

Promise<SearchIndexerDataSourceConnection[]>

listDataSourceConnectionsNames(OperationOptions)

Pobiera listę nazw istniejących źródeł danych w usłudze.

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

Parametry

options

OperationOptions

Opcje operacji indeksatorów listy.

Zwraca

Promise<string[]>

listIndexers(OperationOptions)

Pobiera listę istniejących indeksatorów w usłudze.

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

Parametry

options

OperationOptions

Opcje operacji indeksatorów listy.

Zwraca

Promise<SearchIndexer[]>

listIndexersNames(OperationOptions)

Pobiera listę nazw istniejących indeksatorów w usłudze.

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

Parametry

options

OperationOptions

Opcje operacji indeksatorów listy.

Zwraca

Promise<string[]>

listSkillsets(OperationOptions)

Pobiera listę istniejących zestawów umiejętności w usłudze.

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

Parametry

options

OperationOptions

Opcje do listy Operacje zestawów umiejętności.

Zwraca

Promise<SearchIndexerSkillset[]>

listSkillsetsNames(OperationOptions)

Pobiera listę nazw istniejących zestawów umiejętności w usłudze.

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

Parametry

options

OperationOptions

Opcje do listy Operacje zestawów umiejętności.

Zwraca

Promise<string[]>

resetIndexer(string, OperationOptions)

Resetuje stan śledzenia zmian skojarzony z indeksatorem.

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

Parametry

indexerName

string

Nazwa indeksatora do zresetowania.

options

OperationOptions

Dodatkowe opcjonalne argumenty.

Zwraca

Promise<void>

runIndexer(string, OperationOptions)

Uruchamia indeksator na żądanie.

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

Parametry

indexerName

string

Nazwa indeksatora do uruchomienia.

options

OperationOptions

Dodatkowe opcjonalne argumenty.

Zwraca

Promise<void>