SearchClient class

  • Referentie
Pakket:
@azure/search-documents

Klasse die wordt gebruikt voor het uitvoeren van bewerkingen op een zoekindex, waaronder het uitvoeren van query's op documenten in de index en het toevoegen, bijwerken en verwijderen ervan.

Constructors

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

Hiermee maakt u een exemplaar van SearchClient.

Gebruiksvoorbeeld:

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>(
  ...
);

Eigenschappen

apiVersion

De API-versie die moet worden gebruikt bij de communicatie met de service.
endpoint

Het eindpunt van de zoekservice
indexName

De naam van de index
serviceVersion

De serviceversie die moet worden gebruikt bij de communicatie met de service.

Methoden

autocomplete(string, string, AutocompleteOptions<TModel>)

Retourneert op basis van een gedeeltelijke zoektekst van de gebruiker een lijst met mogelijke voltooiingsreeksen op basis van een opgegeven suggestie.

Voorbeeld

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)

Een set documenten verwijderen.
deleteDocuments(TModel[], IndexDocumentsOptions)

Een set documenten verwijderen.
getDocument<TFields>(string, GetDocumentOptions<TModel, TFields>)

Een bepaald document ophalen uit de index per sleutel.
getDocumentsCount(OperationOptions)

Hiermee haalt u het aantal documenten in de index op.
indexDocuments(IndexDocumentsBatch<TModel>, IndexDocumentsOptions)

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

Een set documenten in de index bijwerken. Zie voor meer informatie over hoe samenvoegen werkt https://docs.microsoft.com/en-us/rest/api/searchservice/AddUpdate-or-Delete-Documents
mergeOrUploadDocuments(TModel[], IndexDocumentsOptions)

Werk een set documenten in de index bij of upload deze als ze niet bestaan. Zie voor meer informatie over hoe samenvoegen werkt https://docs.microsoft.com/en-us/rest/api/searchservice/AddUpdate-or-Delete-Documents
search<TFields>(string, SearchOptions<TModel, TFields>)

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

Voorbeeld

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

Retourneert een korte lijst met suggesties op basis van de searchText en de opgegeven suggester.

Voorbeeld

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)

Upload een matrix met documenten naar de index.

Constructordetails

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

Hiermee maakt u een exemplaar van SearchClient.

Gebruiksvoorbeeld:

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

endpoint

string

Het eindpunt van de zoekservice

indexName

string

De naam van de index

credential

KeyCredential | TokenCredential

Wordt gebruikt om aanvragen voor de service te verifiëren.

options
SearchClientOptions

Wordt gebruikt om de Search-client te configureren.

Eigenschapdetails

apiVersion

Waarschuwing

Deze API is nu afgeschaft.

use {@Link serviceVersion} instead

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

apiVersion: string

Waarde van eigenschap

string

endpoint

Het eindpunt van de zoekservice

endpoint: string

Waarde van eigenschap

string

indexName

De naam van de index

indexName: string

Waarde van eigenschap

string

serviceVersion

De serviceversie die moet worden gebruikt bij de communicatie met de service.

serviceVersion: string

Waarde van eigenschap

string

Methodedetails

autocomplete(string, string, AutocompleteOptions<TModel>)

Retourneert op basis van een gedeeltelijke zoektekst van de gebruiker een lijst met mogelijke voltooiingsreeksen op basis van een opgegeven suggestie.

Voorbeeld

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

searchText

string

De zoektekst waarop de resultaten voor automatisch aanvullen moeten worden gebaseerd.

suggesterName

string

De naam van de suggestiefunctie zoals opgegeven in de verzameling suggesters die deel uitmaakt van de indexdefinitie.

options

AutocompleteOptions<TModel>

Opties voor de bewerking automatisch aanvullen.

Retouren

Promise<AutocompleteResult>

deleteDocuments(keyof TModel, string[], IndexDocumentsOptions)

Een set documenten verwijderen.

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

Parameters

keyName

keyof TModel

De naam van de primaire sleutel in de index.

keyValues

string[]

De primaire sleutelwaarden van documenten die moeten worden verwijderd.

options
IndexDocumentsOptions

Aanvullende opties.

Retouren

Promise<IndexDocumentsResult>

deleteDocuments(TModel[], IndexDocumentsOptions)

Een set documenten verwijderen.

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

Parameters

documents

TModel[]

Documenten die moeten worden verwijderd.

options
IndexDocumentsOptions

Aanvullende opties.

Retouren

Promise<IndexDocumentsResult>

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

Een bepaald document ophalen uit de index per sleutel.

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

Parameters

key

string

De primaire sleutelwaarde van het document

options

GetDocumentOptions<TModel, TFields>

Extra opties

Retouren

Promise<NarrowedModel<TModel, TFields>>

getDocumentsCount(OperationOptions)

Hiermee haalt u het aantal documenten in de index op.

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

Parameters

options
OperationOptions

Opties voor de telbewerking.

Retouren

Promise<number>

indexDocuments(IndexDocumentsBatch<TModel>, IndexDocumentsOptions)

Voer een set indexwijzigingen (upload, merge, mergeOrUpload, delete) uit voor de opgegeven set documenten. Deze bewerking kan gedeeltelijk lukken en niet alle documentbewerkingen worden weergegeven in de index. Als u dit als een uitzondering wilt behandelen, stelt u de throwOnAnyFailure optie in op true. 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

batch

IndexDocumentsBatch<TModel>

Een matrix met acties die moeten worden uitgevoerd op de index.

options
IndexDocumentsOptions

Aanvullende opties.

Retouren

Promise<IndexDocumentsResult>

mergeDocuments(TModel[], IndexDocumentsOptions)

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

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

Parameters

documents

TModel[]

De bijgewerkte documenten.

options
IndexDocumentsOptions

Aanvullende opties.

Retouren

Promise<IndexDocumentsResult>

mergeOrUploadDocuments(TModel[], IndexDocumentsOptions)

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

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

Parameters

documents

TModel[]

De bijgewerkte documenten.

options
IndexDocumentsOptions

Aanvullende opties.

Retouren

Promise<IndexDocumentsResult>

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

Voorbeeld

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

searchText

string

Tekst om te zoeken

options

SearchOptions<TModel, TFields>

Opties voor de zoekbewerking.

Retouren

Promise<SearchDocumentsResult<TModel, TFields>>

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

Retourneert een korte lijst met suggesties op basis van de searchText en de opgegeven suggester.

Voorbeeld

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

searchText

string

De zoektekst die moet worden gebruikt om documenten voor te stellen. Moet ten minste één teken en niet meer dan 100 tekens bevatten.

suggesterName

string

De naam van de suggestiefunctie zoals opgegeven in de verzameling suggesties die deel uitmaakt van de indexdefinitie.

options

SuggestOptions<TModel, TFields>

Opties voor de suggestiebewerking

Retouren

Promise<SuggestDocumentsResult<TModel, TFields>>

uploadDocuments(TModel[], IndexDocumentsOptions)

Upload een matrix met documenten naar de index.

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

Parameters

documents

TModel[]

De documenten die moeten worden geüpload.

options
IndexDocumentsOptions

Aanvullende opties.

Retouren

Promise<IndexDocumentsResult>