SearchIndexClient class

Pakiet:

@azure/search-documents

Klasa do wykonywania operacji w celu zarządzania (tworzeniem, aktualizowaniem, listą/usuwaniem) indeksów, & synonimami.

Konstruktory

SearchIndexClient(string, KeyCredential | TokenCredential, SearchIndexClientOptions)

Tworzy wystąpienie klasy SearchIndexClient. Przykładowe użycie: import { SearchIndexClient, AzureKeyCredential } from "@azure/search-documents"; const indexClient = new SearchIndexClient("<endpoint>", new AzureKeyCredential("<apiKey>"));

Właściwości

apiVersion	Wersja interfejsu API do użycia podczas komunikacji z usługą.
endpoint	Punkt końcowy usługi wyszukiwania
pipeline	Odwołanie do wewnętrznego potoku HTTP do użycia z nieprzetworzonymi żądaniami
serviceVersion	Wersja interfejsu API do użycia podczas komunikacji z usługą.

Metody

analyzeText(string, AnalyzeTextOptions)	Wywołuje analizator lub tokenizer ręcznie w podanym tekście.
createAlias(SearchAlias, OperationOptions)	Tworzy nowy alias wyszukiwania.
createIndex(SearchIndex, OperationOptions)	Tworzy nowy indeks.
createKnowledgeBase(KnowledgeBase, CreateKnowledgeBaseOptions)	Tworzy nową bazę wiedzy.
createKnowledgeSource(KnowledgeSource, CreateKnowledgeSourceOptions)	Tworzy nowe źródło wiedzy.
createOrUpdateAlias(SearchAlias, CreateOrUpdateAliasOptions)	Tworzy nowy alias wyszukiwania lub aktualizuje alias, jeśli już istnieje.
createOrUpdateIndex(SearchIndex, CreateOrUpdateIndexOptions)	Tworzy nowy indeks lub modyfikuje istniejący.
createOrUpdateKnowledgeBase(string, KnowledgeBase, CreateOrUpdateKnowledgeBaseOptions)	Tworzy nową bazę wiedzy lub aktualizuje ją, jeśli już istnieje.
createOrUpdateKnowledgeSource(string, KnowledgeSource, CreateOrUpdateKnowledgeSourceOptions)
createOrUpdateSynonymMap(SynonymMap, CreateOrUpdateSynonymMapOptions)	Tworzy nową mapę synonimu lub modyfikuje istniejącą.
createSynonymMap(SynonymMap, OperationOptions)	Tworzy nową aplikację SynonimMap w usłudze wyszukiwania.
deleteAlias(SearchAlias, DeleteAliasOptions)	Usuwa alias wyszukiwania i skojarzone z nim mapowanie na indeks. Ta operacja jest trwała, bez opcji odzyskiwania. Zamapowany indeks jest nietknięty przez tę operację.
deleteAlias(string, DeleteAliasOptions)	Usuwa alias wyszukiwania i skojarzone z nim mapowanie na indeks. Ta operacja jest trwała, bez opcji odzyskiwania. Zamapowany indeks jest nietknięty przez tę operację.
deleteIndex(SearchIndex, DeleteIndexOptions)	Usuwa istniejący indeks.
deleteIndex(string, DeleteIndexOptions)	Usuwa istniejący indeks.
deleteKnowledgeBase(KnowledgeBase, DeleteKnowledgeBaseOptions)	Usuwa istniejącą bazę wiedzy.
deleteKnowledgeBase(string, DeleteKnowledgeBaseOptions)	Usuwa istniejącą bazę wiedzy.
deleteKnowledgeSource(KnowledgeSource, DeleteKnowledgeSourceOptions)	Usuwa istniejące źródło.
deleteKnowledgeSource(string, DeleteKnowledgeSourceOptions)	Usuwa istniejące źródło.
deleteSynonymMap(string | SynonymMap, DeleteSynonymMapOptions)	Usuwa istniejącą mapę synonimów.
getAlias(string, OperationOptions)	Pobiera definicję aliasu.
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.
getIndexStatsSummary(GetIndexStatsSummaryOptions)	Pobiera listę istniejących indeksów w usłudze.
getKnowledgeBase(string, GetKnowledgeBaseOptions)	Pobiera definicję bazy wiedzy.
getKnowledgeRetrievalClient(string, KnowledgeRetrievalClientOptions)	Pobiera element KnowledgeRetrievalClient odpowiadający temu klientowi SearchIndexClient
getKnowledgeSource(string, GetKnowledgeSourceOptions)	Pobiera definicję źródła wiedzy.
getKnowledgeSourceStatus(string, GetKnowledgeSourceStatusOptions)	Zwraca bieżący stan i historię synchronizacji źródła wiedzy.
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ów itp.
getSynonymMap(string, OperationOptions)	Pobiera informacje o synonimieMap.
listAliases(OperationOptions)	Wyświetla listę wszystkich aliasów dostępnych dla usługi wyszukiwania.
listIndexes(OperationOptions)	Pobiera listę istniejących indeksów w usłudze.
listIndexesNames(OperationOptions)	Pobiera listę nazw istniejących indeksów w usłudze.
listKnowledgeBases(ListKnowledgeBasesOptions)	Pobiera listę istniejących baz wiedzy w usłudze.
listKnowledgeSources(ListKnowledgeSourcesOptions)	Pobiera listę istniejących źródeł wiedzy w usłudze.
listSynonymMaps(OperationOptions)	Pobiera listę istniejących map synonimów w usłudze.
listSynonymMapsNames(OperationOptions)	Pobiera listę nazw istniejących synonimówMap w usłudze.

