SearchIndexClient class
Klass för att utföra åtgärder för att hantera (skapa, uppdatera, lista/ta bort) index & synonymkartor.
Konstruktorer
Search |
Skapar en instans av SearchIndexClient. Exempel på användning:
|
Egenskaper
api |
DEN API-version som ska användas vid kommunikation med tjänsten. |
endpoint | Slutpunkten för söktjänsten |
service |
DEN API-version som ska användas vid kommunikation med tjänsten. |
Metoder
analyze |
Anropar en analysator eller tokeniserare manuellt på angivet text. |
create |
Skapar ett nytt index. |
create |
Skapar ett nytt index eller ändrar ett befintligt. |
create |
Skapar en ny SynonymMap eller ändrar en befintlig. |
create |
Skapar en ny SynonymMap i en söktjänst. |
delete |
Tar bort ett befintligt index. |
delete |
Tar bort en befintlig SynonymMap. |
get |
Hämtar information om ett index. |
get |
Hämtar statistik om ett index, till exempel antalet dokument och storleken på indexlagringen. |
get |
Hämtar SearchClient som motsvarar denna SearchIndexClient |
get |
Hämtar statistik om tjänsten, till exempel antalet dokument, index osv. |
get |
Hämtar information om en SynonymMap. |
list |
Hämtar en lista över befintliga index i tjänsten. |
list |
Hämtar en lista med namn på befintliga index i tjänsten. |
list |
Hämtar en lista över befintliga SynonymMaps i tjänsten. |
list |
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:
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)
Parametrar
- endpoint
-
string
Slutpunkten för söktjänsten
- credential
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 vid kommunikation med tjänsten.
apiVersion: string
Egenskapsvärde
string
endpoint
Slutpunkten för söktjänsten
endpoint: string
Egenskapsvärde
string
serviceVersion
DEN API-version som ska användas vid kommunikation 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å indexet som innehåller fältet som ska analyseras
- options
- AnalyzeTextOptions
Ytterligare argument
Returer
Promise<AnalyzeResult>
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>
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>
createOrUpdateSynonymMap(SynonymMap, CreateOrUpdateSynonymMapOptions)
Skapar en ny SynonymMap eller ändrar en befintlig.
function createOrUpdateSynonymMap(synonymMap: SynonymMap, options?: CreateOrUpdateSynonymMapOptions): Promise<SynonymMap>
Parametrar
- synonymMap
- SynonymMap
Den information 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
Den synonymMappdefinition som ska skapas i en söktjänst.
- options
- OperationOptions
Ytterligare valfria argument.
Returer
Promise<SynonymMap>
deleteIndex(string | SearchIndex, DeleteIndexOptions)
Tar bort ett befintligt index.
function deleteIndex(index: string | SearchIndex, options?: DeleteIndexOptions): Promise<void>
Parametrar
- index
-
string | SearchIndex
- options
- DeleteIndexOptions
Ytterligare valfria argument.
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>
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>
getSearchClient<TModel>(string, SearchClientOptions)
Hämtar SearchClient som motsvarar denna 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>
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
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
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[]>