مشاركة عبر

مرجع رسائل واجهة برمجة تطبيقات المساعدين (معاينة)

  • مقالة

إشعار

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

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

إنشاء رسالة

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

إنشاء رسالة.

معلمة المسار

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

نص الطلب

Name نوع مطلوبة ‏‏الوصف
role سلسلة المطلوب دور الكيان الذي يقوم بإنشاء الرسالة. يمكن أن يكون user، أو assistant. assistant يشير إلى أن الرسالة يتم إرسالها من قبل مستخدم فعلي ويجب استخدامها في معظم الحالات لتمثيل الرسائل التي أنشأها المستخدم. assistant يشير إلى أن الرسالة تم إنشاؤها بواسطة المساعد. استخدم هذه القيمة لإدراج رسائل من المساعد في المحادثة.
content سلسلة المطلوب محتوى الرسالة.
file_ids صفيف اختياري قائمة بمعرفات الملفات التي يجب أن تستخدمها الرسالة. يمكن أن يكون هناك 10 ملفات مرفقة برسالة كحد أقصى. مفيد لأدوات مثل الاسترداد code_interpreter التي يمكنها الوصول إلى الملفات واستخدامها.
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")
    )

thread_message = client.beta.threads.messages.create(
  "thread_abc123",
  role="user",
  content="How does AI work? Explain it in simple terms.",
)
print(thread_message)

سرد الرسائل

GET https://YOUR_RESOURCE_NAME.openai.azure.com/openai/threads/{thread_id}/messages?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 لإحضار الصفحة السابقة من القائمة.

المرتجعات

قائمة كائنات الرسائل .

مثال لطلب رسائل القائمة

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")
    )

thread_messages = client.beta.threads.messages.list("thread_abc123")
print(thread_messages.data)

سرد ملفات الرسائل

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

إرجاع قائمة بملفات الرسائل.

المعلمة نوع مطلوبة ‏‏الوصف
thread_id سلسلة المطلوب معرف مؤشر الترابط الذي تنتمي إليه الرسالة والملفات.
message_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 لإحضار الصفحة السابقة من القائمة.

المرتجعات

قائمة بعناصر ملف الرسائل

مثال طلب ملفات رسائل القائمة

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")
    )

message_files = client.beta.threads.messages.files.list(
  thread_id="thread_abc123",
  message_id="msg_abc123"
)
print(message_files)

استرداد الرسالة

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

استرداد ملف رسالة.

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

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

المرتجعات

كائن الرسالة المطابق للمعرف المحدد.

مثال على استرداد طلب الرسالة

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")
    )

message = client.beta.threads.messages.retrieve(
  message_id="msg_abc123",
  thread_id="thread_abc123",
)
print(message)

استرداد ملف الرسالة

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

استرداد ملف رسالة.

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

المعلمة نوع مطلوبة ‏‏الوصف
thread_id سلسلة المطلوب معرف مؤشر الترابط، الذي تنتمي إليه الرسالة والملف.
message_id سلسلة المطلوب معرف الرسالة التي ينتمي إليها الملف.
file_id سلسلة المطلوب معرف الملف الذي يتم استرداده.

مرتجعات

كائن ملف الرسالة.

مثال على استرداد طلب ملف الرسالة

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")
    )

message_files = client.beta.threads.messages.files.retrieve(
    thread_id="thread_abc123",
    message_id="msg_abc123",
    file_id="assistant-abc123"
)
print(message_files)

تعديل الرسالة

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

تعديل رسالة.

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

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

نص الطلب

المعلمة نوع مطلوبة ‏‏الوصف
بيانات التعريف 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")
    )

message = client.beta.threads.messages.update(
  message_id="msg_abc12",
  thread_id="thread_abc123",
  metadata={
    "modified": "true",
    "user": "abc123",
  },
)
print(message)

كائن الرسالة

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

Name كتابة الوصف
id سلسلة المعرف، الذي يمكن الرجوع إليه في نقاط نهاية واجهة برمجة التطبيقات.
object سلسلة نوع الكائن، وهو دائما thread.message.
created_at integer الطابع الزمني Unix (بالثوان) لوقت إنشاء الرسالة.
thread_id سلسلة معرف مؤشر الترابط الذي تنتمي إليه هذه الرسالة.
role سلسلة الكيان الذي أنتج الرسالة. أحد المستخدمين أو المساعدين.
content صفيف محتوى الرسالة في صفيف من النص و/أو الصور.
assistant_id سلسلة أو قيمة خالية إذا كان ذلك ممكنا، معرف المساعد الذي قام بتأليف هذه الرسالة.
run_id سلسلة أو قيمة خالية إذا كان ذلك ممكنا، معرف التشغيل المقترن بتأليف هذه الرسالة.
file_ids صفيف قائمة بمعرفات الملفات التي يجب أن يستخدمها المساعد. مفيد لأدوات مثل الاسترداد code_interpreter التي يمكنها الوصول إلى الملفات. يمكن إرفاق 10 ملفات كحد أقصى برسالة.
metadata map مجموعة من 16 زوجا من قيم المفاتيح التي يمكن إرفاقها بعنصر. يمكن أن يكون هذا مفيدا لتخزين معلومات إضافية حول الكائن بتنسيق منظم. يمكن أن يكون طول المفاتيح 64 حرفا كحد أقصى ويمكن أن تكون القيم بحد أقصى 512 حرفا.

كائن ملف الرسالة

قائمة بالملفات المرفقة برسالة.

Name كتابة الوصف
id سلسلة المعرف، الذي يمكن الرجوع إليه في نقاط نهاية واجهة برمجة التطبيقات.
object سلسلة نوع الكائن، وهو دائما thread.message.file.
created_at integer الطابع الزمني Unix (بالثوان) لوقت إنشاء ملف الرسالة.
message_id سلسلة معرف الرسالة التي يتم إرفاق الملف بها.