SearchClient class

Csomag:

@azure/search-documents

A keresési indexen végzett műveletekhez használt osztály, beleértve az indexben lévő dokumentumok lekérdezését, valamint azok hozzáadását, frissítését és eltávolítását.

Konstruktorok

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

Létrehozza a SearchClient egy példányát. Példahasználat: import { SearchClient, AzureKeyCredential } from "@azure/search-documents"; const searchClient = new SearchClient( "<endpoint>", "<indexName>", new AzureKeyCredential("<apiKey>"), ); A modell típusa használható az erős gépelés és a gépelés tippjeinek engedélyezéséhez: import { SearchClient, AzureKeyCredential } from "@azure/search-documents"; type TModel = { keyName: string; field1?: string | null; field2?: { anotherField?: string | null; } | null; }; const searchClient = new SearchClient<TModel>( "<endpoint>", "<indexName>", new AzureKeyCredential("<apiKey>"), );

Tulajdonságok

apiVersion	A szolgáltatással való kommunikációhoz használandó API-verzió.
endpoint	A keresési szolgáltatás végpontja
indexName	Az index neve
pipeline	Hivatkozás a belső HTTP-folyamatra a nyers kérésekkel való használathoz
serviceVersion	A szolgáltatással való kommunikációhoz használandó szolgáltatásverzió.

Metódusok

autocomplete(string, string, AutocompleteOptions<TModel>)	A felhasználó részleges keresési szövege alapján adja vissza a lehetséges befejezési sztringek listáját egy megadott javaslat alapján. példa import { SearchClient, AzureKeyCredential, 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)	Dokumentumkészlet törlése.
deleteDocuments(TModel[], IndexDocumentsOptions)	Dokumentumkészlet törlése.
getDocument<TFields>(string, GetDocumentOptions<TModel, TFields>)	Egy adott dokumentum lekérése az indexből kulccsal.
getDocumentsCount(OperationOptions)	Lekéri az indexben lévő dokumentumok számát.
indexDocuments(IndexDocumentsBatch<TModel>, IndexDocumentsOptions)	Az adott dokumentumkészlet indexmódosításait (feltöltés, egyesítés, mergeOrUpload, törlés) hajthatja végre. Ez a művelet részben sikeres lehet, és nem minden dokumentumművelet jelenik meg az indexben. Ha ezt kivételként szeretné kezelni, állítsa a throwOnAnyFailure beállítást igaz értékre. Az egyesítés működésével kapcsolatos további részletekért lásd: https://learn.microsoft.com/rest/api/searchservice/AddUpdate-or-Delete-Documents
mergeDocuments(TModel[], IndexDocumentsOptions)	Frissítsen egy dokumentumkészletet az indexben. Az egyesítés működésével kapcsolatos további részletekért lásd: https://learn.microsoft.com/rest/api/searchservice/AddUpdate-or-Delete-Documents
mergeOrUploadDocuments(TModel[], IndexDocumentsOptions)	Frissítsen egy dokumentumkészletet az indexben, vagy töltse fel őket, ha nem léteznek. Az egyesítés működésével kapcsolatos további részletekért lásd: https://learn.microsoft.com/rest/api/searchservice/AddUpdate-or-Delete-Documents
search<TFields>(string, SearchOptions<TModel, TFields>)	Keresést hajt végre az aktuális indexen a megadott argumentumok alapján. példa import { SearchClient, AzureKeyCredential, 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>)	A keresési szöveg és a megadott javaslati elem alapján visszaadja a javaslatok rövid listáját. példa import { SearchClient, AzureKeyCredential, 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)	Töltsön fel egy dokumentumtömböt az indexbe.

Konstruktor adatai

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

Létrehozza a SearchClient egy példányát.

Példahasználat:

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

const searchClient = new SearchClient(
  "<endpoint>",
  "<indexName>",
  new AzureKeyCredential("<apiKey>"),
);

A modell típusa használható az erős gépelés és a gépelés tippjeinek engedélyezéséhez:

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

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

const searchClient = new SearchClient<TModel>(
  "<endpoint>",
  "<indexName>",
  new AzureKeyCredential("<apiKey>"),
);

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

Paraméterek

endpoint

string

A keresési szolgáltatás végpontja

indexName

string

Az index neve

credential

KeyCredential | TokenCredential

A szolgáltatáshoz érkező kérések hitelesítésére szolgál.

options

SearchClientOptions

A Search-ügyfél konfigurálására szolgál.

Tulajdonság adatai

apiVersion

Figyelmeztetés

Ez az API már elavult.

use {@Link serviceVersion} instead

A szolgáltatással való kommunikációhoz használandó API-verzió.

apiVersion: string

Tulajdonság értéke

string

endpoint

A keresési szolgáltatás végpontja

endpoint: string

Tulajdonság értéke

string

indexName

Az index neve

indexName: string

Tulajdonság értéke

string

pipeline

Hivatkozás a belső HTTP-folyamatra a nyers kérésekkel való használathoz

pipeline: Pipeline

Tulajdonság értéke

Pipeline

serviceVersion

A szolgáltatással való kommunikációhoz használandó szolgáltatásverzió.

