@azure-rest/ai-inference package
الواجهات
| ChatChoiceOutput |
تمثيل إكمال مطالبة واحدة كجزء من طلب إكمال الدردشة الشامل.
بشكل عام، يتم إنشاء خيارات |
| ChatCompletionsNamedToolChoice |
تحديد أداة لأداة دالة محددة مسماة تقيد إكمال الدردشة باستخدام الدالة المسماة. |
| ChatCompletionsNamedToolChoiceFunction |
تحديد أداة لأداة دالة محددة مسماة تقيد إكمال الدردشة باستخدام الدالة المسماة. |
| ChatCompletionsOutput |
تمثيل بيانات الاستجابة من طلب إكمال الدردشة. تدعم عمليات الإكمال مجموعة متنوعة من المهام وتنشئ نصا يستمر من بيانات المطالبة المقدمة أو "يكملها". |
| ChatCompletionsResponseFormatJsonObject |
تنسيق استجابة لإكمالات الدردشة يقيد الاستجابات على إصدار كائنات JSON صالحة. لاحظ أنه لتمكين وضع JSON، قد تتطلب بعض النماذج الذكاء الاصطناعي أيضا إرشاد النموذج لإنتاج JSON عبر نظام أو رسالة مستخدم. |
| ChatCompletionsResponseFormatJsonSchema |
تنسيق استجابة لإكمالات الدردشة يقيد الاستجابات على إصدار كائنات JSON صالحة، مع مخطط JSON المحدد من قبل المتصل. |
| ChatCompletionsResponseFormatJsonSchemaDefinition |
يحدد تنسيق الاستجابة لإكمال الدردشة على أنه JSON مع مخطط معين. سيحتاج نموذج الذكاء الاصطناعي إلى الالتزام بهذا المخطط عند إنشاء عمليات الإكمال. |
| ChatCompletionsResponseFormatParent |
يمثل التنسيق الذي يجب على النموذج إخراجه. استخدم هذا لتمكين وضع JSON بدلا من وضع النص الافتراضي. لاحظ أنه لتمكين وضع JSON، قد تتطلب بعض النماذج الذكاء الاصطناعي أيضا إرشاد النموذج لإنتاج JSON عبر نظام أو رسالة مستخدم. |
| ChatCompletionsResponseFormatText |
تنسيق استجابة لإكمالات الدردشة يصدر استجابات نصية. هذا هو تنسيق الاستجابة الافتراضي. |
| ChatCompletionsToolCall |
استدعاء أداة دالة مطلوب من قبل نموذج الذكاء الاصطناعي. |
| ChatCompletionsToolCallOutput |
استدعاء أداة دالة مطلوب من قبل نموذج الذكاء الاصطناعي. |
| ChatCompletionsToolDefinition |
تعريف أداة إكمال الدردشة التي يمكنها استدعاء دالة. |
| ChatMessageAudioDataContentItem |
عنصر محتوى دردشة منظم لمحتوى الصوت الذي تم تمريره كبيانات مشفرة base64. |
| ChatMessageAudioUrlContentItem |
عنصر محتوى دردشة منظم لمحتوى الصوت الذي تم تمريره كعنصر url. |
| ChatMessageContentItemParent |
تمثيل مجرد لعنصر محتوى منظم داخل رسالة دردشة. |
| ChatMessageImageContentItem |
عنصر محتوى دردشة منظم يحتوي على مرجع صورة. |
| ChatMessageImageUrl |
موقع إنترنت يمكن للنموذج استرداد صورة منه. |
| ChatMessageInputAudio |
تفاصيل بيانات صوت الإدخال. |
| ChatMessageInputAudioUrl |
تفاصيل عنوان URL للصوت. |
| ChatMessageTextContentItem |
عنصر محتوى دردشة منظم يحتوي على نص عادي. |
| ChatRequestAssistantMessage |
رسالة دردشة طلب تمثل استجابة أو إجراء من المساعد. |
| ChatRequestDeveloperMessage |
رسالة دردشة طلب تحتوي على إرشادات المطور التي تؤثر على كيفية إنشاء النموذج استجابة إكمال الدردشة. تدعم بعض نماذج الذكاء الاصطناعي رسالة مطور بدلا من رسالة النظام. |
| ChatRequestMessageParent |
تمثيل مجرد لرسالة دردشة كما هو متوفر في الطلب. |
| ChatRequestSystemMessage |
رسالة دردشة طلب تحتوي على إرشادات النظام التي تؤثر على كيفية إنشاء النموذج استجابة إكمال الدردشة. |
| ChatRequestToolMessage |
رسالة دردشة طلب تمثل الإخراج المطلوب من أداة مكونة. |
| ChatRequestUserMessage |
رسالة دردشة طلب تمثل إدخال المستخدم إلى المساعد. |
| ChatResponseMessageOutput |
تمثيل لرسالة دردشة كما تم تلقيها في استجابة. |
| CompletionsUsageOutput |
تمثيل عدد الرموز المميزة التي تمت معالجتها لطلب الإكمال. تأخذ العد في الاعتبار جميع الرموز المميزة عبر المطالبات والخيارات والخيارات البديلة والأجيال best_of والمستهلكين الآخرين. |
| EmbeddingItemOutput |
تمثيل مقارنة واحدة لترابط التضمينات. |
| EmbeddingsResultOutput |
تمثيل بيانات الاستجابة من طلب تضمينات. تقيس عمليات التضمين مدى ارتباط السلاسل النصية وتستخدم عادة للبحث والتجميع والتوصيات وغيرها من السيناريوهات المماثلة. |
| EmbeddingsUsageOutput |
قياس كمية الرموز المميزة المستخدمة في هذا الطلب والاستجابة. |
| ErrorModel |
كائن الخطأ. |
| FunctionCall |
اسم ووسيطات الدالة التي يجب استدعاؤها، كما تم إنشاؤها بواسطة النموذج. |
| FunctionCallOutput |
اسم ووسيطات الدالة التي يجب استدعاؤها، كما تم إنشاؤها بواسطة النموذج. |
| FunctionDefinition |
تعريف الدالة المحددة للمتصل التي قد تستدعيها عمليات إكمال الدردشة استجابة لإدخال المستخدم المطابق. |
| GetChatCompletions | |
| GetChatCompletions200Response |
لقد نجح الطلب. |
| GetChatCompletionsBodyParam | |
| GetChatCompletionsDefaultHeaders | |
| GetChatCompletionsDefaultResponse | |
| GetChatCompletionsHeaderParam | |
| GetChatCompletionsHeaders | |
| GetEmbeddings | |
| GetEmbeddings200Response |
لقد نجح الطلب. |
| GetEmbeddingsBodyParam | |
| GetEmbeddingsDefaultHeaders | |
| GetEmbeddingsDefaultResponse | |
| GetEmbeddingsHeaderParam | |
| GetEmbeddingsHeaders | |
| GetImageEmbeddings | |
| GetImageEmbeddings200Response |
لقد نجح الطلب. |
| GetImageEmbeddingsBodyParam | |
| GetImageEmbeddingsDefaultHeaders | |
| GetImageEmbeddingsDefaultResponse | |
| GetImageEmbeddingsHeaderParam | |
| GetImageEmbeddingsHeaders | |
| GetModelInfo | |
| GetModelInfo200Response |
لقد نجح الطلب. |
| GetModelInfoDefaultHeaders | |
| GetModelInfoDefaultResponse | |
| ImageEmbeddingInput |
تمثيل صورة مع نص اختياري. |
| ModelClientOptions |
المعلمات الاختيارية للعميل |
| ModelInfoOutput |
يمثل بعض المعلومات الأساسية حول نموذج الذكاء الاصطناعي. |
| Routes | |
النوع أسماء مستعارة
| AudioContentFormat |
الاسم المستعار ل AudioContentFormat |
| ChatCompletionsResponseFormat |
يمثل التنسيق الذي يجب على النموذج إخراجه. استخدم هذا لتمكين وضع JSON بدلا من وضع النص الافتراضي. لاحظ أنه لتمكين وضع JSON، قد تتطلب بعض النماذج الذكاء الاصطناعي أيضا إرشاد النموذج لإنتاج JSON عبر نظام أو رسالة مستخدم. |
| ChatCompletionsToolChoicePreset |
الاسم المستعار ل ChatCompletionsToolChoicePreset |
| ChatMessageContentItem |
تمثيل مجرد لعنصر محتوى منظم داخل رسالة دردشة. |
| ChatMessageImageDetailLevel |
الاسم المستعار ل ChatMessageImageDetailLevel |
| ChatRequestMessage |
تمثيل مجرد لرسالة دردشة كما هو متوفر في الطلب. |
| ChatRole |
الاسم المستعار ل ChatRole |
| ChatRoleOutput |
الاسم المستعار ل ChatRoleOutput |
| CompletionsFinishReasonOutput |
الاسم المستعار ل CompletionsFinishReasonOutput |
| EmbeddingEncodingFormat |
الاسم المستعار ل EmbeddingEncodingFormat |
| EmbeddingInputType |
الاسم المستعار ل EmbeddingInputType |
| ExtraParameters |
الاسم المستعار ل ExtraParameters |
| GetChatCompletionsParameters | |
| GetEmbeddingsParameters | |
| GetImageEmbeddingsParameters | |
| GetModelInfoParameters | |
| ModelClient | |
| ModelTypeOutput |
الاسم المستعار ل ModelTypeOutput |
الوظائف
تفاصيل الوظيفة
default(string, TokenCredential | KeyCredential, ModelClientOptions)
تهيئة مثيل جديد من ModelClient
function default(endpointParam: string, credentials: TokenCredential | KeyCredential, options?: ModelClientOptions): ModelClient
المعلمات
- endpointParam
-
string
معلمة endpointParam
- credentials
تحديد بيانات اعتماد العميل بشكل فريد
- options
- ModelClientOptions
المعلمة لكافة المعلمات الاختيارية
المرتجعات
isUnexpected(GetChatCompletions200Response | GetChatCompletionsDefaultResponse)
function isUnexpected(response: GetChatCompletions200Response | GetChatCompletionsDefaultResponse): response
المعلمات
المرتجعات
response
isUnexpected(GetModelInfo200Response | GetModelInfoDefaultResponse)
function isUnexpected(response: GetModelInfo200Response | GetModelInfoDefaultResponse): response
المعلمات
المرتجعات
response
isUnexpected(GetEmbeddings200Response | GetEmbeddingsDefaultResponse)
function isUnexpected(response: GetEmbeddings200Response | GetEmbeddingsDefaultResponse): response
المعلمات
المرتجعات
response
isUnexpected(GetImageEmbeddings200Response | GetImageEmbeddingsDefaultResponse)
function isUnexpected(response: GetImageEmbeddings200Response | GetImageEmbeddingsDefaultResponse): response
المعلمات
المرتجعات
response