SearchClient class

  • Referensi
Paket:
@azure/search-documents

Kelas yang digunakan untuk melakukan operasi terhadap indeks pencarian, termasuk mengkueri dokumen dalam indeks serta menambahkan, memperbarui, dan menghapusnya.

Konstruktor

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

Membuat instans SearchClient.

Contoh penggunaan:

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

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

Secara opsional, jenis model dapat digunakan untuk mengaktifkan pengetikan yang kuat dan mengetik petunjuk:

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

const client = new SearchClient<TModel>(
  ...
);

Properti

apiVersion

Versi API yang akan digunakan saat berkomunikasi dengan layanan.
endpoint

Titik akhir layanan pencarian
indexName

Nama indeks
serviceVersion

Versi layanan yang digunakan saat berkomunikasi dengan layanan.

Metode

autocomplete(string, string, AutocompleteOptions<TModel>)

Berdasarkan searchText parsial dari pengguna, kembalikan daftar string penyelesaian potensial berdasarkan pemberi saran tertentu.

Contoh

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)

Menghapus sekumpulan dokumen.
deleteDocuments(TModel[], IndexDocumentsOptions)

Menghapus sekumpulan dokumen.
getDocument<TFields>(string, GetDocumentOptions<TModel, TFields>)

Ambil dokumen tertentu dari indeks menurut kunci.
getDocumentsCount(OperationOptions)

Mengambil jumlah dokumen dalam indeks.
indexDocuments(IndexDocumentsBatch<TModel>, IndexDocumentsOptions)

Lakukan serangkaian modifikasi indeks (unggah, gabungkan, mergeOrUpload, hapus) untuk kumpulan dokumen yang diberikan. Operasi ini mungkin berhasil sebagian dan tidak semua operasi dokumen akan tercermin dalam indeks. Jika Anda ingin memperlakukan ini sebagai pengecualian, atur opsi ke throwOnAnyFailure true. Untuk detail selengkapnya tentang cara kerja penggabungan, lihat: https://docs.microsoft.com/en-us/rest/api/searchservice/AddUpdate-or-Delete-Documents
mergeDocuments(TModel[], IndexDocumentsOptions)

Perbarui sekumpulan dokumen dalam indeks. Untuk detail selengkapnya tentang cara kerja penggabungan, lihat https://docs.microsoft.com/en-us/rest/api/searchservice/AddUpdate-or-Delete-Documents
mergeOrUploadDocuments(TModel[], IndexDocumentsOptions)

Perbarui sekumpulan dokumen dalam indeks atau unggah jika tidak ada. Untuk detail selengkapnya tentang cara kerja penggabungan, lihat https://docs.microsoft.com/en-us/rest/api/searchservice/AddUpdate-or-Delete-Documents
search<TFields>(string, SearchOptions<TModel, TFields>)

Melakukan pencarian pada indeks saat ini mengingat argumen yang ditentukan.

Contoh

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

Mengembalikan daftar singkat saran berdasarkan searchText dan pemberi saran yang ditentukan.

Contoh

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)

Unggah array dokumen ke indeks.

Detail Konstruktor

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

Membuat instans SearchClient.

Contoh penggunaan:

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

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

Secara opsional, jenis model dapat digunakan untuk mengaktifkan pengetikan yang kuat dan mengetik petunjuk:

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)

Parameter

endpoint

string

Titik akhir layanan pencarian

indexName

string

Nama indeks

credential

KeyCredential | TokenCredential

Digunakan untuk mengautentikasi permintaan ke layanan.

options
SearchClientOptions

Digunakan untuk mengonfigurasi klien Pencarian.

Detail Properti

apiVersion

Peringatan

API ini sudah tidak digunakan lagi.

use {@Link serviceVersion} instead

Versi API yang akan digunakan saat berkomunikasi dengan layanan.

apiVersion: string

Nilai Properti

string

endpoint

Titik akhir layanan pencarian

endpoint: string

Nilai Properti

string

indexName

Nama indeks

indexName: string

Nilai Properti

string

serviceVersion

Versi layanan yang digunakan saat berkomunikasi dengan layanan.

serviceVersion: string

Nilai Properti

string

Detail Metode

autocomplete(string, string, AutocompleteOptions<TModel>)

Berdasarkan searchText parsial dari pengguna, kembalikan daftar string penyelesaian potensial berdasarkan pemberi saran tertentu.

Contoh

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>

Parameter

searchText

string

Teks pencarian untuk mendasarkan hasil lengkapi otomatis.

suggesterName

string

Nama pemberi saran seperti yang ditentukan dalam koleksi pemberi saran yang menjadi bagian dari definisi indeks.

