SearchIndexClient class

Csomag:

@azure/search-documents

Osztály az indexek kezeléséhez (létrehozáshoz, frissítéshez, listához/törléshez) & szinonimaképek kezeléséhez.

Konstruktorok

SearchIndexClient(string, KeyCredential | TokenCredential, SearchIndexClientOptions)

Létrehozza a SearchIndexClient egy példányát. Példahasználat: const { SearchIndexClient, AzureKeyCredential } = require("@azure/search-documents"); const client = new SearchIndexClient( "<endpoint>", new AzureKeyCredential("<Admin Key>"); );

Tulajdonságok

apiVersion	A szolgáltatással való kommunikációhoz használandó API-verzió.
endpoint	A keresési szolgáltatás végpontja
serviceVersion	A szolgáltatással való kommunikációhoz használandó API-verzió.

Metódusok

analyzeText(string, AnalyzeTextOptions)	Egy elemzőt vagy tokenizert hív meg manuálisan a megadott szövegen.
createIndex(SearchIndex, OperationOptions)	Új indexet hoz létre.
createOrUpdateIndex(SearchIndex, CreateOrUpdateIndexOptions)	Létrehoz egy új indexet, vagy módosít egy meglévőt.
createOrUpdateSynonymMap(SynonymMap, CreateOrUpdateSynonymMapOptions)	Létrehoz egy új szinonimatérképet, vagy módosít egy meglévőt.
createSynonymMap(SynonymMap, OperationOptions)	Új szinonimatérképet hoz létre egy keresési szolgáltatásban.
deleteIndex(string | SearchIndex, DeleteIndexOptions)	Töröl egy meglévő indexet.
deleteSynonymMap(string | SynonymMap, DeleteSynonymMapOptions)	Töröl egy meglévő szinonimatérképet.
getIndex(string, OperationOptions)	Lekéri az indexekkel kapcsolatos információkat.
getIndexStatistics(string, OperationOptions)	Lekéri egy index statisztikáját, például a dokumentumok számát és az indextároló méretét.
getSearchClient<TModel>(string, SearchClientOptions)	Lekéri a SearchIndexClientnek megfelelő SearchClientet
getServiceStatistics(OperationOptions)	Lekéri a szolgáltatásra vonatkozó statisztikákat, például a dokumentumok számát, az indexet stb.
getSynonymMap(string, OperationOptions)	Egy szinonimatérkép információit kéri le.
listIndexes(OperationOptions)	Lekéri a szolgáltatásban meglévő indexek listáját.
listIndexesNames(OperationOptions)	Lekéri a szolgáltatásban meglévő indexek nevének listáját.
listSynonymMaps(OperationOptions)	Lekéri a szolgáltatásban meglévő szinonimatérképek listáját.
listSynonymMapsNames(OperationOptions)	Lekéri a szolgáltatásban meglévő szinonimatérképek nevének listáját.

Konstruktor adatai

SearchIndexClient(string, KeyCredential | TokenCredential, SearchIndexClientOptions)

Létrehozza a SearchIndexClient egy példányát.

Példahasználat:

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)

Paraméterek

endpoint

string

A keresési szolgáltatás végpontja

credential

KeyCredential | TokenCredential

A szolgáltatás felé irányuló kérések hitelesítésére szolgál.

options

SearchIndexClientOptions

A keresési indexügyfél konfigurálására szolgál.

Tulajdonság adatai

apiVersion

Figyelmeztetés

Ez az API már elavult.

use {@Link serviceVersion} instead

A szolgáltatással való kommunikációhoz használandó API-verzió.

apiVersion: string

Tulajdonság értéke

string

endpoint

A keresési szolgáltatás végpontja

endpoint: string

Tulajdonság értéke

string

serviceVersion

A szolgáltatással való kommunikációhoz használandó API-verzió.

serviceVersion: string

Tulajdonság értéke

string

Metódus adatai

analyzeText(string, AnalyzeTextOptions)

Egy elemzőt vagy tokenizert hív meg manuálisan a megadott szövegen.

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

Paraméterek

indexName

string

Az elemezni kívánt mezőt tartalmazó index neve

options

AnalyzeTextOptions

További argumentumok

Válaszok

Promise<AnalyzeResult>

createIndex(SearchIndex, OperationOptions)

Új indexet hoz létre.

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

Paraméterek

index

