ChatCompletionSkill interface

Paket:

@azure/search-documents

Azure Yapay Zeka Atölyesi'nin Chat Completions uç noktası üzerinden dil modeli çağıran bir beceri.

Extends

WebApiSkill

Özellikler

apiKey	Modelde kimlik doğrulaması için API anahtarı. Hem apiKey hem de authIdentity aynı anda belirtilemez.
commonModelParameters	Müşterilerin ince ayar yapabileceği ortak dil modeli parametreleri. Atlanırsa, makul varsayılanlar uygulanacaktır.
extraParameters	Sohbet tamamlama çağrısına eklenmesi gereken modele özgü parametreler için açık tür sözlük. Azure Yapay Zeka Atölyesi'nin genişletilebilirlik desenini izler.
extraParametersBehavior	Azure Yapay Zeka Atölyesi tarafından ekstra parametrelerin nasıl işlendiği. Varsayılan değer 'hata'dır.
odatatype	Bu nesnenin olabileceği farklı türleri belirten polimorfik ayrımcı
responseFormat	LLM'nin yanıtını nasıl biçimlendirmesi gerektiğini belirler. Varsayılan olarak 'metin' yanıt türü kullanılır.

Devralınan Özellikler

authIdentity	Giden bağlantılar için kullanılan kullanıcı tarafından atanan yönetilen kimlik. Bir authResourceId sağlanırsa ve belirtilmezse, sistem tarafından atanan yönetilen kimlik kullanılır. Dizin oluşturucu güncelleştirmelerinde kimlik belirtilmezse değer değişmeden kalır. "Yok" olarak ayarlanırsa, bu özelliğin değeri temizlenir.
authResourceId	Bir Azure fonksiyonunda veya dönüşümleri sağlayan başka bir uygulamada harici koda bağlanan özel becerilere uygulanır. Bu değer, fonksiyon veya uygulama Azure Active Directory'ye kayıtlı olduğunda oluşturulan uygulama kimliği olmalıdır. Özel beceri belirtildiğinde, arama hizmetinin yönetilen kimliğini (sistem veya kullanıcı tarafından atanan) ve bu değeri erişim belirtecinin kapsamını oluşturmak için kaynak kimliği olarak bu değeri kullanarak işleve veya uygulamaya bağlanır.
batchSize	Belge sayısını gösteren istenen toplu iş boyutu.
context	Belge kök veya belge içeriği (örneğin, /document veya /document/content) gibi işlemlerin gerçekleştiği düzeyi temsil eder. Varsayılan değer /document'dır.
degreeOfParallelism	Ayarlanırsa, Web API'sine yapılabilecek paralel çağrıların sayısı.
description	Becerinin girişlerini, çıkışlarını ve kullanımını açıklayan becerinin açıklaması.
httpHeaders	Http isteğinde bulunmak için gereken üst bilgiler.
httpMethod	http isteğinin yöntemi.
inputs	Becerilerin girişleri, kaynak veri kümesindeki bir sütun veya yukarı akış becerisinin çıkışı olabilir.
name	Beceri kümesi içinde benzersiz olarak tanımlayan becerinin adı. Tanımlı adı olmayan bir beceriye beceri dizisinde 1 tabanlı dizininin varsayılan adı verilir ve bu ada '#' karakteri eklenir.
outputs	Bir becerinin çıktısı, arama dizinindeki bir alan veya başka bir beceri tarafından giriş olarak kullanılabilecek bir değerdir.
timeout	İstek için istenen zaman aşımı. Varsayılan değer 30 saniyedir.
uri	Web API'sinin URL'si.

Özellik Ayrıntıları

apiKey

Modelde kimlik doğrulaması için API anahtarı. Hem apiKey hem de authIdentity aynı anda belirtilemez.

apiKey?: string

Özellik Değeri

string

commonModelParameters

Müşterilerin ince ayar yapabileceği ortak dil modeli parametreleri. Atlanırsa, makul varsayılanlar uygulanacaktır.

commonModelParameters?: CommonModelParameters

Özellik Değeri

CommonModelParameters

extraParameters

Sohbet tamamlama çağrısına eklenmesi gereken modele özgü parametreler için açık tür sözlük. Azure Yapay Zeka Atölyesi'nin genişletilebilirlik desenini izler.

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

Özellik Değeri

{[propertyName: string]: unknown}

extraParametersBehavior

