SearchClient class
Dizindeki belgeleri sorgulamanın yanı sıra bunları ekleme, güncelleştirme ve kaldırma dahil olmak üzere bir arama dizininde işlemler gerçekleştirmek için kullanılan sınıf.
Oluşturucular
Search |
SearchClient örneği oluşturur. Örnek kullanım:
İsteğe bağlı olarak, güçlü yazma ve tür ipuçlarını etkinleştirmek için modelin türü kullanılabilir:
|
Özellikler
api |
Hizmetle iletişim kurarken kullanılacak API sürümü. |
endpoint | Arama hizmetinin uç noktası |
index |
Dizinin adı |
service |
Hizmetle iletişim kurarken kullanılacak hizmet sürümü. |
Yöntemler
autocomplete(string, string, Autocomplete |
Kullanıcının kısmi searchText değerine bağlı olarak, belirtilen öneriyi temel alan olası tamamlama dizelerinin listesini döndürür. Örnek
|
delete |
Bir belge kümesini silin. |
delete |
Bir belge kümesini silin. |
get |
Anahtara göre dizinden belirli bir belgeyi alın. |
get |
Dizindeki belge sayısını alır. |
index |
Belirtilen belge kümesi için bir dizi dizin değişikliği (karşıya yükleme, birleştirme, mergeOrUpload, silme) gerçekleştirin.
Bu işlem kısmen başarılı olabilir ve tüm belge işlemleri dizine yansıtılmaz. Bunu bir özel durum olarak ele almak isterseniz, seçeneğini true olarak ayarlayın |
merge |
Dizindeki bir belge kümesini güncelleştirin. Birleştirmenin nasıl çalıştığı hakkında daha fazla ayrıntı için bkz. https://docs.microsoft.com/en-us/rest/api/searchservice/AddUpdate-or-Delete-Documents |
merge |
Dizindeki bir belge kümesini güncelleştirin veya yoksa karşıya yükleyin. Birleştirmenin nasıl çalıştığı hakkında daha fazla ayrıntı için bkz. https://docs.microsoft.com/en-us/rest/api/searchservice/AddUpdate-or-Delete-Documents |
search<TFields>(string, Search |
Belirtilen bağımsız değişkenlere göre geçerli dizinde bir arama gerçekleştirir. Örnek
|
suggest<TFields>(string, string, Suggest |
searchText ve belirtilen öneri oluşturucuyu temel alan kısa bir öneri listesi döndürür. Örnek
|
upload |
Dizine bir belge dizisi yükleyin. |
Oluşturucu Ayrıntıları
SearchClient<TModel>(string, string, KeyCredential | TokenCredential, SearchClientOptions)
SearchClient örneği oluşturur.
Örnek kullanım:
const { SearchClient, AzureKeyCredential } = require("@azure/search-documents");
const client = new SearchClient(
"<endpoint>",
"<indexName>",
new AzureKeyCredential("<Admin Key>")
);
İsteğe bağlı olarak, güçlü yazma ve tür ipuçlarını etkinleştirmek için modelin türü kullanılabilir:
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)
Parametreler
- endpoint
-
string
Arama hizmetinin uç noktası
- indexName
-
string
Dizinin adı
- credential
Hizmete yönelik isteklerin kimliğini doğrulamak için kullanılır.
- options
- SearchClientOptions
Arama istemcisini yapılandırmak için kullanılır.
Özellik Ayrıntıları
apiVersion
Uyarı
Bu API artık kullanım dışıdır.
use {@Link serviceVersion} instead
Hizmetle iletişim kurarken kullanılacak API sürümü.
apiVersion: string
Özellik Değeri
string
endpoint
Arama hizmetinin uç noktası
endpoint: string
Özellik Değeri
string
indexName
Dizinin adı
indexName: string
Özellik Değeri
string
serviceVersion
Hizmetle iletişim kurarken kullanılacak hizmet sürümü.
serviceVersion: string
Özellik Değeri
string
Yöntem Ayrıntıları
autocomplete(string, string, AutocompleteOptions<TModel>)
Kullanıcının kısmi searchText değerine bağlı olarak, belirtilen öneriyi temel alan olası tamamlama dizelerinin listesini döndürür.
Örnek
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>
Parametreler
- searchText
-
string
Otomatik tamamlama sonuçlarını temel alan arama metni.
- suggesterName
-
string
Dizin tanımının parçası olan önerici koleksiyonunda belirtildiği gibi önericinin adı.
- options
-
AutocompleteOptions<TModel>
Otomatik tamamlama işleminin seçenekleri.
Döndürülenler
Promise<AutocompleteResult>
deleteDocuments(keyof TModel, string[], IndexDocumentsOptions)
Bir belge kümesini silin.
function deleteDocuments(keyName: keyof TModel, keyValues: string[], options?: IndexDocumentsOptions): Promise<IndexDocumentsResult>
Parametreler
- keyName
-
keyof TModel
Dizindeki birincil anahtarının adı.
- keyValues
-
string[]
Silinecek belgelerin birincil anahtar değerleri.
- options
- IndexDocumentsOptions
Ek seçenekler.
Döndürülenler
Promise<IndexDocumentsResult>
deleteDocuments(TModel[], IndexDocumentsOptions)
Bir belge kümesini silin.
function deleteDocuments(documents: TModel[], options?: IndexDocumentsOptions): Promise<IndexDocumentsResult>
Parametreler
- documents
-
TModel[]
Silinecek belgeler.
- options
- IndexDocumentsOptions
Ek seçenekler.
Döndürülenler
Promise<IndexDocumentsResult>
getDocument<TFields>(string, GetDocumentOptions<TModel, TFields>)
Anahtara göre dizinden belirli bir belgeyi alın.
function getDocument<TFields>(key: string, options?: GetDocumentOptions<TModel, TFields>): Promise<NarrowedModel<TModel, TFields>>
Parametreler
- key
-
string
Belgenin birincil anahtar değeri
- options
-
GetDocumentOptions<TModel, TFields>
Ek seçenekler
Döndürülenler
Promise<NarrowedModel<TModel, TFields>>
getDocumentsCount(OperationOptions)
Dizindeki belge sayısını alır.
function getDocumentsCount(options?: OperationOptions): Promise<number>
Parametreler
- options
- OperationOptions
Sayım işlemine yönelik seçenekler.
Döndürülenler
Promise<number>
indexDocuments(IndexDocumentsBatch<TModel>, IndexDocumentsOptions)
Belirtilen belge kümesi için bir dizi dizin değişikliği (karşıya yükleme, birleştirme, mergeOrUpload, silme) gerçekleştirin.
Bu işlem kısmen başarılı olabilir ve tüm belge işlemleri dizine yansıtılmaz. Bunu bir özel durum olarak ele almak isterseniz, seçeneğini true olarak ayarlayın throwOnAnyFailure
.
Birleştirmenin nasıl çalıştığı hakkında daha fazla ayrıntı için bkz: https://docs.microsoft.com/en-us/rest/api/searchservice/AddUpdate-or-Delete-Documents
function indexDocuments(batch: IndexDocumentsBatch<TModel>, options?: IndexDocumentsOptions): Promise<IndexDocumentsResult>
Parametreler
- batch
-
IndexDocumentsBatch<TModel>
Dizinde gerçekleştirilecek eylemler dizisi.
- options
- IndexDocumentsOptions
Ek seçenekler.
Döndürülenler
Promise<IndexDocumentsResult>
mergeDocuments(TModel[], IndexDocumentsOptions)
Dizindeki bir belge kümesini güncelleştirin. Birleştirmenin nasıl çalıştığı hakkında daha fazla ayrıntı için bkz. https://docs.microsoft.com/en-us/rest/api/searchservice/AddUpdate-or-Delete-Documents
function mergeDocuments(documents: TModel[], options?: IndexDocumentsOptions): Promise<IndexDocumentsResult>
Parametreler
- documents
-
TModel[]
Güncelleştirilmiş belgeler.
- options
- IndexDocumentsOptions
Ek seçenekler.
Döndürülenler
Promise<IndexDocumentsResult>
mergeOrUploadDocuments(TModel[], IndexDocumentsOptions)
Dizindeki bir belge kümesini güncelleştirin veya yoksa karşıya yükleyin. Birleştirmenin nasıl çalıştığı hakkında daha fazla ayrıntı için bkz. https://docs.microsoft.com/en-us/rest/api/searchservice/AddUpdate-or-Delete-Documents
function mergeOrUploadDocuments(documents: TModel[], options?: IndexDocumentsOptions): Promise<IndexDocumentsResult>
Parametreler
- documents
-
TModel[]
Güncelleştirilmiş belgeler.
- options
- IndexDocumentsOptions
Ek seçenekler.
Döndürülenler
Promise<IndexDocumentsResult>
search<TFields>(string, SearchOptions<TModel, TFields>)
Belirtilen bağımsız değişkenlere göre geçerli dizinde bir arama gerçekleştirir.
Örnek
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>>
Parametreler
- searchText
-
string
Aranacak metin
- options
-
SearchOptions<TModel, TFields>
Arama işlemi için seçenekler.
Döndürülenler
Promise<SearchDocumentsResult<TModel, TFields>>
suggest<TFields>(string, string, SuggestOptions<TModel, TFields>)
searchText ve belirtilen öneri oluşturucuyu temel alan kısa bir öneri listesi döndürür.
Örnek
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>>
Parametreler
- searchText
-
string
Belge önermek için kullanılacak arama metni. En az 1 karakter ve en fazla 100 karakter olmalıdır.
- suggesterName
-
string
Dizin tanımının parçası olan önerici koleksiyonunda belirtilen önericinin adı.
- options
-
SuggestOptions<TModel, TFields>
Öneri işlemi seçenekleri
Döndürülenler
Promise<SuggestDocumentsResult<TModel, TFields>>
uploadDocuments(TModel[], IndexDocumentsOptions)
Dizine bir belge dizisi yükleyin.
function uploadDocuments(documents: TModel[], options?: IndexDocumentsOptions): Promise<IndexDocumentsResult>
Parametreler
- documents
-
TModel[]
Karşıya yüklenecek belgeler.
- options
- IndexDocumentsOptions
Ek seçenekler.
Döndürülenler
Promise<IndexDocumentsResult>