Condividi tramite

SearchClient class

  • Riferimento
Pacchetto:
@azure/search-documents

Classe usata per eseguire operazioni su un indice di ricerca, inclusa l'esecuzione di query sui documenti nell'indice, nonché l'aggiunta, l'aggiornamento e la rimozione.

Costruttori

SearchClient<TModel>(string, string, KeyCredential | TokenCredential, SearchClientOptions)

Crea un'istanza di SearchClient.

Esempio di utilizzo:

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

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

Facoltativamente, il tipo del modello può essere usato per abilitare hint di tipi e tipi sicuri:

type TModel = {
  keyName: string;
  field1?: string | null;
  field2?: { anotherField?: string | null } | null;
};

const client = new SearchClient<TModel>(
  ...
);

Proprietà

apiVersion

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

Endpoint del servizio di ricerca
indexName

Nome dell'indice
serviceVersion

Versione del servizio da usare durante la comunicazione con il servizio.

Metodi

autocomplete(string, string, AutocompleteOptions<TModel>)

In base a un oggetto searchText parziale dell'utente, restituisce un elenco di possibili stringhe di completamento in base a un suggerimento specificato.

Esempio

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

type TModel = {
  key: string;
  azure?: { sdk: string | null } | null;
};

const client = new SearchClient<TModel>(
  "endpoint.azure",
  "indexName",
  new AzureKeyCredential("key")
);

const searchFields: SearchFieldArray<TModel> = ["azure/sdk"];

const autocompleteResult = await client.autocomplete(
  "searchText",
  "suggesterName",
  { searchFields }
);
deleteDocuments(keyof TModel, string[], IndexDocumentsOptions)

Eliminare un set di documenti.
deleteDocuments(TModel[], IndexDocumentsOptions)

Eliminare un set di documenti.
getDocument<TFields>(string, GetDocumentOptions<TModel, TFields>)

Recuperare un documento specifico dall'indice in base alla chiave.
getDocumentsCount(OperationOptions)

Recupera il numero di documenti nell'indice.
indexDocuments(IndexDocumentsBatch<TModel>, IndexDocumentsOptions)

Eseguire un set di modifiche all'indice (caricamento, merge, mergeOrUpload, eliminazione) per il set di documenti specificato. Questa operazione può avere esito positivo e non tutte le operazioni sui documenti verranno riflesse nell'indice. Se si vuole considerare questa opzione come un'eccezione, impostare l'opzione throwOnAnyFailure su true. Per altre informazioni sul funzionamento dell'unione, vedere: https://docs.microsoft.com/en-us/rest/api/searchservice/AddUpdate-or-Delete-Documents
mergeDocuments(TModel[], IndexDocumentsOptions)

Aggiornare un set di documenti nell'indice. Per altre informazioni sul funzionamento dell'unione, vedere https://docs.microsoft.com/en-us/rest/api/searchservice/AddUpdate-or-Delete-Documents
mergeOrUploadDocuments(TModel[], IndexDocumentsOptions)

Aggiornare un set di documenti nell'indice o caricarli se non esistono. Per altre informazioni sul funzionamento dell'unione, vedere https://docs.microsoft.com/en-us/rest/api/searchservice/AddUpdate-or-Delete-Documents
search<TFields>(string, SearchOptions<TModel, TFields>)

Esegue una ricerca sull'indice corrente in base agli argomenti specificati.

Esempio

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

type TModel = {
  key: string;
  azure?: { sdk: string | null } | null;
};

const client = new SearchClient<TModel>(
  "endpoint.azure",
  "indexName",
  new AzureKeyCredential("key")
);

const select = ["azure/sdk"] as const;
const searchFields: SearchFieldArray<TModel> = ["azure/sdk"];

const searchResult = await client.search("searchText", {
  select,
  searchFields,
});
suggest<TFields>(string, string, SuggestOptions<TModel, TFields>)

Restituisce un breve elenco di suggerimenti in base al metodo searchText e al suggerimento specificato.

Esempio

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

type TModel = {
  key: string;
  azure?: { sdk: string | null } | null;
};

const client = new SearchClient<TModel>(
  "endpoint.azure",
  "indexName",
  new AzureKeyCredential("key")
);

const select = ["azure/sdk"] as const;
const searchFields: SearchFieldArray<TModel> = ["azure/sdk"];

const suggestResult = await client.suggest("searchText", "suggesterName", {
  select,
  searchFields,
});
uploadDocuments(TModel[], IndexDocumentsOptions)

