SearchIndexerClient class

Pacchetto:

@azure/search-documents

Classe per eseguire operazioni da gestire (creare, aggiornare, elencare/eliminare) indicizzatori, origini dati & set di competenze.

Costruttori

SearchIndexerClient(string, KeyCredential | TokenCredential, SearchIndexerClientOptions)

Crea un'istanza di SearchIndexerClient. Esempio di utilizzo: const { SearchIndexerClient, AzureKeyCredential } = require("@azure/search-documents"); const client = new SearchIndexerClient( "<endpoint>", new AzureKeyCredential("<Admin Key>"); );

Proprietà

apiVersion	Versione dell'API da usare quando si comunica con il servizio.
endpoint	Endpoint del servizio di ricerca
serviceVersion	Versione dell'API da usare quando si comunica con il servizio.

Metodi

createDataSourceConnection(SearchIndexerDataSourceConnection, OperationOptions)	Crea una nuova origine dati in un servizio di ricerca.
createIndexer(SearchIndexer, OperationOptions)	Crea un nuovo indicizzatore in un servizio di ricerca.
createOrUpdateDataSourceConnection(SearchIndexerDataSourceConnection, CreateorUpdateDataSourceConnectionOptions)	Crea una nuova origine dati o ne modifica una esistente.
createOrUpdateIndexer(SearchIndexer, CreateorUpdateIndexerOptions)	Crea un nuovo indicizzatore o ne modifica uno esistente.
createOrUpdateSkillset(SearchIndexerSkillset, CreateOrUpdateSkillsetOptions)	Crea un nuovo set di competenze o ne modifica uno esistente.
createSkillset(SearchIndexerSkillset, OperationOptions)	Crea un nuovo set di competenze in un servizio di ricerca.
deleteDataSourceConnection(string | SearchIndexerDataSourceConnection, DeleteDataSourceConnectionOptions)	Elimina un'origine dati esistente.
deleteIndexer(string | SearchIndexer, DeleteIndexerOptions)	Elimina un indicizzatore esistente.
deleteSkillset(string | SearchIndexerSkillset, DeleteSkillsetOptions)	Elimina un set di competenze esistente.
getDataSourceConnection(string, OperationOptions)	Recupera informazioni su un'origine dati
getIndexer(string, OperationOptions)	Recupera informazioni su un indicizzatore.
getIndexerStatus(string, OperationOptions)	Restituisce lo stato corrente e la cronologia di esecuzione di un indicizzatore.
getSkillset(string, OperationOptions)	Recupera informazioni su un set di competenze.
listDataSourceConnections(OperationOptions)	Recupera un elenco di origini dati esistenti nel servizio.
listDataSourceConnectionsNames(OperationOptions)	Recupera un elenco di nomi di origini dati esistenti nel servizio.
listIndexers(OperationOptions)	Recupera un elenco di indicizzatori esistenti nel servizio.
listIndexersNames(OperationOptions)	Recupera un elenco di nomi di indicizzatori esistenti nel servizio.
listSkillsets(OperationOptions)	Recupera un elenco dei set di competenze esistenti nel servizio.
listSkillsetsNames(OperationOptions)	Recupera un elenco di nomi dei set di competenze esistenti nel servizio.
resetIndexer(string, OperationOptions)	Reimposta lo stato di rilevamento delle modifiche associato a un indicizzatore.
runIndexer(string, OperationOptions)	Esegue un indicizzatore su richiesta.

Dettagli costruttore

SearchIndexerClient(string, KeyCredential | TokenCredential, SearchIndexerClientOptions)

Crea un'istanza di SearchIndexerClient.

Esempio di utilizzo:

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

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

new SearchIndexerClient(endpoint: string, credential: KeyCredential | TokenCredential, options?: SearchIndexerClientOptions)

Parametri

endpoint

string

Endpoint del servizio di ricerca

credential

KeyCredential | TokenCredential

Usato per autenticare le richieste al servizio.

options

SearchIndexerClientOptions

Usato per configurare il client di ricerca.

Dettagli proprietà

apiVersion

Avviso

Questa API è ora deprecata.

use {@Link serviceVersion} instead

Versione dell'API da usare quando si comunica 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 quando si comunica con il servizio.

serviceVersion: string

Valore della proprietà

string

Dettagli metodo

createDataSourceConnection(SearchIndexerDataSourceConnection, OperationOptions)

Crea una nuova origine dati in un servizio di ricerca.

