Condividi tramite


SearchIndexClient class

Classe per eseguire operazioni per gestire (creare, aggiornare, elencare/eliminare) indici, & mapping sinonimi.

Costruttori

SearchIndexClient(string, KeyCredential | TokenCredential, SearchIndexClientOptions)

Crea un'istanza di SearchIndexClient.

Esempio di utilizzo:

const { SearchIndexClient, AzureKeyCredential } = require("@azure/search-documents");

const client = new SearchIndexClient(
  "<endpoint>",
  new AzureKeyCredential("<Admin Key>");
);

Proprietà

apiVersion

Versione dell'API da usare durante la comunicazione con il servizio.

endpoint

Endpoint del servizio di ricerca

serviceVersion

Versione dell'API da usare durante la comunicazione con il servizio.

Metodi

analyzeText(string, AnalyzeTextOptions)

Chiama manualmente un analizzatore o un tokenizer sul testo specificato.

createIndex(SearchIndex, OperationOptions)

Crea un nuovo indice.

createOrUpdateIndex(SearchIndex, CreateOrUpdateIndexOptions)

Crea un nuovo indice o ne modifica uno esistente.

createOrUpdateSynonymMap(SynonymMap, CreateOrUpdateSynonymMapOptions)

Crea un nuovo SynonymMap o ne modifica uno esistente.

createSynonymMap(SynonymMap, OperationOptions)

Crea un nuovo SynonymMap in un servizio di ricerca.

deleteIndex(string | SearchIndex, DeleteIndexOptions)

Elimina un indice esistente.

deleteSynonymMap(string | SynonymMap, DeleteSynonymMapOptions)

Elimina un oggetto SynonymMap esistente.

getIndex(string, OperationOptions)

Recupera informazioni su un indice.

getIndexStatistics(string, OperationOptions)

Recupera statistiche su un indice, ad esempio il conteggio dei documenti e le dimensioni dell'archiviazione degli indici.

getSearchClient<TModel>(string, SearchClientOptions)

Recupera l'oggetto SearchClient corrispondente a questo SearchIndexClient

getServiceStatistics(OperationOptions)

Recupera statistiche sul servizio, ad esempio il conteggio di documenti, indici e così via.

getSynonymMap(string, OperationOptions)

Recupera informazioni su un oggetto SynonymMap.

listIndexes(OperationOptions)

Recupera un elenco di indici esistenti nel servizio.

listIndexesNames(OperationOptions)

Recupera un elenco di nomi di indici esistenti nel servizio.

listSynonymMaps(OperationOptions)

Recupera un elenco di SynonymMap esistenti nel servizio.

listSynonymMapsNames(OperationOptions)

Recupera un elenco di nomi di SynonymMap esistenti nel servizio.

Dettagli costruttore

SearchIndexClient(string, KeyCredential | TokenCredential, SearchIndexClientOptions)

Crea un'istanza di SearchIndexClient.

Esempio di utilizzo:

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)

Parametri

endpoint

string

Endpoint del servizio di ricerca

credential

KeyCredential | TokenCredential

Usato per autenticare le richieste al servizio.

options
SearchIndexClientOptions

Usato per configurare il client dell'indice di ricerca.

Dettagli proprietà

apiVersion

Avviso

Questa API è ora deprecata.

use {@Link serviceVersion} instead

Versione dell'API da usare durante la comunicazione con il servizio.

apiVersion: string

Valore della proprietà

string

endpoint

Endpoint del servizio di ricerca

endpoint: string

Valore della proprietà

string

serviceVersion

Versione dell'API da usare durante la comunicazione con il servizio.

serviceVersion: string

Valore della proprietà

string

Dettagli metodo

analyzeText(string, AnalyzeTextOptions)

Chiama manualmente un analizzatore o un tokenizer sul testo specificato.

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

Parametri

indexName

string

Nome dell'indice che contiene il campo da analizzare

options
AnalyzeTextOptions

Argomenti aggiuntivi

Restituisce

Promise<AnalyzeResult>

createIndex(SearchIndex, OperationOptions)

Crea un nuovo indice.

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

Parametri

index
SearchIndex

Informazioni che descrivono l'indice da creare.

options
OperationOptions

Argomenti facoltativi aggiuntivi.

