مرجع تشغيل Assistants API (Preview)

مقالة
05/23/2024

إشعار

يمكن للبحث عن الملفات استيعاب ما يصل إلى 10000 ملف لكل مساعد - 500 مرة أكثر من ذي قبل. وهو سريع، ويدعم الاستعلامات المتوازية من خلال عمليات البحث متعددة مؤشرات الترابط، وميزات محسنة لإعادة الإرسال وإعادة كتابة الاستعلام.
- مخزن المتجهات هو كائن جديد في واجهة برمجة التطبيقات. بمجرد إضافة ملف إلى مخزن متجهات، يتم تحليله تلقائيا، وتقسيمه، ودمجه، ويكون جاهزا للبحث فيه. يمكن استخدام مخازن المتجهات عبر المساعدين ومؤشرات الترابط، مما يبسط إدارة الملفات والفوترة.
لقد أضفنا دعما للمعلمة tool_choice التي يمكن استخدامها لفرض استخدام أداة معينة (مثل البحث في الملفات أو مترجم التعليمات البرمجية أو وظيفة) في تشغيل معين.

توفر هذه المقالة وثائق مرجعية ل Python وREST لواجهة برمجة تطبيقات المساعدين الجديدة (معاينة). يتم توفير إرشادات أكثر تعمقا خطوة بخطوة في دليل البدء.

إنشاء تشغيل

POST https://YOUR_RESOURCE_NAME.openai.azure.com/openai/threads/{thread_id}/runs?api-version=2024-05-01-preview

إنشاء تشغيل.

معلمة المسار

المعلمة	نوع	مطلوبة	‏‏الوصف
`thread_id`	سلسلة	المطلوب	معرف مؤشر الترابط لإنشاء رسالة له.

نص الطلب

Name	نوع	مطلوبة	‏‏الوصف
`assistant_id`	سلسلة	المطلوب	معرف المساعد الذي يجب استخدامه لتنفيذ هذا التشغيل.
`model`	سلسلة أو قيمة خالية	اختياري	اسم توزيع النموذج الذي سيتم استخدامه لتنفيذ هذا التشغيل. إذا تم توفير قيمة هنا، فسيتم تجاوز اسم توزيع النموذج المقترن بالمساعد. إذا لم يكن الأمر كما هو، فسيتم استخدام اسم نشر النموذج المقترن بالمساعد.
`instructions`	سلسلة أو قيمة خالية	اختياري	يتجاوز إرشادات المساعد. هذا مفيد لتعديل السلوك على أساس كل تشغيل.
`tools`	صفيف أو خال	اختياري	تجاوز الأدوات التي يمكن أن يستخدمها المساعد لهذا التشغيل. هذا مفيد لتعديل السلوك على أساس كل تشغيل.
`metadata`	map	اختياري	مجموعة من 16 زوجا من قيم المفاتيح التي يمكن إرفاقها بعنصر. يمكن أن يكون هذا مفيدا لتخزين معلومات إضافية حول الكائن بتنسيق منظم. يمكن أن يكون طول المفاتيح 64 حرفا كحد أقصى ويمكن أن تكون القيم بحد أقصى 512 حرفا.

المرتجعات

كائن تشغيل.

from openai import AzureOpenAI
    
client = AzureOpenAI(
    api_key=os.getenv("AZURE_OPENAI_API_KEY"),  
    api_version="2024-05-01-preview",
    azure_endpoint = os.getenv("AZURE_OPENAI_ENDPOINT")
    )

run = client.beta.threads.runs.create(
  thread_id="thread_abc123",
  assistant_id="asst_abc123"
)
print(run)

curl https://YOUR_RESOURCE_NAME.openai.azure.com/openai/threads/{thread_id}/runs?api-version=2024-05-01-preview \
  -H "api-key: $AZURE_OPENAI_API_KEY" \
  -H 'Content-Type: application/json' \
  -d '{
    "assistant_id": "asst_abc123"
  }'

إنشاء مؤشر ترابط وتشغيل

POST https://YOUR_RESOURCE_NAME.openai.azure.com/openai/threads/runs?api-version=2024-05-01-preview

إنشاء مؤشر ترابط وتشغيله في طلب واحد.

نص الطلب