Szczegóły konstruktora

SearchIndexClient(string, KeyCredential | TokenCredential, SearchIndexClientOptions)

Tworzy wystąpienie klasy SearchIndexClient.

Przykładowe użycie:

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

const indexClient = new SearchIndexClient("<endpoint>", new AzureKeyCredential("<apiKey>"));

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 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

pipeline

Odwołanie do wewnętrznego potoku HTTP do użycia z nieprzetworzonymi żądaniami

pipeline: Pipeline

Wartość właściwości

Pipeline

serviceVersion

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

serviceVersion: string

Wartość właściwości

string

Szczegóły metody

analyzeText(string, AnalyzeTextOptions)

Wywołuje analizator lub tokenizer 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>

createAlias(SearchAlias, OperationOptions)

Tworzy nowy alias wyszukiwania.

function createAlias(alias: SearchAlias, options?: OperationOptions): Promise<SearchAlias>

Parametry

alias

SearchAlias

Definicja aliasu do utworzenia.

options

OperationOptions

Parametry opcji.

Zwraca

Promise<SearchAlias>

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>

createKnowledgeBase(KnowledgeBase, CreateKnowledgeBaseOptions)

Tworzy nową bazę wiedzy.

function createKnowledgeBase(knowledgeBase: KnowledgeBase, options?: CreateKnowledgeBaseOptions): Promise<KnowledgeBase>

Parametry

knowledgeBase

KnowledgeBase

definicja bazy wiedzy do tworzenia.

options

CreateKnowledgeBaseOptions

parametry opcji.

Zwraca

Promise<KnowledgeBase>

createKnowledgeSource(KnowledgeSource, CreateKnowledgeSourceOptions)

Tworzy nowe źródło wiedzy.

function createKnowledgeSource(knowledgeSource: KnowledgeSource, options?: CreateKnowledgeSourceOptions): Promise<KnowledgeSource>

Parametry

knowledgeSource

KnowledgeSource

Definicja źródła wiedzy do utworzenia.

options

CreateKnowledgeSourceOptions

Parametry opcji.

Zwraca

Promise<KnowledgeSource>

createOrUpdateAlias(SearchAlias, CreateOrUpdateAliasOptions)

Tworzy nowy alias wyszukiwania lub aktualizuje alias, jeśli już istnieje.

function createOrUpdateAlias(alias: SearchAlias, options?: CreateOrUpdateAliasOptions): Promise<SearchAlias>

Parametry

alias

SearchAlias

Definicja aliasu do utworzenia lub zaktualizowania.

options

CreateOrUpdateAliasOptions

Parametry opcji.

Zwraca

Promise<SearchAlias>

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>

createOrUpdateKnowledgeBase(string, KnowledgeBase, CreateOrUpdateKnowledgeBaseOptions)

Tworzy nową bazę wiedzy lub aktualizuje ją, jeśli już istnieje.

function createOrUpdateKnowledgeBase(knowledgeBaseName: string, knowledgeBase: KnowledgeBase, options?: CreateOrUpdateKnowledgeBaseOptions): Promise<KnowledgeBase>

Parametry

knowledgeBaseName

string

Nazwa bazy wiedzy do stworzenia lub aktualizacji.

knowledgeBase

KnowledgeBase

Definicja bazy wiedzy do stworzenia lub aktualizacji.

options

CreateOrUpdateKnowledgeBaseOptions

parametry opcji.

Zwraca

Promise<KnowledgeBase>

