SearchIndexClient class

Pacchetto:

@azure/search-documents

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

Costruttori

SearchIndexClient(string, KeyCredential | TokenCredential, SearchIndexClientOptions)

Crea un'istanza di SearchIndexClient. Sintassi di esempio: import { SearchIndexClient, AzureKeyCredential } from "@azure/search-documents"; const indexClient = new SearchIndexClient("<endpoint>", new AzureKeyCredential("<apiKey>"));

Proprietà

apiVersion	Versione dell'API da usare durante la comunicazione con il servizio.
endpoint	Endpoint del servizio di ricerca
pipeline	Riferimento alla pipeline HTTP interna da utilizzare con le richieste non elaborate
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.
createAlias(SearchAlias, OperationOptions)	Crea un nuovo alias di ricerca.
createIndex(SearchIndex, OperationOptions)	Crea un nuovo indice.
createKnowledgeBase(KnowledgeBase, CreateKnowledgeBaseOptions)	Crea una nuova base di conoscenza.
createKnowledgeSource(KnowledgeSource, CreateKnowledgeSourceOptions)	Crea una nuova fonte di conoscenza.
createOrUpdateAlias(SearchAlias, CreateOrUpdateAliasOptions)	Crea un nuovo alias di ricerca o aggiorna un alias, se già esistente.
createOrUpdateIndex(SearchIndex, CreateOrUpdateIndexOptions)	Crea un nuovo indice o ne modifica uno esistente.
createOrUpdateKnowledgeBase(string, KnowledgeBase, CreateOrUpdateKnowledgeBaseOptions)	Crea una nuova knowledge base o aggiorna una knowledge base se esiste già.
createOrUpdateKnowledgeSource(string, KnowledgeSource, CreateOrUpdateKnowledgeSourceOptions)
createOrUpdateSynonymMap(SynonymMap, CreateOrUpdateSynonymMapOptions)	Crea un nuovo SynonymMap o ne modifica uno esistente.
createSynonymMap(SynonymMap, OperationOptions)	Crea un nuovo SynonymMap in un servizio di ricerca.
deleteAlias(SearchAlias, DeleteAliasOptions)	Elimina un alias di ricerca e il mapping associato a un indice. Questa operazione è permanente, senza opzione di ripristino. L'indice mappato non è stato modificato da questa operazione.
deleteAlias(string, DeleteAliasOptions)	Elimina un alias di ricerca e il mapping associato a un indice. Questa operazione è permanente, senza opzione di ripristino. L'indice mappato non è stato modificato da questa operazione.
deleteIndex(SearchIndex, DeleteIndexOptions)	Elimina un indice esistente.
deleteIndex(string, DeleteIndexOptions)	Elimina un indice esistente.
deleteKnowledgeBase(KnowledgeBase, DeleteKnowledgeBaseOptions)	Elimina una Knowledge Base esistente.
deleteKnowledgeBase(string, DeleteKnowledgeBaseOptions)	Elimina una Knowledge Base esistente.
deleteKnowledgeSource(KnowledgeSource, DeleteKnowledgeSourceOptions)	Elimina un'origine esistente.
deleteKnowledgeSource(string, DeleteKnowledgeSourceOptions)	Elimina un'origine esistente.
deleteSynonymMap(string | SynonymMap, DeleteSynonymMapOptions)	Elimina un oggetto SynonymMap esistente.
getAlias(string, OperationOptions)	Recupera una definizione di alias.
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.
getIndexStatsSummary(GetIndexStatsSummaryOptions)	Recupera un elenco di indici esistenti nel servizio.
getKnowledgeBase(string, GetKnowledgeBaseOptions)	Recupera una definizione della base di conoscenza.
getKnowledgeRetrievalClient(string, KnowledgeRetrievalClientOptions)	Recupera l'oggetto KnowledgeRetrievalClient corrispondente all'oggetto SearchIndexClient
getKnowledgeSource(string, GetKnowledgeSourceOptions)	Recupera la definizione di un'origine conoscenza.
getKnowledgeSourceStatus(string, GetKnowledgeSourceStatusOptions)	Restituisce lo stato corrente e la cronologia di sincronizzazione di un'origine informazioni.
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.
listAliases(OperationOptions)	Elenca tutti gli alias disponibili per un servizio di ricerca.
listIndexes(OperationOptions)	Recupera un elenco di indici esistenti nel servizio.
listIndexesNames(OperationOptions)	Recupera un elenco di nomi di indici esistenti nel servizio.
listKnowledgeBases(ListKnowledgeBasesOptions)	Recupera un elenco delle KnowledgeBase esistenti nel servizio.
listKnowledgeSources(ListKnowledgeSourcesOptions)	Recupera un elenco di KnowledgeSource 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.