Name	نوع	مطلوبة	‏‏الوصف
`assistant_id`	سلسلة	المطلوب	معرف المساعد الذي يجب استخدامه لتنفيذ هذا التشغيل.
`thread`	كائن	اختياري
`model`	سلسلة أو قيمة خالية	اختياري	معرف اسم توزيع النموذج الذي سيتم استخدامه لتنفيذ هذا التشغيل. إذا تم توفير قيمة هنا، فسيتم تجاوز اسم توزيع النموذج المقترن بالمساعد. إذا لم يكن الأمر كما هو، فسيتم استخدام اسم نشر النموذج المقترن بالمساعد.
`instructions`	سلسلة أو قيمة خالية	اختياري	تجاوز رسالة النظام الافتراضية للمساعد. هذا مفيد لتعديل السلوك على أساس كل تشغيل.
`tools`	صفيف أو خال	اختياري	تجاوز الأدوات التي يمكن أن يستخدمها المساعد لهذا التشغيل. هذا مفيد لتعديل السلوك على أساس كل تشغيل.
`metadata`	map	اختياري	مجموعة من 16 زوجا من قيم المفاتيح التي يمكن إرفاقها بعنصر. يمكن أن يكون هذا مفيدا لتخزين معلومات إضافية حول الكائن بتنسيق منظم. يمكن أن يكون طول المفاتيح 64 حرفا كحد أقصى ويمكن أن تكون القيم بحد أقصى 512 حرفا.

المرتجعات

كائن تشغيل.

مثال إنشاء مؤشر ترابط وتشغيل الطلب

Python 1.x
بقيه

from openai import AzureOpenAI
    
client = AzureOpenAI(
    api_key=os.getenv("AZURE_OPENAI_API_KEY"),  
    api_version="2024-05-01-preview",
    azure_endpoint = os.getenv("AZURE_OPENAI_ENDPOINT")
    )

run = client.beta.threads.create_and_run(
  assistant_id="asst_abc123",
  thread={
    "messages": [
      {"role": "user", "content": "Explain deep learning to a 5 year old."}
    ]
  }
)

curl https://YOUR_RESOURCE_NAME.openai.azure.com/openai/threads/runs?api-version=2024-05-01-preview \
  -H "api-key: $AZURE_OPENAI_API_KEY" \
  -H 'Content-Type: application/json' \
  -d '{
      "assistant_id": "asst_abc123",
      "thread": {
        "messages": [
          {"role": "user", "content": "Explain deep learning to a 5 year old."}
        ]
      }
    }'

تشغيل القائمة

GET https://YOUR_RESOURCE_NAME.openai.azure.com/openai/threads/{thread_id}/runs?api-version=2024-05-01-preview

إرجاع قائمة عمليات التشغيل التي تنتمي إلى مؤشر ترابط.

معلمة المسار

المعلمة	نوع	مطلوبة	‏‏الوصف
`thread_id`	سلسلة	المطلوب	معرف مؤشر الترابط الذي ينتمي إليه التشغيل.

معلمات الاستعلام

Name	نوع	مطلوبة	‏‏الوصف
`limit`	integer	اختياري - الإعدادات الافتراضية إلى 20	حد لعدد العناصر التي سيتم إرجاعها. يمكن أن يتراوح الحد بين 1 و100، والافتراضي هو 20.
`order`	سلسلة	اختياري - الإعدادات الافتراضية ل desc	ترتيب الفرز حسب الطابع الزمني created_at للكائنات. asc للترتيب التصاعدي و desc للترتيب التنازلي.
`after`	سلسلة	اختياري	مؤشر للاستخدام في ترقيم الصفحات. بعد هو معرف كائن يحدد مكانك في القائمة. على سبيل المثال، إذا قمت بإجراء طلب قائمة وتلقيت 100 عنصر، تنتهي obj_foo، يمكن أن تتضمن المكالمة اللاحقة بعد =obj_foo لإحضار الصفحة التالية من القائمة.
`before`	سلسلة	اختياري	مؤشر للاستخدام في ترقيم الصفحات. من قبل هو معرف كائن يحدد مكانك في القائمة. على سبيل المثال، إذا قمت بإجراء طلب قائمة وتلقيت 100 عنصر، تنتهي obj_foo، يمكن أن تتضمن المكالمة اللاحقة قبل=obj_foo لإحضار الصفحة السابقة من القائمة.

المرتجعات

قائمة بعناصر التشغيل .

مثال على طلب تشغيل القائمة

Python 1.x
بقيه

from openai import AzureOpenAI
    