SearchIndex

A létrehozandó indexet leíró információk.

options

OperationOptions

További választható argumentumok.

Válaszok

Promise<SearchIndex>

createOrUpdateIndex(SearchIndex, CreateOrUpdateIndexOptions)

Létrehoz egy új indexet, vagy módosít egy meglévőt.

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

Paraméterek

index

SearchIndex

A létrehozandó indexet leíró információk.

options

CreateOrUpdateIndexOptions

További választható argumentumok.

Válaszok

Promise<SearchIndex>

createOrUpdateSynonymMap(SynonymMap, CreateOrUpdateSynonymMapOptions)

Létrehoz egy új szinonimatérképet, vagy módosít egy meglévőt.

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

Paraméterek

synonymMap

SynonymMap

A létrehozandó szinonimatérképet leíró információk.

options

CreateOrUpdateSynonymMapOptions

További választható argumentumok.

Válaszok

Promise<SynonymMap>

createSynonymMap(SynonymMap, OperationOptions)

Új szinonimatérképet hoz létre egy keresési szolgáltatásban.

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

Paraméterek

synonymMap

SynonymMap

A keresési szolgáltatásban létrehozandó szinonimatérkép-definíció.

options

OperationOptions

További választható argumentumok.

Válaszok

Promise<SynonymMap>

deleteIndex(string | SearchIndex, DeleteIndexOptions)

Töröl egy meglévő indexet.

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

Paraméterek

index

string | SearchIndex

options

DeleteIndexOptions

További választható argumentumok.

Válaszok

Promise<void>

deleteSynonymMap(string | SynonymMap, DeleteSynonymMapOptions)

Töröl egy meglévő szinonimatérképet.

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

Paraméterek

synonymMap

string | SynonymMap

options

DeleteSynonymMapOptions

További választható argumentumok.

Válaszok

Promise<void>

getIndex(string, OperationOptions)

Lekéri az indexekkel kapcsolatos információkat.

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

Paraméterek

indexName

string

Az index neve.

options

OperationOptions

További választható argumentumok.

Válaszok

Promise<SearchIndex>

getIndexStatistics(string, OperationOptions)

Lekéri egy index statisztikáját, például a dokumentumok számát és az indextároló méretét.

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

Paraméterek

indexName

string

Az index neve.

options

OperationOptions

További választható argumentumok.

Válaszok

Promise<SearchIndexStatistics>

getSearchClient<TModel>(string, SearchClientOptions)

Lekéri a SearchIndexClientnek megfelelő SearchClientet

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

Paraméterek

indexName

string

Az index neve

options

SearchClientOptions

SearchClient-beállítások

Válaszok

SearchClient<TModel>

getServiceStatistics(OperationOptions)

Lekéri a szolgáltatásra vonatkozó statisztikákat, például a dokumentumok számát, az indexet stb.

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

Paraméterek

options

OperationOptions

További választható argumentumok.

Válaszok

Promise<SearchServiceStatistics>

getSynonymMap(string, OperationOptions)

Egy szinonimatérkép információit kéri le.

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

Paraméterek

synonymMapName

string

A Szinonimatérkép neve.

options

OperationOptions

További választható argumentumok.

Válaszok

Promise<SynonymMap>

listIndexes(OperationOptions)

Lekéri a szolgáltatásban meglévő indexek listáját.

function listIndexes(options?: OperationOptions): IndexIterator

Paraméterek

options

OperationOptions

A listaindexelési művelet beállításai.

Válaszok

IndexIterator

listIndexesNames(OperationOptions)

Lekéri a szolgáltatásban meglévő indexek nevének listáját.

function listIndexesNames(options?: OperationOptions): IndexNameIterator

Paraméterek

options

OperationOptions

A listaindexelési művelet beállításai.

Válaszok

IndexNameIterator

listSynonymMaps(OperationOptions)

Lekéri a szolgáltatásban meglévő szinonimatérképek listáját.

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

Paraméterek

options

OperationOptions

A Szinonimatérképek listaművelet beállításai.

Válaszok

Promise<SynonymMap[]>

listSynonymMapsNames(OperationOptions)

Lekéri a szolgáltatásban meglévő szinonimatérképek nevének listáját.

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

Paraméterek

options

OperationOptions

A Szinonimatérképek listaművelet beállításai.

Válaszok

Promise<string[]>