SearchClient class

Hiermee maakt u een exemplaar van SearchClient.

Voorbeeldgebruik:

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

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

Optioneel kan het type van het model worden gebruikt om sterke typen en typehints mogelijk te maken:

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)

Parameters

De API-versie die moet worden gebruikt bij het communiceren met de service.

apiVersion: string

Waarde van eigenschap

Het eindpunt van de zoekservice

endpoint: string

Waarde van eigenschap

De naam van de index

indexName: string

Waarde van eigenschap

De serviceversie die moet worden gebruikt bij het communiceren met de service.

serviceVersion: string

Waarde van eigenschap

Op basis van een gedeeltelijke zoektekst van de gebruiker retourneert u een lijst met mogelijke voltooiingstekenreeksen op basis van een opgegeven suggestie.

voorbeeld van

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>

Parameters

Retouren

Een set documenten verwijderen.

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

Parameters

Retouren

Een set documenten verwijderen.

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

Parameters

Retouren

Haal een bepaald document op uit de index op sleutel.

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

Parameters

Retouren

Hiermee haalt u het aantal documenten in de index op.

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

Parameters

Retouren

Voer een set indexwijzigingen (uploaden, samenvoegen, mergeOrUpload, delete) uit voor de opgegeven set documenten. Deze bewerking kan gedeeltelijk slagen en niet alle documentbewerkingen worden weergegeven in de index. Als u dit wilt behandelen als een uitzondering, stelt u de optie throwOnAnyFailure in op waar. Zie voor meer informatie over hoe samenvoegen werkt: https://docs.microsoft.com/en-us/rest/api/searchservice/AddUpdate-or-Delete-Documents

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

Parameters

Retouren

Werk een set documenten in de index bij. Zie https://docs.microsoft.com/en-us/rest/api/searchservice/AddUpdate-or-Delete-Documents voor meer informatie over hoe samenvoegen werkt

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

Parameters

Retouren

Werk een set documenten in de index bij of upload ze als ze niet bestaan. Zie https://docs.microsoft.com/en-us/rest/api/searchservice/AddUpdate-or-Delete-Documents voor meer informatie over hoe samenvoegen werkt

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

Parameters

Retouren

Voert een zoekopdracht uit op de huidige index op basis van de opgegeven argumenten.

voorbeeld van

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

Parameters

Retouren

Retourneert een korte lijst met suggesties op basis van de zoektekst en de opgegeven suggestie.

voorbeeld van

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

Parameters

Retouren

Upload een matrix met documenten naar de index.

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

Parameters

Retouren