@azure/openai-assistants package

الفصول

AssistantsClient

معالجة العميل للعمليات المتعلقة بالمساعد.

AzureKeyCredential

بيانات اعتماد مستندة إلى مفتاح ثابت تدعم تحديث قيمة المفتاح الأساسي.

OpenAIKeyCredential

تمثل فئة OpenAIKeyCredential مفتاح OpenAI API وتستخدم للمصادقة في عميل Assistants لنقطة نهاية OpenAI.

الواجهات

Assistant

يمثل مساعدا يمكنه استدعاء النموذج واستخدام الأدوات.

AssistantCreationOptions

تفاصيل الطلب لاستخدامها عند إنشاء مساعد جديد.

AssistantDeletionStatus

حالة عملية حذف المساعد.

AssistantFile

معلومات حول ملف مرفق بمساعد، كما تستخدمه الأدوات التي يمكنها قراءة الملفات.

AssistantFileDeletionStatus

حالة عملية حذف ملف مساعد.

AssistantThread

معلومات حول مؤشر ترابط واحد مقترن بمساعد.

AssistantThreadCreationOptions

التفاصيل المستخدمة لإنشاء مؤشر ترابط مساعد جديد.

AssistantsClientOptions

التفاصيل المستخدمة لإنشاء عميل مساعد *

CancelRunOptions

التفاصيل المستخدمة لإلغاء التشغيل.

CodeInterpreterImageOutput

تمثيل لإخراج صورة منبعثة من أداة مترجم التعليمات البرمجية استجابة لاستدعاء أداة من قبل النموذج.

CodeInterpreterImageReference

مرجع صورة منبعثة من أداة مترجم التعليمات البرمجية استجابة لاستدعاء أداة من قبل النموذج.

CodeInterpreterLogOutput

تمثيل إخراج السجل المنبعثة من أداة مترجم التعليمات البرمجية استجابة لاستدعاء أداة من قبل النموذج.

CodeInterpreterToolCall

سجل لاستدعاء أداة مترجم التعليمات البرمجية، صادر عن النموذج في تقييم أداة محددة، تمثل المدخلات والمخرجات المستهلكة والمصدرة من قبل مترجم التعليمات البرمجية.

CodeInterpreterToolCallDetails

المعلومات التفصيلية حول استدعاء مترجم التعليمات البرمجية بواسطة النموذج.

CodeInterpreterToolDefinition

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

CreateAndRunThreadOptions

التفاصيل المستخدمة عند إنشاء مؤشر ترابط مساعد جديد وتشغيله على الفور.

CreateAssistantFileOptions

التفاصيل المستخدمة لإنشاء ملف مساعد.

CreateAssistantOptions

التفاصيل المستخدمة لإنشاء مساعد.

CreateMessageOptions

التفاصيل المستخدمة لإنشاء رسالة.

CreateRunOptions

التفاصيل المستخدمة عند إنشاء تشغيل جديد لمترابط مساعد.

CreateRunRequestOptions

التفاصيل المستخدمة لإنشاء طلب تشغيل.

CreateThreadAndRunOptions

التفاصيل المستخدمة لإنشاء مؤشر ترابط وتشغيله.

CreateThreadOptions

التفاصيل المستخدمة لإنشاء مؤشر ترابط.

DeleteAssistantFileOptions

التفاصيل المستخدمة لحذف ملف مساعد.

DeleteAssistantOptions

التفاصيل المستخدمة لحذف مساعد.

DeleteFileOptions

التفاصيل المستخدمة لحذف الملفات.

DeleteThreadOptions

التفاصيل المستخدمة لحذف مؤشر ترابط.

DeletionStatus

تمثيل مجرد لحالة نتيجة عملية حذف OpenAI.

FileDeletionStatus

استجابة حالة من عملية حذف ملف.

FileListResponse

بيانات الاستجابة من عملية قائمة الملفات.

FunctionDefinition

معلومات تعريف الإدخال لدالة.

FunctionToolCall

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

FunctionToolCallDetails

المعلومات التفصيلية حول الدالة التي استدعاها النموذج.

FunctionToolDefinition

معلومات تعريف الإدخال لأداة دالة كما هو مستخدم لتكوين مساعد.

GetAssistantFileOptions

التفاصيل المستخدمة للحصول على ملف مساعد.

GetAssistantOptions

التفاصيل المستخدمة للحصول على مساعد.

GetFileOptions

التفاصيل المستخدمة للحصول على الملفات.

GetMessageFileOptions

التفاصيل المستخدمة للحصول على ملف رسالة.

GetMessageOptions

التفاصيل المستخدمة للحصول على رسالة.

GetRunOptions

التفاصيل المستخدمة للحصول على تشغيل.

GetRunStepOptions

التفاصيل المستخدمة للحصول على خطوة تشغيل.

GetThreadOptions

التفاصيل المستخدمة للحصول على مؤشر ترابط.

InputFile

يمثل مساعدا يمكنه استدعاء النموذج واستخدام الأدوات.

ListAssistantFilesOptions

التفاصيل المستخدمة لسرد ملفات المساعد.

ListAssistantsOptions

التفاصيل المستخدمة لسرد المساعدين.

ListFilesOptions

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

ListMessageFilesOptions

التفاصيل المستخدمة لسرد ملفات الرسائل.

ListMessagesOptions

التفاصيل المستخدمة لسرد الرسائل.

ListResponseOf