serviceVersion: string

Tulajdonság értéke

string

Metódus adatai

autocomplete(string, string, AutocompleteOptions<TModel>)

A felhasználó részleges keresési szövege alapján adja vissza a lehetséges befejezési sztringek listáját egy megadott javaslat alapján.

példa

import { SearchClient, AzureKeyCredential, 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éterek

searchText

string

Az a keresési szöveg, amelyre az automatikus kiegészítési eredményeket alapozza.

suggesterName

string

A javaslattevő neve az indexdefiníció részét képező javaslattevő-gyűjteményben megadottak szerint.

options

AutocompleteOptions<TModel>

Az automatikus kiegészítési művelet beállításai.

Válaszok

Promise<AutocompleteResult>

deleteDocuments(keyof TModel, string[], IndexDocumentsOptions)

Dokumentumkészlet törlése.

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

Paraméterek

keyName

keyof TModel

Az elsődleges kulcs neve az indexben.

keyValues

string[]

A törölni kívánt dokumentumok elsődleges kulcsértékei.

options

IndexDocumentsOptions

További lehetőségek.

Válaszok

Promise<IndexDocumentsResult>

deleteDocuments(TModel[], IndexDocumentsOptions)

Dokumentumkészlet törlése.

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

Paraméterek

documents

TModel[]

A törölni kívánt dokumentumok.

options

IndexDocumentsOptions

További lehetőségek.

Válaszok

Promise<IndexDocumentsResult>

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

Egy adott dokumentum lekérése az indexből kulccsal.

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

Paraméterek

key

string

A dokumentum elsődleges kulcsértéke

options

GetDocumentOptions<TModel, TFields>

További lehetőségek

Válaszok

Promise<NarrowedModel<TModel, TFields>>

getDocumentsCount(OperationOptions)

Lekéri az indexben lévő dokumentumok számát.

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

Paraméterek

options

OperationOptions

A darabszám művelet beállításai.

Válaszok

Promise<number>

indexDocuments(IndexDocumentsBatch<TModel>, IndexDocumentsOptions)

Az adott dokumentumkészlet indexmódosításait (feltöltés, egyesítés, mergeOrUpload, törlés) hajthatja végre. Ez a művelet részben sikeres lehet, és nem minden dokumentumművelet jelenik meg az indexben. Ha ezt kivételként szeretné kezelni, állítsa a throwOnAnyFailure beállítást igaz értékre. Az egyesítés működésével kapcsolatos további részletekért lásd: https://learn.microsoft.com/rest/api/searchservice/AddUpdate-or-Delete-Documents

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

Paraméterek

batch

IndexDocumentsBatch<TModel>

Az indexen végrehajtandó műveletek tömbje.

options

IndexDocumentsOptions

További lehetőségek.

Válaszok

Promise<IndexDocumentsResult>

mergeDocuments(TModel[], IndexDocumentsOptions)

Frissítsen egy dokumentumkészletet az indexben.

Az egyesítés működésével kapcsolatos további részletekért lásd: https://learn.microsoft.com/rest/api/searchservice/AddUpdate-or-Delete-Documents

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

Paraméterek

documents

TModel[]

A frissített dokumentumok.

options

IndexDocumentsOptions

További lehetőségek.

Válaszok

Promise<IndexDocumentsResult>

mergeOrUploadDocuments(TModel[], IndexDocumentsOptions)

Frissítsen egy dokumentumkészletet az indexben, vagy töltse fel őket, ha nem léteznek.

Az egyesítés működésével kapcsolatos további részletekért lásd: https://learn.microsoft.com/rest/api/searchservice/AddUpdate-or-Delete-Documents

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

Paraméterek

documents

TModel[]

A frissített dokumentumok.

options

IndexDocumentsOptions

További lehetőségek.

Válaszok

Promise<IndexDocumentsResult>

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

Keresést hajt végre az aktuális indexen a megadott argumentumok alapján.

példa

import { SearchClient, AzureKeyCredential, 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éterek

searchText

string

Keresendő szöveg

options

SearchOptions<TModel, TFields>

A keresési művelet beállításai.

Válaszok

Promise<SearchDocumentsResult<TModel, TFields>>

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

A keresési szöveg és a megadott javaslati elem alapján visszaadja a javaslatok rövid listáját.

példa

import { SearchClient, AzureKeyCredential, 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éterek

searchText

string

A dokumentumok javaslatára használható keresési szöveg. Legalább 1 karakternek és legfeljebb 100 karakternek kell lennie.

suggesterName

string

A javaslattevő neve az indexdefiníció részét képező javaslattevő-gyűjteményben megadottak szerint.

options

SuggestOptions<TModel, TFields>

A javaslat művelet beállításai

Válaszok

Promise<SuggestDocumentsResult<TModel, TFields>>

uploadDocuments(TModel[], IndexDocumentsOptions)

Töltsön fel egy dokumentumtömböt az indexbe.

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

Paraméterek

documents

TModel[]

A feltöltendő dokumentumok.

options

IndexDocumentsOptions

További lehetőségek.

Válaszok

Promise<IndexDocumentsResult>