SearchIndexClient class

Pakket:

@azure/search-documents

Klasse voor het uitvoeren van bewerkingen voor het beheren van indexen (maken, bijwerken, lijst/verwijderen), & synoniemen.

Constructors

SearchIndexClient(string, KeyCredential | TokenCredential, SearchIndexClientOptions)

Hiermee maakt u een exemplaar van SearchIndexClient. Gebruiksvoorbeeld: const { SearchIndexClient, AzureKeyCredential } = require("@azure/search-documents"); const client = new SearchIndexClient( "<endpoint>", new AzureKeyCredential("<Admin Key>"); );

Eigenschappen

apiVersion	De API-versie die moet worden gebruikt bij de communicatie met de service.
endpoint	Het eindpunt van de zoekservice
serviceVersion	De API-versie die moet worden gebruikt bij de communicatie met de service.

Methoden

analyzeText(string, AnalyzeTextOptions)	Roept handmatig een analyzer of tokenizer aan op opgegeven tekst.
createIndex(SearchIndex, OperationOptions)	Hiermee maakt u een nieuwe index.
createOrUpdateIndex(SearchIndex, CreateOrUpdateIndexOptions)	Hiermee maakt u een nieuwe index of wijzigt u een bestaande index.
createOrUpdateSynonymMap(SynonymMap, CreateOrUpdateSynonymMapOptions)	Hiermee maakt u een nieuwe SynonymMap of wijzigt u een bestaande.
createSynonymMap(SynonymMap, OperationOptions)	Hiermee maakt u een nieuwe SynonymMap in een zoekservice.
deleteIndex(string | SearchIndex, DeleteIndexOptions)	Hiermee verwijdert u een bestaande index.
deleteSynonymMap(string | SynonymMap, DeleteSynonymMapOptions)	Hiermee verwijdert u een bestaande SynonymMap.
getIndex(string, OperationOptions)	Hiermee haalt u informatie over een index op.
getIndexStatistics(string, OperationOptions)	Hiermee worden statistieken opgehaald over een index, zoals het aantal documenten en de grootte van de indexopslag.
getSearchClient<TModel>(string, SearchClientOptions)	Hiermee wordt de SearchClient opgehaald die overeenkomt met deze SearchIndexClient
getServiceStatistics(OperationOptions)	Hiermee worden statistieken opgehaald over de service, zoals het aantal documenten, indexen, enzovoort.
getSynonymMap(string, OperationOptions)	Hiermee wordt informatie opgehaald over een Synoniemmap.
listIndexes(OperationOptions)	Hiermee wordt een lijst met bestaande indexen in de service opgehaald.
listIndexesNames(OperationOptions)	Hiermee haalt u een lijst met namen van bestaande indexen in de service op.
listSynonymMaps(OperationOptions)	Hiermee wordt een lijst met bestaande Synoniemenkaarten in de service opgehaald.
listSynonymMapsNames(OperationOptions)	Hiermee wordt een lijst met namen van bestaande SynonymMaps in de service opgehaald.

Constructordetails

SearchIndexClient(string, KeyCredential | TokenCredential, SearchIndexClientOptions)

Hiermee maakt u een exemplaar van SearchIndexClient.

Gebruiksvoorbeeld:

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)

Parameters

endpoint

string

Het eindpunt van de zoekservice

credential

KeyCredential | TokenCredential

Wordt gebruikt om aanvragen voor de service te verifiëren.

options

SearchIndexClientOptions

Wordt gebruikt om de zoekindexclient te configureren.

Eigenschapdetails

apiVersion

Waarschuwing

Deze API is nu afgeschaft.

use {@Link serviceVersion} instead

De API-versie die moet worden gebruikt bij de communicatie met de service.

apiVersion: string

Waarde van eigenschap

string

endpoint

Het eindpunt van de zoekservice

endpoint: string

Waarde van eigenschap

string

serviceVersion

De API-versie die moet worden gebruikt bij de communicatie met de service.

serviceVersion: string

Waarde van eigenschap

string

Methodedetails

analyzeText(string, AnalyzeTextOptions)

Roept handmatig een analyzer of tokenizer aan op opgegeven tekst.

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

Parameters

indexName

string

De naam van de index die het te analyseren veld bevat

options

AnalyzeTextOptions

Aanvullende argumenten

Retouren

Promise<AnalyzeResult>

createIndex(SearchIndex, OperationOptions)

Hiermee maakt u een nieuwe index.

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

Parameters

index

SearchIndex