Azure Yapay Zeka Atölyesi tarafından ekstra parametrelerin nasıl işlendiği. Varsayılan değer 'hata'dır.

extraParametersBehavior?: string

Özellik Değeri

string

odatatype

Bu nesnenin olabileceği farklı türleri belirten polimorfik ayrımcı

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

Özellik Değeri

"#Microsoft.Skills.Custom.ChatCompletionSkill"

responseFormat

LLM'nin yanıtını nasıl biçimlendirmesi gerektiğini belirler. Varsayılan olarak 'metin' yanıt türü kullanılır.

responseFormat?: ChatCompletionResponseFormat

Özellik Değeri

ChatCompletionResponseFormat

Devralınan Özellik Detayları

authIdentity

Giden bağlantılar için kullanılan kullanıcı tarafından atanan yönetilen kimlik. Bir authResourceId sağlanırsa ve belirtilmezse, sistem tarafından atanan yönetilen kimlik kullanılır. Dizin oluşturucu güncelleştirmelerinde kimlik belirtilmezse değer değişmeden kalır. "Yok" olarak ayarlanırsa, bu özelliğin değeri temizlenir.

authIdentity?: SearchIndexerDataIdentity

Özellik Değeri

SearchIndexerDataIdentity

WebApiSkill.authIdentity'dendevralındı

authResourceId

Bir Azure fonksiyonunda veya dönüşümleri sağlayan başka bir uygulamada harici koda bağlanan özel becerilere uygulanır. Bu değer, fonksiyon veya uygulama Azure Active Directory'ye kayıtlı olduğunda oluşturulan uygulama kimliği olmalıdır. Özel beceri belirtildiğinde, arama hizmetinin yönetilen kimliğini (sistem veya kullanıcı tarafından atanan) ve bu değeri erişim belirtecinin kapsamını oluşturmak için kaynak kimliği olarak bu değeri kullanarak işleve veya uygulamaya bağlanır.

authResourceId?: string

Özellik Değeri

string

WebApiSkill.authResourceId'dendevralındı

batchSize

Belge sayısını gösteren istenen toplu iş boyutu.

batchSize?: number

Özellik Değeri

number

WebApiSkill.batchSize'dandevralındı

context

Belge kök veya belge içeriği (örneğin, /document veya /document/content) gibi işlemlerin gerçekleştiği düzeyi temsil eder. Varsayılan değer /document'dır.

context?: string

Özellik Değeri

string

WebApiSkill.context'tendevralındı

degreeOfParallelism

Ayarlanırsa, Web API'sine yapılabilecek paralel çağrıların sayısı.

degreeOfParallelism?: number

Özellik Değeri

number

WebApiSkill.degreeOfParallelism'dendevralındı

description

Becerinin girişlerini, çıkışlarını ve kullanımını açıklayan becerinin açıklaması.

description?: string

Özellik Değeri

string

WebApiSkill.description'dandevralındı

httpHeaders

Http isteğinde bulunmak için gereken üst bilgiler.

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

Özellik Değeri

{[propertyName: string]: string}

WebApiSkill.httpHeaders'tandevralındı

httpMethod

http isteğinin yöntemi.

httpMethod?: string

Özellik Değeri

string

WebApiSkill.httpMethod'dandevralındı

inputs

Becerilerin girişleri, kaynak veri kümesindeki bir sütun veya yukarı akış becerisinin çıkışı olabilir.

inputs: InputFieldMappingEntry[]

Özellik Değeri

InputFieldMappingEntry[]

WebApiSkill.inputs'tandevralındı

name

Beceri kümesi içinde benzersiz olarak tanımlayan becerinin adı. Tanımlı adı olmayan bir beceriye beceri dizisinde 1 tabanlı dizininin varsayılan adı verilir ve bu ada '#' karakteri eklenir.

name?: string

Özellik Değeri

string

WebApiSkill.name'den devralındı

outputs

Bir becerinin çıktısı, arama dizinindeki bir alan veya başka bir beceri tarafından giriş olarak kullanılabilecek bir değerdir.

outputs: OutputFieldMappingEntry[]

Özellik Değeri

OutputFieldMappingEntry[]

WebApiSkill.outputs'tandevralındı

timeout

İstek için istenen zaman aşımı. Varsayılan değer 30 saniyedir.

timeout?: string

Özellik Değeri

string

WebApiSkill.timeout'tandevralındı

uri

Web API'sinin URL'si.

uri: string

Özellik Değeri

string

WebApiSkill.uri'dendevralındı