المرجع: الإكمال | Azure التعلم الآلي

إنشاء إكمال للمطالبة والمعلمات المتوفرة.

POST /completions?api-version=2024-04-01-preview

الاسم	في	المطلوب	نوع	‏‏الوصف
نسخة واجهة برمجة التطبيقات	استعلام	صواب	سلسلة	إصدار واجهة برمجة التطبيقات بتنسيق "YYYY-MM-DD" أو "YYYY-MM-DD-preview".

رأس الطلب

الاسم	مطلوبة	نوع	‏‏الوصف
معلمات إضافية		سلسلة	سلوك واجهة برمجة التطبيقات عند الإشارة إلى معلمات إضافية في الحمولة. يؤدي استخدام pass-through إلى جعل واجهة برمجة التطبيقات لتمرير المعلمة إلى النموذج الأساسي. استخدم هذه القيمة عندما تريد تمرير المعلمات التي تعرف أن النموذج الأساسي يمكن أن يدعمها. يؤدي استخدام ignore إلى جعل واجهة برمجة التطبيقات لإسقاط أي معلمة غير مدعومة. استخدم هذه القيمة عندما تحتاج إلى استخدام نفس الحمولة عبر نماذج مختلفة، ولكن قد تقوم إحدى المعلمات الإضافية بإنشاء نموذج للخطأ إذا لم يكن مدعوما. يؤدي استخدام error إلى جعل واجهة برمجة التطبيقات لرفض أي معلمة إضافية في الحمولة. يمكن الإشارة إلى المعلمات المحددة في واجهة برمجة التطبيقات هذه فقط، أو إرجاع خطأ 400.
azureml-model-deployment		سلسلة	اسم النشر الذي تريد توجيه الطلب إليه. معتمد لنقاط النهاية التي تدعم عمليات نشر متعددة.

نص الطلب

الاسم	مطلوبة	نوع	‏‏الوصف
prompt	صواب		المطالبات بإنشاء عمليات إكمال ل، مرمزة كسلسلة، أو صفيف من السلاسل، أو صفيف من الرموز المميزة، أو صفيف من صفائف الرمز المميز. لاحظ أن <\|endoftext\|> هو فاصل المستندات الذي يراه النموذج أثناء التدريب، لذلك إذا لم يتم تحديد مطالبة، فسينشئ النموذج كما لو كان من بداية مستند جديد.
frequency_penalty		رقم	تفرض القيم الموجبة عقوبات على الرموز المميزة الجديدة استنادًا إلى تكرارها الحالي في النص حتى الآن، ما يقلل من احتمال تكرار النموذج لنفس الخط الحرفي.
max_tokens		integer	الحد الأقصى لعدد الرموز المميزة التي يمكن إنشاؤها عند الاكتمال. لا يمكن أن يتجاوز عدد الرموز المميزة لمطالبتك بالإضافة إلى max_tokens طول سياق النموذج.
presence_penalty		رقم	تفرض القيم الموجبة عقوبات على الرموز المميزة الجديدة استنادًا إلى إذا كانت تظهر في النص حتى الآن، ما يزيد من احتمالية التحدث عن مواضيع جديدة في النموذج.
seed		integer	إذا تم تحديده، يبذل النموذج أفضل جهد للعينة بشكل محدد، بحيث يجب أن ترجع الطلبات المتكررة بنفسها seed والمعلمات نفس النتيجة. الحتمية غير مضمونة، ويجب عليك الرجوع إلى معلمة الاستجابة system_fingerprint لمراقبة التغييرات في الخلفية.
stop			التسلسلات حيث ستتوقف واجهة برمجة التطبيقات عن إنشاء المزيد من الرموز المميزة. لن يحتوي النص الذي تم إرجاعه على تسلسل الإيقاف.
استدر		boolean	سواء كنت تريد إرجاع التقدم الجزئي أم لا. إذا تم تعيينها، إرسال الرموز المميزة كأحداث مرسلة إلى الخادم فقط عند توفرها، مع إنهاء الدفق بواسطة رسالةdata: [DONE].
درجة الحرارة		رقم	ما هي درجة حرارة أخذ العينات لاستخدامها، بين 0 و2. القيم الأعلى مثل 0.8 ستجعل الإخراج أكثر عشوائية، بينما القيم الأقل مثل 0.2 ستجعله أكثر تركيزا وحسما. نوصي عموما بتغيير temperature أو top_p ولكن ليس كليهما.
top_p		رقم	بديل لأخذ العينات مع درجة الحرارة، يسمى أخذ عينات النواة، حيث يأخذ النموذج في الاعتبار نتائج الرموز المميزة مع كتلة الاحتمال top_p. لذا فإن 0.1 يعني أن الرموز المميزة التي تشكل كتلة الاحتمال الأعلى بنسبة 10٪ هي التي تعتبر فحسب. نوصي عموما بتغيير top_p أو temperature ولكن ليس كليهما.

