SearchIndexClient class
Klasse voor het uitvoeren van bewerkingen voor het beheren (maken, bijwerken, weergeven/verwijderen) van indexen, & synoniemen.
Constructors
Search |
Hiermee maakt u een exemplaar van SearchIndexClient. Voorbeeldgebruik:
|
Eigenschappen
api |
De API-versie die moet worden gebruikt bij het communiceren met de service. |
endpoint | Het eindpunt van de zoekservice |
service |
De API-versie die moet worden gebruikt bij het communiceren met de service. |
Methoden
analyze |
Roept een analyse- of tokenizer handmatig aan op opgegeven tekst. |
create |
Hiermee maakt u een nieuwe index. |
create |
Hiermee maakt u een nieuwe index of wijzigt u een bestaande index. |
create |
Hiermee maakt u een nieuwe Synoniemmap of wijzigt u een bestaande. |
create |
Hiermee maakt u een nieuwe Synoniemmap in een zoekservice. |
delete |
Hiermee verwijdert u een bestaande index. |
delete |
Hiermee verwijdert u een bestaande SynonymMap. |
get |
Haalt informatie over een index op. |
get |
Hiermee worden statistieken opgehaald over een index, zoals het aantal documenten en de grootte van de indexopslag. |
get |
Haalt de SearchClient op die overeenkomt met deze SearchIndexClient |
get |
Hiermee worden statistieken over de service opgehaald, zoals het aantal documenten, index, enzovoort. |
get |
Haalt informatie op over een Synoniemmap. |
list |
Hiermee haalt u een lijst met bestaande indexen in de service op. |
list |
Hiermee haalt u een lijst met namen van bestaande indexen in de service op. |
list |
Hiermee haalt u een lijst met bestaande Synoniemenkaarten op in de service. |
list |
Hiermee haalt u een lijst met namen van bestaande Synoniemenkaarten op in de service. |
Constructordetails
SearchIndexClient(string, KeyCredential | TokenCredential, SearchIndexClientOptions)
Hiermee maakt u een exemplaar van SearchIndexClient.
Voorbeeldgebruik:
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
Wordt gebruikt voor het verifiëren van aanvragen voor de service.
- options
- SearchIndexClientOptions
Wordt gebruikt om de Search Index-client te configureren.
Eigenschapdetails
apiVersion
Waarschuwing
Deze API is nu afgeschaft.
use {@Link serviceVersion} instead
De API-versie die moet worden gebruikt bij het communiceren 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 het communiceren met de service.
serviceVersion: string
Waarde van eigenschap
string
Methodedetails
analyzeText(string, AnalyzeTextOptions)
Roept een analyse- of tokenizer handmatig aan op opgegeven tekst.
function analyzeText(indexName: string, options: AnalyzeTextOptions): Promise<AnalyzeResult>
Parameters
- indexName
-
string
De naam van de index die het veld bevat dat moet worden geanalyseerd
- 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 Synoniemmap of wijzigt u een bestaande.
function createOrUpdateSynonymMap(synonymMap: SynonymMap, options?: CreateOrUpdateSynonymMapOptions): Promise<SynonymMap>
Parameters
- synonymMap
- SynonymMap
De informatie die de SynonymMap beschrijft die moet worden gemaakt.
- options
- CreateOrUpdateSynonymMapOptions
Aanvullende optionele argumenten.
Retouren
Promise<SynonymMap>
createSynonymMap(SynonymMap, OperationOptions)
Hiermee maakt u een nieuwe Synoniemmap 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)
Haalt 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)
Haalt de SearchClient op die overeenkomt met deze SearchIndexClient
function getSearchClient<TModel>(indexName: string, options?: SearchClientOptions): SearchClient<TModel>
Parameters
- indexName
-
string
Naam van de index
- options
- SearchClientOptions
SearchClient-opties
Retouren
SearchClient<TModel>
getServiceStatistics(OperationOptions)
Hiermee worden statistieken over de service opgehaald, zoals het aantal documenten, index, enzovoort.
function getServiceStatistics(options?: OperationOptions): Promise<SearchServiceStatistics>
Parameters
- options
- OperationOptions
Aanvullende optionele argumenten.
Retouren
Promise<SearchServiceStatistics>
getSynonymMap(string, OperationOptions)
Haalt informatie op 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 haalt u een lijst met bestaande indexen in de service op.
function listIndexes(options?: OperationOptions): IndexIterator
Parameters
- options
- OperationOptions
Opties voor de lijstindexbewerking.
Retouren
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
listSynonymMaps(OperationOptions)
Hiermee haalt u een lijst met bestaande Synoniemenkaarten op in de service.
function listSynonymMaps(options?: OperationOptions): Promise<SynonymMap[]>
Parameters
- options
- OperationOptions
Opties voor de lijst SynonymMaps-bewerking.
Retouren
Promise<SynonymMap[]>
listSynonymMapsNames(OperationOptions)
Hiermee haalt u een lijst met namen van bestaande Synoniemenkaarten op in de service.
function listSynonymMapsNames(options?: OperationOptions): Promise<string[]>
Parameters
- options
- OperationOptions
Opties voor de lijst SynonymMaps-bewerking.
Retouren
Promise<string[]>