SearchClient class

Paquet:

@azure/search-documents

Classe utilisée pour effectuer des opérations sur un index de recherche, y compris l’interrogation de documents dans l’index, ainsi que l’ajout, la mise à jour et la suppression de ceux-ci.

Constructeurs

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

Crée un instance de SearchClient. Exemple d’utilisation : const { SearchClient, AzureKeyCredential } = require("@azure/search-documents"); const client = new SearchClient( "<endpoint>", "<indexName>", new AzureKeyCredential("<Admin Key>") ); Si vous le souhaitez, le type du modèle peut être utilisé pour activer des indicateurs de frappe et de type forts : type TModel = { keyName: string; field1?: string | null; field2?: { anotherField?: string | null } | null; }; const client = new SearchClient<TModel>( ... );

Propriétés

apiVersion	Version de l’API à utiliser lors de la communication avec le service.
endpoint	Point de terminaison du service de recherche
indexName	Nom de l’index
serviceVersion	Version du service à utiliser lors de la communication avec le service.

Méthodes

autocomplete(string, string, AutocompleteOptions<TModel>)	En fonction d’une recherche partielle de l’utilisateur, retourne une liste de chaînes d’achèvement potentielles basées sur un suggesteur spécifié. Exemple 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)	Supprimer un ensemble de documents.
deleteDocuments(TModel[], IndexDocumentsOptions)	Supprimer un ensemble de documents.
getDocument<TFields>(string, GetDocumentOptions<TModel, TFields>)	Récupérer un document particulier à partir de l’index par clé.
getDocumentsCount(OperationOptions)	Récupère le nombre de documents dans l’index.
indexDocuments(IndexDocumentsBatch<TModel>, IndexDocumentsOptions)	Effectuez un ensemble de modifications d’index (upload, merge, mergeOrUpload, delete) pour l’ensemble de documents donné. Cette opération peut partiellement réussir et toutes les opérations de document ne sont pas répercutées dans l’index. Si vous souhaitez traiter cela comme une exception, définissez l’option sur throwOnAnyFailure true. Pour plus d’informations sur le fonctionnement de la fusion, consultez : https://docs.microsoft.com/en-us/rest/api/searchservice/AddUpdate-or-Delete-Documents
mergeDocuments(TModel[], IndexDocumentsOptions)	Mettez à jour un ensemble de documents dans l’index. Pour plus d’informations sur le fonctionnement de la fusion, consultez https://docs.microsoft.com/en-us/rest/api/searchservice/AddUpdate-or-Delete-Documents
mergeOrUploadDocuments(TModel[], IndexDocumentsOptions)	Mettez à jour un ensemble de documents dans l’index ou chargez-les s’ils n’existent pas. Pour plus d’informations sur le fonctionnement de la fusion, consultez https://docs.microsoft.com/en-us/rest/api/searchservice/AddUpdate-or-Delete-Documents
search<TFields>(string, SearchOptions<TModel, TFields>)	Effectue une recherche sur l’index actuel en fonction des arguments spécifiés. Exemple 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>)	Retourne une courte liste de suggestions basée sur searchText et le suggesteur spécifié. Exemple 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)	Chargez un tableau de documents dans l’index.

Détails du constructeur

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

Crée un instance de SearchClient.

Exemple d’utilisation :

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

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

Si vous le souhaitez, le type du modèle peut être utilisé pour activer des indicateurs de frappe et de type forts :

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)

Paramètres

endpoint

string

Point de terminaison du service de recherche

indexName

string

Nom de l’index

credential

KeyCredential | TokenCredential

Utilisé pour authentifier les demandes adressées au service.

options

SearchClientOptions

Utilisé pour configurer le client de recherche.

Détails de la propriété

apiVersion

Avertissement

Cette API est à présent déconseillée.

use {@Link serviceVersion} instead

Version de l’API à utiliser lors de la communication avec le service.

apiVersion: string

Valeur de propriété

string

endpoint

Point de terminaison du service de recherche

endpoint: string

Valeur de propriété

string

indexName

Nom de l’index

indexName: string

Valeur de propriété

string

serviceVersion

Version du service à utiliser lors de la communication avec le service.

serviceVersion: string

Valeur de propriété

string

Détails de la méthode

autocomplete(string, string, AutocompleteOptions<TModel>)

En fonction d’une recherche partielle de l’utilisateur, retourne une liste de chaînes d’achèvement potentielles basées sur un suggesteur spécifié.

Exemple

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>

Paramètres

searchText

string