الاستجابات

Name	كتابة	‏‏الوصف
200 جيد	إنشاءCompletionResponse	موافق
401 غير مصرح به	غير مصرح به	الرمز المميز للوصول مفقود أو غير صالح الرؤوس x-ms-error-code: سلسلة
404 لم يتم إيجادها	NotFoundError	طريقة غير مدعومة من قبل النموذج. تحقق من وثائق النموذج لمعرفة المسارات المتوفرة. الرؤوس x-ms-error-code: سلسلة
422 كيان غير قابل للمعالجة	غير قابل للمعالجةContentError	يحتوي الطلب على محتوى غير قابل للمعالجة الرؤوس x-ms-error-code: سلسلة
429 عدد كبير جداً من الطلبات	TooManyRequestsError	لقد وصلت إلى حد المعدل المعين ويجب أن يكون طلبك يسير بخطى سريعة. الرؤوس x-ms-error-code: سلسلة
رموز الحالة الأخرى	ContentFilterError	طلب غير صالح الرؤوس x-ms-error-code: سلسلة

الأمان

التصريح

الرمز المميز مع البادئة Bearer: ، على سبيل المثال. Bearer abcde12345

النوع: apiKey
في: رأس الصفحة

رمز AADToken

مصادقة Azure Active Directory OAuth2

النوع: oauth2
التدفق: التطبيق
عنوان URL للرمز المميز: https://login.microsoftonline.com/common/oauth2/v2.0/token

الأمثلة

إنشاء إكمال للمطالبة والمعلمات المتوفرة

طلب عينة

POST /completions?api-version=2024-04-01-preview

{
  "prompt": "This is a very good text",
  "frequency_penalty": 0,
  "presence_penalty": 0,
  "max_tokens": 256,
  "seed": 42,
  "stop": "<|endoftext|>",
  "stream": false,
  "temperature": 0,
  "top_p": 1
}

استجابة العينة

رمز الحالة: 200

{
  "id": "1234567890",
  "model": "llama2-7b",
  "choices": [
    {
      "index": 0,
      "finish_reason": "stop",
      "text": ", indeed it is a good one."
    }
  ],
  "created": 1234567890,
  "object": "text_completion",
  "usage": {
    "prompt_tokens": 15,
    "completion_tokens": 8,
    "total_tokens": 23
  }
}

التعريفات

Name	‏‏الوصف
Choices	قائمة بخيارات إكمال الدردشة.
اكتمالالقراءة	سبب توقف النموذج عن إنشاء الرموز المميزة. هذا إذا stop وصل النموذج إلى نقطة توقف طبيعية أو تسلسل توقف متوفر، length إذا تم الوصول إلى الحد الأقصى لعدد الرموز المميزة المحددة في الطلب، content_filter إذا تم حذف المحتوى بسبب علامة من عوامل تصفية المحتوى لدينا.
إكمال الاستخدام	إحصائيات الاستخدام لطلب الإكمال.
ContentFilterError	يفشل استدعاء واجهة برمجة التطبيقات عندما تقوم المطالبة بتشغيل عامل تصفية محتوى كما تم تكوينه. تعديل المطالبة والمحاولة مرة أخرى.
CreateCompletionRequest
إنشاءCompletionResponse	يمثل استجابة إكمال من واجهة برمجة التطبيقات.
تفصيل
TextCompletionObject	نوع الكائن، والذي يكون دائما "text_completion"
غير قابل للمعالجةContentError