createOrUpdateKnowledgeSource(string, KnowledgeSource, CreateOrUpdateKnowledgeSourceOptions)

function createOrUpdateKnowledgeSource(sourceName: string, knowledgeSource: KnowledgeSource, options?: CreateOrUpdateKnowledgeSourceOptions): Promise<KnowledgeSource>

Parametry

sourceName

string

knowledgeSource

KnowledgeSource

options

CreateOrUpdateKnowledgeSourceOptions

Zwraca

Promise<KnowledgeSource>

createOrUpdateSynonymMap(SynonymMap, CreateOrUpdateSynonymMapOptions)

Tworzy nową mapę synonimu 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 nową aplikację 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>

deleteAlias(SearchAlias, DeleteAliasOptions)

Usuwa alias wyszukiwania i skojarzone z nim mapowanie na indeks. Ta operacja jest trwała, bez opcji odzyskiwania. Zamapowany indeks jest nietknięty przez tę operację.

function deleteAlias(alias: SearchAlias, options?: DeleteAliasOptions): Promise<void>

Parametry

alias

SearchAlias

Alias do usunięcia.

options

DeleteAliasOptions

Dodatkowe argumenty opcjonalne.

Zwraca

Promise<void>

deleteAlias(string, DeleteAliasOptions)

Usuwa alias wyszukiwania i skojarzone z nim mapowanie na indeks. Ta operacja jest trwała, bez opcji odzyskiwania. Zamapowany indeks jest nietknięty przez tę operację.

function deleteAlias(aliasName: string, options?: DeleteAliasOptions): Promise<void>

Parametry

aliasName

string

Nazwa aliasu do usunięcia.

options

DeleteAliasOptions

Dodatkowe argumenty opcjonalne.

Zwraca

Promise<void>

deleteIndex(SearchIndex, DeleteIndexOptions)

Usuwa istniejący indeks.

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

Parametry

index

SearchIndex

Indeks do usunięcia.

options

DeleteIndexOptions

Dodatkowe argumenty opcjonalne.

Zwraca

Promise<void>

deleteIndex(string, DeleteIndexOptions)

Usuwa istniejący indeks.

function deleteIndex(indexName: string, options?: DeleteIndexOptions): Promise<void>

Parametry

indexName

string

Nazwa indeksu do usunięcia.

options

DeleteIndexOptions

Dodatkowe argumenty opcjonalne.

Zwraca

Promise<void>

deleteKnowledgeBase(KnowledgeBase, DeleteKnowledgeBaseOptions)

Usuwa istniejącą bazę wiedzy.

function deleteKnowledgeBase(knowledgeBase: KnowledgeBase, options?: DeleteKnowledgeBaseOptions): Promise<void>

Parametry

knowledgeBase

KnowledgeBase

Baza wiedzy do usunięcia.

options

DeleteKnowledgeBaseOptions

parametry opcji.

Zwraca

Promise<void>

deleteKnowledgeBase(string, DeleteKnowledgeBaseOptions)

Usuwa istniejącą bazę wiedzy.

function deleteKnowledgeBase(knowledgeBaseName: string, options?: DeleteKnowledgeBaseOptions): Promise<void>

Parametry

knowledgeBaseName

string

Nazwa bazy wiedzy do usunięcia.

options

DeleteKnowledgeBaseOptions

parametry opcji.

Zwraca

Promise<void>

deleteKnowledgeSource(KnowledgeSource, DeleteKnowledgeSourceOptions)

Usuwa istniejące źródło.

function deleteKnowledgeSource(source: KnowledgeSource, options?: DeleteKnowledgeSourceOptions): Promise<void>

Parametry

source

KnowledgeSource

Źródło wiedzy do usunięcia.

options

DeleteKnowledgeSourceOptions

parametry opcji.

Zwraca

Promise<void>

deleteKnowledgeSource(string, DeleteKnowledgeSourceOptions)

Usuwa istniejące źródło.

function deleteKnowledgeSource(sourceName: string, options?: DeleteKnowledgeSourceOptions): Promise<void>

Parametry

sourceName

string

Nazwa źródła wiedzy do usunięcia.

options

DeleteKnowledgeSourceOptions

parametry opcji.

Zwraca

Promise<void>

deleteSynonymMap(string | SynonymMap, DeleteSynonymMapOptions)

Usuwa istniejącą mapę synonimów.

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

Parametry

synonymMap

string | SynonymMap

options

DeleteSynonymMapOptions

Dodatkowe argumenty opcjonalne.

Zwraca

Promise<void>