client = AzureOpenAI(
    api_key=os.getenv("AZURE_OPENAI_API_KEY"),  
    api_version="2024-05-01-preview",
    azure_endpoint = os.getenv("AZURE_OPENAI_ENDPOINT")
    )

runs = client.beta.threads.runs.list(
  "thread_abc123"
)
print(runs)

curl https://YOUR_RESOURCE_NAME.openai.azure.com/openai/threads/{thread_id}/runs?api-version=2024-05-01-preview \
  -H "api-key: $AZURE_OPENAI_API_KEY" \
  -H 'Content-Type: application/json'

سرد خطوات التشغيل

GET https://YOUR_RESOURCE_NAME.openai.azure.com/openai/threads/{thread_id}/runs/{run_id}/steps?api-version=2024-05-01-preview

إرجاع قائمة بالخطوات التي تنتمي إلى تشغيل.

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

المعلمة	نوع	مطلوبة	‏‏الوصف
`thread_id`	سلسلة	المطلوب	معرف مؤشر الترابط الذي ينتمي إليه التشغيل.
`run_id`	سلسلة	المطلوب	معرف التشغيل المقترن بخطوات التشغيل التي سيتم الاستعلام عنها.

معلمات الاستعلام

Name	نوع	مطلوبة	‏‏الوصف
`limit`	integer	اختياري - الإعدادات الافتراضية إلى 20	حد لعدد العناصر التي سيتم إرجاعها. يمكن أن يتراوح الحد بين 1 و100، والافتراضي هو 20.
`order`	سلسلة	اختياري - الإعدادات الافتراضية ل desc	ترتيب الفرز حسب الطابع الزمني created_at للكائنات. asc للترتيب التصاعدي و desc للترتيب التنازلي.
`after`	سلسلة	اختياري	مؤشر للاستخدام في ترقيم الصفحات. بعد هو معرف كائن يحدد مكانك في القائمة. على سبيل المثال، إذا قمت بإجراء طلب قائمة وتلقيت 100 عنصر، تنتهي obj_foo، يمكن أن تتضمن المكالمة اللاحقة بعد =obj_foo لإحضار الصفحة التالية من القائمة.
`before`	سلسلة	اختياري	مؤشر للاستخدام في ترقيم الصفحات. من قبل هو معرف كائن يحدد مكانك في القائمة. على سبيل المثال، إذا قمت بإجراء طلب قائمة وتلقيت 100 عنصر، تنتهي obj_foo، يمكن أن تتضمن المكالمة اللاحقة قبل=obj_foo لإحضار الصفحة السابقة من القائمة.

المرتجعات

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

مثال لطلب خطوات تشغيل القائمة

Python 1.x
بقيه

from openai import AzureOpenAI
    
client = AzureOpenAI(
    api_key=os.getenv("AZURE_OPENAI_API_KEY"),  
    api_version="2024-05-01-preview",
    azure_endpoint = os.getenv("AZURE_OPENAI_ENDPOINT")
    )

run_steps = client.beta.threads.runs.steps.list(
    thread_id="thread_abc123",
    run_id="run_abc123"
)
print(run_steps)

curl https://YOUR_RESOURCE_NAME.openai.azure.com/openai/threads/{thread_id}/runs/{run_id}/steps?api-version=2024-05-01-preview \
  -H "api-key: $AZURE_OPENAI_API_KEY" \
  -H 'Content-Type: application/json'

استرداد التشغيل

Python 1.x
بقيه

from openai import OpenAI
client = OpenAI()

run = client.beta.threads.runs.retrieve(
  thread_id="thread_abc123",
  run_id="run_abc123"
)

print(run)

curl https://YOUR_RESOURCE_NAME.openai.azure.com/openai/threads/{thread_id}/runs/{run_id}?api-version=2024-05-01-preview
  -H "api-key: $AZURE_OPENAI_API_KEY" \
  -H 'Content-Type: application/json'

استرداد تشغيل.

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

المعلمة	نوع	مطلوبة	‏‏الوصف
`thread_id`	سلسلة	المطلوب	معرف مؤشر الترابط الذي تم تشغيله.
`run_id`	سلسلة	المطلوب	معرف التشغيل المراد استرداده.

المرتجعات

كائن التشغيل المطابق لمعرف التشغيل المحدد.

مثال لطلب خطوات تشغيل القائمة

Python 1.x
بقيه

from openai import AzureOpenAI
    