Caricare una matrice di documenti nell'indice.

Dettagli costruttore

SearchClient<TModel>(string, string, KeyCredential | TokenCredential, SearchClientOptions)

Crea un'istanza di SearchClient.

Esempio di utilizzo:

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

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

Facoltativamente, il tipo del modello può essere usato per abilitare hint di tipi e tipi sicuri:

type TModel = {
  keyName: string;
  field1?: string | null;
  field2?: { anotherField?: string | null } | null;
};

const client = new SearchClient<TModel>(
  ...
);

new SearchClient(endpoint: string, indexName: string, credential: KeyCredential | TokenCredential, options?: SearchClientOptions)

Parametri

endpoint

string

Endpoint del servizio di ricerca

indexName

string

Nome dell'indice

credential

KeyCredential | TokenCredential

Usato per autenticare le richieste al servizio.

options
SearchClientOptions

Usato per configurare il client 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

indexName

Nome dell'indice

indexName: string

Valore della proprietà

string

serviceVersion

Versione del servizio da usare durante la comunicazione con il servizio.

serviceVersion: string

Valore della proprietà

string

Dettagli metodo

autocomplete(string, string, AutocompleteOptions<TModel>)

In base a un oggetto searchText parziale dell'utente, restituisce un elenco di possibili stringhe di completamento in base a un suggerimento specificato.

Esempio

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

type TModel = {
  key: string;
  azure?: { sdk: string | null } | null;
};

const client = new SearchClient<TModel>(
  "endpoint.azure",
  "indexName",
  new AzureKeyCredential("key")
);

const searchFields: SearchFieldArray<TModel> = ["azure/sdk"];

const autocompleteResult = await client.autocomplete(
  "searchText",
  "suggesterName",
  { searchFields }
);

function autocomplete(searchText: string, suggesterName: string, options?: AutocompleteOptions<TModel>): Promise<AutocompleteResult>

Parametri

searchText

string

Testo di ricerca in cui basare il completamento automatico dei risultati.

suggesterName

string

Nome del suggerimento specificato nell'insieme dei suggerimenti che fa parte della definizione dell'indice.

options

AutocompleteOptions<TModel>

Opzioni per l'operazione di completamento automatico.

Restituisce

Promise<AutocompleteResult>

deleteDocuments(keyof TModel, string[], IndexDocumentsOptions)

Eliminare un set di documenti.

function deleteDocuments(keyName: keyof TModel, keyValues: string[], options?: IndexDocumentsOptions): Promise<IndexDocumentsResult>

Parametri

keyName

keyof TModel

Nome della chiave primaria nell'indice.

keyValues

string[]

Valori di chiave primaria dei documenti da eliminare.

options
IndexDocumentsOptions

Opzioni aggiuntive.

Restituisce

Promise<IndexDocumentsResult>

deleteDocuments(TModel[], IndexDocumentsOptions)

Eliminare un set di documenti.

function deleteDocuments(documents: TModel[], options?: IndexDocumentsOptions): Promise<IndexDocumentsResult>

Parametri

documents

TModel[]

Documenti da eliminare.

options
IndexDocumentsOptions

Opzioni aggiuntive.

Restituisce

Promise<IndexDocumentsResult>

getDocument<TFields>(string, GetDocumentOptions<TModel, TFields>)

Recuperare un documento specifico dall'indice in base alla chiave.

function getDocument<TFields>(key: string, options?: GetDocumentOptions<TModel, TFields>): Promise<NarrowedModel<TModel, TFields>>

Parametri

key

string

Valore della chiave primaria del documento

options

GetDocumentOptions<TModel, TFields>

Opzioni aggiuntive

Restituisce

Promise<NarrowedModel<TModel, TFields>>

getDocumentsCount(OperationOptions)

Recupera il numero di documenti nell'indice.

function getDocumentsCount(options?: OperationOptions): Promise<number>

Parametri

options
OperationOptions

Opzioni per l'operazione di conteggio.

Restituisce

Promise<number>

indexDocuments(IndexDocumentsBatch<TModel>, IndexDocumentsOptions)

Eseguire un set di modifiche all'indice (caricamento, merge, mergeOrUpload, eliminazione) per il set di documenti specificato. Questa operazione può avere esito positivo e non tutte le operazioni sui documenti verranno riflesse nell'indice. Se si vuole considerare questa opzione come un'eccezione, impostare l'opzione throwOnAnyFailure su true. Per altre informazioni sul funzionamento dell'unione, vedere: https://docs.microsoft.com/en-us/rest/api/searchservice/AddUpdate-or-Delete-Documents

