Bagikan melalui

WebApiSkill interface

  • Referensi
Paket:
@azure/search-documents

Keterampilan yang dapat memanggil titik akhir API Web, memungkinkan Anda memperluas set keterampilan dengan memanggil kode kustom Anda.

Memperluas
BaseSearchIndexerSkill

Properti

authIdentity

Identitas terkelola yang ditetapkan pengguna yang digunakan untuk koneksi keluar. Jika authResourceId disediakan dan tidak ditentukan, identitas terkelola yang ditetapkan sistem akan digunakan. Pada pembaruan pengindeks, jika identitas tidak ditentukan, nilainya tetap tidak berubah. Jika tidak ditentukan, nilai properti ini dihapus.
authResourceId

Berlaku untuk keterampilan kustom yang terhubung ke kode eksternal dalam fungsi Azure atau beberapa aplikasi lain yang menyediakan transformasi. Nilai ini harus berupa ID aplikasi yang dibuat untuk fungsi atau aplikasi saat terdaftar di Azure Active Directory. Ketika ditentukan, keterampilan kustom terhubung ke fungsi atau aplikasi menggunakan ID terkelola (baik sistem atau yang ditetapkan pengguna) dari layanan pencarian dan token akses fungsi atau aplikasi, menggunakan nilai ini sebagai id sumber daya untuk membuat cakupan token akses.
batchSize

Ukuran batch yang diinginkan yang menunjukkan jumlah dokumen.
degreeOfParallelism

Jika diatur, jumlah panggilan paralel yang dapat dilakukan ke API Web.
httpHeaders

Header yang diperlukan untuk membuat permintaan http.
httpMethod

Metode untuk permintaan http.
odatatype

Diskriminator polimorfik, yang menentukan berbagai jenis objek ini dapat
timeout

Batas waktu yang diinginkan untuk permintaan. Defaultnya adalah 30 detik.
uri

Url untuk API Web.

Properti yang Diwariskan

context

Mewakili tingkat di mana operasi berlangsung, seperti akar dokumen atau konten dokumen (misalnya, /document atau /document/content). Defaultnya adalah /document.
description

Deskripsi keterampilan yang menjelaskan input, output, dan penggunaan keterampilan.
inputs

Input keterampilan bisa menjadi kolom dalam himpunan data sumber, atau output keterampilan hulu.
name

Nama keterampilan yang secara unik mengidentifikasinya dalam set keterampilan. Keterampilan tanpa nama yang ditentukan akan diberi nama default indeks berbasis 1 dalam array keterampilan, diawali dengan karakter '#'.
outputs

Output keterampilan adalah bidang dalam indeks pencarian, atau nilai yang dapat dikonsumsi sebagai input oleh keterampilan lain.

Detail Properti

authIdentity

Identitas terkelola yang ditetapkan pengguna yang digunakan untuk koneksi keluar. Jika authResourceId disediakan dan tidak ditentukan, identitas terkelola yang ditetapkan sistem akan digunakan. Pada pembaruan pengindeks, jika identitas tidak ditentukan, nilainya tetap tidak berubah. Jika tidak ditentukan, nilai properti ini dihapus.

authIdentity?: SearchIndexerDataIdentity

Nilai Properti

SearchIndexerDataIdentity

authResourceId

Berlaku untuk keterampilan kustom yang terhubung ke kode eksternal dalam fungsi Azure atau beberapa aplikasi lain yang menyediakan transformasi. Nilai ini harus berupa ID aplikasi yang dibuat untuk fungsi atau aplikasi saat terdaftar di Azure Active Directory. Ketika ditentukan, keterampilan kustom terhubung ke fungsi atau aplikasi menggunakan ID terkelola (baik sistem atau yang ditetapkan pengguna) dari layanan pencarian dan token akses fungsi atau aplikasi, menggunakan nilai ini sebagai id sumber daya untuk membuat cakupan token akses.

authResourceId?: string

Nilai Properti

string

batchSize

Ukuran batch yang diinginkan yang menunjukkan jumlah dokumen.

batchSize?: number

Nilai Properti

number

degreeOfParallelism

Jika diatur, jumlah panggilan paralel yang dapat dilakukan ke API Web.

degreeOfParallelism?: number

Nilai Properti

number

httpHeaders

Header yang diperlukan untuk membuat permintaan http.

httpHeaders?: {[propertyName: string]: string}

Nilai Properti

{[propertyName: string]: string}

httpMethod

Metode untuk permintaan http.

httpMethod?: string

Nilai Properti

string

odatatype

Diskriminator polimorfik, yang menentukan berbagai jenis objek ini dapat

odatatype: "#Microsoft.Skills.Custom.WebApiSkill"

Nilai Properti

"#Microsoft.Skills.Custom.WebApiSkill"

timeout

Batas waktu yang diinginkan untuk permintaan. Defaultnya adalah 30 detik.

timeout?: string

Nilai Properti

string

uri

Url untuk API Web.

uri: string

Nilai Properti

string

Detail Properti yang Diwariskan

context

Mewakili tingkat di mana operasi berlangsung, seperti akar dokumen atau konten dokumen (misalnya, /document atau /document/content). Defaultnya adalah /document.

context?: string

Nilai Properti

string

Diwariskan DariBaseSearchIndexerSkill.context

description

Deskripsi keterampilan yang menjelaskan input, output, dan penggunaan keterampilan.

description?: string

Nilai Properti

string

Diwariskan DariBaseSearchIndexerSkill.description

inputs

Input keterampilan bisa menjadi kolom dalam himpunan data sumber, atau output keterampilan hulu.

inputs: InputFieldMappingEntry[]

Nilai Properti

InputFieldMappingEntry[]

Diwarisi DariBaseSearchIndexerSkill.inputs

name

Nama keterampilan yang secara unik mengidentifikasinya dalam set keterampilan. Keterampilan tanpa nama yang ditentukan akan diberi nama default indeks berbasis 1 dalam array keterampilan, diawali dengan karakter '#'.

name?: string

Nilai Properti

string

Diwariskan DariBaseSearchIndexerSkill.name

outputs

Output keterampilan adalah bidang dalam indeks pencarian, atau nilai yang dapat dikonsumsi sebagai input oleh keterampilan lain.

outputs: OutputFieldMappingEntry[]

Nilai Properti

OutputFieldMappingEntry[]

Diwarisi DariBaseSearchIndexerSkill.outputs