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: import { SearchIndexClient, AzureKeyCredential } from "@azure/search-documents"; const indexClient = new SearchIndexClient("<endpoint>", new AzureKeyCredential("<apiKey>"));

Properti

apiVersion	Versi API yang digunakan saat berkomunikasi dengan layanan.
endpoint	Titik akhir layanan pencarian
pipeline	Referensi ke alur HTTP internal untuk digunakan dengan permintaan mentah
serviceVersion	Versi API yang digunakan saat berkomunikasi dengan layanan.

Metode

analyzeText(string, AnalyzeTextOptions)	Memanggil penganalisis atau tokenizer secara manual pada teks yang disediakan.
createAlias(SearchAlias, OperationOptions)	Membuat alias pencarian baru.
createIndex(SearchIndex, OperationOptions)	Membuat indeks baru.
createKnowledgeBase(KnowledgeBase, CreateKnowledgeBaseOptions)	Membuat basis pengetahuan baru.
createKnowledgeSource(KnowledgeSource, CreateKnowledgeSourceOptions)	Membuat sumber pengetahuan baru.
createOrUpdateAlias(SearchAlias, CreateOrUpdateAliasOptions)	Membuat alias pencarian baru atau memperbarui alias jika sudah ada.
createOrUpdateIndex(SearchIndex, CreateOrUpdateIndexOptions)	Membuat indeks baru atau memodifikasi indeks yang sudah ada.
createOrUpdateKnowledgeBase(string, KnowledgeBase, CreateOrUpdateKnowledgeBaseOptions)	Membuat pangkalan pengetahuan baru atau memperbarui pangkalan pengetahuan jika sudah ada.
createOrUpdateKnowledgeSource(string, KnowledgeSource, CreateOrUpdateKnowledgeSourceOptions)
createOrUpdateSynonymMap(SynonymMap, CreateOrUpdateSynonymMapOptions)	Membuat SynonymMap baru atau memodifikasi yang sudah ada.
createSynonymMap(SynonymMap, OperationOptions)	Membuat SynonymMap baru di layanan pencarian.
deleteAlias(SearchAlias, DeleteAliasOptions)	Menghapus alias pencarian dan pemetaan terkait ke indeks. Operasi ini bersifat permanen, tanpa opsi pemulihan. Indeks yang dipetakan tidak tersentuh oleh operasi ini.
deleteAlias(string, DeleteAliasOptions)	Menghapus alias pencarian dan pemetaan terkait ke indeks. Operasi ini bersifat permanen, tanpa opsi pemulihan. Indeks yang dipetakan tidak tersentuh oleh operasi ini.
deleteIndex(SearchIndex, DeleteIndexOptions)	Menghapus indeks yang ada.
deleteIndex(string, DeleteIndexOptions)	Menghapus indeks yang ada.
deleteKnowledgeBase(KnowledgeBase, DeleteKnowledgeBaseOptions)	Menghapus basis pengetahuan yang ada.
deleteKnowledgeBase(string, DeleteKnowledgeBaseOptions)	Menghapus basis pengetahuan yang ada.
deleteKnowledgeSource(KnowledgeSource, DeleteKnowledgeSourceOptions)	Menghapus sumber yang ada.
deleteKnowledgeSource(string, DeleteKnowledgeSourceOptions)	Menghapus sumber yang ada.
deleteSynonymMap(string | SynonymMap, DeleteSynonymMapOptions)	Menghapus SynonymMap yang ada.
getAlias(string, OperationOptions)	Mengambil definisi alias.
getIndex(string, OperationOptions)	Mengambil informasi tentang indeks.
getIndexStatistics(string, OperationOptions)	Mengambil statistik tentang indeks, seperti jumlah dokumen dan ukuran penyimpanan indeks.
getIndexStatsSummary(GetIndexStatsSummaryOptions)	Mengambil daftar indeks yang ada dalam layanan.
getKnowledgeBase(string, GetKnowledgeBaseOptions)	Mengambil definisi basis pengetahuan.
getKnowledgeRetrievalClient(string, KnowledgeRetrievalClientOptions)	Mengambil KnowledgeRetrievalClient yang sesuai dengan SearchIndexClient ini
getKnowledgeSource(string, GetKnowledgeSourceOptions)	Mengambil definisi sumber pengetahuan.
getKnowledgeSourceStatus(string, GetKnowledgeSourceStatusOptions)	Mengembalikan status saat ini dan riwayat sinkronisasi sumber pengetahuan.
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.
listAliases(OperationOptions)	Mencantumkan semua alias yang tersedia untuk layanan pencarian.
listIndexes(OperationOptions)	Mengambil daftar indeks yang ada dalam layanan.
listIndexesNames(OperationOptions)	Mengambil daftar nama indeks yang ada dalam layanan.
listKnowledgeBases(ListKnowledgeBasesOptions)	Mengambil daftar Basis Pengetahuan yang ada dalam layanan.
listKnowledgeSources(ListKnowledgeSourcesOptions)	Mengambil daftar KnowledgeSources 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:

import { SearchIndexClient, AzureKeyCredential } from "@azure/search-documents";

const indexClient = new SearchIndexClient("<endpoint>", new AzureKeyCredential("<apiKey>"));

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

pipeline

Referensi ke alur HTTP internal untuk digunakan dengan permintaan mentah

pipeline: Pipeline

Nilai Properti

Pipeline

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>

createAlias(SearchAlias, OperationOptions)

Membuat alias pencarian baru.

function createAlias(alias: SearchAlias, options?: OperationOptions): Promise<SearchAlias>

Parameter

alias

SearchAlias

Definisi alias untuk membuat.

options

OperationOptions

Parameter opsi.

Mengembalikan

Promise<SearchAlias>

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>

createKnowledgeBase(KnowledgeBase, CreateKnowledgeBaseOptions)

Membuat basis pengetahuan baru.

function createKnowledgeBase(knowledgeBase: KnowledgeBase, options?: CreateKnowledgeBaseOptions): Promise<KnowledgeBase>

Parameter

knowledgeBase

KnowledgeBase

definisi basis pengetahuan yang akan dibuat.

options

CreateKnowledgeBaseOptions

opsi.

Mengembalikan

Promise<KnowledgeBase>

createKnowledgeSource(KnowledgeSource, CreateKnowledgeSourceOptions)

Membuat sumber pengetahuan baru.

function createKnowledgeSource(knowledgeSource: KnowledgeSource, options?: CreateKnowledgeSourceOptions): Promise<KnowledgeSource>

Parameter

knowledgeSource

KnowledgeSource

Definisi sumber pengetahuan untuk dibuat.

options

CreateKnowledgeSourceOptions

Parameter opsi.

Mengembalikan

Promise<KnowledgeSource>

createOrUpdateAlias(SearchAlias, CreateOrUpdateAliasOptions)

Membuat alias pencarian baru atau memperbarui alias jika sudah ada.

function createOrUpdateAlias(alias: SearchAlias, options?: CreateOrUpdateAliasOptions): Promise<SearchAlias>

Parameter

alias

SearchAlias

Definisi alias untuk membuat atau memperbarui.

options

CreateOrUpdateAliasOptions

Parameter opsi.

Mengembalikan

Promise<SearchAlias>

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>

createOrUpdateKnowledgeBase(string, KnowledgeBase, CreateOrUpdateKnowledgeBaseOptions)

Membuat pangkalan pengetahuan baru atau memperbarui pangkalan pengetahuan jika sudah ada.

function createOrUpdateKnowledgeBase(knowledgeBaseName: string, knowledgeBase: KnowledgeBase, options?: CreateOrUpdateKnowledgeBaseOptions): Promise<KnowledgeBase>

Parameter

knowledgeBaseName

string

nama Basis Pengetahuan yang akan dibuat atau diperbarui.

knowledgeBase

KnowledgeBase

definisi basis pengetahuan untuk dibuat atau diperbarui.

options