client = AzureOpenAI(
    api_key=os.getenv("AZURE_OPENAI_API_KEY"),  
    api_version="2024-05-01-preview",
    azure_endpoint = os.getenv("AZURE_OPENAI_ENDPOINT")
    )

run = client.beta.threads.runs.retrieve(
  thread_id="thread_abc123",
  run_id="run_abc123"
)
print(run)

curl https://YOUR_RESOURCE_NAME.openai.azure.com/openai/threads/{thread_id}/runs/{run_id}?api-version=2024-05-01-preview \
  -H "api-key: $AZURE_OPENAI_API_KEY" \
  -H 'Content-Type: application/json'

استرداد خطوة التشغيل

GET https://YOUR_RESOURCE_NAME.openai.azure.com/openai/threads/{thread_id}/runs/{run_id}/steps/{step_id}?api-version=2024-05-01-preview

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

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

المعلمة	نوع	مطلوبة	‏‏الوصف
`thread_id`	سلسلة	المطلوب	معرف مؤشر الترابط الذي تنتمي إليه خطوة التشغيل والتشغيل.
`run_id`	سلسلة	المطلوب	معرف التشغيل الذي تنتمي إليه خطوة التشغيل.
`step_id`	سلسلة	المطلوب	معرف خطوة التشغيل لاسترداده.

المرتجعات

كائن خطوة التشغيل المطابق للمعرف المحدد.

مثال على استرداد طلب خطوات التشغيل

Python 1.x
بقيه

from openai import AzureOpenAI
    
client = AzureOpenAI(
    api_key=os.getenv("AZURE_OPENAI_API_KEY"),  
    api_version="2024-05-01-preview",
    azure_endpoint = os.getenv("AZURE_OPENAI_ENDPOINT")
    )

run_step = client.beta.threads.runs.steps.retrieve(
    thread_id="thread_abc123",
    run_id="run_abc123",
    step_id="step_abc123"
)
print(run_step)

curl https://YOUR_RESOURCE_NAME.openai.azure.com/openai/threads/{thread_id}/runs/{run_id}/steps/{step_id}?api-version=2024-05-01-preview \
  -H "api-key: $AZURE_OPENAI_API_KEY" \
  -H 'Content-Type: application/json'

تعديل التشغيل

POST https://YOUR_RESOURCE_NAME.openai.azure.com/openai/threads/{thread_id}/runs/{run_id}?api-version=2024-05-01-preview

تعديل تشغيل.

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

المعلمة	نوع	مطلوبة	‏‏الوصف
`thread_id`	سلسلة	المطلوب	معرف مؤشر الترابط الذي تم تشغيله.
`run_id`	سلسلة	المطلوب	معرف التشغيل المراد تعديله.

نص الطلب

Name	نوع	مطلوبة	‏‏الوصف
`metadata`	map	اختياري	مجموعة من 16 زوجا من قيم المفاتيح التي يمكن إرفاقها بعنصر. يمكن أن يكون هذا مفيدا لتخزين معلومات إضافية حول الكائن بتنسيق منظم. يمكن أن يكون طول المفاتيح 64 حرفا كحد أقصى ويمكن أن تكون القيم بحد أقصى 512 حرفا.

المرتجعات

كائن التشغيل المعدل المطابق للمعرف المحدد.

مثال تعديل طلب التشغيل

Python 1.x
بقيه

from openai import AzureOpenAI
    
client = AzureOpenAI(
    api_key=os.getenv("AZURE_OPENAI_API_KEY"),  
    api_version="2024-05-01-preview",
    azure_endpoint = os.getenv("AZURE_OPENAI_ENDPOINT")
    )

run = client.beta.threads.runs.update(
  thread_id="thread_abc123",
  run_id="run_abc123",
  metadata={"user_id": "user_abc123"},
)
print(run)

curl https://YOUR_RESOURCE_NAME.openai.azure.com/openai/threads/{thread_id}/runs/{run_id}?api-version=2024-05-01-preview \
  -H "api-key: $AZURE_OPENAI_API_KEY" \
  -H 'Content-Type: application/json' 
  -d '{
    "metadata": {
      "user_id": "user_abc123"
    }
  }'

إرسال مخرجات الأداة للتشغيل

POST https://YOUR_RESOURCE_NAME.openai.azure.com/openai/threads/{thread_id}/runs/{run_id}/submit_tool_outputs?api-version=2024-05-01-preview

