SearchClient class

Balíček:

@azure/search-documents

Třída, která slouží k provádění operací s indexem vyhledávání, včetně dotazování dokumentů v indexu a přidávání, aktualizace a odebírání.

Konstruktory

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

Vytvoří instanci SearchClient. Příklad použití: const { SearchClient, AzureKeyCredential } = require("@azure/search-documents"); const client = new SearchClient( "<endpoint>", "<indexName>", new AzureKeyCredential("<Admin Key>") ); Volitelně je možné použít typ modelu k povolení silného psaní a nápovědy k typům: type TModel = { keyName: string; field1?: string | null; field2?: { anotherField?: string | null } | null; }; const client = new SearchClient<TModel>( ... );

Vlastnosti

apiVersion	Verze rozhraní API, která se má použít při komunikaci se službou.
endpoint	Koncový bod vyhledávací služby
indexName	Název indexu
serviceVersion	Verze služby, která se má použít při komunikaci se službou.

Metody

autocomplete(string, string, AutocompleteOptions<TModel>)	Na základě částečného vyhledávacího textu od uživatele vrátí seznam potenciálních řetězců dokončení na základě zadaného navrhovače. příklad 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)	Odstraňte sadu dokumentů.
deleteDocuments(TModel[], IndexDocumentsOptions)	Odstraňte sadu dokumentů.
getDocument<TFields>(string, GetDocumentOptions<TModel, TFields>)	Načtěte konkrétní dokument z indexu podle klíče.
getDocumentsCount(OperationOptions)	Načte počet dokumentů v indexu.
indexDocuments(IndexDocumentsBatch<TModel>, IndexDocumentsOptions)	Proveďte sadu úprav indexu (nahrání, sloučení, mergeOrUpload, odstranění) pro danou sadu dokumentů. Tato operace může být částečně úspěšná a ne všechny operace dokumentu se projeví v indexu. Pokud chcete s tímto výjimkou zacházet, nastavte možnost throwOnAnyFailure na true. Další podrobnosti o tom, jak slučování funguje, najdete v tématu: https://docs.microsoft.com/en-us/rest/api/searchservice/AddUpdate-or-Delete-Documents
mergeDocuments(TModel[], IndexDocumentsOptions)	Aktualizujte sadu dokumentů v indexu. Další podrobnosti o tom, jak slučování funguje, najdete v tématu https://docs.microsoft.com/en-us/rest/api/searchservice/AddUpdate-or-Delete-Documents
mergeOrUploadDocuments(TModel[], IndexDocumentsOptions)	Aktualizujte sadu dokumentů v indexu nebo je nahrajte, pokud neexistují. Další podrobnosti o tom, jak slučování funguje, najdete v tématu https://docs.microsoft.com/en-us/rest/api/searchservice/AddUpdate-or-Delete-Documents
search<TFields>(string, SearchOptions<TModel, TFields>)	Provede vyhledávání aktuálního indexu vzhledem k zadaným argumentům. příklad 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>)	Vrátí krátký seznam návrhů založených na vyhledávacím textu a zadaném sugestivním prvku. příklad 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)	Nahrajte pole dokumentů do indexu.

Podrobnosti konstruktoru

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

Vytvoří instanci SearchClient.

Příklad použití:

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

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

Volitelně je možné použít typ modelu k povolení silného psaní a nápovědy k typům:

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)

Parametry

endpoint

string

Koncový bod vyhledávací služby

indexName

string

Název indexu

credential

KeyCredential | TokenCredential

Používá se k ověřování požadavků na službu.

options

SearchClientOptions

Slouží ke konfiguraci klienta vyhledávání.

Podrobnosti vlastnosti

apiVersion

Upozornění

Toto rozhraní API je teď zastaralé.

use {@Link serviceVersion} instead

Verze rozhraní API, která se má použít při komunikaci se službou.

apiVersion: string

Hodnota vlastnosti

string

endpoint

Koncový bod vyhledávací služby

endpoint: string

Hodnota vlastnosti

string

indexName

Název indexu

indexName: string

Hodnota vlastnosti

string

serviceVersion

Verze služby, která se má použít při komunikaci se službou.

serviceVersion: string

Hodnota vlastnosti

string

Podrobnosti metody

autocomplete(string, string, AutocompleteOptions<TModel>)

Na základě částečného vyhledávacího textu od uživatele vrátí seznam potenciálních řetězců dokončení na základě zadaného navrhovače.

příklad

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>

Parametry

searchText