Sintassi di esempio:

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

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

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

pipeline

Riferimento alla pipeline HTTP interna da utilizzare con le richieste non elaborate

pipeline: Pipeline

Valore della proprietà

Pipeline

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>

createAlias(SearchAlias, OperationOptions)

Crea un nuovo alias di ricerca.

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

Parametri

alias

SearchAlias

Definizione dell'alias da creare.

options

OperationOptions

Parametri delle opzioni.

Restituisce

Promise<SearchAlias>

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>

createKnowledgeBase(KnowledgeBase, CreateKnowledgeBaseOptions)

Crea una nuova base di conoscenza.

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

Parametri

knowledgeBase

KnowledgeBase

Definizione della base di conoscenza da creare.

options

CreateKnowledgeBaseOptions

parametri delle opzioni.

Restituisce

Promise<KnowledgeBase>

createKnowledgeSource(KnowledgeSource, CreateKnowledgeSourceOptions)

Crea una nuova fonte di conoscenza.

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

Parametri

knowledgeSource

KnowledgeSource

Definizione dell'origine della conoscenza da creare.

options

CreateKnowledgeSourceOptions

Parametri delle opzioni.

Restituisce

Promise<KnowledgeSource>

createOrUpdateAlias(SearchAlias, CreateOrUpdateAliasOptions)

Crea un nuovo alias di ricerca o aggiorna un alias, se già esistente.

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

Parametri

alias

SearchAlias

Definizione dell'alias da creare o aggiornare.

options

CreateOrUpdateAliasOptions

Parametri delle opzioni.

Restituisce

Promise<SearchAlias>

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>

createOrUpdateKnowledgeBase(string, KnowledgeBase, CreateOrUpdateKnowledgeBaseOptions)

Crea una nuova knowledge base o aggiorna una knowledge base se esiste già.

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

Parametri

knowledgeBaseName

string

Nome della knowledge base da creare o aggiornare.

knowledgeBase

KnowledgeBase

Definizione della base di conoscenza da creare o aggiornare.

options

CreateOrUpdateKnowledgeBaseOptions

parametri delle opzioni.

Restituisce

Promise<KnowledgeBase>

createOrUpdateKnowledgeSource(string, KnowledgeSource, CreateOrUpdateKnowledgeSourceOptions)

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

Parametri

sourceName

string

knowledgeSource

KnowledgeSource

options

CreateOrUpdateKnowledgeSourceOptions

Restituisce

Promise<KnowledgeSource>

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>

deleteAlias(SearchAlias, DeleteAliasOptions)

Elimina un alias di ricerca e il mapping associato a un indice. Questa operazione è permanente, senza opzione di ripristino. L'indice mappato non è stato modificato da questa operazione.

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

Parametri

alias

SearchAlias

Alias da eliminare.

options

DeleteAliasOptions

Argomenti facoltativi aggiuntivi.

Restituisce

Promise<void>

deleteAlias(string, DeleteAliasOptions)

Elimina un alias di ricerca e il mapping associato a un indice. Questa operazione è permanente, senza opzione di ripristino. L'indice mappato non è stato modificato da questa operazione.

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

Parametri

aliasName

string

Nome dell'alias da eliminare.

options

DeleteAliasOptions

Argomenti facoltativi aggiuntivi.

Restituisce

Promise<void>

deleteIndex(SearchIndex, DeleteIndexOptions)

Elimina un indice esistente.

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

Parametri

index

SearchIndex

Indice da eliminare.

options

DeleteIndexOptions

Argomenti facoltativi aggiuntivi.

Restituisce

Promise<void>

deleteIndex(string, DeleteIndexOptions)

Elimina un indice esistente.

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

Parametri

indexName

string

Nome dell'indice da eliminare.

options

DeleteIndexOptions

Argomenti facoltativi aggiuntivi.

Restituisce

Promise<void>

deleteKnowledgeBase(KnowledgeBase, DeleteKnowledgeBaseOptions)

Elimina una Knowledge Base esistente.

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

Parametri

knowledgeBase

KnowledgeBase

La base di conoscenza da cancellare.

options