options

AutocompleteOptions<TModel>

Opsi untuk operasi pelengkapan otomatis.

Mengembalikan

Promise<AutocompleteResult>

deleteDocuments(keyof TModel, string[], IndexDocumentsOptions)

Menghapus sekumpulan dokumen.

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

Parameter

keyName

keyof TModel

Nama kunci utama mereka dalam indeks.

keyValues

string[]

Nilai kunci utama dokumen yang akan dihapus.

options
IndexDocumentsOptions

Opsi tambahan.

Mengembalikan

Promise<IndexDocumentsResult>

deleteDocuments(TModel[], IndexDocumentsOptions)

Menghapus sekumpulan dokumen.

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

Parameter

documents

TModel[]

Dokumen yang akan dihapus.

options
IndexDocumentsOptions

Opsi tambahan.

Mengembalikan

Promise<IndexDocumentsResult>

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

Ambil dokumen tertentu dari indeks menurut kunci.

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

Parameter

key

string

Nilai kunci utama dokumen

options

GetDocumentOptions<TModel, TFields>

Opsi tambahan

Mengembalikan

Promise<NarrowedModel<TModel, TFields>>

getDocumentsCount(OperationOptions)

Mengambil jumlah dokumen dalam indeks.

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

Parameter

options
OperationOptions

Opsi untuk operasi penghitungan.

Mengembalikan

Promise<number>

indexDocuments(IndexDocumentsBatch<TModel>, IndexDocumentsOptions)

Lakukan serangkaian modifikasi indeks (unggah, gabungkan, mergeOrUpload, hapus) untuk kumpulan dokumen yang diberikan. Operasi ini mungkin berhasil sebagian dan tidak semua operasi dokumen akan tercermin dalam indeks. Jika Anda ingin memperlakukan ini sebagai pengecualian, atur opsi ke throwOnAnyFailure true. Untuk detail selengkapnya tentang cara kerja penggabungan, lihat: https://docs.microsoft.com/en-us/rest/api/searchservice/AddUpdate-or-Delete-Documents

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

Parameter

batch

IndexDocumentsBatch<TModel>

Array tindakan yang akan dilakukan pada indeks.

options
IndexDocumentsOptions

Opsi tambahan.

Mengembalikan

Promise<IndexDocumentsResult>

mergeDocuments(TModel[], IndexDocumentsOptions)

Perbarui sekumpulan dokumen dalam indeks. Untuk detail selengkapnya tentang cara kerja penggabungan, lihat https://docs.microsoft.com/en-us/rest/api/searchservice/AddUpdate-or-Delete-Documents

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

Parameter

documents

TModel[]

Dokumen yang diperbarui.

options
IndexDocumentsOptions

Opsi tambahan.

Mengembalikan

Promise<IndexDocumentsResult>

mergeOrUploadDocuments(TModel[], IndexDocumentsOptions)

Perbarui sekumpulan dokumen dalam indeks atau unggah jika tidak ada. Untuk detail selengkapnya tentang cara kerja penggabungan, lihat https://docs.microsoft.com/en-us/rest/api/searchservice/AddUpdate-or-Delete-Documents

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

Parameter

documents

TModel[]

Dokumen yang diperbarui.

options
IndexDocumentsOptions

Opsi tambahan.

Mengembalikan

Promise<IndexDocumentsResult>

Melakukan pencarian pada indeks saat ini mengingat argumen yang ditentukan.

Contoh

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

Parameter

searchText

string

Teks untuk dicari

options

SearchOptions<TModel, TFields>

Opsi untuk operasi pencarian.

Mengembalikan

Promise<SearchDocumentsResult<TModel, TFields>>

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

Mengembalikan daftar singkat saran berdasarkan searchText dan pemberi saran yang ditentukan.

Contoh

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

Parameter

searchText

string

Teks pencarian yang digunakan untuk menyarankan dokumen. Harus minimal 1 karakter, dan tidak lebih dari 100 karakter.

suggesterName

string

Nama pemberi saran seperti yang ditentukan dalam koleksi pemberi saran yang menjadi bagian dari definisi indeks.

options

SuggestOptions<TModel, TFields>

Opsi untuk operasi saran

Mengembalikan

Promise<SuggestDocumentsResult<TModel, TFields>>

uploadDocuments(TModel[], IndexDocumentsOptions)

Unggah array dokumen ke indeks.

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

Parameter

documents

TModel[]

Dokumen yang akan diunggah.

options
IndexDocumentsOptions

Opsi tambahan.

Mengembalikan

Promise<IndexDocumentsResult>