SearchIndexClient class

Balíček:

@azure/search-documents

Třída pro provádění operací pro správu indexů (vytvoření, aktualizace, výpis/odstranění) & mapování synonym.

Konstruktory

SearchIndexClient(string, KeyCredential | TokenCredential, SearchIndexClientOptions)

Vytvoří instanci SearchIndexClient. Příklad použití: const { SearchIndexClient, AzureKeyCredential } = require("@azure/search-documents"); const client = new SearchIndexClient( "<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

analyzeText(string, AnalyzeTextOptions)	Ručně zavolá analyzátor nebo tokenizátor na zadaný text.
createIndex(SearchIndex, OperationOptions)	Vytvoří nový index.
createOrUpdateIndex(SearchIndex, CreateOrUpdateIndexOptions)	Vytvoří nový index nebo upraví existující index.
createOrUpdateSynonymMap(SynonymMap, CreateOrUpdateSynonymMapOptions)	Vytvoří novou mapu synonym nebo upraví existující.
createSynonymMap(SynonymMap, OperationOptions)	Vytvoří novou mapu synonym ve vyhledávací službě.
deleteIndex(string | SearchIndex, DeleteIndexOptions)	Odstraní existující index.
deleteSynonymMap(string | SynonymMap, DeleteSynonymMapOptions)	Odstraní existující mapu synonym.
getIndex(string, OperationOptions)	Načte informace o indexu.
getIndexStatistics(string, OperationOptions)	Načte statistiky o indexu, například počet dokumentů a velikost úložiště indexu.
getSearchClient<TModel>(string, SearchClientOptions)	Načte SearchClient odpovídající tomuto SearchIndexClient.
getServiceStatistics(OperationOptions)	Načte statistiky o službě, například počet dokumentů, index atd.
getSynonymMap(string, OperationOptions)	Načte informace o SynonymMap.
listIndexes(OperationOptions)	Načte seznam existujících indexů ve službě.
listIndexesNames(OperationOptions)	Načte seznam názvů existujících indexů ve službě.
listSynonymMaps(OperationOptions)	Načte seznam existujících synonymMap ve službě.
listSynonymMapsNames(OperationOptions)	Načte seznam názvů existujících synonymMap ve službě.

Podrobnosti konstruktoru

SearchIndexClient(string, KeyCredential | TokenCredential, SearchIndexClientOptions)

Vytvoří instanci SearchIndexClient.

Příklad použití:

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

Koncový bod vyhledávací služby

credential

KeyCredential | TokenCredential

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

options

SearchIndexClientOptions

Slouží ke konfiguraci klienta indexu vyhledávání.

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

analyzeText(string, AnalyzeTextOptions)

Ručně zavolá analyzátor nebo tokenizátor na zadaný text.

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

Parametry

indexName

string

Název indexu, který obsahuje pole k analýze

options

AnalyzeTextOptions

Další argumenty

Návraty

Promise<AnalyzeResult>

createIndex(SearchIndex, OperationOptions)

Vytvoří nový index.

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

Parametry

index

SearchIndex

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

options

OperationOptions

Další volitelné argumenty

Návraty

Promise<SearchIndex>

createOrUpdateIndex(SearchIndex, CreateOrUpdateIndexOptions)

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

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

Parametry

index

SearchIndex

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

options

CreateOrUpdateIndexOptions

Další volitelné argumenty

Návraty

Promise<SearchIndex>

createOrUpdateSynonymMap(SynonymMap, CreateOrUpdateSynonymMapOptions)

Vytvoří novou mapu synonym nebo upraví existující.

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

Parametry

synonymMap

SynonymMap

Informace popisující mapu synonym, která se má vytvořit.

options

CreateOrUpdateSynonymMapOptions

Další volitelné argumenty

Návraty

Promise<SynonymMap>

createSynonymMap(SynonymMap, OperationOptions)

Vytvoří novou mapu synonym ve vyhledávací službě.

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

Parametry

synonymMap

SynonymMap

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

options

OperationOptions

Další volitelné argumenty

Návraty

Promise<SynonymMap>

deleteIndex(string | SearchIndex, DeleteIndexOptions)

Odstraní existující index.

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

Parametry

index

string | SearchIndex

options

DeleteIndexOptions

Další volitelné argumenty

Návraty

Promise<void>

deleteSynonymMap(string | SynonymMap, DeleteSynonymMapOptions)

Odstraní existující mapu synonym.

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

Parametry

synonymMap

string | SynonymMap

options

DeleteSynonymMapOptions

Další volitelné argumenty

Návraty

Promise<void>

getIndex(string, OperationOptions)

Načte informace o indexu.

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

Parametry

indexName

string

Název indexu.

options

OperationOptions

Další volitelné argumenty

Návraty

Promise<SearchIndex>

getIndexStatistics(string, OperationOptions)

Načte statistiky o indexu, například počet dokumentů a velikost úložiště indexu.

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

Parametry

indexName

string

Název indexu.

options

OperationOptions

Další volitelné argumenty

Návraty

Promise<SearchIndexStatistics>

getSearchClient<TModel>(string, SearchClientOptions)

Načte SearchClient odpovídající tomuto SearchIndexClient.

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

Parametry

indexName

string

Název indexu

options

SearchClientOptions

Možnosti searchclient

Návraty

SearchClient<TModel>

getServiceStatistics(OperationOptions)

Načte statistiky o službě, například počet dokumentů, index atd.

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

Parametry

options

OperationOptions

Další volitelné argumenty

Návraty

Promise<SearchServiceStatistics>

getSynonymMap(string, OperationOptions)

Načte informace o SynonymMap.

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

Parametry

synonymMapName

string

Název objektu SynonymMap.

options

OperationOptions

Další volitelné argumenty

Návraty

Promise<SynonymMap>

listIndexes(OperationOptions)

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

function listIndexes(options?: OperationOptions): IndexIterator

Parametry

options

OperationOptions

Možnosti operace indexování seznamu

Návraty

IndexIterator

listIndexesNames(OperationOptions)

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

function listIndexesNames(options?: OperationOptions): IndexNameIterator

Parametry

options

OperationOptions

Možnosti operace indexování seznamu

Návraty

IndexNameIterator

listSynonymMaps(OperationOptions)

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

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

Parametry

options

OperationOptions

Možnosti operace SynonymMaps v seznamu.

Návraty

Promise<SynonymMap[]>

listSynonymMapsNames(OperationOptions)

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

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

Parametry

options

OperationOptions

Možnosti operace SynonymMaps v seznamu.

Návraty

Promise<string[]>