عندما يكون للتشغيل الحالة: "requires_action" required_action.type submit_tool_outputs، يمكن استخدام نقطة النهاية هذه لإرسال المخرجات من استدعاءات الأداة بمجرد اكتمالها جميعا. يجب إرسال جميع المخرجات في طلب واحد.

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

المعلمة	نوع	مطلوبة	‏‏الوصف
`thread_id`	سلسلة	المطلوب	معرف مؤشر الترابط الذي ينتمي إليه هذا التشغيل.
`run_id`	سلسلة	المطلوب	معرف التشغيل الذي يتطلب إرسال إخراج الأداة.

نص الطلب

Name	نوع	مطلوبة	‏‏الوصف
`tool_outputs`	صفيف	المطلوب	قائمة بالأدوات التي يتم إرسال المخرجات لها.

المرتجعات

كائن التشغيل المعدل المطابق للمعرف المحدد.

مثال إرسال مخرجات الأداة لتشغيل الطلب

Python 1.x
بقيه

from openai import AzureOpenAI
    
client = AzureOpenAI(
    api_key=os.getenv("AZURE_OPENAI_API_KEY"),  
    api_version="2024-05-01-preview",
    azure_endpoint = os.getenv("AZURE_OPENAI_ENDPOINT")
    )

run = client.beta.threads.runs.submit_tool_outputs(
  thread_id="thread_abc123",
  run_id="run_abc123",
  tool_outputs=[
    {
      "tool_call_id": "call_abc123",
      "output": "28C"
    }
  ]
)
print(run)

curl https://YOUR_RESOURCE_NAME.openai.azure.com/openai/threads/{thread_id}/runs/{run_id}/submit_tool_outputs?api-version=2024-05-01-preview \
  -H "api-key: $AZURE_OPENAI_API_KEY" \
  -H 'Content-Type: application/json' \
  -d '{
    "tool_outputs": [
      {
        "tool_call_id": "call_abc123",
        "output": "28C"
      }
    ]
  }'

إلغاء تشغيل

POST https://YOUR_RESOURCE_NAME.openai.azure.com/openai/threads/{thread_id}/runs/{run_id}/cancel?api-version=2024-05-01-preview

إلغاء تشغيل in_progress.

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

المعلمة	نوع	مطلوبة	‏‏الوصف
`thread_id`	سلسلة	المطلوب	معرف مؤشر الترابط الذي ينتمي إليه هذا التشغيل.
`run_id`	سلسلة	المطلوب	معرف التشغيل لإلغاء الأمر.

المرتجعات

كائن التشغيل المعدل المطابق للمعرف المحدد.

مثال إرسال مخرجات الأداة لتشغيل الطلب

Python 1.x
بقيه

from openai import AzureOpenAI
    
client = AzureOpenAI(
    api_key=os.getenv("AZURE_OPENAI_API_KEY"),  
    api_version="2024-05-01-preview",
    azure_endpoint = os.getenv("AZURE_OPENAI_ENDPOINT")
    )

run = client.beta.threads.runs.cancel(
  thread_id="thread_abc123",
  run_id="run_abc123"
)
print(run)

curl https://YOUR_RESOURCE_NAME.openai.azure.com/openai/threads/{thread_id}/runs/{run_id}/cancel?api-version=2024-05-01-preview \
  -H "api-key: $AZURE_OPENAI_API_KEY" \
  -H 'Content-Type: application/json' \
  -X POST

تشغيل الكائن

يمثل تنفيذا يتم تشغيله على مؤشر ترابط.

