ChatCompletionSkill interface

الحزمة:

@azure/search-documents

مهارة تستدعي نموذج لغة عبر نقطة نهاية إكمال الدردشة في Azure الذكاء الاصطناعي Foundry.

يمتد

WebApiSkill

الخصائص

apiKey	مفتاح واجهة برمجة التطبيقات للمصادقة على النموذج. لا يمكن تحديد كل من apiKey و authIdentity في نفس الوقت.
commonModelParameters	معلمات نموذج اللغة الشائعة التي يمكن للعملاء تعديلها. إذا تم حذفها ، تطبيق التخلف عن السداد المعقول.
extraParameters	قاموس من النوع المفتوح للمعلمات الخاصة بالنموذج التي يجب إلحاقها باستدعاء إكمال الدردشة. يتبع نمط قابلية التوسعة ل Azure الذكاء الاصطناعي Foundry.
extraParametersBehavior	كيفية التعامل مع المعلمات الإضافية بواسطة Azure الذكاء الاصطناعي Foundry. الافتراضي هو "خطأ".
odatatype	تمييزي متعدد الأشكال، والذي يحدد الأنواع المختلفة التي يمكن أن يكون هذا الكائن
responseFormat	يحدد كيفية تنسيق LLM استجابته. يتم الإعداد الافتراضي لنوع الاستجابة "نص".

الخصائص الموروثة

authIdentity	الهوية المدارة المعينة من قبل المستخدم المستخدمة للاتصالات الصادرة. إذا تم توفير authResourceId ولم يتم تحديده، يتم استخدام الهوية المدارة المعينة من قبل النظام. في تحديثات المفهرس، إذا كانت الهوية غير محددة، تظل القيمة دون تغيير. إذا تم تعيينه إلى "بلا"، مسح قيمة هذه الخاصية.
authResourceId	ينطبق على المهارات المخصصة التي تتصل بالتعليمات البرمجية الخارجية في وظيفة Azure أو بعض التطبيقات الأخرى التي توفر التحويلات. يجب أن تكون هذه القيمة معرف التطبيق الذي تم إنشاؤه للوظيفة أو التطبيق عند تسجيله مع Azure Active Directory. عند تحديدها، تتصل المهارة المخصصة بالوظيفة أو التطبيق باستخدام معرف مدار (إما نظام أو تعيين من قبل المستخدم) لخدمة البحث ورمز الوصول للوظيفة أو التطبيق، باستخدام هذه القيمة كمعرف المورد لإنشاء نطاق الرمز المميز للوصول.
batchSize	حجم الدفعة المطلوب الذي يشير إلى عدد المستندات.
context	يمثل المستوى الذي تحدث فيه العمليات، مثل جذر المستند أو محتوى المستند (على سبيل المثال، /document أو /document/content). الإعداد الافتراضي هو /document.
degreeOfParallelism	إذا تم تعيينه، عدد الاستدعاءات المتوازية التي يمكن إجراؤها على واجهة برمجة تطبيقات الويب.
description	وصف المهارة التي تصف مدخلات المهارة ومخرجاتها واستخدامها.
httpHeaders	العناوين المطلوبة لإجراء طلب http.
httpMethod	أسلوب طلب http.
inputs	يمكن أن تكون مدخلات المهارات عمودا في مجموعة البيانات المصدر، أو إخراج مهارة المصدر.
name	اسم المهارة التي تحددها بشكل فريد داخل مجموعة المهارات. سيتم إعطاء مهارة بدون اسم معرف اسما افتراضيا لفهرسها المستند إلى 1 في صفيف المهارات، مسبوقا بالحرف '#'.
outputs	إخراج المهارة هو إما حقل في فهرس بحث، أو قيمة يمكن استهلاكها كمدخل من قبل مهارة أخرى.
timeout	المهلة المطلوبة للطلب. الافتراضي هو 30 ثانية.
uri	عنوان URL لواجهة برمجة تطبيقات الويب.

تفاصيل الخاصية

apiKey

مفتاح واجهة برمجة التطبيقات للمصادقة على النموذج. لا يمكن تحديد كل من apiKey و authIdentity في نفس الوقت.

apiKey?: string

قيمة الخاصية

string

commonModelParameters

معلمات نموذج اللغة الشائعة التي يمكن للعملاء تعديلها. إذا تم حذفها ، تطبيق التخلف عن السداد المعقول.

commonModelParameters?: CommonModelParameters

قيمة الخاصية

CommonModelParameters

extraParameters

قاموس من النوع المفتوح للمعلمات الخاصة بالنموذج التي يجب إلحاقها باستدعاء إكمال الدردشة. يتبع نمط قابلية التوسعة ل Azure الذكاء الاصطناعي Foundry.

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

قيمة الخاصية