function createDataSourceConnection(dataSourceConnection: SearchIndexerDataSourceConnection, options?: OperationOptions): Promise<SearchIndexerDataSourceConnection>

Parametri

dataSourceConnection

SearchIndexerDataSourceConnection

Definizione dataSource da creare in un servizio di ricerca.

options

OperationOptions

Argomenti facoltativi aggiuntivi.

Restituisce

Promise<SearchIndexerDataSourceConnection>

createIndexer(SearchIndexer, OperationOptions)

Crea un nuovo indicizzatore in un servizio di ricerca.

function createIndexer(indexer: SearchIndexer, options?: OperationOptions): Promise<SearchIndexer>

Parametri

indexer

SearchIndexer

Definizione dell'indicizzatore da creare in un servizio di ricerca.

options

OperationOptions

Argomenti facoltativi aggiuntivi.

Restituisce

Promise<SearchIndexer>

createOrUpdateDataSourceConnection(SearchIndexerDataSourceConnection, CreateorUpdateDataSourceConnectionOptions)

Crea una nuova origine dati o ne modifica una esistente.

function createOrUpdateDataSourceConnection(dataSourceConnection: SearchIndexerDataSourceConnection, options?: CreateorUpdateDataSourceConnectionOptions): Promise<SearchIndexerDataSourceConnection>

Parametri

dataSourceConnection

SearchIndexerDataSourceConnection

Informazioni che descrivono l'origine dati da creare/aggiornare.

options

CreateorUpdateDataSourceConnectionOptions

Argomenti facoltativi aggiuntivi.

Restituisce

Promise<SearchIndexerDataSourceConnection>

createOrUpdateIndexer(SearchIndexer, CreateorUpdateIndexerOptions)

Crea un nuovo indicizzatore o ne modifica uno esistente.

function createOrUpdateIndexer(indexer: SearchIndexer, options?: CreateorUpdateIndexerOptions): Promise<SearchIndexer>

Parametri

indexer

SearchIndexer

Informazioni che descrivono l'indicizzatore da creare/aggiornare.

options

CreateorUpdateIndexerOptions

Argomenti facoltativi aggiuntivi.

Restituisce

Promise<SearchIndexer>

createOrUpdateSkillset(SearchIndexerSkillset, CreateOrUpdateSkillsetOptions)

Crea un nuovo set di competenze o ne modifica uno esistente.

function createOrUpdateSkillset(skillset: SearchIndexerSkillset, options?: CreateOrUpdateSkillsetOptions): Promise<SearchIndexerSkillset>

Parametri

skillset

SearchIndexerSkillset

Informazioni che descrivono l'indice da creare.

options

CreateOrUpdateSkillsetOptions

Argomenti facoltativi aggiuntivi.

Restituisce

Promise<SearchIndexerSkillset>

createSkillset(SearchIndexerSkillset, OperationOptions)

Crea un nuovo set di competenze in un servizio di ricerca.

function createSkillset(skillset: SearchIndexerSkillset, options?: OperationOptions): Promise<SearchIndexerSkillset>

Parametri

skillset

SearchIndexerSkillset

Set di competenze contenente una o più competenze da creare in un servizio di ricerca.

options

OperationOptions

Argomenti facoltativi aggiuntivi.

Restituisce

Promise<SearchIndexerSkillset>

deleteDataSourceConnection(string | SearchIndexerDataSourceConnection, DeleteDataSourceConnectionOptions)

Elimina un'origine dati esistente.

function deleteDataSourceConnection(dataSourceConnection: string | SearchIndexerDataSourceConnection, options?: DeleteDataSourceConnectionOptions): Promise<void>

Parametri

dataSourceConnection

string | SearchIndexerDataSourceConnection

options

DeleteDataSourceConnectionOptions

Argomenti facoltativi aggiuntivi.

Restituisce

Promise<void>

deleteIndexer(string | SearchIndexer, DeleteIndexerOptions)

Elimina un indicizzatore esistente.

function deleteIndexer(indexer: string | SearchIndexer, options?: DeleteIndexerOptions): Promise<void>

Parametri

indexer

string | SearchIndexer

Indicizzatore/Nome dell'indicizzatore da eliminare.

options

DeleteIndexerOptions

Argomenti facoltativi aggiuntivi.

Restituisce

Promise<void>

deleteSkillset(string | SearchIndexerSkillset, DeleteSkillsetOptions)

Elimina un set di competenze esistente.