اختيارات

قائمة بخيارات إكمال الدردشة.

Name	كتابة	‏‏الوصف
finish_reason	اكتمالالقراءة	سبب توقف النموذج عن إنشاء الرموز المميزة. هذا إذا stop وصل النموذج إلى نقطة توقف طبيعية أو تسلسل توقف متوفر، length إذا تم الوصول إلى الحد الأقصى لعدد الرموز المميزة المحددة في الطلب، content_filter إذا تم حذف المحتوى بسبب علامة من عوامل تصفية المحتوى لدينا، tool_calls إذا كان النموذج يسمى أداة.
الفهرس	integer	فهرس الاختيار في قائمة الاختيارات.
النص	سلسلة	النص الذي تم إنشاؤه.

اكتمالالقراءة

سبب توقف النموذج عن إنشاء الرموز المميزة. هذا إذا stop وصل النموذج إلى نقطة توقف طبيعية أو تسلسل توقف متوفر، length إذا تم الوصول إلى الحد الأقصى لعدد الرموز المميزة المحددة في الطلب، content_filter إذا تم حذف المحتوى بسبب علامة من عوامل تصفية المحتوى لدينا.

Name	كتابة	‏‏الوصف
content_filter	سلسلة
طول	سلسلة
stop	سلسلة

إكمال الاستخدام

إحصائيات الاستخدام لطلب الإكمال.

Name	كتابة	‏‏الوصف
completion_tokens	integer	عدد الرموز المميزة في الإكمال الذي تم إنشاؤه.
prompt_tokens	integer	عدد الرموز المميزة في المطالبة.
total_tokens	integer	إجمالي عدد الرموز المميزة المستخدمة في الطلب (المطالبة + الإكمال).

ContentFilterError

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

Name	كتابة	‏‏الوصف
الكود	سلسلة	رمز الخطأ.
error	سلسلة	وصف الخطأ.
رسالة	سلسلة	رسالة الخطأ.
بارام	سلسلة	المعلمة التي أدت إلى تشغيل عامل تصفية المحتوى.
الحالة	integer	رمز حالة HTTP.

CreateCompletionRequest

Name	نوع	القيمة الافتراضية	‏‏الوصف
frequency_penalty	رقم	0	تفرض القيم الموجبة عقوبات على الرموز المميزة الجديدة استنادًا إلى تكرارها الحالي في النص حتى الآن، ما يقلل من احتمال تكرار النموذج لنفس الخط الحرفي.
max_tokens	integer	256	الحد الأقصى لعدد الرموز المميزة التي يمكن إنشاؤها عند الاكتمال. لا يمكن أن يتجاوز عدد الرموز المميزة لمطالبتك بالإضافة إلى max_tokens طول سياق النموذج.
presence_penalty	رقم	0	تفرض القيم الموجبة عقوبات على الرموز المميزة الجديدة استنادًا إلى إذا كانت تظهر في النص حتى الآن، ما يزيد من احتمالية التحدث عن مواضيع جديدة في النموذج.
prompt		<\|endoftext\|>	المطالبات بإنشاء عمليات إكمال ل، مرمزة كسلسلة، أو صفيف من السلاسل، أو صفيف من الرموز المميزة، أو صفيف من صفائف الرمز المميز. لاحظ أن <\|endoftext\|> هو فاصل المستندات الذي يراه النموذج أثناء التدريب، لذلك إذا لم يتم تحديد مطالبة، فسينشئ النموذج كما لو كان من بداية مستند جديد.
seed	integer		إذا تم تحديده، فسيبذل نظامنا أفضل جهد للعينة بشكل محدد، بحيث أن الطلبات المتكررة بنفسها seed والمعلمات يجب أن ترجع نفس النتيجة. الحتمية غير مضمونة، ويجب عليك الرجوع إلى معلمة الاستجابة system_fingerprint لمراقبة التغييرات في الخلفية.
stop			التسلسلات حيث ستتوقف واجهة برمجة التطبيقات عن إنشاء المزيد من الرموز المميزة. لن يحتوي النص الذي تم إرجاعه على تسلسل الإيقاف.
استدر	boolean	خطأ	سواء كنت تريد إرجاع التقدم الجزئي أم لا. إذا تم تعيينها، إرسال الرموز المميزة كأحداث مرسلة إلى الخادم فقط عند توفرها، مع إنهاء الدفق بواسطة رسالةdata: [DONE].
درجة الحرارة	رقم	1	ما هي درجة حرارة أخذ العينات لاستخدامها، بين 0 و2. القيم الأعلى مثل 0.8 ستجعل الإخراج أكثر عشوائية، بينما القيم الأقل مثل 0.2 ستجعله أكثر تركيزا وحسما. نوصي عموما بتغيير هذا أو top_p ولكن ليس كليهما.
top_p	رقم	1	بديل لأخذ العينات مع درجة الحرارة، يسمى أخذ عينات النواة، حيث يأخذ النموذج في الاعتبار نتائج الرموز المميزة مع كتلة الاحتمال top_p. لذا فإن 0.1 يعني أن الرموز المميزة التي تشكل كتلة الاحتمال الأعلى بنسبة 10٪ هي التي تعتبر فحسب. نوصي عموما بتغيير هذا أو temperature ولكن ليس كليهما.