CreateOrUpdateKnowledgeBaseOptions

opsi.

Mengembalikan

Promise<KnowledgeBase>

createOrUpdateKnowledgeSource(string, KnowledgeSource, CreateOrUpdateKnowledgeSourceOptions)

function createOrUpdateKnowledgeSource(sourceName: string, knowledgeSource: KnowledgeSource, options?: CreateOrUpdateKnowledgeSourceOptions): Promise<KnowledgeSource>

Parameter

sourceName

string

knowledgeSource

KnowledgeSource

options

CreateOrUpdateKnowledgeSourceOptions

Mengembalikan

Promise<KnowledgeSource>

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>

deleteAlias(SearchAlias, DeleteAliasOptions)

Menghapus alias pencarian dan pemetaan terkait ke indeks. Operasi ini bersifat permanen, tanpa opsi pemulihan. Indeks yang dipetakan tidak tersentuh oleh operasi ini.

function deleteAlias(alias: SearchAlias, options?: DeleteAliasOptions): Promise<void>

Parameter

alias

SearchAlias

Alias untuk dihapus.

options

DeleteAliasOptions

Argumen opsional tambahan.

Mengembalikan

Promise<void>

deleteAlias(string, DeleteAliasOptions)

Menghapus alias pencarian dan pemetaan terkait ke indeks. Operasi ini bersifat permanen, tanpa opsi pemulihan. Indeks yang dipetakan tidak tersentuh oleh operasi ini.

function deleteAlias(aliasName: string, options?: DeleteAliasOptions): Promise<void>

Parameter

aliasName

string

Nama alias yang akan dihapus.

options

DeleteAliasOptions

Argumen opsional tambahan.

Mengembalikan

Promise<void>

deleteIndex(SearchIndex, DeleteIndexOptions)

Menghapus indeks yang ada.

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

Parameter

index

SearchIndex

Indeks yang akan dihapus.

options

DeleteIndexOptions

Argumen opsional tambahan.

Mengembalikan

Promise<void>

deleteIndex(string, DeleteIndexOptions)

Menghapus indeks yang ada.

function deleteIndex(indexName: string, options?: DeleteIndexOptions): Promise<void>

Parameter

indexName

string

Nama indeks yang akan dihapus.

options

DeleteIndexOptions

Argumen opsional tambahan.

Mengembalikan

Promise<void>

deleteKnowledgeBase(KnowledgeBase, DeleteKnowledgeBaseOptions)

Menghapus basis pengetahuan yang ada.

function deleteKnowledgeBase(knowledgeBase: KnowledgeBase, options?: DeleteKnowledgeBaseOptions): Promise<void>

Parameter

knowledgeBase

KnowledgeBase

Basis pengetahuan untuk dihapus.

options

DeleteKnowledgeBaseOptions

opsi.

Mengembalikan

Promise<void>

deleteKnowledgeBase(string, DeleteKnowledgeBaseOptions)

Menghapus basis pengetahuan yang ada.

function deleteKnowledgeBase(knowledgeBaseName: string, options?: DeleteKnowledgeBaseOptions): Promise<void>

Parameter

knowledgeBaseName

string

nama Pangkalan Pengetahuan yang akan dihapus.

options

DeleteKnowledgeBaseOptions

opsi.

Mengembalikan

Promise<void>

deleteKnowledgeSource(KnowledgeSource, DeleteKnowledgeSourceOptions)

Menghapus sumber yang ada.

function deleteKnowledgeSource(source: KnowledgeSource, options?: DeleteKnowledgeSourceOptions): Promise<void>

Parameter

source

KnowledgeSource

sumber pengetahuan yang akan dihapus.

options

DeleteKnowledgeSourceOptions

opsi.

Mengembalikan

Promise<void>

deleteKnowledgeSource(string, DeleteKnowledgeSourceOptions)

Menghapus sumber yang ada.

function deleteKnowledgeSource(sourceName: string, options?: DeleteKnowledgeSourceOptions): Promise<void>

Parameter

sourceName

