AssistantsClient class
معالجة العميل للعمليات المتعلقة بالمساعد.
المنشئون
| Assistants |
تهيئة مثيل AssistantsClient للاستخدام مع نقطة النهاية غير Azure OpenAI. |
| Assistants |
تهيئة مثيل AssistantsClient للاستخدام مع مورد OpenAI. |
| Assistants |
تهيئة مثيل AssistantsClient للاستخدام مع مورد Azure OpenAI. |
الخصائص
| pipeline | البنية الأساسية لبرنامج ربط العمليات التجارية المستخدمة من قبل هذا العميل لتقديم الطلبات |
الأساليب
| cancel |
إلغاء تشغيل مؤشر ترابط قيد التقدم. |
| create |
إنشاء مساعد جديد. |
| create |
إرفاق ملف تم تحميله مسبقا إلى مساعد لاستخدامه بواسطة الأدوات التي يمكنها قراءة الملفات. |
| create |
إنشاء رسالة جديدة على مؤشر ترابط محدد. |
| create |
إنشاء تشغيل جديد لمترابط مساعد. |
| create |
إنشاء مؤشر ترابط جديد. تحتوي مؤشرات الترابط على رسائل ويمكن تشغيلها بواسطة المساعدين. |
| create |
إنشاء مؤشر ترابط مساعد جديد وبدء تشغيل على الفور باستخدام مؤشر الترابط الجديد هذا. |
| delete |
حذف مساعد. |
| delete |
إلغاء ارتباط ملف تم إرفاقه مسبقا من مساعد، مما يجعله غير متوفر للاستخدام بواسطة الأدوات التي يمكنها قراءة الملفات. |
| delete |
حذف ملف تم تحميله مسبقا. |
| delete |
حذف مؤشر ترابط موجود. |
| get |
استرداد مساعد موجود. |
| get |
استرداد ملف مرفق بمساعد. |
| get |
إرجاع معلومات حول ملف معين. لا يسترد محتوى الملف. |
| get |
يحصل على رسالة موجودة من مؤشر ترابط موجود. |
| get |
يحصل على معلومات حول مرفق ملف برسالة داخل مؤشر ترابط. |
| get |
يحصل على تشغيل موجود من مؤشر ترابط موجود. |
| get |
يحصل على خطوة تشغيل واحدة من تشغيل مؤشر ترابط. |
| get |
الحصول على معلومات حول مؤشر ترابط موجود. |
| list |
يحصل على قائمة بالملفات المرفقة بمساعد معين، كما تستخدمها الأدوات التي يمكنها قراءة الملفات. |
| list |
يحصل على قائمة المساعدين الذين تم إنشاؤهم مسبقا. |
| list |
الحصول على قائمة بالملفات التي تم تحميلها مسبقا. |
| list |
يحصل على قائمة بالملفات التي تم تحميلها مسبقا المقترنة برسالة من مؤشر ترابط. |
| list |
يحصل على قائمة بالرسائل الموجودة على مؤشر ترابط. |
| list |
يحصل على قائمة عمليات التشغيل لمترابط محدد. |
| list |
يحصل على قائمة بخطوات التشغيل من تشغيل مؤشر ترابط. |
| submit |
إرسال المخرجات من الأدوات كما هو مطلوب بواسطة استدعاءات الأدوات في التشغيل. ستكون عمليات التشغيل التي تحتاج إلى مخرجات الأداة المرسلة حالة "requires_action" مع required_action.type من "submit_tool_outputs". |
| update |
تعديل مساعد موجود. |
| update |
تعديل رسالة موجودة على مؤشر ترابط موجود. |
| update |
تعديل تشغيل مؤشر ترابط موجود. |
| update |
تعديل مؤشر ترابط موجود. |
| upload |
تحميل ملف للاستخدام من قبل عمليات أخرى. |
تفاصيل المنشئ
AssistantsClient(KeyCredential, AssistantsClientOptions)
تهيئة مثيل AssistantsClient للاستخدام مع نقطة النهاية غير Azure OpenAI.
new AssistantsClient(openAiApiKey: KeyCredential, options?: AssistantsClientOptions)المعلمات
- openAiApiKey
- KeyCredential
مفتاح API لاستخدامه عند الاتصال بنقطة نهاية OpenAI غير Azure.
- options
- AssistantsClientOptions
خيارات تكوين العميل.
الملاحظات
يمكن استخدام كائنات AssistantsClient التي تمت تهيئتها باستخدام هذا المنشئ فقط مع نقطة نهاية الاستدلال غير Azure OpenAI. لاستخدام AssistantsClient مع مورد Azure OpenAI، استخدم الدالة الإنشائية التي تقبل مورد URI وبيانات اعتماد مصادقة Azure بدلا من ذلك.
AssistantsClient(string, KeyCredential, AssistantsClientOptions)
تهيئة مثيل AssistantsClient للاستخدام مع مورد OpenAI.
new AssistantsClient(endpoint: string, credential: KeyCredential, options?: AssistantsClientOptions)المعلمات
- endpoint
-
string
عنوان URI لمورد Azure OpenAI، بما في ذلك البروتوكول واسم المضيف. على سبيل المثال: https://my-resource.openai.azure.com.
- credential
- KeyCredential
بيانات اعتماد مفتاح تستخدم للمصادقة على مورد Azure OpenAI.
- options
- AssistantsClientOptions
خيارات تكوين العميل.
الملاحظات
يقوم هذا المنشئ بتهيئة كائن AssistantsClient الذي يمكن استخدامه فقط مع موارد Azure OpenAI. لاستخدام AssistantsClient مع نقطة نهاية استدلال غير Azure OpenAI، استخدم الدالة الإنشائية التي تقبل مفتاح واجهة برمجة تطبيقات غير Azure OpenAI بدلا من ذلك.
AssistantsClient(string, TokenCredential, AssistantsClientOptions)
تهيئة مثيل AssistantsClient للاستخدام مع مورد Azure OpenAI.
new AssistantsClient(endpoint: string, credential: TokenCredential, options?: AssistantsClientOptions)المعلمات
- endpoint
-
string
عنوان URI لمورد Azure OpenAI، بما في ذلك البروتوكول واسم المضيف. على سبيل المثال: https://my-resource.openai.azure.com.
- credential
- TokenCredential
بيانات اعتماد الرمز المميز المستخدمة للمصادقة مع مورد Azure OpenAI.
- options
- AssistantsClientOptions
خيارات تكوين العميل.
تفاصيل الخاصية
pipeline
البنية الأساسية لبرنامج ربط العمليات التجارية المستخدمة من قبل هذا العميل لتقديم الطلبات
pipeline: Pipelineقيمة الخاصية
تفاصيل الأسلوب
cancelRun(string, string, CancelRunOptions)
إلغاء تشغيل مؤشر ترابط قيد التقدم.
function cancelRun(threadId: string, runId: string, options?: CancelRunOptions): Promise<ThreadRun>المعلمات
- threadId
-
string
- runId
-
string
- options
- CancelRunOptions
المرتجعات
Promise<ThreadRun>
createAssistant(AssistantCreationOptions, CreateAssistantOptions)
إنشاء مساعد جديد.
function createAssistant(body: AssistantCreationOptions, options?: CreateAssistantOptions): Promise<Assistant>المعلمات
- options
- CreateAssistantOptions
المرتجعات
Promise<Assistant>
createAssistantFile(string, string, CreateAssistantFileOptions)
إرفاق ملف تم تحميله مسبقا إلى مساعد لاستخدامه بواسطة الأدوات التي يمكنها قراءة الملفات.
function createAssistantFile(assistantId: string, fileId: string, options?: CreateAssistantFileOptions): Promise<AssistantFile>المعلمات
- assistantId
-
string
- fileId
-
string
- options
- CreateAssistantFileOptions
المرتجعات
Promise<AssistantFile>
createMessage(string, string, string, CreateMessageOptions)
إنشاء رسالة جديدة على مؤشر ترابط محدد.
function createMessage(threadId: string, role: string, content: string, options?: CreateMessageOptions): Promise<ThreadMessage>المعلمات
- threadId
-
string
- role
-
string
- content
-
string
- options
- CreateMessageOptions
المرتجعات
Promise<ThreadMessage>
createRun(string, CreateRunOptions, CreateRunRequestOptions)
إنشاء تشغيل جديد لمترابط مساعد.
function createRun(threadId: string, createRunOptions: CreateRunOptions, options?: CreateRunRequestOptions): Promise<ThreadRun>المعلمات
- threadId
-
string
- createRunOptions
- CreateRunOptions
- options
- CreateRunRequestOptions
المرتجعات
Promise<ThreadRun>
createThread(AssistantThreadCreationOptions, CreateThreadOptions)
إنشاء مؤشر ترابط جديد. تحتوي مؤشرات الترابط على رسائل ويمكن تشغيلها بواسطة المساعدين.
function createThread(body?: AssistantThreadCreationOptions, options?: CreateThreadOptions): Promise<AssistantThread>المعلمات
- options
- CreateThreadOptions
المرتجعات
Promise<AssistantThread>
createThreadAndRun(CreateAndRunThreadOptions, CreateThreadAndRunOptions)
إنشاء مؤشر ترابط مساعد جديد وبدء تشغيل على الفور باستخدام مؤشر الترابط الجديد هذا.
function createThreadAndRun(body: CreateAndRunThreadOptions, options?: CreateThreadAndRunOptions): Promise<ThreadRun>المعلمات
- options
- CreateThreadAndRunOptions
المرتجعات
Promise<ThreadRun>
deleteAssistant(string, DeleteAssistantOptions)
حذف مساعد.
function deleteAssistant(assistantId: string, options?: DeleteAssistantOptions): Promise<AssistantDeletionStatus>المعلمات
- assistantId
-
string
- options
- DeleteAssistantOptions
المرتجعات
Promise<AssistantDeletionStatus>
deleteAssistantFile(string, string, DeleteAssistantFileOptions)
إلغاء ارتباط ملف تم إرفاقه مسبقا من مساعد، مما يجعله غير متوفر للاستخدام بواسطة الأدوات التي يمكنها قراءة الملفات.
function deleteAssistantFile(assistantId: string, fileId: string, options?: DeleteAssistantFileOptions): Promise<AssistantFileDeletionStatus>المعلمات
- assistantId
-
string
- fileId
-
string
- options
- DeleteAssistantFileOptions
المرتجعات
Promise<AssistantFileDeletionStatus>
deleteFile(string, DeleteFileOptions)
حذف ملف تم تحميله مسبقا.
function deleteFile(fileId: string, options?: DeleteFileOptions): Promise<FileDeletionStatus>المعلمات
- fileId
-
string
- options
- DeleteFileOptions
المرتجعات
Promise<FileDeletionStatus>
deleteThread(string, DeleteThreadOptions)
حذف مؤشر ترابط موجود.
function deleteThread(threadId: string, options?: DeleteThreadOptions): Promise<ThreadDeletionStatus>المعلمات
- threadId
-
string
- options
- DeleteThreadOptions
المرتجعات
Promise<ThreadDeletionStatus>
getAssistant(string, GetAssistantOptions)
استرداد مساعد موجود.
function getAssistant(assistantId: string, options?: GetAssistantOptions): Promise<Assistant>المعلمات
- assistantId
-
string
- options
- GetAssistantOptions
المرتجعات
Promise<Assistant>
getAssistantFile(string, string, GetAssistantFileOptions)
استرداد ملف مرفق بمساعد.
function getAssistantFile(assistantId: string, fileId: string, options?: GetAssistantFileOptions): Promise<AssistantFile>المعلمات
- assistantId
-
string
- fileId
-
string
- options
- GetAssistantFileOptions
المرتجعات
Promise<AssistantFile>
getFile(string, GetFileOptions)
إرجاع معلومات حول ملف معين. لا يسترد محتوى الملف.
function getFile(fileId: string, options?: GetFileOptions): Promise<InputFile>المعلمات
- fileId
-
string
- options
- GetFileOptions
المرتجعات
Promise<InputFile>
getMessage(string, string, GetMessageOptions)
يحصل على رسالة موجودة من مؤشر ترابط موجود.
function getMessage(threadId: string, messageId: string, options?: GetMessageOptions): Promise<ThreadMessage>المعلمات
- threadId
-
string
- messageId
-
string
- options
- GetMessageOptions
المرتجعات
Promise<ThreadMessage>
getMessageFile(string, string, string, GetMessageFileOptions)
يحصل على معلومات حول مرفق ملف برسالة داخل مؤشر ترابط.
function getMessageFile(threadId: string, messageId: string, fileId: string, options?: GetMessageFileOptions): Promise<MessageFile>المعلمات
- threadId
-
string
- messageId
-
string
- fileId
-
string
- options
- GetMessageFileOptions
المرتجعات
Promise<MessageFile>
getRun(string, string, GetRunOptions)
يحصل على تشغيل موجود من مؤشر ترابط موجود.
function getRun(threadId: string, runId: string, options?: GetRunOptions): Promise<ThreadRun>المعلمات
- threadId
-
string
- runId
-
string
- options
- GetRunOptions
المرتجعات
Promise<ThreadRun>
getRunStep(string, string, string, GetRunStepOptions)
يحصل على خطوة تشغيل واحدة من تشغيل مؤشر ترابط.
function getRunStep(threadId: string, runId: string, stepId: string, options?: GetRunStepOptions): Promise<RunStep>المعلمات
- threadId
-
string
- runId
-
string
- stepId
-
string
- options
- GetRunStepOptions
المرتجعات
Promise<RunStep>
getThread(string, GetThreadOptions)
الحصول على معلومات حول مؤشر ترابط موجود.
function getThread(threadId: string, options?: GetThreadOptions): Promise<AssistantThread>المعلمات
- threadId
-
string
- options
- GetThreadOptions
المرتجعات
Promise<AssistantThread>
listAssistantFiles(string, ListAssistantFilesOptions)
يحصل على قائمة بالملفات المرفقة بمساعد معين، كما تستخدمها الأدوات التي يمكنها قراءة الملفات.
function listAssistantFiles(assistantId: string, options?: ListAssistantFilesOptions): Promise<ListResponseOf<AssistantFile>>المعلمات
- assistantId
-
string
- options
- ListAssistantFilesOptions
المرتجعات
Promise<ListResponseOf<AssistantFile>>
listAssistants(ListAssistantsOptions)
يحصل على قائمة المساعدين الذين تم إنشاؤهم مسبقا.
function listAssistants(options?: ListAssistantsOptions): Promise<ListResponseOf<Assistant>>المعلمات
- options
- ListAssistantsOptions
المرتجعات
Promise<ListResponseOf<Assistant>>
listFiles(ListFilesOptions)
الحصول على قائمة بالملفات التي تم تحميلها مسبقا.
function listFiles(options?: ListFilesOptions): Promise<FileListResponse>المعلمات
- options
- ListFilesOptions
المرتجعات
Promise<FileListResponse>
listMessageFiles(string, string, ListMessageFilesOptions)
يحصل على قائمة بالملفات التي تم تحميلها مسبقا المقترنة برسالة من مؤشر ترابط.
function listMessageFiles(threadId: string, messageId: string, options?: ListMessageFilesOptions): Promise<ListResponseOf<MessageFile>>المعلمات
- threadId
-
string
- messageId
-
string
- options
- ListMessageFilesOptions
المرتجعات
Promise<ListResponseOf<MessageFile>>
listMessages(string, ListMessagesOptions)
يحصل على قائمة بالرسائل الموجودة على مؤشر ترابط.
function listMessages(threadId: string, options?: ListMessagesOptions): Promise<ListResponseOf<ThreadMessage>>المعلمات
- threadId
-
string
- options
- ListMessagesOptions
المرتجعات
Promise<ListResponseOf<ThreadMessage>>
listRuns(string, ListRunsOptions)
يحصل على قائمة عمليات التشغيل لمترابط محدد.
function listRuns(threadId: string, options?: ListRunsOptions): Promise<ListResponseOf<ThreadRun>>المعلمات
- threadId
-
string
- options
- ListRunsOptions
المرتجعات
Promise<ListResponseOf<ThreadRun>>
listRunSteps(string, string, ListRunStepsOptions)
يحصل على قائمة بخطوات التشغيل من تشغيل مؤشر ترابط.
function listRunSteps(threadId: string, runId: string, options?: ListRunStepsOptions): Promise<ListResponseOf<RunStep>>المعلمات
- threadId
-
string
- runId
-
string
- options
- ListRunStepsOptions
المرتجعات
Promise<ListResponseOf<RunStep>>
submitToolOutputsToRun(string, string, ToolOutput[], SubmitToolOutputsToRunOptions)
إرسال المخرجات من الأدوات كما هو مطلوب بواسطة استدعاءات الأدوات في التشغيل. ستكون عمليات التشغيل التي تحتاج إلى مخرجات الأداة المرسلة حالة "requires_action" مع required_action.type من "submit_tool_outputs".
function submitToolOutputsToRun(threadId: string, runId: string, toolOutputs: ToolOutput[], options?: SubmitToolOutputsToRunOptions): Promise<ThreadRun>المعلمات
- threadId
-
string
- runId
-
string
- toolOutputs
- options
- SubmitToolOutputsToRunOptions
المرتجعات
Promise<ThreadRun>
updateAssistant(string, UpdateAssistantOptions, UpdateAssistantRequestOptions)
تعديل مساعد موجود.
function updateAssistant(assistantId: string, body: UpdateAssistantOptions, options?: UpdateAssistantRequestOptions): Promise<Assistant>المعلمات
- assistantId
-
string
- options
- UpdateAssistantRequestOptions
المرتجعات
Promise<Assistant>
updateMessage(string, string, UpdateMessageOptions)
تعديل رسالة موجودة على مؤشر ترابط موجود.
function updateMessage(threadId: string, messageId: string, options?: UpdateMessageOptions): Promise<ThreadMessage>المعلمات
- threadId
-
string
- messageId
-
string
- options
- UpdateMessageOptions
المرتجعات
Promise<ThreadMessage>
updateRun(string, string, UpdateRunOptions)
تعديل تشغيل مؤشر ترابط موجود.
function updateRun(threadId: string, runId: string, options?: UpdateRunOptions): Promise<ThreadRun>المعلمات
- threadId
-
string
- runId
-
string
- options
- UpdateRunOptions
المرتجعات
Promise<ThreadRun>
updateThread(string, UpdateThreadOptions)
تعديل مؤشر ترابط موجود.
function updateThread(threadId: string, options?: UpdateThreadOptions): Promise<AssistantThread>المعلمات
- threadId
-
string
- options
- UpdateThreadOptions
المرتجعات
Promise<AssistantThread>
uploadFile(Uint8Array, string, UploadFileOptions)
تحميل ملف للاستخدام من قبل عمليات أخرى.
function uploadFile(file: Uint8Array, purpose: string, options?: UploadFileOptions): Promise<InputFile>المعلمات
- file
-
Uint8Array
- purpose
-
string
- options
- UploadFileOptions
المرتجعات
Promise<InputFile>
Azure SDK for JavaScript
الملاحظات
قريبًا: خلال عام 2024، سنتخلص تدريجيًا من GitHub Issues بوصفها آلية إرسال ملاحظات للمحتوى ونستبدلها بنظام ملاحظات جديد. لمزيد من المعلومات، راجع https://aka.ms/ContentUserFeedback.
إرسال الملاحظات وعرضها المتعلقة بـ