إنشاءCompletionResponse

يمثل استجابة إكمال من واجهة برمجة التطبيقات. ملاحظة: تشترك كائنات الاستجابة المتدفقة وغير المتدفقة في نفس الشكل (على عكس نقطة نهاية الدردشة).

Name	كتابة	‏‏الوصف
الخيارات	الاختيارات[]	قائمة خيارات الإكمال النموذج الذي تم إنشاؤه لمطالبة الإدخال.
تم الإنشاء	integer	الطابع الزمني Unix (بالثوان) لوقت إنشاء الإكمال.
المعرف	سلسلة	معرف فريد للاكتمال.
نموذج	سلسلة	النموذج المستخدم للإكمال.
كائن	TextCompletionObject	نوع الكائن، والذي يكون دائما "text_completion"
system_fingerprint	سلسلة	تمثل بصمة الإصبع هذه تكوين الخلفية التي يعمل بها النموذج. يمكن استخدامها مع معلمة seed الطلب لفهم متى تم إجراء تغييرات الواجهة الخلفية التي قد تؤثر على الحتمية.
نشط	إكمال الاستخدام	إحصائيات الاستخدام لطلب الإكمال.

التفاصيل

Name	كتابة	‏‏الوصف
خط التماس	string[]	المعلمة التي تسبب المشكلة
قيمة	سلسلة	القيمة التي تم تمريرها إلى المعلمة التي تسبب مشكلات.

TextCompletionObject

نوع الكائن، والذي يكون دائما "text_completion"

Name	كتابة	‏‏الوصف
text_completion	سلسلة

ListObject

نوع الكائن، وهو دائما "قائمة".

Name	كتابة	‏‏الوصف
قائمة	سلسلة

NotFoundError

Name	كتابة	‏‏الوصف
error	سلسلة	وصف الخطأ.
رسالة	سلسلة	رسالة الخطأ.
الحالة	integer	رمز حالة HTTP.

TooManyRequestsError

Name	كتابة	‏‏الوصف
error	سلسلة	وصف الخطأ.
رسالة	سلسلة	رسالة الخطأ.
الحالة	integer	رمز حالة HTTP.

غير مصرح به

Name	كتابة	‏‏الوصف
error	سلسلة	وصف الخطأ.
رسالة	سلسلة	رسالة الخطأ.
الحالة	integer	رمز حالة HTTP.

غير قابل للمعالجةContentError

Name	كتابة	‏‏الوصف
الكود	سلسلة	رمز الخطأ.
تفصيل	تفصيل
error	سلسلة	وصف الخطأ.
رسالة	سلسلة	رسالة الخطأ.
الحالة	integer	رمز حالة HTTP.