function indexDocuments(batch: IndexDocumentsBatch<TModel>, options?: IndexDocumentsOptions): Promise<IndexDocumentsResult>

Parametri

batch

IndexDocumentsBatch<TModel>

Matrice di azioni da eseguire sull'indice.

options
IndexDocumentsOptions

Opzioni aggiuntive.

Restituisce

Promise<IndexDocumentsResult>

mergeDocuments(TModel[], IndexDocumentsOptions)

Aggiornare un set di documenti nell'indice. Per altre informazioni sul funzionamento dell'unione, vedere https://docs.microsoft.com/en-us/rest/api/searchservice/AddUpdate-or-Delete-Documents

function mergeDocuments(documents: TModel[], options?: IndexDocumentsOptions): Promise<IndexDocumentsResult>

Parametri

documents

TModel[]

Documenti aggiornati.

options
IndexDocumentsOptions

Opzioni aggiuntive.

Restituisce

Promise<IndexDocumentsResult>

mergeOrUploadDocuments(TModel[], IndexDocumentsOptions)

Aggiornare un set di documenti nell'indice o caricarli se non esistono. Per altre informazioni sul funzionamento dell'unione, vedere https://docs.microsoft.com/en-us/rest/api/searchservice/AddUpdate-or-Delete-Documents

function mergeOrUploadDocuments(documents: TModel[], options?: IndexDocumentsOptions): Promise<IndexDocumentsResult>

Parametri

documents

TModel[]

Documenti aggiornati.

options
IndexDocumentsOptions

Opzioni aggiuntive.

Restituisce

Promise<IndexDocumentsResult>

Esegue una ricerca sull'indice corrente in base agli argomenti specificati.

Esempio

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

type TModel = {
  key: string;
  azure?: { sdk: string | null } | null;
};

const client = new SearchClient<TModel>(
  "endpoint.azure",
  "indexName",
  new AzureKeyCredential("key")
);

const select = ["azure/sdk"] as const;
const searchFields: SearchFieldArray<TModel> = ["azure/sdk"];

const searchResult = await client.search("searchText", {
  select,
  searchFields,
});

function search<TFields>(searchText?: string, options?: SearchOptions<TModel, TFields>): Promise<SearchDocumentsResult<TModel, TFields>>

Parametri

searchText

string

Testo da cercare

options

SearchOptions<TModel, TFields>

Opzioni per l'operazione di ricerca.

Restituisce

Promise<SearchDocumentsResult<TModel, TFields>>

suggest<TFields>(string, string, SuggestOptions<TModel, TFields>)

Restituisce un breve elenco di suggerimenti in base al metodo searchText e al suggerimento specificato.

Esempio

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

type TModel = {
  key: string;
  azure?: { sdk: string | null } | null;
};

const client = new SearchClient<TModel>(
  "endpoint.azure",
  "indexName",
  new AzureKeyCredential("key")
);

const select = ["azure/sdk"] as const;
const searchFields: SearchFieldArray<TModel> = ["azure/sdk"];

const suggestResult = await client.suggest("searchText", "suggesterName", {
  select,
  searchFields,
});

function suggest<TFields>(searchText: string, suggesterName: string, options?: SuggestOptions<TModel, TFields>): Promise<SuggestDocumentsResult<TModel, TFields>>

Parametri

searchText

string

Testo di ricerca da utilizzare per suggerire documenti. Deve essere composto da un minimo di 1 carattere e da un massimo di 100 caratteri.

suggesterName

string

Nome del suggerimento specificato nell'insieme dei suggerimenti che fa parte della definizione dell'indice.

options

SuggestOptions<TModel, TFields>

Opzioni per l'operazione di suggerimento

Restituisce

Promise<SuggestDocumentsResult<TModel, TFields>>

uploadDocuments(TModel[], IndexDocumentsOptions)

Caricare una matrice di documenti nell'indice.

function uploadDocuments(documents: TModel[], options?: IndexDocumentsOptions): Promise<IndexDocumentsResult>

Parametri

documents

TModel[]

Documenti da caricare.

options
IndexDocumentsOptions

Opzioni aggiuntive.

Restituisce

Promise<IndexDocumentsResult>