function deleteSkillset(skillset: string | SearchIndexerSkillset, options?: DeleteSkillsetOptions): Promise<void>

Parametri

skillset

string | SearchIndexerSkillset

Set di competenze/Nome del set di competenze da eliminare.

options

DeleteSkillsetOptions

Argomenti facoltativi aggiuntivi.

Restituisce

Promise<void>

getDataSourceConnection(string, OperationOptions)

Recupera informazioni su un'origine dati

function getDataSourceConnection(dataSourceConnectionName: string, options?: OperationOptions): Promise<SearchIndexerDataSourceConnection>

Parametri

dataSourceConnectionName

string

options

OperationOptions

Argomenti facoltativi aggiuntivi

Restituisce

Promise<SearchIndexerDataSourceConnection>

getIndexer(string, OperationOptions)

Recupera informazioni su un indicizzatore.

function getIndexer(indexerName: string, options?: OperationOptions): Promise<SearchIndexer>

Parametri

indexerName

string

Nome dell'indicizzatore.

options

OperationOptions

Argomenti facoltativi aggiuntivi.

Restituisce

Promise<SearchIndexer>

getIndexerStatus(string, OperationOptions)

Restituisce lo stato corrente e la cronologia di esecuzione di un indicizzatore.

function getIndexerStatus(indexerName: string, options?: OperationOptions): Promise<SearchIndexerStatus>

Parametri

indexerName

string

Nome dell'indicizzatore.

options

OperationOptions

Argomenti facoltativi aggiuntivi.

Restituisce

Promise<SearchIndexerStatus>

getSkillset(string, OperationOptions)

Recupera informazioni su un set di competenze.

function getSkillset(skillsetName: string, options?: OperationOptions): Promise<SearchIndexerSkillset>

Parametri

skillsetName

string

options

OperationOptions

Argomenti facoltativi aggiuntivi.

Restituisce

Promise<SearchIndexerSkillset>

listDataSourceConnections(OperationOptions)

Recupera un elenco di origini dati esistenti nel servizio.

function listDataSourceConnections(options?: OperationOptions): Promise<SearchIndexerDataSourceConnection[]>

Parametri

options

OperationOptions

Opzioni per l'operazione degli indicizzatori di elenco.

Restituisce

Promise<SearchIndexerDataSourceConnection[]>

listDataSourceConnectionsNames(OperationOptions)

Recupera un elenco di nomi di origini dati esistenti nel servizio.

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

Parametri

options

OperationOptions

Opzioni per l'operazione degli indicizzatori di elenco.

Restituisce

Promise<string[]>

listIndexers(OperationOptions)

Recupera un elenco di indicizzatori esistenti nel servizio.

function listIndexers(options?: OperationOptions): Promise<SearchIndexer[]>

Parametri

options

OperationOptions

Opzioni per l'operazione degli indicizzatori di elenco.

Restituisce

Promise<SearchIndexer[]>

listIndexersNames(OperationOptions)

Recupera un elenco di nomi di indicizzatori esistenti nel servizio.

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

Parametri

options

OperationOptions

Opzioni per l'operazione degli indicizzatori di elenco.

Restituisce

Promise<string[]>

listSkillsets(OperationOptions)

Recupera un elenco dei set di competenze esistenti nel servizio.

function listSkillsets(options?: OperationOptions): Promise<SearchIndexerSkillset[]>

Parametri

options

OperationOptions

Opzioni per l'operazione del set di competenze elenco.

Restituisce

Promise<SearchIndexerSkillset[]>

listSkillsetsNames(OperationOptions)

Recupera un elenco di nomi dei set di competenze esistenti nel servizio.

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

Parametri

options

OperationOptions

Opzioni per l'operazione del set di competenze elenco.

Restituisce

Promise<string[]>

resetIndexer(string, OperationOptions)

Reimposta lo stato di rilevamento delle modifiche associato a un indicizzatore.

function resetIndexer(indexerName: string, options?: OperationOptions): Promise<void>

Parametri

indexerName

string

Nome dell'indicizzatore da reimpostare.

options

OperationOptions

Argomenti facoltativi aggiuntivi.

Restituisce

Promise<void>

runIndexer(string, OperationOptions)

Esegue un indicizzatore su richiesta.

function runIndexer(indexerName: string, options?: OperationOptions): Promise<void>

Parametri

indexerName

string

Nome dell'indicizzatore da eseguire.

options

OperationOptions

Argomenti facoltativi aggiuntivi.

Restituisce

Promise<void>