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 |
| pipeline | Een verwijzing naar de interne HTTP-pijplijn voor gebruik met onbewerkte aanvragen |
| 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 zoekalias. |
| create |
Hiermee maakt u een nieuwe index. |
| create |
Maakt een nieuwe kennisbasis aan. |
| create |
Hiermee maakt u een nieuwe kennisbron. |
| create |
Hiermee maakt u een nieuwe zoekalias of werkt u een alias bij als deze al bestaat. |
| create |
Hiermee maakt u een nieuwe index of wijzigt u een bestaande index. |
| create |
Maakt een nieuwe kennisbank aan of werkt een kennisbank bij als die al bestaat. |
| create |
|
| 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 zoekalias en de bijbehorende toewijzing aan een index. Deze bewerking is permanent, zonder hersteloptie. De toegewezen index blijft ongewijzigd door deze bewerking. |
| delete |
Hiermee verwijdert u een zoekalias en de bijbehorende toewijzing aan een index. Deze bewerking is permanent, zonder hersteloptie. De toegewezen index blijft ongewijzigd door deze bewerking. |
| delete |
Hiermee verwijdert u een bestaande index. |
| delete |
Hiermee verwijdert u een bestaande index. |
| delete |
Hiermee verwijdert u een bestaande kennisbank. |
| delete |
Hiermee verwijdert u een bestaande kennisbank. |
| delete |
Hiermee verwijdert u een bestaande bron. |
| delete |
Hiermee verwijdert u een bestaande bron. |
| delete |
Hiermee verwijdert u een bestaande SynonymMap. |
| get |
Hiermee haalt u een aliasdefinitie op. |
| 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 |
Hiermee haalt u een lijst met bestaande indexen in de service op. |
| get |
Haalt een kennisbasisdefinitie op. |
| get |
Haalt de KnowledgeRetrievalClient op die overeenkomt met deze SearchIndexClient |
| get |
Haalt een definitie van een kennisbron op. |
| get |
Geeft als resultaat de huidige status en synchronisatiegeschiedenis van een kennisbron. |
| 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 |
Een lijst met alle aliassen die beschikbaar zijn voor een zoekservice. |
| 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 |
Haalt een lijst op van bestaande kennisbases in de service. |
| list |
Hiermee haalt u een lijst op met bestaande kennisbronnen in de service. |
| 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:
import { SearchIndexClient, AzureKeyCredential } from "@azure/search-documents";
const indexClient = new SearchIndexClient("<endpoint>", new AzureKeyCredential("<apiKey>"));
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: stringWaarde van eigenschap
string
endpoint
Het eindpunt van de zoekservice
endpoint: stringWaarde van eigenschap
string
pipeline
Een verwijzing naar de interne HTTP-pijplijn voor gebruik met onbewerkte aanvragen
pipeline: PipelineWaarde van eigenschap
serviceVersion
De API-versie die moet worden gebruikt bij het communiceren met de service.
serviceVersion: stringWaarde 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>
createAlias(SearchAlias, OperationOptions)
Hiermee maakt u een nieuwe zoekalias.
function createAlias(alias: SearchAlias, options?: OperationOptions): Promise<SearchAlias>Parameters
- alias
- SearchAlias
De definitie van de alias om te maken.
- options
- OperationOptions
De optiesparameters.
Retouren
Promise<SearchAlias>
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>
createKnowledgeBase(KnowledgeBase, CreateKnowledgeBaseOptions)
Maakt een nieuwe kennisbasis aan.
function createKnowledgeBase(knowledgeBase: KnowledgeBase, options?: CreateKnowledgeBaseOptions): Promise<KnowledgeBase>Parameters
- knowledgeBase
- KnowledgeBase
Definitie van de kennisbasis die gecreëerd moet worden.
- options
- CreateKnowledgeBaseOptions
opties parameters.
Retouren
Promise<KnowledgeBase>
createKnowledgeSource(KnowledgeSource, CreateKnowledgeSourceOptions)
Hiermee maakt u een nieuwe kennisbron.
function createKnowledgeSource(knowledgeSource: KnowledgeSource, options?: CreateKnowledgeSourceOptions): Promise<KnowledgeSource>Parameters
- knowledgeSource
- KnowledgeSource
De definitie van de te creëren kennisbron.
- options
- CreateKnowledgeSourceOptions
De optiesparameters.
Retouren
Promise<KnowledgeSource>
createOrUpdateAlias(SearchAlias, CreateOrUpdateAliasOptions)
Hiermee maakt u een nieuwe zoekalias of werkt u een alias bij als deze al bestaat.
function createOrUpdateAlias(alias: SearchAlias, options?: CreateOrUpdateAliasOptions): Promise<SearchAlias>Parameters
- alias
- SearchAlias
De definitie van de alias die moet worden gemaakt of bijgewerkt.
- options
- CreateOrUpdateAliasOptions
De optiesparameters.
Retouren
Promise<SearchAlias>
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>
createOrUpdateKnowledgeBase(string, KnowledgeBase, CreateOrUpdateKnowledgeBaseOptions)
Maakt een nieuwe kennisbank aan of werkt een kennisbank bij als die al bestaat.
function createOrUpdateKnowledgeBase(knowledgeBaseName: string, knowledgeBase: KnowledgeBase, options?: CreateOrUpdateKnowledgeBaseOptions): Promise<KnowledgeBase>Parameters
- knowledgeBaseName
-
string
Naam van de kennisbank die gemaakt of bijgewerkt moet worden.
- knowledgeBase
- KnowledgeBase
Definitie van de kennisbank die gemaakt of bijgewerkt moet worden.
opties parameters.
Retouren
Promise<KnowledgeBase>
createOrUpdateKnowledgeSource(string, KnowledgeSource, CreateOrUpdateKnowledgeSourceOptions)
function createOrUpdateKnowledgeSource(sourceName: string, knowledgeSource: KnowledgeSource, options?: CreateOrUpdateKnowledgeSourceOptions): Promise<KnowledgeSource>Parameters
- sourceName
-
string
- knowledgeSource
- KnowledgeSource
Retouren
Promise<KnowledgeSource>
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>
deleteAlias(SearchAlias, DeleteAliasOptions)
Hiermee verwijdert u een zoekalias en de bijbehorende toewijzing aan een index. Deze bewerking is permanent, zonder hersteloptie. De toegewezen index blijft ongewijzigd door deze bewerking.
function deleteAlias(alias: SearchAlias, options?: DeleteAliasOptions): Promise<void>Parameters
- alias
- SearchAlias
De alias om te verwijderen.
- options
- DeleteAliasOptions
Aanvullende optionele argumenten.
Retouren
Promise<void>
deleteAlias(string, DeleteAliasOptions)
Hiermee verwijdert u een zoekalias en de bijbehorende toewijzing aan een index. Deze bewerking is permanent, zonder hersteloptie. De toegewezen index blijft ongewijzigd door deze bewerking.
function deleteAlias(aliasName: string, options?: DeleteAliasOptions): Promise<void>Parameters
- aliasName
-
string
Naam van de alias die u wilt verwijderen.
- options
- DeleteAliasOptions
Aanvullende optionele argumenten.
Retouren
Promise<void>
deleteIndex(SearchIndex, DeleteIndexOptions)
Hiermee verwijdert u een bestaande index.
function deleteIndex(index: SearchIndex, options?: DeleteIndexOptions): Promise<void>Parameters
- index
- SearchIndex
De index die u wilt verwijderen.
- options
- DeleteIndexOptions
Aanvullende optionele argumenten.
Retouren
Promise<void>
deleteIndex(string, DeleteIndexOptions)
Hiermee verwijdert u een bestaande index.
function deleteIndex(indexName: string, options?: DeleteIndexOptions): Promise<void>Parameters
- indexName
-
string
Naam van de index die u wilt verwijderen.
- options
- DeleteIndexOptions
Aanvullende optionele argumenten.
Retouren
Promise<void>
deleteKnowledgeBase(KnowledgeBase, DeleteKnowledgeBaseOptions)
Hiermee verwijdert u een bestaande kennisbank.
function deleteKnowledgeBase(knowledgeBase: KnowledgeBase, options?: DeleteKnowledgeBaseOptions): Promise<void>Parameters
- knowledgeBase
- KnowledgeBase
De kennisbank om te verwijderen.
- options
- DeleteKnowledgeBaseOptions
opties parameters.
Retouren
Promise<void>
deleteKnowledgeBase(string, DeleteKnowledgeBaseOptions)
Hiermee verwijdert u een bestaande kennisbank.
function deleteKnowledgeBase(knowledgeBaseName: string, options?: DeleteKnowledgeBaseOptions): Promise<void>Parameters
- knowledgeBaseName
-
string
naam van de kennisbank die verwijderd moet worden.
- options
- DeleteKnowledgeBaseOptions
opties parameters.
Retouren
Promise<void>
deleteKnowledgeSource(KnowledgeSource, DeleteKnowledgeSourceOptions)
Hiermee verwijdert u een bestaande bron.
function deleteKnowledgeSource(source: KnowledgeSource, options?: DeleteKnowledgeSourceOptions): Promise<void>Parameters
- source
- KnowledgeSource
de kennisbron die u wilt verwijderen.
- options
- DeleteKnowledgeSourceOptions
opties parameters.
Retouren
Promise<void>
deleteKnowledgeSource(string, DeleteKnowledgeSourceOptions)
Hiermee verwijdert u een bestaande bron.
function deleteKnowledgeSource(sourceName: string, options?: DeleteKnowledgeSourceOptions): Promise<void>Parameters
- sourceName
-
string
Naam van de kennisbron die u wilt verwijderen.
- options
- DeleteKnowledgeSourceOptions
opties parameters.
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>
getAlias(string, OperationOptions)
Hiermee haalt u een aliasdefinitie op.
function getAlias(aliasName: string, options?: OperationOptions): Promise<SearchAlias>Parameters
- aliasName
-
string
De naam van de alias die moet worden opgehaald.
- options
- OperationOptions
De optiesparameters.
Retouren
Promise<SearchAlias>
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>
getIndexStatsSummary(GetIndexStatsSummaryOptions)
Hiermee haalt u een lijst met bestaande indexen in de service op.
function getIndexStatsSummary(options?: GetIndexStatsSummaryOptions): IndexStatisticsSummaryIteratorParameters
- options
- GetIndexStatsSummaryOptions
Opties voor de lijstindexbewerking.
Retouren
getKnowledgeBase(string, GetKnowledgeBaseOptions)
Haalt een kennisbasisdefinitie op.
function getKnowledgeBase(knowledgeBaseName: string, options?: GetKnowledgeBaseOptions): Promise<KnowledgeBase>Parameters
- knowledgeBaseName
-
string
naam van de kennisbank die je moet ophalen.
- options
- GetKnowledgeBaseOptions
opties parameters.
Retouren
Promise<KnowledgeBase>
getKnowledgeRetrievalClient(string, KnowledgeRetrievalClientOptions)
Haalt de KnowledgeRetrievalClient op die overeenkomt met deze SearchIndexClient
function getKnowledgeRetrievalClient(knowledgeBaseName: string, options?: KnowledgeRetrievalClientOptions): KnowledgeRetrievalClientParameters
- knowledgeBaseName
-
string
Naam van de kennisbank
- options
- KnowledgeRetrievalClientOptions
KnowledgeRetrievalClient-opties
Retouren
getKnowledgeSource(string, GetKnowledgeSourceOptions)
Haalt een definitie van een kennisbron op.
function getKnowledgeSource(sourceName: string, options?: GetKnowledgeSourceOptions): Promise<KnowledgeSource>Parameters
- sourceName
-
string
De naam van de kennisbron die moet worden opgehaald.
- options
- GetKnowledgeSourceOptions
De optiesparameters.
Retouren
Promise<KnowledgeSource>
getKnowledgeSourceStatus(string, GetKnowledgeSourceStatusOptions)
Geeft als resultaat de huidige status en synchronisatiegeschiedenis van een kennisbron.
function getKnowledgeSourceStatus(sourceName: string, options?: GetKnowledgeSourceStatusOptions): Promise<KnowledgeSourceStatus>Parameters
- sourceName
-
string
De naam van de kennisbron waarvoor de status moet worden opgehaald.
- options
- GetKnowledgeSourceStatusOptions
De optiesparameters.
Retouren
Promise<KnowledgeSourceStatus>
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>
listAliases(OperationOptions)
Een lijst met alle aliassen die beschikbaar zijn voor een zoekservice.
function listAliases(options?: OperationOptions): AliasIteratorParameters
- options
- OperationOptions
De optiesparameters.
Retouren
listIndexes(OperationOptions)
Hiermee haalt u een lijst met bestaande indexen in de service op.
function listIndexes(options?: OperationOptions): IndexIteratorParameters
- 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): IndexNameIteratorParameters
- options
- OperationOptions
Opties voor de lijstindexbewerking.
Retouren
listKnowledgeBases(ListKnowledgeBasesOptions)
Haalt een lijst op van bestaande kennisbases in de service.
function listKnowledgeBases(options?: ListKnowledgeBasesOptions): KnowledgeBaseIteratorParameters
- options
- ListKnowledgeBasesOptions
Opties voor de lijst van kennisbasisoperaties.
Retouren
listKnowledgeSources(ListKnowledgeSourcesOptions)
Hiermee haalt u een lijst op met bestaande kennisbronnen in de service.
function listKnowledgeSources(options?: ListKnowledgeSourcesOptions): KnowledgeSourceIteratorParameters
- options
- ListKnowledgeSourcesOptions
Opties voor de bewerking Kennisbronnen weergeven.
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[]>
