SearchClient class
A keresési indexen végzett műveletekhez használt osztály, beleértve az indexben lévő dokumentumok lekérdezését, valamint az indexek hozzáadását, frissítését és eltávolítását.
Konstruktorok
Search |
Létrehozza a SearchClient egy példányát. Példahasználat:
A modell típusa használható erős gépelési és típusmutatók engedélyezésére is:
|
Tulajdonságok
api |
A szolgáltatással való kommunikációhoz használandó API-verzió. |
endpoint | A keresési szolgáltatás végpontja |
index |
Az index neve |
service |
A szolgáltatás verziójának használata a szolgáltatással való kommunikációhoz. |
Metódusok
autocomplete(string, string, Autocomplete |
A felhasználó részleges keresési szövege alapján adja vissza a lehetséges befejezési sztringek listáját egy adott javaslat alapján. Példa
|
delete |
Dokumentumkészlet törlése. |
delete |
Dokumentumkészlet törlése. |
get |
Egy adott dokumentum lekérése az indexből kulcs alapján. |
get |
Lekéri az indexben lévő dokumentumok számát. |
index |
Végezzen indexmódosításokat (feltöltés, egyesítés, mergeOrUpload, törlés) az adott dokumentumkészlethez.
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 |
merge |
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://docs.microsoft.com/en-us/rest/api/searchservice/AddUpdate-or-Delete-Documents |
merge |
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://docs.microsoft.com/en-us/rest/api/searchservice/AddUpdate-or-Delete-Documents |
search<TFields>(string, Search |
Keresést végez az aktuális indexen a megadott argumentumok alapján. Példa
|
suggest<TFields>(string, string, Suggest |
A keresési szöveg és a megadott javaslat alapján visszaadja a javaslatok rövid listáját. Példa
|
upload |
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:
const { SearchClient, AzureKeyCredential } = require("@azure/search-documents");
const client = new SearchClient(
"<endpoint>",
"<indexName>",
new AzureKeyCredential("<Admin Key>")
);
A modell típusa használható erős gépelési és típusmutatók engedélyezésére is:
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éterek
- endpoint
-
string
A keresési szolgáltatás végpontja
- indexName
-
string
Az index neve
- credential
A szolgáltatás felé irányuló kérések hitelesítésére szolgál.
- options
- SearchClientOptions
A Search-ügyfél konfigurálásához használatos.
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
serviceVersion
A szolgáltatás verziójának használata a szolgáltatással való kommunikációhoz.
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 adott javaslat alapján.
Példa
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éterek
- searchText
-
string
Az automatikus kiegészítési eredmények alapjául szolgáló keresési szöveg.
- suggesterName
-
string
A javaslattevőnek az indexdefiníció részét képező javaslattevő-gyűjteményben megadott neve.
- 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 kulcs alapján.
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 beállítások
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)
Végezzen indexmódosításokat (feltöltés, egyesítés, mergeOrUpload, törlés) az adott dokumentumkészlethez.
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 true (igaz) értékre.
Az egyesítés működésével kapcsolatos további információkért lásd: https://docs.microsoft.com/en-us/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://docs.microsoft.com/en-us/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://docs.microsoft.com/en-us/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 végez az aktuális indexen a megadott argumentumok alapján.
Példa
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é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 javaslat alapján visszaadja a javaslatok rövid listáját.
Példa
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é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 javaslati 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>