بيانات الاستجابة لقائمة العناصر المطلوبة.

ListRunStepsOptions

التفاصيل المستخدمة لسرد خطوات التشغيل.

ListRunsOptions

التفاصيل المستخدمة لسرد عمليات التشغيل.

MessageFile

معلومات حول ملف مرفق برسالة مؤشر ترابط مساعد.

MessageImageFileContent

تمثيل لمحتوى ملف الصورة في رسالة مؤشر ترابط.

MessageImageFileDetails

مرجع صورة، كما هو ممثل في محتوى رسالة مؤشر الترابط.

MessageTextContent

تمثيل لعنصر نصي لمحتوى رسالة مؤشر الترابط.

MessageTextDetails

النص والتعليقات التوضيحية المقترنة لعنصر واحد من محتوى رسالة مؤشر ترابط المساعد.

MessageTextFileCitationAnnotation

اقتباس داخل الرسالة يشير إلى اقتباس معين من ملف معين مقترن بالمساعد أو الرسالة. يتم إنشاؤه عندما يستخدم المساعد أداة "الاسترداد" للبحث في الملفات.

MessageTextFileCitationDetails

تمثيل لاقتباس نص مستند إلى ملف، كما هو مستخدم في التعليق التوضيحي المستند إلى ملف لمحتوى رسالة مؤشر الترابط النصي.

MessageTextFilePathAnnotation

اقتباس داخل الرسالة يشير إلى ملف موجود في مسار معين.

MessageTextFilePathDetails

تغليف لمعرف ملف صورة، كما يستخدمه محتوى صورة الرسالة.

RequiredAction

تمثيل مجرد لإجراء مطلوب لتشغيل مؤشر ترابط مساعد للمتابعة.

RequiredFunctionToolCall

تمثيل استدعاء مطلوب إلى أداة دالة، يحتاجها النموذج لمتابعة تقييم التشغيل.

RetrievalToolCall

سجل استدعاء إلى أداة استرداد، صادرة عن النموذج في تقييم أداة محددة، تمثل إجراءات الاسترداد المنفذة.

RetrievalToolDefinition

معلومات تعريف الإدخال لأداة استرداد كما هو مستخدم لتكوين مساعد.

RunError

تفاصيل خطأ كما تمت مواجهته بواسطة تشغيل مؤشر ترابط مساعد.

RunStep

معلومات مفصلة حول خطوة واحدة لتشغيل مؤشر ترابط مساعد.

RunStepError

معلومات الخطأ المقترنة بخطوة تشغيل فاشلة.

RunStepMessageCreationDetails

المعلومات التفصيلية المقترنة بخطوة تشغيل إنشاء رسالة.

RunStepMessageCreationReference

تفاصيل رسالة تم إنشاؤها كجزء من خطوة التشغيل.

RunStepToolCallDetails

المعلومات التفصيلية المرتبطة بأدوات استدعاء خطوة التشغيل.

SubmitToolOutputsDetails

التفاصيل التي تصف الأدوات التي يجب استدعاؤها لإرسال مخرجات الأداة.

SubmitToolOutputsToRunOptions

التفاصيل المستخدمة لإرسال مخرجات الأداة إلى التشغيل.

ThreadDeletionStatus

حالة عملية حذف مؤشر الترابط.

ThreadMessage

رسالة واحدة موجودة داخل مؤشر ترابط مساعد.

ThreadRun

البيانات التي تمثل عملية تقييم واحدة لمترابط مساعد.

ToolOutput

تنتج البيانات المقدمة أثناء أداة الإرسال لحل استدعاءات الأدوات المعلقة والسماح للنموذج بالمتابعة.

UpdateAssistantOptions

تفاصيل الطلب لاستخدامها عند تعديل مساعد موجود.

UpdateAssistantRequestOptions

التفاصيل المستخدمة لتحديث مساعد.

UpdateMessageOptions

التفاصيل المستخدمة لتحديث رسالة.

UpdateRunOptions

التفاصيل المستخدمة لتحديث تشغيل.

UpdateThreadOptions

التفاصيل المستخدمة لتحديث مؤشر ترابط.

UploadFileOptions

التفاصيل المستخدمة لتحميل الملفات.

النوع أسماء مستعارة

CodeInterpreterToolCallOutput

الاسم المستعار ل CodeInterpreterToolCallOutput

FilePurpose

"ضبط"، "ضبط النتائج"، "المساعدون"، "assistants_output"

ListSortOrder

"asc"، "desc"

MessageContent

الاسم المستعار ل MessageContent

MessageRole

"المستخدم"، "مساعد"

MessageTextAnnotation

الاسم المستعار ل MessageTextAnnotation

RequiredToolCall

الاسم المستعار ل RequiredToolCall

RunStatus

"في قائمة الانتظار" و"in_progress" و"requires_action" و"إلغاء" و"تم الإلغاء" و"فشل" و"مكتمل" و"منتهية الصلاحية"

RunStepDetails

الاسم المستعار ل RunStepDetails

RunStepErrorCode

"server_error"، "rate_limit_exceeded"

RunStepStatus

"in_progress"، "تم الإلغاء"، "فشل"، "مكتمل"، "منتهية الصلاحية"

RunStepType

"message_creation"، "tool_calls"

ToolCall

الاسم المستعار ل ToolCall

ToolDefinition

تمثيل مجرد لتعريف أداة إدخال يمكن أن يستخدمه المساعد.