Restituisce

Promise<SearchIndex>

createOrUpdateIndex(SearchIndex, CreateOrUpdateIndexOptions)

Crea un nuovo indice o ne modifica uno esistente.

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

Parametri

index
SearchIndex

Informazioni che descrivono l'indice da creare.

options
CreateOrUpdateIndexOptions

Argomenti facoltativi aggiuntivi.

Restituisce

Promise<SearchIndex>

createOrUpdateSynonymMap(SynonymMap, CreateOrUpdateSynonymMapOptions)

Crea un nuovo SynonymMap o ne modifica uno esistente.

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

Parametri

synonymMap
SynonymMap

Informazioni che descrivono l'oggetto SynonymMap da creare.

options
CreateOrUpdateSynonymMapOptions

Argomenti facoltativi aggiuntivi.

Restituisce

Promise<SynonymMap>

createSynonymMap(SynonymMap, OperationOptions)

Crea un nuovo SynonymMap in un servizio di ricerca.

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

Parametri

synonymMap
SynonymMap

Definizione synonymMap da creare in un servizio di ricerca.

options
OperationOptions

Argomenti facoltativi aggiuntivi.

Restituisce

Promise<SynonymMap>

deleteIndex(string | SearchIndex, DeleteIndexOptions)

Elimina un indice esistente.

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

Parametri

index

string | SearchIndex

options
DeleteIndexOptions

Argomenti facoltativi aggiuntivi.

Restituisce

Promise<void>

deleteSynonymMap(string | SynonymMap, DeleteSynonymMapOptions)

Elimina un oggetto SynonymMap esistente.

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

Parametri

synonymMap

string | SynonymMap

options
DeleteSynonymMapOptions

Argomenti facoltativi aggiuntivi.

Restituisce

Promise<void>

getIndex(string, OperationOptions)

Recupera informazioni su un indice.

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

Parametri

indexName

string

Nome dell'indice.

options
OperationOptions

Argomenti facoltativi aggiuntivi.

Restituisce

Promise<SearchIndex>

getIndexStatistics(string, OperationOptions)

Recupera statistiche su un indice, ad esempio il conteggio dei documenti e le dimensioni dell'archiviazione degli indici.

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

Parametri

indexName

string

Nome dell'indice.

options
OperationOptions

Argomenti facoltativi aggiuntivi.

Restituisce

getSearchClient<TModel>(string, SearchClientOptions)

Recupera l'oggetto SearchClient corrispondente a questo SearchIndexClient

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

Parametri

indexName

string

Nome dell'indice

options
SearchClientOptions

Opzioni SearchClient

Restituisce

SearchClient<TModel>

getServiceStatistics(OperationOptions)

Recupera statistiche sul servizio, ad esempio il conteggio di documenti, indici e così via.

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

Parametri

options
OperationOptions

Argomenti facoltativi aggiuntivi.

Restituisce

getSynonymMap(string, OperationOptions)

Recupera informazioni su un oggetto SynonymMap.

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

Parametri

synonymMapName

string

Nome dell'oggetto SynonymMap.

options
OperationOptions

Argomenti facoltativi aggiuntivi.

Restituisce

Promise<SynonymMap>

listIndexes(OperationOptions)

Recupera un elenco di indici esistenti nel servizio.

function listIndexes(options?: OperationOptions): IndexIterator

Parametri

options
OperationOptions

Opzioni per l'operazione di indice dell'elenco.

Restituisce

listIndexesNames(OperationOptions)

Recupera un elenco di nomi di indici esistenti nel servizio.

function listIndexesNames(options?: OperationOptions): IndexNameIterator

Parametri

options
OperationOptions

Opzioni per l'operazione di indice dell'elenco.

Restituisce

listSynonymMaps(OperationOptions)

Recupera un elenco di SynonymMap esistenti nel servizio.

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

Parametri

options
OperationOptions

Opzioni per l'operazione SynonymMaps dell'elenco.

Restituisce

Promise<SynonymMap[]>

listSynonymMapsNames(OperationOptions)

Recupera un elenco di nomi di SynonymMap esistenti nel servizio.

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

Parametri

options
OperationOptions

Opzioni per l'operazione SynonymMaps dell'elenco.

Restituisce

Promise<string[]>