SearchIndexClient class

Paket:

@azure/search-documents

Kelas untuk melakukan operasi untuk mengelola (membuat, memperbarui, mencantumkan/menghapus) indeks, & sinonim.

Konstruktor

SearchIndexClient(string, KeyCredential | TokenCredential, SearchIndexClientOptions)

Membuat instans SearchIndexClient. Contoh penggunaan: const { SearchIndexClient, AzureKeyCredential } = require("@azure/search-documents"); const client = new SearchIndexClient( "<endpoint>", new AzureKeyCredential("<Admin Key>"); );

Properti

apiVersion	Versi API yang digunakan saat berkomunikasi dengan layanan.
endpoint	Titik akhir layanan pencarian
serviceVersion	Versi API yang digunakan saat berkomunikasi dengan layanan.

Metode

analyzeText(string, AnalyzeTextOptions)	Memanggil penganalisis atau tokenizer secara manual pada teks yang disediakan.
createIndex(SearchIndex, OperationOptions)	Membuat indeks baru.
createOrUpdateIndex(SearchIndex, CreateOrUpdateIndexOptions)	Membuat indeks baru atau memodifikasi indeks yang sudah ada.
createOrUpdateSynonymMap(SynonymMap, CreateOrUpdateSynonymMapOptions)	Membuat SynonymMap baru atau memodifikasi yang sudah ada.
createSynonymMap(SynonymMap, OperationOptions)	Membuat SynonymMap baru di layanan pencarian.
deleteIndex(string | SearchIndex, DeleteIndexOptions)	Menghapus indeks yang ada.
deleteSynonymMap(string | SynonymMap, DeleteSynonymMapOptions)	Menghapus SynonymMap yang ada.
getIndex(string, OperationOptions)	Mengambil informasi tentang indeks.
getIndexStatistics(string, OperationOptions)	Mengambil statistik tentang indeks, seperti jumlah dokumen dan ukuran penyimpanan indeks.
getSearchClient<TModel>(string, SearchClientOptions)	Mengambil SearchClient yang sesuai dengan SearchIndexClient ini
getServiceStatistics(OperationOptions)	Mengambil statistik tentang layanan, seperti jumlah dokumen, indeks, dll.
getSynonymMap(string, OperationOptions)	Mengambil informasi tentang SynonymMap.
listIndexes(OperationOptions)	Mengambil daftar indeks yang ada dalam layanan.
listIndexesNames(OperationOptions)	Mengambil daftar nama indeks yang ada dalam layanan.
listSynonymMaps(OperationOptions)	Mengambil daftar SynonymMaps yang ada dalam layanan.
listSynonymMapsNames(OperationOptions)	Mengambil daftar nama SynonymMaps yang ada dalam layanan.

Detail Konstruktor

SearchIndexClient(string, KeyCredential | TokenCredential, SearchIndexClientOptions)

Membuat instans SearchIndexClient.

Contoh penggunaan:

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

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

new SearchIndexClient(endpoint: string, credential: KeyCredential | TokenCredential, options?: SearchIndexClientOptions)

Parameter

endpoint

string

Titik akhir layanan pencarian

credential

KeyCredential | TokenCredential

Digunakan untuk mengautentikasi permintaan ke layanan.

options

SearchIndexClientOptions

Digunakan untuk mengonfigurasi klien Indeks Pencarian.

Detail Properti

apiVersion

Peringatan

API ini sudah tidak digunakan lagi.

use {@Link serviceVersion} instead

Versi API yang digunakan saat berkomunikasi dengan layanan.

apiVersion: string

Nilai Properti

string

endpoint

Titik akhir layanan pencarian

endpoint: string

Nilai Properti

string

serviceVersion

Versi API yang digunakan saat berkomunikasi dengan layanan.

serviceVersion: string

Nilai Properti

string

Detail Metode

analyzeText(string, AnalyzeTextOptions)

Memanggil penganalisis atau tokenizer secara manual pada teks yang disediakan.

function analyzeText(indexName: string, options: AnalyzeTextOptions): Promise<AnalyzeResult>

Parameter

indexName

string

Nama indeks yang berisi bidang yang akan dianalisis

options

AnalyzeTextOptions

Argumen tambahan

Mengembalikan

Promise<AnalyzeResult>

createIndex(SearchIndex, OperationOptions)

Membuat indeks baru.

function createIndex(index: SearchIndex, options?: OperationOptions): Promise<SearchIndex>

Parameter

index

SearchIndex

Informasi yang menjelaskan indeks yang akan dibuat.

options

OperationOptions

Argumen opsional tambahan.

Mengembalikan

Promise<SearchIndex>

createOrUpdateIndex(SearchIndex, CreateOrUpdateIndexOptions)

Membuat indeks baru atau memodifikasi indeks yang sudah ada.

function createOrUpdateIndex(index: SearchIndex, options?: CreateOrUpdateIndexOptions): Promise<SearchIndex>

Parameter

index

SearchIndex

Informasi yang menjelaskan indeks yang akan dibuat.

