SearchIndexClient class

Paket:

@azure/search-documents

Klass för att utföra åtgärder för att hantera (skapa, uppdatera, lista/ta bort) index, & synonymmappar.

Konstruktorer

SearchIndexClient(string, KeyCredential | TokenCredential, SearchIndexClientOptions)

Skapar en instans av SearchIndexClient. Exempel på användning: import { SearchIndexClient, AzureKeyCredential } from "@azure/search-documents"; const indexClient = new SearchIndexClient("<endpoint>", new AzureKeyCredential("<apiKey>"));

Egenskaper

apiVersion	DEN API-version som ska användas när du kommunicerar med tjänsten.
endpoint	Slutpunkten för söktjänsten
pipeline	En referens till den interna HTTP-pipelinen för användning med rådatabegäranden
serviceVersion	DEN API-version som ska användas när du kommunicerar med tjänsten.

Metoder

analyzeText(string, AnalyzeTextOptions)	Anropar en analysator eller tokeniserare manuellt på angivet text.
createAlias(SearchAlias, OperationOptions)	Skapar ett nytt sökalias.
createIndex(SearchIndex, OperationOptions)	Skapar ett nytt index.
createKnowledgeBase(KnowledgeBase, CreateKnowledgeBaseOptions)	Skapar en ny kunskapsbas.
createKnowledgeSource(KnowledgeSource, CreateKnowledgeSourceOptions)	Skapar en ny kunskapskälla.
createOrUpdateAlias(SearchAlias, CreateOrUpdateAliasOptions)	Skapar ett nytt sökalias eller uppdaterar ett alias om det redan finns.
createOrUpdateIndex(SearchIndex, CreateOrUpdateIndexOptions)	Skapar ett nytt index eller ändrar ett befintligt.
createOrUpdateKnowledgeBase(string, KnowledgeBase, CreateOrUpdateKnowledgeBaseOptions)	Skapar en ny kunskapsbas eller uppdaterar en kunskapsbas om den redan finns.
createOrUpdateKnowledgeSource(string, KnowledgeSource, CreateOrUpdateKnowledgeSourceOptions)
createOrUpdateSynonymMap(SynonymMap, CreateOrUpdateSynonymMapOptions)	Skapar en ny SynonymMap eller ändrar en befintlig.
createSynonymMap(SynonymMap, OperationOptions)	Skapar en ny SynonymMap i en söktjänst.
deleteAlias(SearchAlias, DeleteAliasOptions)	Tar bort ett sökalias och dess associerade mappning till ett index. Den här åtgärden är permanent, utan återställningsalternativ. Det mappade indexet är orört av den här åtgärden.
deleteAlias(string, DeleteAliasOptions)	Tar bort ett sökalias och dess associerade mappning till ett index. Den här åtgärden är permanent, utan återställningsalternativ. Det mappade indexet är orört av den här åtgärden.
deleteIndex(SearchIndex, DeleteIndexOptions)	Tar bort ett befintligt index.
deleteIndex(string, DeleteIndexOptions)	Tar bort ett befintligt index.
deleteKnowledgeBase(KnowledgeBase, DeleteKnowledgeBaseOptions)	Tar bort en befintlig 知識庫.
deleteKnowledgeBase(string, DeleteKnowledgeBaseOptions)	Tar bort en befintlig 知識庫.
deleteKnowledgeSource(KnowledgeSource, DeleteKnowledgeSourceOptions)	Tar bort en befintlig källa.
deleteKnowledgeSource(string, DeleteKnowledgeSourceOptions)	Tar bort en befintlig källa.
deleteSynonymMap(string | SynonymMap, DeleteSynonymMapOptions)	Tar bort en befintlig SynonymMap.
getAlias(string, OperationOptions)	Hämtar en aliasdefinition.
getIndex(string, OperationOptions)	Hämtar information om ett index.
getIndexStatistics(string, OperationOptions)	Hämtar statistik om ett index, till exempel antalet dokument och storleken på indexlagringen.
getIndexStatsSummary(GetIndexStatsSummaryOptions)	Hämtar en lista över befintliga index i tjänsten.
getKnowledgeBase(string, GetKnowledgeBaseOptions)	Hämtar en kunskapsbasdefinition.
getKnowledgeRetrievalClient(string, KnowledgeRetrievalClientOptions)	Hämtar den KnowledgeRetrievalClient som motsvarar den här SearchIndexClient
getKnowledgeSource(string, GetKnowledgeSourceOptions)	Hämtar en definition av en kunskapskälla.
getKnowledgeSourceStatus(string, GetKnowledgeSourceStatusOptions)	Returnerar aktuell status och synkroniseringshistorik för en kunskapskälla.
getSearchClient<TModel>(string, SearchClientOptions)	Hämtar SearchClient som motsvarar detta SearchIndexClient
getServiceStatistics(OperationOptions)	Hämtar statistik om tjänsten, till exempel antalet dokument, index osv.
getSynonymMap(string, OperationOptions)	Hämtar information om en SynonymMap.
listAliases(OperationOptions)	Visar en lista över alla alias som är tillgängliga för en söktjänst.
listIndexes(OperationOptions)	Hämtar en lista över befintliga index i tjänsten.
listIndexesNames(OperationOptions)	Hämtar en lista med namn på befintliga index i tjänsten.
listKnowledgeBases(ListKnowledgeBasesOptions)	Hämtar en lista över befintliga kunskapsbaser i tjänsten.
listKnowledgeSources(ListKnowledgeSourcesOptions)	Hämtar en lista över befintliga KnowledgeSources i tjänsten.
listSynonymMaps(OperationOptions)	Hämtar en lista över befintliga SynonymMaps i tjänsten.
listSynonymMapsNames(OperationOptions)	Hämtar en lista med namn på befintliga SynonymMaps i tjänsten.