Name	كتابة	الوصف
`id`	سلسلة	المعرف، الذي يمكن الرجوع إليه في نقاط نهاية واجهة برمجة التطبيقات.
`object`	سلسلة	نوع الكائن، وهو thread.run دائما.
`created_at`	integer	الطابع الزمني Unix (بالثوان) لوقت إنشاء التشغيل.
`thread_id`	سلسلة	معرف مؤشر الترابط الذي تم تنفيذه كجزء من هذا التشغيل.
`assistant_id`	سلسلة	معرف المساعد المستخدم لتنفيذ هذا التشغيل.
`status`	سلسلة	حالة التشغيل، والتي يمكن أن تكون إما `queued`أو `in_progress`أو `requires_action`أو `failedcompletedcancellingcancelled`.`expired`
`required_action`	كائن أو خال	تفاصيل حول الإجراء المطلوب لمتابعة التشغيل. سيكون فارغا إذا لم يكن هناك إجراء مطلوب.
`last_error`	كائن أو خال	الخطأ الأخير المقترن بهذا التشغيل. ستكون خالية إذا لم تكن هناك أخطاء.
`expires_at`	integer	الطابع الزمني Unix (بالثوان) لوقت انتهاء صلاحية التشغيل.
`started_at`	عدد صحيح أو خال	الطابع الزمني Unix (بالثوان) لوقت بدء التشغيل.
`cancelled_at`	عدد صحيح أو خال	الطابع الزمني Unix (بالثوان) لوقت إلغاء التشغيل.
`failed_at`	عدد صحيح أو خال	الطابع الزمني Unix (بالثوان) لوقت فشل التشغيل.
`completed_at`	عدد صحيح أو خال	الطابع الزمني Unix (بالثوان) لوقت اكتمال التشغيل.
`model`	سلسلة	اسم توزيع النموذج الذي استخدمه المساعد لهذا التشغيل.
`instructions`	سلسلة	الإرشادات التي استخدمها المساعد لهذا التشغيل.
`tools`	صفيف	قائمة الأدوات التي استخدمها المساعد لهذا التشغيل.
`file_ids`	صفيف	قائمة معرفات الملفات التي استخدمها المساعد لهذا التشغيل.
`metadata`	map	مجموعة من 16 زوجا من قيم المفاتيح التي يمكن إرفاقها بعنصر. يمكن أن يكون هذا مفيدا لتخزين معلومات إضافية حول الكائن بتنسيق منظم. يمكن أن يكون طول المفاتيح 64 حرفا كحد أقصى ويمكن أن تكون القيم بحد أقصى 512 حرفا.
`tool_choice`	سلسلة أو عنصر	يتحكم في الأداة التي يتم استدعاؤها (إن وجدت) بواسطة النموذج. `none` يعني أن النموذج لن يستدعي أي أدوات وبدلا من ذلك ينشئ رسالة. `auto` هي القيمة الافتراضية ويعني أن النموذج يمكنه الاختيار بين إنشاء رسالة أو استدعاء أداة. تحديد أداة معينة مثل `{"type": "file_search"}` أو `{"type": "function", "function": {"name": "my_function"}}` يجبر النموذج على استدعاء تلك الأداة.
`max_prompt_tokens`	عدد صحيح أو خال	الحد الأقصى لعدد الرموز المميزة للمطالبة المحددة لاستخدامها على مدار التشغيل.
`max_completion_tokens`	عدد صحيح أو خال	الحد الأقصى لعدد رموز الإكمال المميزة المحددة لاستخدامها على مدار التشغيل.
`usage`	كائن أو خال	إحصائيات الاستخدام المتعلقة بالتشغيل. ستكون هذه القيمة فارغة إذا لم يكن التشغيل في حالة طرفية (على سبيل المثال `in_progress`، `queued`).

تشغيل كائن الخطوة

تمثيل خطوة في تنفيذ تشغيل.

Name	كتابة	الوصف
`id`	سلسلة	معرف خطوة التشغيل، والتي يمكن الرجوع إليها في نقاط نهاية واجهة برمجة التطبيقات.
`object`	سلسلة	نوع الكائن، وهو thread.run.step دائما.
`created_at`	integer	الطابع الزمني Unix (بالثوان) لوقت إنشاء خطوة التشغيل.
`assistant_id`	سلسلة	معرف المساعد المقترن بخطوة التشغيل.
`thread_id`	سلسلة	معرف مؤشر الترابط الذي تم تشغيله.
`run_id`	سلسلة	معرف التشغيل الذي تعد خطوة التشغيل هذه جزءا منه.
`type`	سلسلة	نوع خطوة التشغيل، والتي يمكن أن تكون إما message_creation أو tool_calls.
`status`	سلسلة	حالة خطوة التشغيل، والتي يمكن أن تكون إما `in_progress`أو `cancelledfailedcompleted`.`expired`
`step_details`	كائن	تفاصيل خطوة التشغيل.
`last_error`	كائن أو خال	الخطأ الأخير المقترن بخطوة التشغيل هذه. ستكون خالية إذا لم تكن هناك أخطاء.
`expired_at`	عدد صحيح أو خال	الطابع الزمني Unix (بالثوان) لوقت انتهاء صلاحية خطوة التشغيل. تعتبر الخطوة منتهية الصلاحية إذا انتهت صلاحية التشغيل الأصل.
`cancelled_at`	عدد صحيح أو خال	الطابع الزمني Unix (بالثوان) لوقت إلغاء خطوة التشغيل.
`failed_at`	عدد صحيح أو خال	الطابع الزمني Unix (بالثوان) لوقت فشل خطوة التشغيل.
`completed_at`	عدد صحيح أو خال	الطابع الزمني Unix (بالثوان) عند اكتمال خطوة التشغيل.
`metadata`	map	مجموعة من 16 زوجا من قيم المفاتيح التي يمكن إرفاقها بعنصر. يمكن أن يكون هذا مفيدا لتخزين معلومات إضافية حول الكائن بتنسيق منظم. يمكن أن يكون طول المفاتيح 64 حرفا كحد أقصى ويمكن أن تكون القيم بحد أقصى 512 حرفا.