{[propertyName: string]: unknown}

extraParametersBehavior

كيفية التعامل مع المعلمات الإضافية بواسطة Azure الذكاء الاصطناعي Foundry. الافتراضي هو "خطأ".

extraParametersBehavior?: string

قيمة الخاصية

string

odatatype

تمييزي متعدد الأشكال، والذي يحدد الأنواع المختلفة التي يمكن أن يكون هذا الكائن

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

قيمة الخاصية

"#Microsoft.Skills.Custom.ChatCompletionSkill"

responseFormat

يحدد كيفية تنسيق LLM استجابته. يتم الإعداد الافتراضي لنوع الاستجابة "نص".

responseFormat?: ChatCompletionResponseFormat

قيمة الخاصية

ChatCompletionResponseFormat

تفاصيل الخاصية الموروثة

authIdentity

الهوية المدارة المعينة من قبل المستخدم المستخدمة للاتصالات الصادرة. إذا تم توفير authResourceId ولم يتم تحديده، يتم استخدام الهوية المدارة المعينة من قبل النظام. في تحديثات المفهرس، إذا كانت الهوية غير محددة، تظل القيمة دون تغيير. إذا تم تعيينه إلى "بلا"، مسح قيمة هذه الخاصية.

authIdentity?: SearchIndexerDataIdentity

قيمة الخاصية

SearchIndexerDataIdentity

موروثة منWebApiSkill.authIdentity

authResourceId

ينطبق على المهارات المخصصة التي تتصل بالتعليمات البرمجية الخارجية في وظيفة Azure أو بعض التطبيقات الأخرى التي توفر التحويلات. يجب أن تكون هذه القيمة معرف التطبيق الذي تم إنشاؤه للوظيفة أو التطبيق عند تسجيله مع Azure Active Directory. عند تحديدها، تتصل المهارة المخصصة بالوظيفة أو التطبيق باستخدام معرف مدار (إما نظام أو تعيين من قبل المستخدم) لخدمة البحث ورمز الوصول للوظيفة أو التطبيق، باستخدام هذه القيمة كمعرف المورد لإنشاء نطاق الرمز المميز للوصول.

authResourceId?: string

قيمة الخاصية

string

موروثة منWebApiSkill.authResourceId

batchSize

حجم الدفعة المطلوب الذي يشير إلى عدد المستندات.

batchSize?: number

قيمة الخاصية

number

موروثة منWebApiSkill.batchSize

context

يمثل المستوى الذي تحدث فيه العمليات، مثل جذر المستند أو محتوى المستند (على سبيل المثال، /document أو /document/content). الإعداد الافتراضي هو /document.

context?: string

قيمة الخاصية

string

موروثة منWebApiSkill.context

degreeOfParallelism

إذا تم تعيينه، عدد الاستدعاءات المتوازية التي يمكن إجراؤها على واجهة برمجة تطبيقات الويب.

degreeOfParallelism?: number

قيمة الخاصية

number

موروثة منWebApiSkill.degreeOfParallelism

description

وصف المهارة التي تصف مدخلات المهارة ومخرجاتها واستخدامها.

description?: string

قيمة الخاصية

string

موروثة منWebApiSkill.description

httpHeaders

العناوين المطلوبة لإجراء طلب http.

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

قيمة الخاصية

{[propertyName: string]: string}

موروثة منWebApiSkill.httpHeaders

httpMethod

أسلوب طلب http.

httpMethod?: string

قيمة الخاصية

string

موروثة منWebApiSkill.httpMethod

inputs

يمكن أن تكون مدخلات المهارات عمودا في مجموعة البيانات المصدر، أو إخراج مهارة المصدر.

inputs: InputFieldMappingEntry[]

قيمة الخاصية

InputFieldMappingEntry[]

موروثة منWebApiSkill.inputs

name

اسم المهارة التي تحددها بشكل فريد داخل مجموعة المهارات. سيتم إعطاء مهارة بدون اسم معرف اسما افتراضيا لفهرسها المستند إلى 1 في صفيف المهارات، مسبوقا بالحرف '#'.

name?: string

قيمة الخاصية

string

موروثة منWebApiSkill.name

outputs

إخراج المهارة هو إما حقل في فهرس بحث، أو قيمة يمكن استهلاكها كمدخل من قبل مهارة أخرى.

outputs: OutputFieldMappingEntry[]

قيمة الخاصية

OutputFieldMappingEntry[]

موروثة منWebApiSkill.outputs

timeout

المهلة المطلوبة للطلب. الافتراضي هو 30 ثانية.

timeout?: string

قيمة الخاصية

string

موروثة منWebApiSkill.timeout

uri

عنوان URL لواجهة برمجة تطبيقات الويب.

uri: string

قيمة الخاصية

string

موروثة منWebApiSkill.uri