string

nama sumber pengetahuan yang akan dihapus.

options

DeleteKnowledgeSourceOptions

opsi.

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>

getAlias(string, OperationOptions)

Mengambil definisi alias.

function getAlias(aliasName: string, options?: OperationOptions): Promise<SearchAlias>

Parameter

aliasName

string

Nama alias yang akan diambil.

options

OperationOptions

Parameter opsi.

Mengembalikan

Promise<SearchAlias>

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>

getIndexStatsSummary(GetIndexStatsSummaryOptions)

Mengambil daftar indeks yang ada dalam layanan.

function getIndexStatsSummary(options?: GetIndexStatsSummaryOptions): IndexStatisticsSummaryIterator

Parameter

options

GetIndexStatsSummaryOptions

Opsi untuk operasi indeks daftar.

Mengembalikan

IndexStatisticsSummaryIterator

getKnowledgeBase(string, GetKnowledgeBaseOptions)

Mengambil definisi basis pengetahuan.

function getKnowledgeBase(knowledgeBaseName: string, options?: GetKnowledgeBaseOptions): Promise<KnowledgeBase>

Parameter

knowledgeBaseName

string

nama basis pengetahuan yang akan diambil.

options

GetKnowledgeBaseOptions

opsi.

Mengembalikan

Promise<KnowledgeBase>

getKnowledgeRetrievalClient(string, KnowledgeRetrievalClientOptions)

Mengambil KnowledgeRetrievalClient yang sesuai dengan SearchIndexClient ini

function getKnowledgeRetrievalClient(knowledgeBaseName: string, options?: KnowledgeRetrievalClientOptions): KnowledgeRetrievalClient

Parameter

knowledgeBaseName

string

Nama basis pengetahuan

options

KnowledgeRetrievalClientOptions

Opsi KnowledgeRetrievalClient

Mengembalikan

KnowledgeRetrievalClient

getKnowledgeSource(string, GetKnowledgeSourceOptions)

Mengambil definisi sumber pengetahuan.

function getKnowledgeSource(sourceName: string, options?: GetKnowledgeSourceOptions): Promise<KnowledgeSource>

Parameter

sourceName

string

Nama sumber pengetahuan yang akan diambil.

options

GetKnowledgeSourceOptions

Parameter opsi.

Mengembalikan

Promise<KnowledgeSource>

getKnowledgeSourceStatus(string, GetKnowledgeSourceStatusOptions)

Mengembalikan status saat ini dan riwayat sinkronisasi sumber pengetahuan.

function getKnowledgeSourceStatus(sourceName: string, options?: GetKnowledgeSourceStatusOptions): Promise<KnowledgeSourceStatus>

Parameter

sourceName

string

Nama sumber pengetahuan yang akan diambil statusnya.

options

GetKnowledgeSourceStatusOptions

Parameter opsi.

Mengembalikan

Promise<KnowledgeSourceStatus>

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>

listAliases(OperationOptions)

Mencantumkan semua alias yang tersedia untuk layanan pencarian.

function listAliases(options?: OperationOptions): AliasIterator

Parameter

options

OperationOptions

Parameter opsi.

Mengembalikan

AliasIterator

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

listKnowledgeBases(ListKnowledgeBasesOptions)

Mengambil daftar Basis Pengetahuan yang ada dalam layanan.

function listKnowledgeBases(options?: ListKnowledgeBasesOptions): KnowledgeBaseIterator

Parameter

options

ListKnowledgeBasesOptions

Opsi untuk operasi daftar basis pengetahuan.

Mengembalikan

KnowledgeBaseIterator

listKnowledgeSources(ListKnowledgeSourcesOptions)

Mengambil daftar KnowledgeSources yang ada dalam layanan.

function listKnowledgeSources(options?: ListKnowledgeSourcesOptions): KnowledgeSourceIterator

Parameter

options

ListKnowledgeSourcesOptions

Opsi untuk operasi daftar sumber pengetahuan.

Mengembalikan

KnowledgeSourceIterator

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