string

Hledaný text, na kterém se mají založit výsledky automatického dokončování.

suggesterName

string

Název navrhujícího, jak je uvedeno v kolekci pro návrhy, která je součástí definice indexu.

options

AutocompleteOptions<TModel>

Možnosti operace automatického dokončování

Návraty

Promise<AutocompleteResult>

deleteDocuments(keyof TModel, string[], IndexDocumentsOptions)

Odstraňte sadu dokumentů.

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

Parametry

keyName

keyof TModel

Název primárního klíče v indexu

keyValues

string[]

Hodnoty primárního klíče dokumentů, které chcete odstranit.

options

IndexDocumentsOptions

Další možnosti

Návraty

Promise<IndexDocumentsResult>

deleteDocuments(TModel[], IndexDocumentsOptions)

Odstraňte sadu dokumentů.

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

Parametry

documents

TModel[]

Dokumenty, které se mají odstranit.

options

IndexDocumentsOptions

Další možnosti

Návraty

Promise<IndexDocumentsResult>

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

Načtěte konkrétní dokument z indexu podle klíče.

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

Parametry

key

string

Hodnota primárního klíče dokumentu

options

GetDocumentOptions<TModel, TFields>

Další možnosti

Návraty

Promise<NarrowedModel<TModel, TFields>>

getDocumentsCount(OperationOptions)

Načte počet dokumentů v indexu.

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

Parametry

options

OperationOptions

Možnosti operace počtu

Návraty

Promise<number>

indexDocuments(IndexDocumentsBatch<TModel>, IndexDocumentsOptions)

Proveďte sadu úprav indexu (nahrání, sloučení, mergeOrUpload, odstranění) pro danou sadu dokumentů. Tato operace může být částečně úspěšná a ne všechny operace dokumentu se projeví v indexu. Pokud chcete s tímto výjimkou zacházet, nastavte možnost throwOnAnyFailure na true. Další podrobnosti o tom, jak slučování funguje, najdete v tématu: https://docs.microsoft.com/en-us/rest/api/searchservice/AddUpdate-or-Delete-Documents

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

Parametry

batch

IndexDocumentsBatch<TModel>

Pole akcí,kteréchch

options

IndexDocumentsOptions

Další možnosti

Návraty

Promise<IndexDocumentsResult>

mergeDocuments(TModel[], IndexDocumentsOptions)

Aktualizujte sadu dokumentů v indexu. Další podrobnosti o tom, jak slučování funguje, najdete v tématu https://docs.microsoft.com/en-us/rest/api/searchservice/AddUpdate-or-Delete-Documents

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

Parametry

documents

TModel[]

Aktualizované dokumenty.

options

IndexDocumentsOptions

Další možnosti

Návraty

Promise<IndexDocumentsResult>

mergeOrUploadDocuments(TModel[], IndexDocumentsOptions)

Aktualizujte sadu dokumentů v indexu nebo je nahrajte, pokud neexistují. Další podrobnosti o tom, jak slučování funguje, najdete v tématu https://docs.microsoft.com/en-us/rest/api/searchservice/AddUpdate-or-Delete-Documents

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

Parametry

documents

TModel[]

Aktualizované dokumenty.

options

IndexDocumentsOptions

Další možnosti

Návraty

Promise<IndexDocumentsResult>

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

Provede vyhledávání aktuálního indexu vzhledem k zadaným argumentům.

příklad

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

Parametry

searchText

string

Text, který se má hledat

options

SearchOptions<TModel, TFields>

Možnosti pro operaci hledání

Návraty

Promise<SearchDocumentsResult<TModel, TFields>>

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

Vrátí krátký seznam návrhů založených na vyhledávacím textu a zadaném sugestivním prvku.

příklad

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

Parametry

searchText

string

Hledaný text, který se má použít k návrhu dokumentů. Musí mít alespoň 1 znak a nesmí být delší než 100 znaků.

suggesterName

string

Název navrhujícího, jak je uvedeno v kolekci pro návrhy, která je součástí definice indexu.

options

SuggestOptions<TModel, TFields>

Možnosti pro operaci návrhu

Návraty

Promise<SuggestDocumentsResult<TModel, TFields>>

uploadDocuments(TModel[], IndexDocumentsOptions)

Nahrajte pole dokumentů do indexu.

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

Parametry

documents

TModel[]

Dokumenty, které chcete nahrát.

options

IndexDocumentsOptions

Další možnosti

Návraty

Promise<IndexDocumentsResult>