De informatie die de index beschrijft die moet worden gemaakt.

options

OperationOptions

Aanvullende optionele argumenten.

Retouren

Promise<SearchIndex>

createOrUpdateIndex(SearchIndex, CreateOrUpdateIndexOptions)

Hiermee maakt u een nieuwe index of wijzigt u een bestaande index.

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

Parameters

index

SearchIndex

De informatie die de index beschrijft die moet worden gemaakt.

options

CreateOrUpdateIndexOptions

Aanvullende optionele argumenten.

Retouren

Promise<SearchIndex>

createOrUpdateSynonymMap(SynonymMap, CreateOrUpdateSynonymMapOptions)

Hiermee maakt u een nieuwe SynonymMap of wijzigt u een bestaande.

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

Parameters

synonymMap

SynonymMap

De informatie die de synoniemmap beschrijft die moet worden gemaakt.

options

CreateOrUpdateSynonymMapOptions

Aanvullende optionele argumenten.

Retouren

Promise<SynonymMap>

createSynonymMap(SynonymMap, OperationOptions)

Hiermee maakt u een nieuwe SynonymMap in een zoekservice.

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

Parameters

synonymMap

SynonymMap

De synoniemmapdefinitie die moet worden gemaakt in een zoekservice.

options

OperationOptions

Aanvullende optionele argumenten.

Retouren

Promise<SynonymMap>

deleteIndex(string | SearchIndex, DeleteIndexOptions)

Hiermee verwijdert u een bestaande index.

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

Parameters

index

string | SearchIndex

options

DeleteIndexOptions

Aanvullende optionele argumenten.

Retouren

Promise<void>

deleteSynonymMap(string | SynonymMap, DeleteSynonymMapOptions)

Hiermee verwijdert u een bestaande SynonymMap.

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

Parameters

synonymMap

string | SynonymMap

options

DeleteSynonymMapOptions

Aanvullende optionele argumenten.

Retouren

Promise<void>

getIndex(string, OperationOptions)

Hiermee haalt u informatie over een index op.

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

Parameters

indexName

string

De naam van de index.

options

OperationOptions

Aanvullende optionele argumenten.

Retouren

Promise<SearchIndex>

getIndexStatistics(string, OperationOptions)

Hiermee worden statistieken opgehaald over een index, zoals het aantal documenten en de grootte van de indexopslag.

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

Parameters

indexName

string

De naam van de index.

options

OperationOptions

Aanvullende optionele argumenten.

Retouren

Promise<SearchIndexStatistics>

getSearchClient<TModel>(string, SearchClientOptions)

Hiermee wordt de SearchClient opgehaald die overeenkomt met deze SearchIndexClient

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

Parameters

indexName

string

Naam van de index

options

SearchClientOptions

Opties voor SearchClient

Retouren

SearchClient<TModel>

getServiceStatistics(OperationOptions)

Hiermee worden statistieken opgehaald over de service, zoals het aantal documenten, indexen, enzovoort.

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

Parameters

options

OperationOptions

Aanvullende optionele argumenten.

Retouren

Promise<SearchServiceStatistics>

getSynonymMap(string, OperationOptions)

Hiermee wordt informatie opgehaald over een Synoniemmap.

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

Parameters

synonymMapName

string

De naam van de SynonymMap.

options

OperationOptions

Aanvullende optionele argumenten.

Retouren

Promise<SynonymMap>

listIndexes(OperationOptions)

Hiermee wordt een lijst met bestaande indexen in de service opgehaald.

function listIndexes(options?: OperationOptions): IndexIterator

Parameters

options

OperationOptions

Opties voor de lijstindexbewerking.

Retouren

IndexIterator

listIndexesNames(OperationOptions)

Hiermee haalt u een lijst met namen van bestaande indexen in de service op.

function listIndexesNames(options?: OperationOptions): IndexNameIterator

Parameters

options

OperationOptions

Opties voor de lijstindexbewerking.

Retouren

IndexNameIterator

listSynonymMaps(OperationOptions)

Hiermee wordt een lijst met bestaande Synoniemenkaarten in de service opgehaald.

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

Parameters

options

OperationOptions

Opties voor de bewerking SynonymMaps.

Retouren

Promise<SynonymMap[]>

listSynonymMapsNames(OperationOptions)

Hiermee wordt een lijst met namen van bestaande SynonymMaps in de service opgehaald.

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

Parameters

options

OperationOptions

Opties voor de bewerking SynonymMaps.

Retouren

Promise<string[]>