دفق نتيجة تشغيل (معاينة)

دفق نتيجة تنفيذ تشغيل أو استئناف تشغيل بعد إرسال مخرجات الأداة. يمكنك دفق الأحداث بعد:

إنشاء مؤشر ترابط وتشغيل
إنشاء تشغيل
إرسال مخرجات الأداة

لدفق نتيجة، مرر "stream": true أثناء إنشاء تشغيل. ستكون الاستجابة دفق أحداث Server-Sent.

مثال الدفق

from typing_extensions import override
from openai import AssistantEventHandler
 
# First, we create a EventHandler class to define
# how we want to handle the events in the response stream.
 
class EventHandler(AssistantEventHandler):    
  @override
  def on_text_created(self, text) -> None:
    print(f"\nassistant > ", end="", flush=True)
      
  @override
  def on_text_delta(self, delta, snapshot):
    print(delta.value, end="", flush=True)
      
  def on_tool_call_created(self, tool_call):
    print(f"\nassistant > {tool_call.type}\n", flush=True)
  
  def on_tool_call_delta(self, delta, snapshot):
    if delta.type == 'code_interpreter':
      if delta.code_interpreter.input:
        print(delta.code_interpreter.input, end="", flush=True)
      if delta.code_interpreter.outputs:
        print(f"\n\noutput >", flush=True)
        for output in delta.code_interpreter.outputs:
          if output.type == "logs":
            print(f"\n{output.logs}", flush=True)
 
# Then, we use the `create_and_stream` SDK helper 
# with the `EventHandler` class to create the Run 
# and stream the response.
 
with client.beta.threads.runs.stream(
  thread_id=thread.id,
  assistant_id=assistant.id,
  instructions="Please address the user as Jane Doe. The user has a premium account.",
  event_handler=EventHandler(),
) as stream:
  stream.until_done()

كائن دلتا الرسالة

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

Name	كتابة	الوصف
`id`	سلسلة	معرف الرسالة، والذي يمكن الرجوع إليه في نقاط نهاية واجهة برمجة التطبيقات.
`object`	سلسلة	نوع الكائن، وهو دائما `thread.message.delta`.
`delta`	كائن	دلتا تحتوي على الحقول التي تم تغييرها في الرسالة.

تشغيل كائن دلتا للخطوة

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

Name	كتابة	الوصف
`id`	سلسلة	معرف خطوة التشغيل، والتي يمكن الرجوع إليها في نقاط نهاية واجهة برمجة التطبيقات.
`object`	سلسلة	نوع الكائن، وهو دائما `thread.run.step.delta`.
`delta`	كائن	دلتا تحتوي على الحقول التي تم تغييرها في خطوة التشغيل.

أحداث دفق المساعد

يمثل حدثا منبعثا عند دفق تشغيل. يحتوي كل حدث في دفق الأحداث المرسلة من الخادم على خاصية حدث وبيانات:

event: thread.created
data: {"id": "thread_123", "object": "thread", ...}

يتم إصدار الأحداث كلما تم إنشاء كائن جديد، أو الانتقال إلى حالة جديدة، أو يتم دفقها في أجزاء (دلتا). على سبيل المثال، thread.run.created يتم إصدار عند إنشاء تشغيل جديد، thread.run.completed وعند اكتمال التشغيل، وما إلى ذلك. عندما يختار مساعد إنشاء رسالة أثناء التشغيل، نبعث حدثا thread.message.created ، وحدثا thread.message.in_progress ، والعديد من مؤشرات الترابط.message.delta الأحداث، وأخيرا thread.message.completed حدث.