Konstruktorinformation

SearchIndexClient(string, KeyCredential | TokenCredential, SearchIndexClientOptions)

Skapar en instans av SearchIndexClient.

Exempel på användning:

import { SearchIndexClient, AzureKeyCredential } from "@azure/search-documents";

const indexClient = new SearchIndexClient("<endpoint>", new AzureKeyCredential("<apiKey>"));

new SearchIndexClient(endpoint: string, credential: KeyCredential | TokenCredential, options?: SearchIndexClientOptions)

Parametrar

endpoint

string

Slutpunkten för söktjänsten

credential

KeyCredential | TokenCredential

Används för att autentisera begäranden till tjänsten.

options

SearchIndexClientOptions

Används för att konfigurera Search Index-klienten.

Egenskapsinformation

apiVersion

Varning

Det här API:et är nu inaktuellt.

use {@Link serviceVersion} instead

DEN API-version som ska användas när du kommunicerar med tjänsten.

apiVersion: string

Egenskapsvärde

string

endpoint

Slutpunkten för söktjänsten

endpoint: string

Egenskapsvärde

string

pipeline

En referens till den interna HTTP-pipelinen för användning med rådatabegäranden

pipeline: Pipeline

Egenskapsvärde

Pipeline

serviceVersion

DEN API-version som ska användas när du kommunicerar med tjänsten.

serviceVersion: string

Egenskapsvärde

string

Metodinformation

analyzeText(string, AnalyzeTextOptions)

Anropar en analysator eller tokeniserare manuellt på angivet text.

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

Parametrar

indexName

string

Namnet på det index som innehåller fältet som ska analyseras

options

AnalyzeTextOptions

Ytterligare argument

Returer

Promise<AnalyzeResult>

createAlias(SearchAlias, OperationOptions)

Skapar ett nytt sökalias.

function createAlias(alias: SearchAlias, options?: OperationOptions): Promise<SearchAlias>

Parametrar

alias

SearchAlias

Definitionen av det alias som ska skapas.

options

OperationOptions

Alternativparametrarna.

Returer

Promise<SearchAlias>

createIndex(SearchIndex, OperationOptions)

Skapar ett nytt index.

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

Parametrar

index

SearchIndex

Den information som beskriver indexet som ska skapas.

options

OperationOptions

Ytterligare valfria argument.

Returer

Promise<SearchIndex>

createKnowledgeBase(KnowledgeBase, CreateKnowledgeBaseOptions)

Skapar en ny kunskapsbas.

function createKnowledgeBase(knowledgeBase: KnowledgeBase, options?: CreateKnowledgeBaseOptions): Promise<KnowledgeBase>

Parametrar

knowledgeBase

KnowledgeBase

Definition av kunskapsbasen att skapa.

options

CreateKnowledgeBaseOptions

parametrar för optioner.

Returer

Promise<KnowledgeBase>

createKnowledgeSource(KnowledgeSource, CreateKnowledgeSourceOptions)

