ChatCompletionSkill interface

Paket:

@azure/search-documents

Keterampilan yang memanggil model bahasa melalui titik akhir Penyelesaian Obrolan Azure AI Foundry.

Memperluas

WebApiSkill

Properti

apiKey	Kunci API untuk mengautentikasi ke model. Baik apiKey dan authIdentity tidak dapat ditentukan secara bersamaan.
commonModelParameters	Parameter model bahasa umum yang dapat disesuaikan oleh pelanggan. Jika dihilangkan, default yang wajar akan diterapkan.
extraParameters	Kamus tipe terbuka untuk parameter khusus model yang harus ditambahkan ke panggilan penyelesaian obrolan. Mengikuti pola ekstensibilitas Azure AI Foundry.
extraParametersBehavior	Bagaimana parameter tambahan ditangani oleh Azure AI Foundry. Defaultnya adalah 'error'.
odatatype	Diskriminator polimorfik, yang menentukan berbagai jenis objek ini dapat
responseFormat	Menentukan bagaimana LLM harus memformat responsnya. Default ke jenis respons 'teks'.

Properti yang Diwariskan

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 diatur ke "none", nilai properti ini akan 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.
context	Mewakili tingkat di mana operasi berlangsung, seperti akar dokumen atau konten dokumen (misalnya, /document atau /document/content). Defaultnya adalah /document.
degreeOfParallelism	Jika diatur, jumlah panggilan paralel yang dapat dilakukan ke API Web.
description	Deskripsi keterampilan yang menjelaskan input, output, dan penggunaan keterampilan.
httpHeaders	Header yang diperlukan untuk membuat permintaan http.
httpMethod	Metode untuk permintaan http.
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.
timeout	Batas waktu yang diinginkan untuk permintaan. Secara default, waktunya adalah 30 detik.
uri	Url untuk API Web.

Detail Properti

apiKey

Kunci API untuk mengautentikasi ke model. Baik apiKey dan authIdentity tidak dapat ditentukan secara bersamaan.

apiKey?: string

Nilai Properti

string

commonModelParameters

Parameter model bahasa umum yang dapat disesuaikan oleh pelanggan. Jika dihilangkan, default yang wajar akan diterapkan.

commonModelParameters?: CommonModelParameters

Nilai Properti

CommonModelParameters

extraParameters

Kamus tipe terbuka untuk parameter khusus model yang harus ditambahkan ke panggilan penyelesaian obrolan. Mengikuti pola ekstensibilitas Azure AI Foundry.

extraParameters?: {[propertyName: string]: unknown}

Nilai Properti

{[propertyName: string]: unknown}

extraParametersBehavior

Bagaimana parameter tambahan ditangani oleh Azure AI Foundry. Defaultnya adalah 'error'.

extraParametersBehavior?: string

Nilai Properti

string

odatatype

Diskriminator polimorfik, yang menentukan berbagai jenis objek ini dapat

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

Nilai Properti

"#Microsoft.Skills.Custom.ChatCompletionSkill"

responseFormat

Menentukan bagaimana LLM harus memformat responsnya. Default ke jenis respons 'teks'.

responseFormat?: ChatCompletionResponseFormat

Nilai Properti

ChatCompletionResponseFormat

Detail Properti yang Diwariskan

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 diatur ke "none", nilai properti ini akan dihapus.

authIdentity?: SearchIndexerDataIdentity

Nilai Properti

SearchIndexerDataIdentity

Diwarisi dariWebApiSkill.authIdentity

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

Diwarisi dariWebApiSkill.authResourceId

batchSize

Ukuran batch yang diinginkan yang menunjukkan jumlah dokumen.

batchSize?: number

Nilai Properti

number

Diwarisi dariWebApiSkill.batchSize

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

Diwarisi dariWebApiSkill.context

degreeOfParallelism

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

degreeOfParallelism?: number

Nilai Properti

number

Diwarisi dariWebApiSkill.degreeOfParallelism

description

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

description?: string

Nilai Properti

string

Diwarisi dariWebApiSkill.description

httpHeaders

Header yang diperlukan untuk membuat permintaan http.

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

Nilai Properti

{[propertyName: string]: string}

Diwarisi dariWebApiSkill.httpHeaders

httpMethod

Metode untuk permintaan http.

httpMethod?: string

Nilai Properti

string

Diwarisi dariWebApiSkill.httpMethod

inputs

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

inputs: InputFieldMappingEntry[]

Nilai Properti

InputFieldMappingEntry[]

Diwarisi dariWebApiSkill.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

Diwarisi dari WebApiSkill.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 dariWebApiSkill.outputs

timeout

Batas waktu yang diinginkan untuk permintaan. Secara default, waktunya adalah 30 detik.

timeout?: string

Nilai Properti

string

Diwarisi dariWebApiSkill.timeout

uri

Url untuk API Web.

uri: string

Nilai Properti

string

Diwarisi dariWebApiSkill.uri