DeleteKnowledgeBaseOptions

parametri delle opzioni.

Restituisce

Promise<void>

deleteKnowledgeBase(string, DeleteKnowledgeBaseOptions)

Elimina una Knowledge Base esistente.

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

Parametri

knowledgeBaseName

string

Nome della knowledge base da eliminare.

options

DeleteKnowledgeBaseOptions

parametri delle opzioni.

Restituisce

Promise<void>

deleteKnowledgeSource(KnowledgeSource, DeleteKnowledgeSourceOptions)

Elimina un'origine esistente.

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

Parametri

source

KnowledgeSource

l'origine della conoscenza da eliminare.

options

DeleteKnowledgeSourceOptions

parametri delle opzioni.

Restituisce

Promise<void>

deleteKnowledgeSource(string, DeleteKnowledgeSourceOptions)

Elimina un'origine esistente.

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

Parametri

sourceName

string

Nome dell'origine della conoscenza da eliminare.

options

DeleteKnowledgeSourceOptions

parametri delle opzioni.

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>

getAlias(string, OperationOptions)

Recupera una definizione di alias.

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

Parametri

aliasName

string

Nome dell'alias da recuperare.

options

OperationOptions

Parametri delle opzioni.

Restituisce

Promise<SearchAlias>

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

Promise<SearchIndexStatistics>

getIndexStatsSummary(GetIndexStatsSummaryOptions)

Recupera un elenco di indici esistenti nel servizio.

function getIndexStatsSummary(options?: GetIndexStatsSummaryOptions): IndexStatisticsSummaryIterator

Parametri

options

GetIndexStatsSummaryOptions

Opzioni per l'operazione di indice dell'elenco.

Restituisce

IndexStatisticsSummaryIterator

getKnowledgeBase(string, GetKnowledgeBaseOptions)

Recupera una definizione della base di conoscenza.

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

Parametri

knowledgeBaseName

string

Nome della knowledge base da recuperare.

options

GetKnowledgeBaseOptions

parametri delle opzioni.

Restituisce

Promise<KnowledgeBase>

getKnowledgeRetrievalClient(string, KnowledgeRetrievalClientOptions)

Recupera l'oggetto KnowledgeRetrievalClient corrispondente all'oggetto SearchIndexClient

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

Parametri

knowledgeBaseName

string

Nome della base di conoscenza

options

KnowledgeRetrievalClientOptions

Opzioni di KnowledgeRetrievalClient

Restituisce

KnowledgeRetrievalClient

getKnowledgeSource(string, GetKnowledgeSourceOptions)

Recupera la definizione di un'origine conoscenza.

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

Parametri

sourceName

string

Nome dell'origine della conoscenza da recuperare.

options

GetKnowledgeSourceOptions

Parametri delle opzioni.

Restituisce

Promise<KnowledgeSource>

getKnowledgeSourceStatus(string, GetKnowledgeSourceStatusOptions)

Restituisce lo stato corrente e la cronologia di sincronizzazione di un'origine informazioni.

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

Parametri

sourceName

string

Nome dell'origine informazioni di cui recuperare lo stato.

options

GetKnowledgeSourceStatusOptions

Parametri delle opzioni.

Restituisce

Promise<KnowledgeSourceStatus>

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

Promise<SearchServiceStatistics>

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>

listAliases(OperationOptions)

Elenca tutti gli alias disponibili per un servizio di ricerca.

function listAliases(options?: OperationOptions): AliasIterator

Parametri

options

OperationOptions

Parametri delle opzioni.

Restituisce

AliasIterator

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

IndexIterator

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

IndexNameIterator

listKnowledgeBases(ListKnowledgeBasesOptions)

Recupera un elenco delle KnowledgeBase esistenti nel servizio.

function listKnowledgeBases(options?: ListKnowledgeBasesOptions): KnowledgeBaseIterator

Parametri

options

ListKnowledgeBasesOptions

Opzioni per l'operazione della lista delle basi di conoscenza.

Restituisce

KnowledgeBaseIterator

listKnowledgeSources(ListKnowledgeSourcesOptions)

Recupera un elenco di KnowledgeSource esistenti nel servizio.

function listKnowledgeSources(options?: ListKnowledgeSourcesOptions): KnowledgeSourceIterator

Parametri

options

ListKnowledgeSourcesOptions

Opzioni per l'operazione di elenco delle fonti di conoscenza.

Restituisce

KnowledgeSourceIterator

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[]>