Skapar en ny kunskapskälla.

function createKnowledgeSource(knowledgeSource: KnowledgeSource, options?: CreateKnowledgeSourceOptions): Promise<KnowledgeSource>

Parametrar

knowledgeSource

KnowledgeSource

Definitionen av den kunskapskälla som ska skapas.

options

CreateKnowledgeSourceOptions

Alternativparametrarna.

Returer

Promise<KnowledgeSource>

createOrUpdateAlias(SearchAlias, CreateOrUpdateAliasOptions)

Skapar ett nytt sökalias eller uppdaterar ett alias om det redan finns.

function createOrUpdateAlias(alias: SearchAlias, options?: CreateOrUpdateAliasOptions): Promise<SearchAlias>

Parametrar

alias

SearchAlias

Definitionen av aliaset som ska skapas eller uppdateras.

options

CreateOrUpdateAliasOptions

Alternativparametrarna.

Returer

Promise<SearchAlias>

createOrUpdateIndex(SearchIndex, CreateOrUpdateIndexOptions)

Skapar ett nytt index eller ändrar ett befintligt.

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

Parametrar

index

SearchIndex

Den information som beskriver indexet som ska skapas.

options

CreateOrUpdateIndexOptions

Ytterligare valfria argument.

Returer

Promise<SearchIndex>

createOrUpdateKnowledgeBase(string, KnowledgeBase, CreateOrUpdateKnowledgeBaseOptions)

Skapar en ny kunskapsbas eller uppdaterar en kunskapsbas om den redan finns.

function createOrUpdateKnowledgeBase(knowledgeBaseName: string, knowledgeBase: KnowledgeBase, options?: CreateOrUpdateKnowledgeBaseOptions): Promise<KnowledgeBase>

Parametrar

knowledgeBaseName

string

Namnet på kunskapsbasen som ska skapas eller uppdateras.

knowledgeBase

KnowledgeBase

Definition av kunskapsbasen som ska skapas eller uppdateras.

options

CreateOrUpdateKnowledgeBaseOptions

parametrar för optioner.

Returer

Promise<KnowledgeBase>

createOrUpdateKnowledgeSource(string, KnowledgeSource, CreateOrUpdateKnowledgeSourceOptions)

function createOrUpdateKnowledgeSource(sourceName: string, knowledgeSource: KnowledgeSource, options?: CreateOrUpdateKnowledgeSourceOptions): Promise<KnowledgeSource>

Parametrar

sourceName

string

knowledgeSource

KnowledgeSource

options

CreateOrUpdateKnowledgeSourceOptions

Returer

Promise<KnowledgeSource>

createOrUpdateSynonymMap(SynonymMap, CreateOrUpdateSynonymMapOptions)

Skapar en ny SynonymMap eller ändrar en befintlig.

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

Parametrar

synonymMap

SynonymMap

Informationen som beskriver synonymkartan som ska skapas.

options

CreateOrUpdateSynonymMapOptions

Ytterligare valfria argument.

Returer

Promise<SynonymMap>

createSynonymMap(SynonymMap, OperationOptions)

Skapar en ny SynonymMap i en söktjänst.

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

Parametrar

synonymMap

SynonymMap

SynonymMappdefinitionen som ska skapas i en söktjänst.

options

OperationOptions

Ytterligare valfria argument.

Returer

Promise<SynonymMap>

deleteAlias(SearchAlias, DeleteAliasOptions)

Tar bort ett sökalias och dess associerade mappning till ett index. Den här åtgärden är permanent, utan återställningsalternativ. Det mappade indexet är orört av den här åtgärden.

function deleteAlias(alias: SearchAlias, options?: DeleteAliasOptions): Promise<void>

Parametrar

alias

SearchAlias

Aliaset som ska tas bort.

options

DeleteAliasOptions

Ytterligare valfria argument.

Returer

Promise<void>

deleteAlias(string, DeleteAliasOptions)

Tar bort ett sökalias och dess associerade mappning till ett index. Den här åtgärden är permanent, utan återställningsalternativ. Det mappade indexet är orört av den här åtgärden.

function deleteAlias(aliasName: string, options?: DeleteAliasOptions): Promise<void>

Parametrar

aliasName

string

Namnet på det alias som ska tas bort.

options

DeleteAliasOptions

Ytterligare valfria argument.

Returer

Promise<void>

deleteIndex(SearchIndex, DeleteIndexOptions)