Name	كتابة	‏‏الوصف
`thread.created`	`data` هو مؤشر ترابط.	يحدث عند إنشاء مؤشر ترابط جديد.
`thread.run.created`	`data` هو تشغيل.	يحدث عند إنشاء تشغيل جديد.
`thread.run.queued`	`data` هو تشغيل.	يحدث عندما ينتقل تشغيل إلى حالة في قائمة الانتظار.
`thread.run.in_progress`	`data` هو تشغيل.	يحدث عندما ينتقل تشغيل إلى حالة in_progress.
`thread.run.requires_action`	`data` هو تشغيل.	يحدث عندما ينتقل تشغيل إلى حالة `requires_action` .
`thread.run.completed`	`data` هو تشغيل.	يحدث عند اكتمال التشغيل.
`thread.run.failed`	`data` هو تشغيل.	يحدث عند فشل تشغيل.
`thread.run.cancelling`	`data` هو تشغيل.	يحدث عندما ينتقل تشغيل إلى حالة `cancelling` .
`thread.run.cancelled`	`data` هو تشغيل.	يحدث عند إلغاء تشغيل.
`thread.run.expired`	`data` هو تشغيل.	يحدث عند انتهاء صلاحية تشغيل.
`thread.run.step.created`	`data` هي خطوة تشغيل.	يحدث عند إنشاء خطوة تشغيل.
`thread.run.step.in_progress`	`data` هي خطوة تشغيل.	يحدث عندما تنتقل خطوة تشغيل إلى حالة `in_progress` .
`thread.run.step.delta`	`data` هو دلتا خطوة التشغيل.	يحدث عندما يتم دفق أجزاء من خطوة تشغيل.
`thread.run.step.completed`	`data` هي خطوة تشغيل.	يحدث عند اكتمال خطوة تشغيل.
`thread.run.step.failed`	`data` هي خطوة تشغيل.	يحدث عند فشل خطوة تشغيل.
`thread.run.step.cancelled`	`data` هي خطوة تشغيل.	يحدث عند إلغاء خطوة تشغيل.
`thread.run.step.expired`	`data` هي خطوة تشغيل.	يحدث عند انتهاء صلاحية خطوة تشغيل.
`thread.message.created`	`data` هو رسالة.	يحدث عند إنشاء رسالة.
`thread.message.in_progress`	`data` هو رسالة.	يحدث عندما تنتقل رسالة إلى حالة in_progress.
`thread.message.delta`	`data` هو دلتا رسالة.	يحدث عندما يتم دفق أجزاء من رسالة.
`thread.message.completed`	`data` هو رسالة.	يحدث عند اكتمال رسالة.
`thread.message.incomplete`	`data` هو رسالة.	يحدث عندما تنتهي الرسالة قبل اكتمالها.
`error`	`data` هو خطأ.	يحدث عند حدوث خطأ. يمكن أن يحدث هذا بسبب خطأ خادم داخلي أو مهلة.
`done`	`data` هو `[DONE]`	يحدث عند انتهاء الدفق.

مشاركة عبر

مرجع تشغيل Assistants API (Preview)

إنشاء تشغيل

المرتجعات

مثال على إنشاء طلب تشغيل

إنشاء مؤشر ترابط وتشغيل

المرتجعات

مثال إنشاء مؤشر ترابط وتشغيل الطلب

تشغيل القائمة

المرتجعات

مثال على طلب تشغيل القائمة

سرد خطوات التشغيل

المرتجعات

مثال لطلب خطوات تشغيل القائمة

استرداد التشغيل

المرتجعات

مثال لطلب خطوات تشغيل القائمة

استرداد خطوة التشغيل

المرتجعات

مثال على استرداد طلب خطوات التشغيل

تعديل التشغيل

المرتجعات

مثال تعديل طلب التشغيل

إرسال مخرجات الأداة للتشغيل

المرتجعات

مثال إرسال مخرجات الأداة لتشغيل الطلب

إلغاء تشغيل

المرتجعات

مثال إرسال مخرجات الأداة لتشغيل الطلب

تشغيل الكائن

تشغيل كائن الخطوة

دفق نتيجة تشغيل (معاينة)

مثال الدفق

كائن دلتا الرسالة

تشغيل كائن دلتا للخطوة

أحداث دفق المساعد

الملاحظات

الملاحظات

الموارد الإضافية