options

CreateOrUpdateIndexOptions

Argumen opsional tambahan.

Mengembalikan

Promise<SearchIndex>

createOrUpdateSynonymMap(SynonymMap, CreateOrUpdateSynonymMapOptions)

Membuat SynonymMap baru atau memodifikasi yang sudah ada.

function createOrUpdateSynonymMap(synonymMap: SynonymMap, options?: CreateOrUpdateSynonymMapOptions): Promise<SynonymMap>

Parameter

synonymMap

SynonymMap

Informasi yang menjelaskan SynonymMap yang akan dibuat.

options

CreateOrUpdateSynonymMapOptions

Argumen opsional tambahan.

Mengembalikan

Promise<SynonymMap>

createSynonymMap(SynonymMap, OperationOptions)

Membuat SynonymMap baru di layanan pencarian.

function createSynonymMap(synonymMap: SynonymMap, options?: OperationOptions): Promise<SynonymMap>

Parameter

synonymMap

SynonymMap

Definisi synonymMap untuk dibuat di layanan pencarian.

options

OperationOptions

Argumen opsional tambahan.

Mengembalikan

Promise<SynonymMap>

deleteIndex(string | SearchIndex, DeleteIndexOptions)

Menghapus indeks yang ada.

function deleteIndex(index: string | SearchIndex, options?: DeleteIndexOptions): Promise<void>

Parameter

index

string | SearchIndex

options

DeleteIndexOptions

Argumen opsional tambahan.

Mengembalikan

Promise<void>

deleteSynonymMap(string | SynonymMap, DeleteSynonymMapOptions)

Menghapus SynonymMap yang ada.

function deleteSynonymMap(synonymMap: string | SynonymMap, options?: DeleteSynonymMapOptions): Promise<void>

Parameter

synonymMap

string | SynonymMap

options

DeleteSynonymMapOptions

Argumen opsional tambahan.

Mengembalikan

Promise<void>

getIndex(string, OperationOptions)

Mengambil informasi tentang indeks.

function getIndex(indexName: string, options?: OperationOptions): Promise<SearchIndex>

Parameter

indexName

string

Nama indeks.

options

OperationOptions

Argumen opsional tambahan.

Mengembalikan

Promise<SearchIndex>

getIndexStatistics(string, OperationOptions)

Mengambil statistik tentang indeks, seperti jumlah dokumen dan ukuran penyimpanan indeks.

function getIndexStatistics(indexName: string, options?: OperationOptions): Promise<SearchIndexStatistics>

Parameter

indexName

string

Nama indeks.

options

OperationOptions

Argumen opsional tambahan.

Mengembalikan

Promise<SearchIndexStatistics>

getSearchClient<TModel>(string, SearchClientOptions)

Mengambil SearchClient yang sesuai dengan SearchIndexClient ini

function getSearchClient<TModel>(indexName: string, options?: SearchClientOptions): SearchClient<TModel>

Parameter

indexName

string

Nama indeks

options

SearchClientOptions

Opsi SearchClient

Mengembalikan

SearchClient<TModel>

getServiceStatistics(OperationOptions)

Mengambil statistik tentang layanan, seperti jumlah dokumen, indeks, dll.

function getServiceStatistics(options?: OperationOptions): Promise<SearchServiceStatistics>

Parameter

options

OperationOptions

Argumen opsional tambahan.

Mengembalikan

Promise<SearchServiceStatistics>

getSynonymMap(string, OperationOptions)

Mengambil informasi tentang SynonymMap.

function getSynonymMap(synonymMapName: string, options?: OperationOptions): Promise<SynonymMap>

Parameter

synonymMapName

string

Nama SynonymMap.

options

OperationOptions

Argumen opsional tambahan.

Mengembalikan

Promise<SynonymMap>

listIndexes(OperationOptions)

Mengambil daftar indeks yang ada dalam layanan.

function listIndexes(options?: OperationOptions): IndexIterator

Parameter

options

OperationOptions

Opsi untuk operasi indeks daftar.

Mengembalikan

IndexIterator

listIndexesNames(OperationOptions)

Mengambil daftar nama indeks yang ada dalam layanan.

function listIndexesNames(options?: OperationOptions): IndexNameIterator

Parameter

options

OperationOptions

Opsi untuk operasi indeks daftar.

Mengembalikan

IndexNameIterator

listSynonymMaps(OperationOptions)

Mengambil daftar SynonymMaps yang ada dalam layanan.

function listSynonymMaps(options?: OperationOptions): Promise<SynonymMap[]>

Parameter

options

OperationOptions

Opsi untuk daftar operasi SynonymMaps.

Mengembalikan

Promise<SynonymMap[]>

listSynonymMapsNames(OperationOptions)

Mengambil daftar nama SynonymMaps yang ada dalam layanan.

function listSynonymMapsNames(options?: OperationOptions): Promise<string[]>

Parameter

options

OperationOptions

Opsi untuk daftar operasi SynonymMaps.

Mengembalikan

Promise<string[]>