Tar bort ett befintligt index.

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

Parametrar

index

SearchIndex

Indexet som ska tas bort.

options

DeleteIndexOptions

Ytterligare valfria argument.

Returer

Promise<void>

deleteIndex(string, DeleteIndexOptions)

Tar bort ett befintligt index.

function deleteIndex(indexName: string, options?: DeleteIndexOptions): Promise<void>

Parametrar

indexName

string

Namnet på indexet som ska tas bort.

options

DeleteIndexOptions

Ytterligare valfria argument.

Returer

Promise<void>

deleteKnowledgeBase(KnowledgeBase, DeleteKnowledgeBaseOptions)

Tar bort en befintlig 知識庫.

function deleteKnowledgeBase(knowledgeBase: KnowledgeBase, options?: DeleteKnowledgeBaseOptions): Promise<void>

Parametrar

knowledgeBase

KnowledgeBase

kunskapsbasen att ta bort.

options

DeleteKnowledgeBaseOptions

parametrar för optioner.

Returer

Promise<void>

deleteKnowledgeBase(string, DeleteKnowledgeBaseOptions)

Tar bort en befintlig 知識庫.

function deleteKnowledgeBase(knowledgeBaseName: string, options?: DeleteKnowledgeBaseOptions): Promise<void>

Parametrar

knowledgeBaseName

string

Namnet på kunskapsbasen som ska tas bort.

options

DeleteKnowledgeBaseOptions

parametrar för optioner.

Returer

Promise<void>

deleteKnowledgeSource(KnowledgeSource, DeleteKnowledgeSourceOptions)

Tar bort en befintlig källa.

function deleteKnowledgeSource(source: KnowledgeSource, options?: DeleteKnowledgeSourceOptions): Promise<void>

Parametrar

source

KnowledgeSource

Kunskapskällan som ska tas bort.

options

DeleteKnowledgeSourceOptions

parametrar för optioner.

Returer

Promise<void>

deleteKnowledgeSource(string, DeleteKnowledgeSourceOptions)

Tar bort en befintlig källa.

function deleteKnowledgeSource(sourceName: string, options?: DeleteKnowledgeSourceOptions): Promise<void>

Parametrar

sourceName

string

Namnet på den kunskapskälla som ska tas bort.

options

DeleteKnowledgeSourceOptions

parametrar för optioner.

Returer

Promise<void>

deleteSynonymMap(string | SynonymMap, DeleteSynonymMapOptions)

Tar bort en befintlig SynonymMap.

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

Parametrar

synonymMap

string | SynonymMap

options

DeleteSynonymMapOptions

Ytterligare valfria argument.

Returer

Promise<void>

getAlias(string, OperationOptions)

Hämtar en aliasdefinition.

function getAlias(aliasName: string, options?: OperationOptions): Promise<SearchAlias>

Parametrar

aliasName

string

Namnet på aliaset som ska hämtas.

options

OperationOptions

Alternativparametrarna.

Returer

Promise<SearchAlias>

getIndex(string, OperationOptions)

Hämtar information om ett index.

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

Parametrar

indexName

string

Namnet på indexet.

options

OperationOptions

Ytterligare valfria argument.

Returer

Promise<SearchIndex>

getIndexStatistics(string, OperationOptions)

Hämtar statistik om ett index, till exempel antalet dokument och storleken på indexlagringen.

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

Parametrar

indexName

string

Namnet på indexet.

options

OperationOptions

Ytterligare valfria argument.

Returer

Promise<SearchIndexStatistics>

getIndexStatsSummary(GetIndexStatsSummaryOptions)

Hämtar en lista över befintliga index i tjänsten.

function getIndexStatsSummary(options?: GetIndexStatsSummaryOptions): IndexStatisticsSummaryIterator

Parametrar

options

GetIndexStatsSummaryOptions

Alternativ för listindexåtgärden.

Returer

IndexStatisticsSummaryIterator

getKnowledgeBase(string, GetKnowledgeBaseOptions)

Hämtar en kunskapsbasdefinition.

function getKnowledgeBase(knowledgeBaseName: string, options?: GetKnowledgeBaseOptions): Promise<KnowledgeBase>

Parametrar

knowledgeBaseName

string

Namnet på kunskapsbasen som ska hämtas.

options

GetKnowledgeBaseOptions

parametrar för optioner.

Returer

Promise<KnowledgeBase>