getAlias(string, OperationOptions)

Pobiera definicję aliasu.

function getAlias(aliasName: string, options?: OperationOptions): Promise<SearchAlias>

Parametry

aliasName

string

Nazwa aliasu do pobrania.

options

OperationOptions

Parametry opcji.

Zwraca

Promise<SearchAlias>

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>

getIndexStatsSummary(GetIndexStatsSummaryOptions)

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

function getIndexStatsSummary(options?: GetIndexStatsSummaryOptions): IndexStatisticsSummaryIterator

Parametry

options

GetIndexStatsSummaryOptions

Opcje operacji indeksowania listy.

Zwraca

IndexStatisticsSummaryIterator

getKnowledgeBase(string, GetKnowledgeBaseOptions)

Pobiera definicję bazy wiedzy.

function getKnowledgeBase(knowledgeBaseName: string, options?: GetKnowledgeBaseOptions): Promise<KnowledgeBase>

Parametry

knowledgeBaseName

string

Nazwę bazy wiedzy do odzyskania.

options

GetKnowledgeBaseOptions

parametry opcji.

Zwraca

Promise<KnowledgeBase>

getKnowledgeRetrievalClient(string, KnowledgeRetrievalClientOptions)

Pobiera element KnowledgeRetrievalClient odpowiadający temu klientowi SearchIndexClient

function getKnowledgeRetrievalClient(knowledgeBaseName: string, options?: KnowledgeRetrievalClientOptions): KnowledgeRetrievalClient

Parametry

knowledgeBaseName

string

Nazwa bazy wiedzy

options

KnowledgeRetrievalClientOptions

Opcje klienta KnowledgeRetrievalClient

Zwraca

KnowledgeRetrievalClient

getKnowledgeSource(string, GetKnowledgeSourceOptions)

Pobiera definicję źródła wiedzy.

function getKnowledgeSource(sourceName: string, options?: GetKnowledgeSourceOptions): Promise<KnowledgeSource>

Parametry

sourceName

string

Nazwa źródła wiedzy do pobrania.

options

GetKnowledgeSourceOptions

Parametry opcji.

Zwraca

Promise<KnowledgeSource>

getKnowledgeSourceStatus(string, GetKnowledgeSourceStatusOptions)

Zwraca bieżący stan i historię synchronizacji źródła wiedzy.

function getKnowledgeSourceStatus(sourceName: string, options?: GetKnowledgeSourceStatusOptions): Promise<KnowledgeSourceStatus>

Parametry

sourceName

string

Nazwa źródła wiedzy, dla którego ma zostać pobrany stan.

options

GetKnowledgeSourceStatusOptions

Parametry opcji.

Zwraca

Promise<KnowledgeSourceStatus>

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ów itp.

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

Parametry

options

OperationOptions

Dodatkowe argumenty opcjonalne.

Zwraca

Promise<SearchServiceStatistics>

getSynonymMap(string, OperationOptions)

Pobiera informacje o synonimieMap.

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

Parametry

synonymMapName

string

Nazwa synonimuMap.

options

OperationOptions

Dodatkowe argumenty opcjonalne.

Zwraca

Promise<SynonymMap>

listAliases(OperationOptions)

Wyświetla listę wszystkich aliasów dostępnych dla usługi wyszukiwania.

function listAliases(options?: OperationOptions): AliasIterator

Parametry

options

OperationOptions

Parametry opcji.

Zwraca

AliasIterator

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

listKnowledgeBases(ListKnowledgeBasesOptions)

Pobiera listę istniejących baz wiedzy w usłudze.

function listKnowledgeBases(options?: ListKnowledgeBasesOptions): KnowledgeBaseIterator

Parametry

options

ListKnowledgeBasesOptions

Opcje operacji baz wiedzy na liście.

Zwraca

KnowledgeBaseIterator

listKnowledgeSources(ListKnowledgeSourcesOptions)

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

function listKnowledgeSources(options?: ListKnowledgeSourcesOptions): KnowledgeSourceIterator

Parametry

options

ListKnowledgeSourcesOptions

Opcje operacji wyświetlania listy źródeł wiedzy.

Zwraca

KnowledgeSourceIterator

listSynonymMaps(OperationOptions)

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

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

Parametry

options

OperationOptions

Opcje operacji SynonimyMapy listy.

Zwraca

Promise<SynonymMap[]>

listSynonymMapsNames(OperationOptions)

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

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

Parametry

options

OperationOptions

Opcje operacji SynonimyMapy listy.

Zwraca

Promise<string[]>