Texte de recherche sur lequel baser les résultats de l’autocomplétion.

suggesterName

string

Nom du suggesteur tel que spécifié dans la collection de suggesteurs qui fait partie de la définition d’index.

options

AutocompleteOptions<TModel>

Options de l’opération de saisie semi-automatique.

Retours

Promise<AutocompleteResult>

deleteDocuments(keyof TModel, string[], IndexDocumentsOptions)

Supprimer un ensemble de documents.

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

Paramètres

keyName

keyof TModel

Nom de leur clé primaire dans l’index.

keyValues

string[]

Valeurs de clé primaire des documents à supprimer.

options

IndexDocumentsOptions

Options supplémentaires.

Retours

Promise<IndexDocumentsResult>

deleteDocuments(TModel[], IndexDocumentsOptions)

Supprimer un ensemble de documents.

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

Paramètres

documents

TModel[]

Documents à supprimer.

options

IndexDocumentsOptions

Options supplémentaires.

Retours

Promise<IndexDocumentsResult>

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

Récupérer un document particulier à partir de l’index par clé.

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

Paramètres

key

string

Valeur de clé primaire du document

options

GetDocumentOptions<TModel, TFields>

Options supplémentaires

Retours

Promise<NarrowedModel<TModel, TFields>>

getDocumentsCount(OperationOptions)

Récupère le nombre de documents dans l’index.

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

Paramètres

options

OperationOptions

Options de l’opération de comptage.

Retours

Promise<number>

indexDocuments(IndexDocumentsBatch<TModel>, IndexDocumentsOptions)

Effectuez un ensemble de modifications d’index (upload, merge, mergeOrUpload, delete) pour l’ensemble de documents donné. Cette opération peut partiellement réussir et toutes les opérations de document ne sont pas répercutées dans l’index. Si vous souhaitez traiter cela comme une exception, définissez l’option sur throwOnAnyFailure true. Pour plus d’informations sur le fonctionnement de la fusion, consultez : https://docs.microsoft.com/en-us/rest/api/searchservice/AddUpdate-or-Delete-Documents

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

Paramètres

batch

IndexDocumentsBatch<TModel>

Tableau d’actions à effectuer sur l’index.

options

IndexDocumentsOptions

Options supplémentaires.

Retours

Promise<IndexDocumentsResult>

mergeDocuments(TModel[], IndexDocumentsOptions)

Mettez à jour un ensemble de documents dans l’index. Pour plus d’informations sur le fonctionnement de la fusion, consultez https://docs.microsoft.com/en-us/rest/api/searchservice/AddUpdate-or-Delete-Documents

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

Paramètres

documents

TModel[]

Documents mis à jour.

options

IndexDocumentsOptions

Options supplémentaires.

Retours

Promise<IndexDocumentsResult>

mergeOrUploadDocuments(TModel[], IndexDocumentsOptions)

Mettez à jour un ensemble de documents dans l’index ou chargez-les s’ils n’existent pas. Pour plus d’informations sur le fonctionnement de la fusion, consultez https://docs.microsoft.com/en-us/rest/api/searchservice/AddUpdate-or-Delete-Documents

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

Paramètres

documents

TModel[]

Documents mis à jour.

options

IndexDocumentsOptions

Options supplémentaires.

Retours

Promise<IndexDocumentsResult>

search<TFields>(string, SearchOptions<TModel, TFields>)

Effectue une recherche sur l’index actuel en fonction des arguments spécifiés.

Exemple

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

Paramètres

searchText

string

Texte à rechercher

options

SearchOptions<TModel, TFields>

Options de l’opération de recherche.

Retours

Promise<SearchDocumentsResult<TModel, TFields>>

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

Retourne une courte liste de suggestions basée sur searchText et le suggesteur spécifié.

Exemple

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

Paramètres

searchText

string

Texte de recherche à utiliser pour suggérer des documents. Doit comprendre 1 caractère au minimum et 100 caractères au maximum.

suggesterName

string

Nom du suggesteur tel que spécifié dans la collection suggesteurs qui fait partie de la définition d’index.

options

SuggestOptions<TModel, TFields>

Options pour l’opération de suggestion

Retours

Promise<SuggestDocumentsResult<TModel, TFields>>

uploadDocuments(TModel[], IndexDocumentsOptions)

Chargez un tableau de documents dans l’index.

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

Paramètres

documents

TModel[]

Documents à charger.

options

IndexDocumentsOptions

Options supplémentaires.

Retours

Promise<IndexDocumentsResult>