SearchIndexClient class

Pakiet:

@azure/search-documents

Klasa do wykonywania operacji zarządzania indeksami (tworzenie, aktualizowanie, wyświetlanie/usuwanie) & mapami synonimów.

Konstruktory

SearchIndexClient(string, KeyCredential | TokenCredential, SearchIndexClientOptions)

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

Właściwości

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

Metody

analyzeText(string, AnalyzeTextOptions)	Wywołuje analizatora lub tokenizatora ręcznie w podanym tekście.
createIndex(SearchIndex, OperationOptions)	Tworzy nowy indeks.
createOrUpdateIndex(SearchIndex, CreateOrUpdateIndexOptions)	Tworzy nowy indeks lub modyfikuje istniejący.
createOrUpdateSynonymMap(SynonymMap, CreateOrUpdateSynonymMapOptions)	Tworzy nowy obiekt SynonimMap lub modyfikuje istniejącą.
createSynonymMap(SynonymMap, OperationOptions)	Tworzy nowy synonimMap w usłudze wyszukiwania.
deleteIndex(string | SearchIndex, DeleteIndexOptions)	Usuwa istniejący indeks.
deleteSynonymMap(string | SynonymMap, DeleteSynonymMapOptions)	Usuwa istniejący obiekt SynonimMap.
getIndex(string, OperationOptions)	Pobiera informacje o indeksie.
getIndexStatistics(string, OperationOptions)	Pobiera statystyki dotyczące indeksu, takie jak liczba dokumentów i rozmiar magazynu indeksów.
getSearchClient<TModel>(string, SearchClientOptions)	Pobiera element SearchClient odpowiadający temu elementowi SearchIndexClient
getServiceStatistics(OperationOptions)	Pobiera statystyki dotyczące usługi, takie jak liczba dokumentów, indeks itp.
getSynonymMap(string, OperationOptions)	Pobiera informacje o obiekcie SynonymMap.
listIndexes(OperationOptions)	Pobiera listę istniejących indeksów w usłudze.
listIndexesNames(OperationOptions)	Pobiera listę nazw istniejących indeksów w usłudze.
listSynonymMaps(OperationOptions)	Pobiera listę istniejących obiektów SynonimMap w usłudze.
listSynonymMapsNames(OperationOptions)	Pobiera listę nazw istniejących obiektów SynonimMap w usłudze.

Szczegóły konstruktora

SearchIndexClient(string, KeyCredential | TokenCredential, SearchIndexClientOptions)

Tworzy wystąpienie klasy SearchIndexClient.

Przykład użycia:

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

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

new SearchIndexClient(endpoint: string, credential: KeyCredential | TokenCredential, options?: SearchIndexClientOptions)

Parametry

endpoint

string

Punkt końcowy usługi wyszukiwania

credential

KeyCredential | TokenCredential

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

options

SearchIndexClientOptions

Służy do konfigurowania klienta indeksu 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 komunikowania się 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 komunikowania się z usługą.

serviceVersion: string

Wartość właściwości

string

Szczegóły metody

analyzeText(string, AnalyzeTextOptions)

Wywołuje analizatora lub tokenizatora ręcznie w podanym tekście.

function analyzeText(indexName: string, options: AnalyzeTextOptions): Promise<AnalyzeResult>

Parametry

indexName

string

Nazwa indeksu zawierającego pole do przeanalizowania

options

AnalyzeTextOptions

Dodatkowe argumenty

Zwraca

Promise<AnalyzeResult>

createIndex(SearchIndex, OperationOptions)

Tworzy nowy indeks.

function createIndex(index: SearchIndex, options?: OperationOptions): Promise<SearchIndex>

Parametry

index

SearchIndex

Informacje opisujące indeks do utworzenia.

options

OperationOptions

Dodatkowe argumenty opcjonalne.

Zwraca

Promise<SearchIndex>

createOrUpdateIndex(SearchIndex, CreateOrUpdateIndexOptions)

Tworzy nowy indeks lub modyfikuje istniejący.

function createOrUpdateIndex(index: SearchIndex, options?: CreateOrUpdateIndexOptions): Promise<SearchIndex>

Parametry

index

SearchIndex

Informacje opisujące indeks do utworzenia.

options

CreateOrUpdateIndexOptions

Dodatkowe argumenty opcjonalne.

Zwraca

Promise<SearchIndex>

createOrUpdateSynonymMap(SynonymMap, CreateOrUpdateSynonymMapOptions)

Tworzy nowy obiekt SynonimMap lub modyfikuje istniejącą.