getKnowledgeRetrievalClient(string, KnowledgeRetrievalClientOptions)

Hämtar den KnowledgeRetrievalClient som motsvarar den här SearchIndexClient

function getKnowledgeRetrievalClient(knowledgeBaseName: string, options?: KnowledgeRetrievalClientOptions): KnowledgeRetrievalClient

Parametrar

knowledgeBaseName

string

Namnet på kunskapsbasen

options

KnowledgeRetrievalClientOptions

KnowledgeRetrievalClient-alternativ

Returer

KnowledgeRetrievalClient

getKnowledgeSource(string, GetKnowledgeSourceOptions)

Hämtar en definition av en kunskapskälla.

function getKnowledgeSource(sourceName: string, options?: GetKnowledgeSourceOptions): Promise<KnowledgeSource>

Parametrar

sourceName

string

Namnet på den kunskapskälla som ska hämtas.

options

GetKnowledgeSourceOptions

Alternativparametrarna.

Returer

Promise<KnowledgeSource>

getKnowledgeSourceStatus(string, GetKnowledgeSourceStatusOptions)

Returnerar aktuell status och synkroniseringshistorik för en kunskapskälla.

function getKnowledgeSourceStatus(sourceName: string, options?: GetKnowledgeSourceStatusOptions): Promise<KnowledgeSourceStatus>

Parametrar

sourceName

string

Namnet på den kunskapskälla som status ska hämtas för.

options

GetKnowledgeSourceStatusOptions

Alternativparametrarna.

Returer

Promise<KnowledgeSourceStatus>

getSearchClient<TModel>(string, SearchClientOptions)

Hämtar SearchClient som motsvarar detta SearchIndexClient

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

Parametrar

indexName

string

Indexets namn

options

SearchClientOptions

SearchClient-alternativ

Returer

SearchClient<TModel>

getServiceStatistics(OperationOptions)

Hämtar statistik om tjänsten, till exempel antalet dokument, index osv.

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

Parametrar

options

OperationOptions

Ytterligare valfria argument.

Returer

Promise<SearchServiceStatistics>

getSynonymMap(string, OperationOptions)

Hämtar information om en SynonymMap.

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

Parametrar

synonymMapName

string

Namnet på SynonymMap.

options

OperationOptions

Ytterligare valfria argument.

Returer

Promise<SynonymMap>

listAliases(OperationOptions)

Visar en lista över alla alias som är tillgängliga för en söktjänst.

function listAliases(options?: OperationOptions): AliasIterator

Parametrar

options

OperationOptions

Alternativparametrarna.

Returer

AliasIterator

listIndexes(OperationOptions)

Hämtar en lista över befintliga index i tjänsten.

function listIndexes(options?: OperationOptions): IndexIterator

Parametrar

options

OperationOptions

Alternativ för listindexåtgärden.

Returer

IndexIterator

listIndexesNames(OperationOptions)

Hämtar en lista med namn på befintliga index i tjänsten.

function listIndexesNames(options?: OperationOptions): IndexNameIterator

Parametrar

options

OperationOptions

Alternativ för listindexåtgärden.

Returer

IndexNameIterator

listKnowledgeBases(ListKnowledgeBasesOptions)

Hämtar en lista över befintliga kunskapsbaser i tjänsten.

function listKnowledgeBases(options?: ListKnowledgeBasesOptions): KnowledgeBaseIterator

Parametrar

options

ListKnowledgeBasesOptions

Alternativ för att lista kunskapsbasoperation.

Returer

KnowledgeBaseIterator

listKnowledgeSources(ListKnowledgeSourcesOptions)

Hämtar en lista över befintliga KnowledgeSources i tjänsten.

function listKnowledgeSources(options?: ListKnowledgeSourcesOptions): KnowledgeSourceIterator

Parametrar

options

ListKnowledgeSourcesOptions

Alternativ för åtgärden lista kunskapskällor.

Returer

KnowledgeSourceIterator

listSynonymMaps(OperationOptions)

Hämtar en lista över befintliga SynonymMaps i tjänsten.

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

Parametrar

options

OperationOptions

Alternativ för liståtgärden SynonymMaps.

Returer

Promise<SynonymMap[]>

listSynonymMapsNames(OperationOptions)

Hämtar en lista med namn på befintliga SynonymMaps i tjänsten.

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

Parametrar

options

OperationOptions

Alternativ för liståtgärden SynonymMaps.

Returer

Promise<string[]>