SearchClient class
Klasa używana do wykonywania operacji względem indeksu wyszukiwania, w tym wykonywania zapytań dotyczących dokumentów w indeksie, a także dodawania, aktualizowania i usuwania.
Konstruktory
Search |
Tworzy wystąpienie elementu SearchClient. Przykład użycia:
Opcjonalnie można użyć typu modelu, aby włączyć silne wpisywanie i wskazówki dotyczące typów:
|
Właściwości
api |
Wersja interfejsu API do użycia podczas komunikowania się z usługą. |
endpoint | Punkt końcowy usługi wyszukiwania |
index |
Nazwa indeksu |
service |
Wersja usługi, która ma być używana podczas komunikowania się z usługą. |
Metody
autocomplete(string, string, Autocomplete |
Na podstawie częściowego elementu searchText od użytkownika zwróć listę potencjalnych ciągów uzupełniania na podstawie określonego sugestora. Przykład
|
delete |
Usuń zestaw dokumentów. |
delete |
Usuń zestaw dokumentów. |
get |
Pobierz określony dokument z indeksu według klucza. |
get |
Pobiera liczbę dokumentów w indeksie. |
index |
Wykonaj zestaw modyfikacji indeksu (przekazywanie, scalanie, scalanie, scalanie, ładowanie, usuwanie) dla danego zestawu dokumentów.
Ta operacja może częściowo zakończyć się powodzeniem, a nie wszystkie operacje dokumentu zostaną odzwierciedlone w indeksie. Jeśli chcesz traktować to jako wyjątek, ustaw |
merge |
Zaktualizuj zestaw dokumentów w indeksie. Aby uzyskać więcej informacji na temat sposobu działania scalania, zobacz https://docs.microsoft.com/en-us/rest/api/searchservice/AddUpdate-or-Delete-Documents |
merge |
Zaktualizuj zestaw dokumentów w indeksie lub przekaż je, jeśli nie istnieją. Aby uzyskać więcej informacji na temat sposobu działania scalania, zobacz https://docs.microsoft.com/en-us/rest/api/searchservice/AddUpdate-or-Delete-Documents |
search<TFields>(string, Search |
Wykonuje wyszukiwanie w bieżącym indeksie, biorąc pod uwagę określone argumenty. Przykład
|
suggest<TFields>(string, string, Suggest |
Zwraca krótką listę sugestii na podstawie tekstu wyszukiwania i określonego sugestora. Przykład
|
upload |
Przekaż tablicę dokumentów do indeksu. |
Szczegóły konstruktora
SearchClient<TModel>(string, string, KeyCredential | TokenCredential, SearchClientOptions)
Tworzy wystąpienie elementu SearchClient.
Przykład użycia:
const { SearchClient, AzureKeyCredential } = require("@azure/search-documents");
const client = new SearchClient(
"<endpoint>",
"<indexName>",
new AzureKeyCredential("<Admin Key>")
);
Opcjonalnie można użyć typu modelu, aby włączyć silne wpisywanie i wskazówki dotyczące typów:
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
Punkt końcowy usługi wyszukiwania
- indexName
-
string
Nazwa indeksu
- credential
Służy do uwierzytelniania żądań w usłudze.
- options
- SearchClientOptions
Służy do konfigurowania klienta wyszukiwania.
Szczegóły właściwości
apiVersion
Ostrzeżenie
Ten interfejs API jest już przestarzały.
use {@Link serviceVersion} instead
Wersja interfejsu API do użycia podczas komunikowania się z usługą.
apiVersion: string
Wartość właściwości
string
endpoint
Punkt końcowy usługi wyszukiwania
endpoint: string
Wartość właściwości
string
indexName
Nazwa indeksu
indexName: string
Wartość właściwości
string
serviceVersion
Wersja usługi, która ma być używana podczas komunikowania się z usługą.
serviceVersion: string
Wartość właściwości
string
Szczegóły metody
autocomplete(string, string, AutocompleteOptions<TModel>)
Na podstawie częściowego elementu searchText od użytkownika zwróć listę potencjalnych ciągów uzupełniania na podstawie określonego sugestora.
Przykład
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
Tekst wyszukiwania, na którym mają być oparte wyniki autouzupełniania.
- suggesterName
-
string
Nazwa sugestora określona w kolekcji sugestorów, która jest częścią definicji indeksu.
- options
-
AutocompleteOptions<TModel>
Opcje operacji autouzupełniania.
Zwraca
Promise<AutocompleteResult>
deleteDocuments(keyof TModel, string[], IndexDocumentsOptions)
Usuń zestaw dokumentów.
function deleteDocuments(keyName: keyof TModel, keyValues: string[], options?: IndexDocumentsOptions): Promise<IndexDocumentsResult>
Parametry
- keyName
-
keyof TModel
Nazwa klucza podstawowego w indeksie.
- keyValues
-
string[]
Podstawowe wartości klucza dokumentów do usunięcia.
- options
- IndexDocumentsOptions
Dodatkowe opcje.
Zwraca
Promise<IndexDocumentsResult>
deleteDocuments(TModel[], IndexDocumentsOptions)
Usuń zestaw dokumentów.
function deleteDocuments(documents: TModel[], options?: IndexDocumentsOptions): Promise<IndexDocumentsResult>
Parametry
- documents
-
TModel[]
Dokumenty do usunięcia.
- options
- IndexDocumentsOptions
Dodatkowe opcje.
Zwraca
Promise<IndexDocumentsResult>
getDocument<TFields>(string, GetDocumentOptions<TModel, TFields>)
Pobierz określony dokument z indeksu według klucza.
function getDocument<TFields>(key: string, options?: GetDocumentOptions<TModel, TFields>): Promise<NarrowedModel<TModel, TFields>>
Parametry
- key
-
string
Wartość klucza podstawowego dokumentu
- options
-
GetDocumentOptions<TModel, TFields>
Opcje dodatkowe
Zwraca
Promise<NarrowedModel<TModel, TFields>>
getDocumentsCount(OperationOptions)
Pobiera liczbę dokumentów w indeksie.
function getDocumentsCount(options?: OperationOptions): Promise<number>
Parametry
- options
- OperationOptions
Opcje operacji licznika.
Zwraca
Promise<number>
indexDocuments(IndexDocumentsBatch<TModel>, IndexDocumentsOptions)
Wykonaj zestaw modyfikacji indeksu (przekazywanie, scalanie, scalanie, scalanie, ładowanie, usuwanie) dla danego zestawu dokumentów.
Ta operacja może częściowo zakończyć się powodzeniem, a nie wszystkie operacje dokumentu zostaną odzwierciedlone w indeksie. Jeśli chcesz traktować to jako wyjątek, ustaw throwOnAnyFailure
opcję true.
Aby uzyskać więcej informacji na temat sposobu działania scalania, zobacz: 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>
Tablica akcji do wykonania w indeksie.
- options
- IndexDocumentsOptions
Dodatkowe opcje.
Zwraca
Promise<IndexDocumentsResult>
mergeDocuments(TModel[], IndexDocumentsOptions)
Zaktualizuj zestaw dokumentów w indeksie. Aby uzyskać więcej informacji na temat sposobu działania scalania, zobacz https://docs.microsoft.com/en-us/rest/api/searchservice/AddUpdate-or-Delete-Documents
function mergeDocuments(documents: TModel[], options?: IndexDocumentsOptions): Promise<IndexDocumentsResult>
Parametry
- documents
-
TModel[]
Zaktualizowane dokumenty.
- options
- IndexDocumentsOptions
Dodatkowe opcje.
Zwraca
Promise<IndexDocumentsResult>
mergeOrUploadDocuments(TModel[], IndexDocumentsOptions)
Zaktualizuj zestaw dokumentów w indeksie lub przekaż je, jeśli nie istnieją. Aby uzyskać więcej informacji na temat sposobu działania scalania, zobacz https://docs.microsoft.com/en-us/rest/api/searchservice/AddUpdate-or-Delete-Documents
function mergeOrUploadDocuments(documents: TModel[], options?: IndexDocumentsOptions): Promise<IndexDocumentsResult>
Parametry
- documents
-
TModel[]
Zaktualizowane dokumenty.
- options
- IndexDocumentsOptions
Dodatkowe opcje.
Zwraca
Promise<IndexDocumentsResult>
search<TFields>(string, SearchOptions<TModel, TFields>)
Wykonuje wyszukiwanie w bieżącym indeksie, biorąc pod uwagę określone argumenty.
Przykład
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
Tekst do wyszukania
- options
-
SearchOptions<TModel, TFields>
Opcje operacji wyszukiwania.
Zwraca
Promise<SearchDocumentsResult<TModel, TFields>>
suggest<TFields>(string, string, SuggestOptions<TModel, TFields>)
Zwraca krótką listę sugestii na podstawie tekstu wyszukiwania i określonego sugestora.
Przykład
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
Tekst wyszukiwania, który ma być używany do sugerowania dokumentów. Musi mieć co najmniej 1 znak i nie więcej niż 100 znaków.
- suggesterName
-
string
Nazwa sugestora określona w kolekcji sugestorów, która jest częścią definicji indeksu.
- options
-
SuggestOptions<TModel, TFields>
Opcje operacji sugerowanej
Zwraca
Promise<SuggestDocumentsResult<TModel, TFields>>
uploadDocuments(TModel[], IndexDocumentsOptions)
Przekaż tablicę dokumentów do indeksu.
function uploadDocuments(documents: TModel[], options?: IndexDocumentsOptions): Promise<IndexDocumentsResult>
Parametry
- documents
-
TModel[]
Dokumenty do przekazania.
- options
- IndexDocumentsOptions
Dodatkowe opcje.
Zwraca
Promise<IndexDocumentsResult>