function createOrUpdateSynonymMap(synonymMap: SynonymMap, options?: CreateOrUpdateSynonymMapOptions): Promise<SynonymMap>

Parametry

synonymMap

SynonymMap

Informacje opisujące mapę synonimów do utworzenia.

options

CreateOrUpdateSynonymMapOptions

Dodatkowe argumenty opcjonalne.

Zwraca

Promise<SynonymMap>

createSynonymMap(SynonymMap, OperationOptions)

Tworzy nowy synonimMap w usłudze wyszukiwania.

function createSynonymMap(synonymMap: SynonymMap, options?: OperationOptions): Promise<SynonymMap>

Parametry

synonymMap

SynonymMap

Definicja synonimuMap do utworzenia w usłudze wyszukiwania.

options

OperationOptions

Dodatkowe argumenty opcjonalne.

Zwraca

Promise<SynonymMap>

deleteIndex(string | SearchIndex, DeleteIndexOptions)

Usuwa istniejący indeks.

function deleteIndex(index: string | SearchIndex, options?: DeleteIndexOptions): Promise<void>

Parametry

index

string | SearchIndex

options

DeleteIndexOptions

Dodatkowe argumenty opcjonalne.

Zwraca

Promise<void>

deleteSynonymMap(string | SynonymMap, DeleteSynonymMapOptions)

Usuwa istniejący obiekt SynonimMap.

function deleteSynonymMap(synonymMap: string | SynonymMap, options?: DeleteSynonymMapOptions): Promise<void>

Parametry

synonymMap

string | SynonymMap

options

DeleteSynonymMapOptions

Dodatkowe argumenty opcjonalne.

Zwraca

Promise<void>

getIndex(string, OperationOptions)

Pobiera informacje o indeksie.

function getIndex(indexName: string, options?: OperationOptions): Promise<SearchIndex>

Parametry

indexName

string

Nazwa indeksu.

options

OperationOptions

Dodatkowe argumenty opcjonalne.

Zwraca

Promise<SearchIndex>

getIndexStatistics(string, OperationOptions)

Pobiera statystyki dotyczące indeksu, takie jak liczba dokumentów i rozmiar magazynu indeksów.

function getIndexStatistics(indexName: string, options?: OperationOptions): Promise<SearchIndexStatistics>

Parametry

indexName

string

Nazwa indeksu.

options

OperationOptions

Dodatkowe argumenty opcjonalne.

Zwraca

Promise<SearchIndexStatistics>

getSearchClient<TModel>(string, SearchClientOptions)

Pobiera element SearchClient odpowiadający temu elementowi SearchIndexClient

function getSearchClient<TModel>(indexName: string, options?: SearchClientOptions): SearchClient<TModel>

Parametry

indexName

string

Nazwa indeksu

options

SearchClientOptions

Opcje elementu SearchClient

Zwraca

SearchClient<TModel>

getServiceStatistics(OperationOptions)

Pobiera statystyki dotyczące usługi, takie jak liczba dokumentów, indeks itp.

function getServiceStatistics(options?: OperationOptions): Promise<SearchServiceStatistics>

Parametry

options

OperationOptions

Dodatkowe argumenty opcjonalne.

Zwraca

Promise<SearchServiceStatistics>

getSynonymMap(string, OperationOptions)

Pobiera informacje o obiekcie SynonymMap.

function getSynonymMap(synonymMapName: string, options?: OperationOptions): Promise<SynonymMap>

Parametry

synonymMapName

string

Nazwa synonimuMap.

options

OperationOptions

Dodatkowe argumenty opcjonalne.

Zwraca

Promise<SynonymMap>

listIndexes(OperationOptions)

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

function listIndexes(options?: OperationOptions): IndexIterator

Parametry

options

OperationOptions

Opcje operacji indeksowania listy.

Zwraca

IndexIterator

listIndexesNames(OperationOptions)

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

function listIndexesNames(options?: OperationOptions): IndexNameIterator

Parametry

options

OperationOptions

Opcje operacji indeksowania listy.

Zwraca

IndexNameIterator

listSynonymMaps(OperationOptions)

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

function listSynonymMaps(options?: OperationOptions): Promise<SynonymMap[]>

Parametry

options

OperationOptions

Opcje operacji SynonymMaps listy.

Zwraca

Promise<SynonymMap[]>

listSynonymMapsNames(OperationOptions)

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

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

Parametry

options

OperationOptions

Opcje operacji SynonymMaps listy.

Zwraca

Promise<string[]>