SearchIndexerClient class

Paket:

@azure/search-documents

Kelas untuk melakukan operasi untuk mengelola pengindeks (buat, perbarui, daftar/hapus), sumber data & skillset.

Konstruktor

SearchIndexerClient(string, KeyCredential | TokenCredential, SearchIndexerClientOptions)

Membuat instans SearchIndexerClient. Contoh penggunaan: import { SearchIndexerClient, AzureKeyCredential } from "@azure/search-documents"; const indexerClient = new SearchIndexerClient("<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

createDataSourceConnection(SearchIndexerDataSourceConnection, OperationOptions)	Membuat dataSource baru di layanan pencarian.
createIndexer(SearchIndexer, OperationOptions)	Membuat pengindeks baru di layanan pencarian.
createOrUpdateDataSourceConnection(SearchIndexerDataSourceConnection, CreateorUpdateDataSourceConnectionOptions)	Membuat sumber data baru atau memodifikasi sumber data yang sudah ada.
createOrUpdateIndexer(SearchIndexer, CreateorUpdateIndexerOptions)	Membuat pengindeks baru atau memodifikasi pengindeks yang sudah ada.
createOrUpdateSkillset(SearchIndexerSkillset, CreateOrUpdateSkillsetOptions)	Membuat Skillset baru atau memodifikasi skillset yang sudah ada.
createSkillset(SearchIndexerSkillset, OperationOptions)	Membuat set keterampilan baru di layanan pencarian.
deleteDataSourceConnection(string | SearchIndexerDataSourceConnection, DeleteDataSourceConnectionOptions)	Menghapus sumber data yang ada.
deleteIndexer(string | SearchIndexer, DeleteIndexerOptions)	Menghapus pengindeks yang ada.
deleteSkillset(string | SearchIndexerSkillset, DeleteSkillsetOptions)	Menghapus Skillset yang ada.
getDataSourceConnection(string, OperationOptions)	Mengambil informasi tentang DataSource
getIndexer(string, OperationOptions)	Mengambil informasi tentang Pengindeks.
getIndexerStatus(string, OperationOptions)	Mengembalikan status saat ini dan riwayat eksekusi pengindeks.
getSkillset(string, OperationOptions)	Mengambil informasi tentang Skillset.
listDataSourceConnections(OperationOptions)	Mengambil daftar sumber data yang ada dalam layanan.
listDataSourceConnectionsNames(OperationOptions)	Mengambil daftar nama sumber data yang ada dalam layanan.
listIndexers(OperationOptions)	Mengambil daftar pengindeks yang ada dalam layanan.
listIndexersNames(OperationOptions)	Mengambil daftar nama pengindeks yang ada dalam layanan.
listSkillsets(OperationOptions)	Mengambil daftar Skillset yang ada dalam layanan.
listSkillsetsNames(OperationOptions)	Mengambil daftar nama Skillset yang ada dalam layanan.
resetDocuments(string, ResetDocumentsOptions)	Mengatur ulang dokumen tertentu dalam sumber data untuk diserap ulang secara selektif oleh pengindeks.
resetIndexer(string, OperationOptions)	Mengatur ulang status pelacakan perubahan yang terkait dengan pengindeks.
resetSkills(string, ResetSkillsOptions)	Reset set keterampilan yang ada di layanan pencarian.
runIndexer(string, OperationOptions)	Menjalankan pengindeks sesuai permintaan.

Detail Konstruktor

SearchIndexerClient(string, KeyCredential | TokenCredential, SearchIndexerClientOptions)

Membuat instans SearchIndexerClient.

Contoh penggunaan:

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

const indexerClient = new SearchIndexerClient("<endpoint>", new AzureKeyCredential("<apiKey>"));

new SearchIndexerClient(endpoint: string, credential: KeyCredential | TokenCredential, options?: SearchIndexerClientOptions)

Parameter

endpoint

string

Titik akhir layanan pencarian

credential

KeyCredential | TokenCredential

Digunakan untuk mengautentikasi permintaan ke layanan.

options

SearchIndexerClientOptions

Digunakan untuk mengonfigurasi klien 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

createDataSourceConnection(SearchIndexerDataSourceConnection, OperationOptions)

Membuat dataSource baru di layanan pencarian.

function createDataSourceConnection(dataSourceConnection: SearchIndexerDataSourceConnection, options?: OperationOptions): Promise<SearchIndexerDataSourceConnection>

Parameter

dataSourceConnection

SearchIndexerDataSourceConnection

Definisi dataSource untuk dibuat di layanan pencarian.

options

OperationOptions

Argumen opsional tambahan.

Mengembalikan

Promise<SearchIndexerDataSourceConnection>

createIndexer(SearchIndexer, OperationOptions)

Membuat pengindeks baru di layanan pencarian.

function createIndexer(indexer: SearchIndexer, options?: OperationOptions): Promise<SearchIndexer>

Parameter

indexer

SearchIndexer

Definisi pengindeks untuk dibuat di layanan pencarian.

options

OperationOptions

Argumen opsional tambahan.

Mengembalikan

Promise<SearchIndexer>

createOrUpdateDataSourceConnection(SearchIndexerDataSourceConnection, CreateorUpdateDataSourceConnectionOptions)

Membuat sumber data baru atau memodifikasi sumber data yang sudah ada.

function createOrUpdateDataSourceConnection(dataSourceConnection: SearchIndexerDataSourceConnection, options?: CreateorUpdateDataSourceConnectionOptions): Promise<SearchIndexerDataSourceConnection>

Parameter

dataSourceConnection

SearchIndexerDataSourceConnection

Informasi yang menjelaskan sumber data yang akan dibuat/diperbarui.

options

CreateorUpdateDataSourceConnectionOptions

Argumen opsional tambahan.

Mengembalikan

Promise<SearchIndexerDataSourceConnection>

createOrUpdateIndexer(SearchIndexer, CreateorUpdateIndexerOptions)

Membuat pengindeks baru atau memodifikasi pengindeks yang sudah ada.

function createOrUpdateIndexer(indexer: SearchIndexer, options?: CreateorUpdateIndexerOptions): Promise<SearchIndexer>

Parameter

indexer

SearchIndexer

Informasi yang menjelaskan pengindeks yang akan dibuat/diperbarui.

options

CreateorUpdateIndexerOptions

Argumen opsional tambahan.

Mengembalikan

Promise<SearchIndexer>

createOrUpdateSkillset(SearchIndexerSkillset, CreateOrUpdateSkillsetOptions)

Membuat Skillset baru atau memodifikasi skillset yang sudah ada.

function createOrUpdateSkillset(skillset: SearchIndexerSkillset, options?: CreateOrUpdateSkillsetOptions): Promise<SearchIndexerSkillset>

Parameter

skillset

SearchIndexerSkillset

Informasi yang menjelaskan indeks yang akan dibuat.

options

CreateOrUpdateSkillsetOptions

Argumen opsional tambahan.

Mengembalikan

Promise<SearchIndexerSkillset>

createSkillset(SearchIndexerSkillset, OperationOptions)

Membuat set keterampilan baru di layanan pencarian.

function createSkillset(skillset: SearchIndexerSkillset, options?: OperationOptions): Promise<SearchIndexerSkillset>

Parameter

skillset

SearchIndexerSkillset

Set keterampilan yang berisi satu atau beberapa keterampilan untuk dibuat dalam layanan pencarian.

options

OperationOptions

Argumen opsional tambahan.

Mengembalikan

Promise<SearchIndexerSkillset>

deleteDataSourceConnection(string | SearchIndexerDataSourceConnection, DeleteDataSourceConnectionOptions)

Menghapus sumber data yang ada.

function deleteDataSourceConnection(dataSourceConnection: string | SearchIndexerDataSourceConnection, options?: DeleteDataSourceConnectionOptions): Promise<void>

Parameter

dataSourceConnection

string | SearchIndexerDataSourceConnection

options

DeleteDataSourceConnectionOptions

Argumen opsional tambahan.

Mengembalikan

Promise<void>

deleteIndexer(string | SearchIndexer, DeleteIndexerOptions)

Menghapus pengindeks yang ada.

function deleteIndexer(indexer: string | SearchIndexer, options?: DeleteIndexerOptions): Promise<void>

Parameter

indexer

string | SearchIndexer

Pengindeks/Nama pengindeks yang akan dihapus.

options

DeleteIndexerOptions

Argumen opsional tambahan.

Mengembalikan

Promise<void>

deleteSkillset(string | SearchIndexerSkillset, DeleteSkillsetOptions)

Menghapus Skillset yang ada.

function deleteSkillset(skillset: string | SearchIndexerSkillset, options?: DeleteSkillsetOptions): Promise<void>

Parameter

skillset

string | SearchIndexerSkillset

Skillset/Nama Skillset yang akan dihapus.

options

DeleteSkillsetOptions

Argumen opsional tambahan.

Mengembalikan

Promise<void>

getDataSourceConnection(string, OperationOptions)

Mengambil informasi tentang DataSource

function getDataSourceConnection(dataSourceConnectionName: string, options?: OperationOptions): Promise<SearchIndexerDataSourceConnection>

Parameter

dataSourceConnectionName

string

options

OperationOptions

Argumen opsional tambahan

Mengembalikan

Promise<SearchIndexerDataSourceConnection>

getIndexer(string, OperationOptions)

Mengambil informasi tentang Pengindeks.

function getIndexer(indexerName: string, options?: OperationOptions): Promise<SearchIndexer>

Parameter

indexerName

string

Nama Pengindeks.

options

OperationOptions

Argumen opsional tambahan.

Mengembalikan

Promise<SearchIndexer>

getIndexerStatus(string, OperationOptions)

Mengembalikan status saat ini dan riwayat eksekusi pengindeks.

function getIndexerStatus(indexerName: string, options?: OperationOptions): Promise<SearchIndexerStatus>

Parameter

indexerName

string

Nama pengindeks.

options

OperationOptions

Argumen opsional tambahan.

Mengembalikan

Promise<SearchIndexerStatus>

getSkillset(string, OperationOptions)

Mengambil informasi tentang Skillset.

function getSkillset(skillsetName: string, options?: OperationOptions): Promise<SearchIndexerSkillset>

Parameter

skillsetName

string

options

OperationOptions

Argumen opsional tambahan.

Mengembalikan

Promise<SearchIndexerSkillset>

listDataSourceConnections(OperationOptions)

Mengambil daftar sumber data yang ada dalam layanan.

function listDataSourceConnections(options?: OperationOptions): Promise<SearchIndexerDataSourceConnection[]>

Parameter

options

OperationOptions

Opsi untuk operasi pengindeks daftar.

Mengembalikan

Promise<SearchIndexerDataSourceConnection[]>

listDataSourceConnectionsNames(OperationOptions)

Mengambil daftar nama sumber data yang ada dalam layanan.

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

Parameter

options

OperationOptions

Opsi untuk operasi pengindeks daftar.

Mengembalikan

Promise<string[]>

listIndexers(OperationOptions)

Mengambil daftar pengindeks yang ada dalam layanan.

function listIndexers(options?: OperationOptions): Promise<SearchIndexer[]>

Parameter

options

OperationOptions

Opsi untuk operasi pengindeks daftar.

Mengembalikan

Promise<SearchIndexer[]>

listIndexersNames(OperationOptions)

Mengambil daftar nama pengindeks yang ada dalam layanan.

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

Parameter

options

OperationOptions

Opsi untuk operasi pengindeks daftar.

Mengembalikan

Promise<string[]>

listSkillsets(OperationOptions)

Mengambil daftar Skillset yang ada dalam layanan.

function listSkillsets(options?: OperationOptions): Promise<SearchIndexerSkillset[]>

Parameter

options

OperationOptions

Opsi untuk daftar operasi Skillsets.

Mengembalikan

Promise<SearchIndexerSkillset[]>

listSkillsetsNames(OperationOptions)

Mengambil daftar nama Skillset yang ada dalam layanan.

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

Parameter

options

OperationOptions

Opsi untuk daftar operasi Skillsets.

Mengembalikan

Promise<string[]>

resetDocuments(string, ResetDocumentsOptions)

Mengatur ulang dokumen tertentu dalam sumber data untuk diserap ulang secara selektif oleh pengindeks.

function resetDocuments(indexerName: string, options?: ResetDocumentsOptions): Promise<void>

Parameter

indexerName

string

Nama pengindeks untuk mengatur ulang dokumen.

options

ResetDocumentsOptions

Argumen opsional tambahan.

Mengembalikan

Promise<void>

resetIndexer(string, OperationOptions)

Mengatur ulang status pelacakan perubahan yang terkait dengan pengindeks.

function resetIndexer(indexerName: string, options?: OperationOptions): Promise<void>

Parameter

indexerName

string

Nama pengindeks yang akan direset.

options

OperationOptions

Argumen opsional tambahan.

Mengembalikan

Promise<void>

resetSkills(string, ResetSkillsOptions)

Reset set keterampilan yang ada di layanan pencarian.

function resetSkills(skillsetName: string, options?: ResetSkillsOptions): Promise<void>

Parameter

skillsetName

string

Nama set keterampilan yang akan direset.

options

ResetSkillsOptions

Parameter opsi.

Mengembalikan

Promise<void>

runIndexer(string, OperationOptions)

Menjalankan pengindeks sesuai permintaan.

function runIndexer(indexerName: string, options?: OperationOptions): Promise<void>

Parameter

indexerName

string

Nama pengindeks yang akan dijalankan.

options

OperationOptions

Argumen opsional tambahan.

Mengembalikan

Promise<void>