Azure OpenAI في Microsoft Foundry Models تأليف مرجع معاينة REST API

توفر هذه المقالة تفاصيل حول نقاط نهاية واجهة برمجة تطبيقات REST للاستدلال Azure OpenAI.

API specs

يتم تقسيم إدارة Azure والموارد الخاصة ب OpenAI والتفاعل معها عبر ثلاثة أسطح واجهة برمجة التطبيقات الأساسية:

  • Control plane
  • مستوى البيانات - التأليف
  • مستوى البيانات - الاستدلال

يغلف كل سطح/مواصفات واجهة برمجة تطبيقات مجموعة مختلفة من قدرات OpenAI Azure. تحتوي كل واجهة برمجة تطبيقات على مجموعة فريدة خاصة بها من المعاينة وإصدارات واجهة برمجة التطبيقات (GA) الثابتة/المتوفرة بشكل عام. تميل إصدارات المعاينة حاليا إلى اتباع إيقاع شهري.

Important

هناك الآن واجهة برمجة تطبيقات استدلال معاينة جديدة. تعرف على المزيد في دليل دورة حياة واجهة برمجة التطبيقات.

API أحدث إصدار معاينة أحدث إصدار من GA Specifications Description
Control plane 2025-07-01-preview 2025-06-01 Spec files يتم استخدام واجهة برمجة تطبيقات مستوى التحكم لعمليات مثل إنشاء المواردونشر النموذج ومهام إدارة الموارد الأخرى ذات المستوى الأعلى. تحكم وحدة التحكم أيضا ما يمكن القيام به مع قدرات مثل Azure Resource Manager Bicep وTerraform Azure CLI.
Data plane v1 preview v1 Spec files تتحكم واجهة برمجة تطبيقات مستوى البيانات في عمليات الاستدلال والتأليف.

Authentication

يوفر Azure OpenAI طريقتين للمصادقة. يمكنك استخدام مفاتيح واجهة برمجة التطبيقات أو Microsoft Entra ID.

  • مصادقة مفتاح API: لهذا النوع من المصادقة، يجب أن تتضمن جميع طلبات واجهة برمجة التطبيقات مفتاح API في api-key رأس HTTP. يوفر التشغيل السريع إرشادات حول كيفية إجراء مكالمات باستخدام هذا النوع من المصادقة.

  • مصادقة Microsoft Entra ID: يمكنك مصادقة استدعاء واجهة برمجة التطبيقات باستخدام رمز مميز Microsoft Entra. يتم تضمين رموز المصادقة المميزة في طلب كعنوان Authorization . يجب أن يسبق Bearerالرمز المميز المقدم ، على سبيل المثال Bearer YOUR_AUTH_TOKEN. يمكنك قراءة دليل الكيفية حول مصادقة باستخدام Microsoft Entra ID.

إصدار واجهة برمجة تطبيقات REST

يتم إصدار واجهات برمجة التطبيقات للخدمة باستخدام معلمة api-version الاستعلام. تتبع جميع الإصدارات بنية التاريخ YYYY-MM-DD. For example:

POST https://YOUR_RESOURCE_NAME.openai.azure.com/openai/deployments/YOUR_DEPLOYMENT_NAME/chat/completions?api-version=2024-06-01

تأليف مستوى البيانات

تغطي بقية المقالة إصدار المعاينة لمواصفات استدلال مستوى بيانات OpenAI Azure، 2025-04-01-preview.

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

دفعة - قائمة

GET {endpoint}/openai/batches?api-version=2025-04-01-preview

يحصل على قائمة بجميع الدفعات المملوكة لمورد Azure OpenAI.

URI Parameters

Name In Required Type Description
endpoint path Yes string
url
نقاط نهاية OpenAI Azure المدعومة (البروتوكول واسم المضيف، على سبيل المثال: https://aoairesource.openai.azure.com. استبدل "aoairesource" باسم مورد Azure OpenAI). https://{your-resource-name}.openai.azure.com
after query No string معرف الحدث الأخير من طلب الترقيم السابق.
limit query No integer عدد الدفعات المراد استردادها. الإعدادات الافتراضية إلى 20.
$filter query No string تعبير OData لوصف شروط التصفية.
$orderby query No string تعبير OData لوصف ترتيب الفرز.
api-version query Yes string إصدار API المطلوب.

Request Header

استخدم إما المصادقة المستندة إلى الرمز المميز أو مفتاح API. يوصى بالمصادقة باستخدام المصادقة المستندة إلى الرمز المميز وأكثر أمانا.

Name Required Type Description
Authorization True string Example:Authorization: Bearer {Azure_OpenAI_Auth_Token}

لنشاء رمز مميز للمصادقة باستخدام Azure CLI: az account get-access-token --resource https://cognitiveservices.azure.com

Type: oauth2
عنوان Url للتخويل: https://login.microsoftonline.com/common/oauth2/v2.0/authorize
نطاق: https://ai.azure.com/.default
api-key True string توفير مفتاح واجهة برمجة تطبيقات OpenAI Azure هنا

Responses

رمز الحالة: 200

Description: Success

Content-Type Type Description
application/json BatchesList

رمز الحالة: افتراضي

الوصف: حدث خطأ.

Content-Type Type Description
application/json ErrorResponse

Examples

GET {endpoint}/openai/batches?api-version=2025-04-01-preview

الاستجابات: رمز الحالة: 200

{
  "headers": {},
  "body": {
    "has_more": false,
    "data": [
      {
        "object": "batch",
        "id": "batch_72a2792ef7d24ba7b82c7fe4a37e379f",
        "endpoint": "/chat/completions",
        "errors": null,
        "input_file_id": "file-b4fa7277f3eb4722ac18b90f46102c3f",
        "completion_window": "24h",
        "status": "completed",
        "output_file_id": "file-f2ddaf43-b48b-46dd-b264-90da10c7a85b",
        "error_file_id": "file-c3b563b0-ebc7-47da-93e3-a2fa694aef0c",
        "created_at": 1646126127,
        "in_progress_at": 1646126130,
        "expires_at": 1646126170,
        "finalizing_at": 1646126134,
        "completed_at": 1646126136,
        "failed_at": null,
        "expired_at": null,
        "cancelling_at": null,
        "cancelled_at": null,
        "request_counts": {
          "total": 500,
          "completed": 400,
          "failed": 100
        },
        "first_id": "batch_abc123",
        "last_id": "batch_abc456",
        "metadata": {
          "batch_description": "Evaluation job"
        }
      }
    ],
    "object": "list"
  }
}

دفعة - إنشاء

POST {endpoint}/openai/batches?api-version=2025-04-01-preview

إنشاء دفعة وتنفيذها من ملف تم تحميله من الطلبات.

تتضمن الاستجابة تفاصيل المهمة المدرجة في قائمة الانتظار بما في ذلك حالة الوظيفة.

تتم إضافة معرف ملف النتيجة إلى الاستجابة بمجرد اكتمالها.

URI Parameters

Name In Required Type Description
endpoint path Yes string
url
نقاط نهاية OpenAI Azure المدعومة (البروتوكول واسم المضيف، على سبيل المثال: https://aoairesource.openai.azure.com. استبدل "aoairesource" باسم مورد Azure OpenAI). https://{your-resource-name}.openai.azure.com
api-version query Yes string إصدار API المطلوب.

Request Header

استخدم إما المصادقة المستندة إلى الرمز المميز أو مفتاح API. يوصى بالمصادقة باستخدام المصادقة المستندة إلى الرمز المميز وأكثر أمانا.

Name Required Type Description
Authorization True string Example:Authorization: Bearer {Azure_OpenAI_Auth_Token}

لنشاء رمز مميز للمصادقة باستخدام Azure CLI: az account get-access-token --resource https://cognitiveservices.azure.com

Type: oauth2
عنوان Url للتخويل: https://login.microsoftonline.com/common/oauth2/v2.0/authorize
نطاق: https://ai.azure.com/.default
api-key True string توفير مفتاح واجهة برمجة تطبيقات OpenAI Azure هنا

Request Body

Content-Type: application/json

Name Type Description Required Default
completion_window string الإطار الزمني الذي يجب أن تتم فيه معالجة الدفعة. Yes
endpoint string نقطة نهاية API المستخدمة من قبل الدفعة. Yes
input_blob string عنوان url تخزين Azure blob لاستخدامه كمدخل للدفعة. No
input_file_id string معرف ملف الإدخال للدفعة. No
metadata object مجموعة من أزواج المفاتيح والقيم التي يمكن ربطها بالدفعة. يمكن أن يكون هذا مفيدا لتخزين معلومات إضافية حول الدفعة بتنسيق منظم. No
output_expires_after FileExpiresAfter تعريف انتهاء صلاحية الملف. No
output_folder BatchOutputReference مجلد تخزين Azure لتخزين الإخراج. No

Responses

رمز الحالة: 201

الوصف: تم إنشاء الدفعة بنجاح.

Content-Type Type Description
application/json Batch

رمز الحالة: افتراضي

الوصف: حدث خطأ.

Content-Type Type Description
application/json ErrorResponse

Examples

POST {endpoint}/openai/batches?api-version=2025-04-01-preview

الاستجابات: رمز الحالة: 201

{
  "headers": {
    "deployment-enqueued-tokens": 1000,
    "deployment-maximum-enqueued-tokens": 5000
  },
  "body": {
    "object": "batch",
    "id": "batch_72a2792ef7d24ba7b82c7fe4a37e379f",
    "endpoint": "/chat/completions",
    "errors": null,
    "input_file_id": "file-b4fa7277f3eb4722ac18b90f46102c3f",
    "completion_window": "24h",
    "status": "validating",
    "output_file_id": null,
    "error_file_id": null,
    "created_at": 1646126127,
    "in_progress_at": null,
    "expires_at": null,
    "finalizing_at": null,
    "completed_at": null,
    "failed_at": null,
    "expired_at": null,
    "cancelling_at": null,
    "cancelled_at": null,
    "request_counts": {
      "total": 0,
      "completed": 0,
      "failed": 0
    },
    "metadata": {
      "batch_description": "Evaluation job"
    }
  }
}

الدفعة - الحصول على

GET {endpoint}/openai/batches/{batch-id}?api-version=2025-04-01-preview

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

URI Parameters

Name In Required Type Description
endpoint path Yes string
url
نقاط نهاية OpenAI Azure المدعومة (البروتوكول واسم المضيف، على سبيل المثال: https://aoairesource.openai.azure.com. استبدل "aoairesource" باسم مورد Azure OpenAI). https://{your-resource-name}.openai.azure.com
batch-id path Yes string معرف الدفعة.
api-version query Yes string إصدار API المطلوب.

Request Header

استخدم إما المصادقة المستندة إلى الرمز المميز أو مفتاح API. يوصى بالمصادقة باستخدام المصادقة المستندة إلى الرمز المميز وأكثر أمانا.

Name Required Type Description
Authorization True string Example:Authorization: Bearer {Azure_OpenAI_Auth_Token}

لنشاء رمز مميز للمصادقة باستخدام Azure CLI: az account get-access-token --resource https://cognitiveservices.azure.com

Type: oauth2
عنوان Url للتخويل: https://login.microsoftonline.com/common/oauth2/v2.0/authorize
نطاق: https://ai.azure.com/.default
api-key True string توفير مفتاح واجهة برمجة تطبيقات OpenAI Azure هنا

Responses

رمز الحالة: 200

Description: Success

Content-Type Type Description
application/json Batch

رمز الحالة: افتراضي

الوصف: حدث خطأ.

Content-Type Type Description
application/json ErrorResponse

Examples

GET {endpoint}/openai/batches/{batch-id}?api-version=2025-04-01-preview

الاستجابات: رمز الحالة: 200

{
  "headers": {},
  "body": {
    "object": "batch",
    "id": "batch_72a2792ef7d24ba7b82c7fe4a37e379f",
    "endpoint": "/chat/completions",
    "errors": null,
    "input_file_id": "file-b4fa7277f3eb4722ac18b90f46102c3f",
    "completion_window": "24h",
    "status": "completed",
    "output_file_id": "file-f2ddaf43-b48b-46dd-b264-90da10c7a85b",
    "error_file_id": "file-c3b563b0-ebc7-47da-93e3-a2fa694aef0c",
    "created_at": 1646126127,
    "in_progress_at": 1646126130,
    "expires_at": 1646126170,
    "finalizing_at": 1646126134,
    "completed_at": 1646126136,
    "failed_at": null,
    "expired_at": null,
    "cancelling_at": null,
    "cancelled_at": null,
    "request_counts": {
      "total": 500,
      "completed": 400,
      "failed": 100
    },
    "metadata": {
      "batch_description": "Evaluation job"
    }
  }
}

Batch - إلغاء الأمر

POST {endpoint}/openai/batches/{batch-id}/cancel?api-version=2025-04-01-preview

إلغاء معالجة الدفعة المحددة بواسطة معرف الدفعة المحدد.

URI Parameters

Name In Required Type Description
endpoint path Yes string
url
نقاط نهاية OpenAI Azure المدعومة (البروتوكول واسم المضيف، على سبيل المثال: https://aoairesource.openai.azure.com. استبدل "aoairesource" باسم مورد Azure OpenAI). https://{your-resource-name}.openai.azure.com
batch-id path Yes string معرف الدفعة.
api-version query Yes string إصدار API المطلوب.

Request Header

استخدم إما المصادقة المستندة إلى الرمز المميز أو مفتاح API. يوصى بالمصادقة باستخدام المصادقة المستندة إلى الرمز المميز وأكثر أمانا.

Name Required Type Description
Authorization True string Example:Authorization: Bearer {Azure_OpenAI_Auth_Token}

لنشاء رمز مميز للمصادقة باستخدام Azure CLI: az account get-access-token --resource https://cognitiveservices.azure.com

Type: oauth2
عنوان Url للتخويل: https://login.microsoftonline.com/common/oauth2/v2.0/authorize
نطاق: https://ai.azure.com/.default
api-key True string توفير مفتاح واجهة برمجة تطبيقات OpenAI Azure هنا

Responses

رمز الحالة: 200

الوصف: تم إلغاء الدفعة بنجاح.

Content-Type Type Description
application/json Batch

رمز الحالة: افتراضي

الوصف: حدث خطأ.

Content-Type Type Description
application/json ErrorResponse

Examples

POST {endpoint}/openai/batches/{batch-id}/cancel?api-version=2025-04-01-preview

الاستجابات: رمز الحالة: 200

{
  "headers": {},
  "body": {
    "object": "batch",
    "id": "batch_72a2792ef7d24ba7b82c7fe4a37e379f",
    "endpoint": "/chat/completions",
    "errors": null,
    "input_file_id": "file-b4fa7277f3eb4722ac18b90f46102c3f",
    "completion_window": "24h",
    "status": "cancelling",
    "output_file_id": null,
    "error_file_id": null,
    "created_at": 1646126127,
    "in_progress_at": 1646126130,
    "expires_at": 1646126170,
    "finalizing_at": null,
    "completed_at": null,
    "failed_at": null,
    "expired_at": null,
    "cancelling_at": 1646126138,
    "cancelled_at": null,
    "request_counts": {
      "total": 500,
      "completed": 100,
      "failed": 5
    },
    "metadata": {
      "batch_description": "Evaluation job"
    }
  }
}

الإكمال المخزن - قائمة

GET {endpoint}/openai/chat/completions?api-version=2025-04-01-preview

يحصل على قائمة بالإكمالات المخزنة.

URI Parameters

Name In Required Type Description
endpoint path Yes string
url
نقاط نهاية OpenAI Azure المدعومة (البروتوكول واسم المضيف، على سبيل المثال: https://aoairesource.openai.azure.com. استبدل "aoairesource" باسم مورد Azure OpenAI). https://{your-resource-name}.openai.azure.com
metadata query No string قم بالتصفية حسب زوج (المفتاح، القيمة) في الإكمال المخزن.
model query No string التصفية حسب اسم النموذج.
after query No string معرف آخر اكتمال مخزن من طلب ترقيم الصفحات السابق.
limit query No integer عدد عمليات الإكمال المخزنة المراد استردادها. الإعدادات الافتراضية إلى 20.
order query No string ترتيب النتائج حسب وقت الإنشاء (تصاعدي أو تنازلي). الافتراضي إلى desc.
api-version query Yes string إصدار API المطلوب.

Request Header

استخدم إما المصادقة المستندة إلى الرمز المميز أو مفتاح API. يوصى بالمصادقة باستخدام المصادقة المستندة إلى الرمز المميز وأكثر أمانا.

Name Required Type Description
Authorization True string Example:Authorization: Bearer {Azure_OpenAI_Auth_Token}

لنشاء رمز مميز للمصادقة باستخدام Azure CLI: az account get-access-token --resource https://cognitiveservices.azure.com

Type: oauth2
عنوان Url للتخويل: https://login.microsoftonline.com/common/oauth2/v2.0/authorize
نطاق: https://ai.azure.com/.default
api-key True string توفير مفتاح واجهة برمجة تطبيقات OpenAI Azure هنا

Responses

رمز الحالة: 200

Description: Success

Content-Type Type Description
application/json StoredCompletionList

رمز الحالة: افتراضي

الوصف: حدث خطأ.

Content-Type Type Description
application/json ErrorResponse

Examples

GET {endpoint}/openai/chat/completions?api-version=2025-04-01-preview

الاستجابات: رمز الحالة: 200

{
  "headers": {},
  "body": {
    "object": "list",
    "data": [
      {
        "id": "chatcmpl-AvBCKqg2xqxVHCCEnUB4Bgj1Bjl7Y",
        "model": "gpt-4o-mini-2024-07-18",
        "created": 1738193475,
        "request_id": "e539c139-a97d-4ee1-bde9-3be3d5c6edb5",
        "usage": {
          "total_tokens": 25,
          "completion_tokens": 7,
          "prompt_tokens": 18
        },
        "seed": 123,
        "top_p": 1,
        "temperature": 1,
        "presence_penalty": 0,
        "frequency_penalty": 0,
        "system_fingerprint": "fp_f3927aa00d",
        "metadata": {
          "key_1": "val_1",
          "key_2": "val_2"
        },
        "choices": [
          {
            "index": 0,
            "message": {
              "content": "Hello, how are you?",
              "role": "assistant"
            },
            "finish_reason": "stop"
          }
        ]
      }
    ],
    "total": 1,
    "first_id": "chatcmpl-AvBCKqg2xqxVHCCEnUB4Bgj1Bjl7Y",
    "last_id": "chatcmpl-AvBCKqg2xqxVHCCEnUB4Bgj1Bjl7Y",
    "has_more": false
  }
}

الإكمال المخزن - الحصول على

GET {endpoint}/openai/chat/completions/{stored-completion-id}?api-version=2025-04-01-preview

يحصل على الإكمال المخزن بواسطة معرف الإكمال المخزن المحدد.

URI Parameters

Name In Required Type Description
endpoint path Yes string
url
نقاط نهاية OpenAI Azure المدعومة (البروتوكول واسم المضيف، على سبيل المثال: https://aoairesource.openai.azure.com. استبدل "aoairesource" باسم مورد Azure OpenAI). https://{your-resource-name}.openai.azure.com
stored-completion-id path Yes string معرف الإكمال المخزن.
api-version query Yes string إصدار API المطلوب.

Request Header

استخدم إما المصادقة المستندة إلى الرمز المميز أو مفتاح API. يوصى بالمصادقة باستخدام المصادقة المستندة إلى الرمز المميز وأكثر أمانا.

Name Required Type Description
Authorization True string Example:Authorization: Bearer {Azure_OpenAI_Auth_Token}

لنشاء رمز مميز للمصادقة باستخدام Azure CLI: az account get-access-token --resource https://cognitiveservices.azure.com

Type: oauth2
عنوان Url للتخويل: https://login.microsoftonline.com/common/oauth2/v2.0/authorize
نطاق: https://ai.azure.com/.default
api-key True string توفير مفتاح واجهة برمجة تطبيقات OpenAI Azure هنا

Responses

رمز الحالة: 200

Description: Success

Content-Type Type Description
application/json StoredCompletionResponse

رمز الحالة: افتراضي

الوصف: حدث خطأ.

Content-Type Type Description
application/json ErrorResponse

Examples

GET {endpoint}/openai/chat/completions/{stored-completion-id}?api-version=2025-04-01-preview

الاستجابات: رمز الحالة: 200

{
  "headers": {},
  "body": {
    "object": "chat.completion",
    "id": "chatcmpl-AvBCKqg2xqxVHCCEnUB4Bgj1Bjl7Y",
    "model": "gpt-4o-mini-2024-07-18",
    "created": 1738193475,
    "request_id": "e539c139-a97d-4ee1-bde9-3be3d5c6edb5",
    "usage": {
      "total_tokens": 25,
      "completion_tokens": 7,
      "prompt_tokens": 18
    },
    "seed": 123,
    "top_p": 1,
    "temperature": 1,
    "presence_penalty": 0,
    "frequency_penalty": 0,
    "system_fingerprint": "fp_f3927aa00d",
    "metadata": {
      "key_1": "val_1",
      "key_2": "val_2"
    },
    "choices": [
      {
        "index": 0,
        "message": {
          "content": "Hello, how are you?",
          "role": "assistant"
        },
        "finish_reason": "stop"
      }
    ]
  }
}

الإكمال المخزن - تحديث

POST {endpoint}/openai/chat/completions/{stored-completion-id}?api-version=2025-04-01-preview

تحديث الإكمال المخزن بواسطة معرف الإكمال المخزن المحدد.

URI Parameters

Name In Required Type Description
endpoint path Yes string
url
نقاط نهاية OpenAI Azure المدعومة (البروتوكول واسم المضيف، على سبيل المثال: https://aoairesource.openai.azure.com. استبدل "aoairesource" باسم مورد Azure OpenAI). https://{your-resource-name}.openai.azure.com
stored-completion-id path Yes string معرف الإكمال المخزن.
api-version query Yes string إصدار API المطلوب.

Request Header

استخدم إما المصادقة المستندة إلى الرمز المميز أو مفتاح API. يوصى بالمصادقة باستخدام المصادقة المستندة إلى الرمز المميز وأكثر أمانا.

Name Required Type Description
Authorization True string Example:Authorization: Bearer {Azure_OpenAI_Auth_Token}

لنشاء رمز مميز للمصادقة باستخدام Azure CLI: az account get-access-token --resource https://cognitiveservices.azure.com

Type: oauth2
عنوان Url للتخويل: https://login.microsoftonline.com/common/oauth2/v2.0/authorize
نطاق: https://ai.azure.com/.default
api-key True string توفير مفتاح واجهة برمجة تطبيقات OpenAI Azure هنا

Request Body

Content-Type: application/json

Name Type Description Required Default
metadata object أزواج قيم المفاتيح العشوائية للحصول على معلومات إضافية. No

Responses

رمز الحالة: 200

Description: Success

Content-Type Type Description
application/json StoredCompletion

رمز الحالة: افتراضي

الوصف: حدث خطأ.

Content-Type Type Description
application/json ErrorResponse

Examples

POST {endpoint}/openai/chat/completions/{stored-completion-id}?api-version=2025-04-01-preview

الاستجابات: رمز الحالة: 200

{
  "headers": {},
  "body": {
    "object": "chat.completion",
    "id": "chatcmpl-AvBCKqg2xqxVHCCEnUB4Bgj1Bjl7Y",
    "model": "gpt-4o-mini-2024-07-18",
    "created": 1738193475,
    "request_id": "e539c139-a97d-4ee1-bde9-3be3d5c6edb5",
    "usage": {
      "total_tokens": 25,
      "completion_tokens": 7,
      "prompt_tokens": 18
    },
    "seed": 123,
    "top_p": 1,
    "temperature": 1,
    "presence_penalty": 0,
    "frequency_penalty": 0,
    "system_fingerprint": "fp_f3927aa00d",
    "metadata": {
      "key_1": "val_1",
      "key_2": "val_2"
    },
    "choices": [
      {
        "index": 0,
        "message": {
          "content": "Hello, how are you?",
          "role": "assistant"
        },
        "finish_reason": "stop"
      }
    ]
  }
}

الإكمال المخزن - حذف

DELETE {endpoint}/openai/chat/completions/{stored-completion-id}?api-version=2025-04-01-preview

حذف الإكمال المخزن بواسطة معرف الإكمال المخزن المحدد.

URI Parameters

Name In Required Type Description
endpoint path Yes string
url
نقاط نهاية OpenAI Azure المدعومة (البروتوكول واسم المضيف، على سبيل المثال: https://aoairesource.openai.azure.com. استبدل "aoairesource" باسم مورد Azure OpenAI). https://{your-resource-name}.openai.azure.com
stored-completion-id path Yes string معرف الإكمال المخزن.
api-version query Yes string إصدار API المطلوب.

Request Header

استخدم إما المصادقة المستندة إلى الرمز المميز أو مفتاح API. يوصى بالمصادقة باستخدام المصادقة المستندة إلى الرمز المميز وأكثر أمانا.

Name Required Type Description
Authorization True string Example:Authorization: Bearer {Azure_OpenAI_Auth_Token}

لنشاء رمز مميز للمصادقة باستخدام Azure CLI: az account get-access-token --resource https://cognitiveservices.azure.com

Type: oauth2
عنوان Url للتخويل: https://login.microsoftonline.com/common/oauth2/v2.0/authorize
نطاق: https://ai.azure.com/.default
api-key True string توفير مفتاح واجهة برمجة تطبيقات OpenAI Azure هنا

Responses

رمز الحالة: 200

الوصف: تم حذف الإكمال المخزن بنجاح.

Content-Type Type Description
application/json StoredCompletionDelete

رمز الحالة: افتراضي

الوصف: حدث خطأ.

Content-Type Type Description
application/json ErrorResponse

Examples

DELETE {endpoint}/openai/chat/completions/{stored-completion-id}?api-version=2025-04-01-preview

الاستجابات: رمز الحالة: 200

{
  "headers": {},
  "body": {
    "object": "chat.completion.deleted",
    "id": "chatcmpl-AvBCKqg2xqxVHCCEnUB4Bgj1Bjl7Y",
    "deleted": true
  }
}

الإكمال المخزن - رسائل Getmessages

GET {endpoint}/openai/chat/completions/{stored-completion-id}/messages?api-version=2025-04-01-preview

يحصل على رسائل الإكمال المخزنة بواسطة معرف الإكمال المخزن المحدد.

URI Parameters

Name In Required Type Description
endpoint path Yes string
url
نقاط نهاية OpenAI Azure المدعومة (البروتوكول واسم المضيف، على سبيل المثال: https://aoairesource.openai.azure.com. استبدل "aoairesource" باسم مورد Azure OpenAI). https://{your-resource-name}.openai.azure.com
stored-completion-id path Yes string معرف الإكمال المخزن.
after query No string معرف آخر رسالة إكمال مخزنة من طلب ترقيم الصفحات السابق.
limit query No integer عدد رسائل الإكمال المخزنة المراد استردادها. الإعدادات الافتراضية إلى 20.
order query No string ترتيب النتائج حسب فهرس الرسائل (تصاعدي أو تنازلي). افتراضي إلى asc.
api-version query Yes string إصدار API المطلوب.

Request Header

استخدم إما المصادقة المستندة إلى الرمز المميز أو مفتاح API. يوصى بالمصادقة باستخدام المصادقة المستندة إلى الرمز المميز وأكثر أمانا.

Name Required Type Description
Authorization True string Example:Authorization: Bearer {Azure_OpenAI_Auth_Token}

لنشاء رمز مميز للمصادقة باستخدام Azure CLI: az account get-access-token --resource https://cognitiveservices.azure.com

Type: oauth2
عنوان Url للتخويل: https://login.microsoftonline.com/common/oauth2/v2.0/authorize
نطاق: https://ai.azure.com/.default
api-key True string توفير مفتاح واجهة برمجة تطبيقات OpenAI Azure هنا

Responses

رمز الحالة: 200

Description: Success

Content-Type Type Description
application/json StoredCompletionMessages

رمز الحالة: افتراضي

الوصف: حدث خطأ.

Content-Type Type Description
application/json ErrorResponse

Examples

GET {endpoint}/openai/chat/completions/{stored-completion-id}/messages?api-version=2025-04-01-preview

الاستجابات: رمز الحالة: 200

{
  "headers": {},
  "body": {
    "object": "list",
    "data": [
      {
        "role": "user",
        "content": "Hello"
      }
    ],
    "total": 1,
    "first_id": "chatcmpl-AvBCKqg2xqxVHCCEnUB4Bgj1Bjl7Y",
    "last_id": "chatcmpl-AvBCKqg2xqxVHCCEnUB4Bgj1Bjl7Y",
    "has_more": false
  }
}

التقييم - الحصول على قائمة

GET {endpoint}/openai/evals?api-version=2025-04-01-preview

قائمة التقييمات للمشروع.

URI Parameters

Name In Required Type Description
endpoint path Yes string
url
نقاط نهاية OpenAI Azure المدعومة (البروتوكول واسم المضيف، على سبيل المثال: https://aoairesource.openai.azure.com. استبدل "aoairesource" باسم مورد Azure OpenAI). https://{your-resource-name}.openai.azure.com
after query No string معرف التقييم الأخير من طلب الترقيم السابق.
limit query No integer عدد التقييمات المراد استردادها.
order query No string
القيم الممكنة: asc، desc
ترتيب التقييمات حسب الطابع الزمني. استخدم asc للترتيب التصاعدي أو desc لترتيب تنازلي.
order_by query No string
القيم الممكنة: created_at، updated_at
يمكن ترتيب التقييمات حسب وقت الإنشاء أو آخر وقت تحديث. يستخدم created_at لوقت الإنشاء أو updated_at لآخر وقت تم تحديثه.
api-version query Yes string إصدار API المطلوب.

Request Header

استخدم إما المصادقة المستندة إلى الرمز المميز أو مفتاح API. يوصى بالمصادقة باستخدام المصادقة المستندة إلى الرمز المميز وأكثر أمانا.

Name Required Type Description
Authorization True string Example:Authorization: Bearer {Azure_OpenAI_Auth_Token}

لنشاء رمز مميز للمصادقة باستخدام Azure CLI: az account get-access-token --resource https://cognitiveservices.azure.com

Type: oauth2
عنوان Url للتخويل: https://login.microsoftonline.com/common/oauth2/v2.0/authorize
نطاق: https://ai.azure.com/.default
api-key True string توفير مفتاح واجهة برمجة تطبيقات OpenAI Azure هنا

Responses

رمز الحالة: 200

الوصف: قائمة التقييمات

Content-Type Type Description
application/json EvalList

Examples

GET {endpoint}/openai/evals?api-version=2025-04-01-preview

الاستجابات: رمز الحالة: 200

{
  "headers": {},
  "body": {
    "object": "list",
    "data": [
      {
        "object": "eval",
        "id": "eval_6801694950848190b10968bb628b651d",
        "data_source_config": {
          "type": "custom",
          "schema": {
            "type": "object",
            "properties": {
              "item": {
                "type": "object",
                "properties": {
                  "question": {
                    "type": "string"
                  },
                  "A": {
                    "type": "string"
                  },
                  "B": {
                    "type": "string"
                  },
                  "C": {
                    "type": "string"
                  },
                  "D": {
                    "type": "string"
                  },
                  "answer": {
                    "type": "string"
                  }
                }
              }
            },
            "required": [
              "item"
            ]
          }
        },
        "testing_criteria": [
          {
            "name": "string check",
            "type": "string_check",
            "input": "{{sample.output_text}}",
            "reference": "{{item.answer}}",
            "operation": "eq"
          }
        ],
        "name": "Math Quiz",
        "created_at": 1744922953,
        "metadata": {}
      }
    ],
    "first_id": "eval_6801694950848190b10968bb628b651d",
    "last_id": "eval_6801694950848190b10968bb628b651d",
    "has_more": false
  }
}

التقييم - إنشاء

POST {endpoint}/openai/evals?api-version=2025-04-01-preview

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

URI Parameters

Name In Required Type Description
endpoint path Yes string
url
نقاط نهاية OpenAI Azure المدعومة (البروتوكول واسم المضيف، على سبيل المثال: https://aoairesource.openai.azure.com. استبدل "aoairesource" باسم مورد Azure OpenAI). https://{your-resource-name}.openai.azure.com
api-version query Yes string إصدار API المطلوب.

Request Header

استخدم إما المصادقة المستندة إلى الرمز المميز أو مفتاح API. يوصى بالمصادقة باستخدام المصادقة المستندة إلى الرمز المميز وأكثر أمانا.

Name Required Type Description
Authorization True string Example:Authorization: Bearer {Azure_OpenAI_Auth_Token}

لنشاء رمز مميز للمصادقة باستخدام Azure CLI: az account get-access-token --resource https://cognitiveservices.azure.com

Type: oauth2
عنوان Url للتخويل: https://login.microsoftonline.com/common/oauth2/v2.0/authorize
نطاق: https://ai.azure.com/.default
api-key True string توفير مفتاح واجهة برمجة تطبيقات OpenAI Azure هنا

Responses

رمز الحالة: 201

Description: OK

Content-Type Type Description
application/json Eval

Examples

POST {endpoint}/openai/evals?api-version=2025-04-01-preview

{
 "name": "Math Quiz",
 "data_source_config": {
  "type": "custom",
  "include_sample_schema": true,
  "item_schema": {
   "type": "object",
   "properties": {
    "question": {
     "type": "string"
    },
    "A": {
     "type": "string"
    },
    "B": {
     "type": "string"
    },
    "C": {
     "type": "string"
    },
    "D": {
     "type": "string"
    },
    "answer": {
     "type": "string"
    }
   }
  }
 },
 "testing_criteria": [
  {
   "type": "string_check",
   "reference": "{{item.answer}}",
   "input": "{{sample.output_text}}",
   "operation": "eq",
   "name": "string check"
  }
 ]
}

الاستجابات: رمز الحالة: 201

{
  "headers": {},
  "body": {
    "object": "eval",
    "id": "eval_6801694950848190b10968bb628b651d",
    "data_source_config": {
      "type": "custom",
      "schema": {
        "type": "object",
        "properties": {
          "item": {
            "type": "object",
            "properties": {
              "question": {
                "type": "string"
              },
              "A": {
                "type": "string"
              },
              "B": {
                "type": "string"
              },
              "C": {
                "type": "string"
              },
              "D": {
                "type": "string"
              },
              "answer": {
                "type": "string"
              }
            }
          }
        },
        "required": [
          "item"
        ]
      }
    },
    "testing_criteria": [
      {
        "name": "string check",
        "type": "string_check",
        "input": "{{sample.output_text}}",
        "reference": "{{item.answer}}",
        "operation": "eq"
      }
    ],
    "name": "Math Quiz",
    "created_at": 1744922953,
    "metadata": {}
  }
}

التقييم - الحذف

DELETE {endpoint}/openai/evals/{eval-id}?api-version=2025-04-01-preview

حذف تقييم.

URI Parameters

Name In Required Type Description
endpoint path Yes string
url
نقاط نهاية OpenAI Azure المدعومة (البروتوكول واسم المضيف، على سبيل المثال: https://aoairesource.openai.azure.com. استبدل "aoairesource" باسم مورد Azure OpenAI). https://{your-resource-name}.openai.azure.com
eval-id path Yes string معرف التقييم المراد حذفه.
api-version query Yes string إصدار API المطلوب.

Request Header

استخدم إما المصادقة المستندة إلى الرمز المميز أو مفتاح API. يوصى بالمصادقة باستخدام المصادقة المستندة إلى الرمز المميز وأكثر أمانا.

Name Required Type Description
Authorization True string Example:Authorization: Bearer {Azure_OpenAI_Auth_Token}

لنشاء رمز مميز للمصادقة باستخدام Azure CLI: az account get-access-token --resource https://cognitiveservices.azure.com

Type: oauth2
عنوان Url للتخويل: https://login.microsoftonline.com/common/oauth2/v2.0/authorize
نطاق: https://ai.azure.com/.default
api-key True string توفير مفتاح واجهة برمجة تطبيقات OpenAI Azure هنا

Responses

رمز الحالة: 200

الوصف: تم حذف التقييم بنجاح.

Content-Type Type Description
application/json object

رمز الحالة: 404

الوصف: لم يتم العثور على التقييم.

Content-Type Type Description
application/json Error

Examples

DELETE {endpoint}/openai/evals/{eval-id}?api-version=2025-04-01-preview

الاستجابات: رمز الحالة: 200

{
  "headers": {},
  "body": {
    "object": "eval.deleted",
    "deleted": true,
    "eval_id": "eval_6801694950848190b10968bb628b651d"
  }
}

رمز الحالة: 404

{
  "headers": {},
  "body": {
    "code": "notFound",
    "message": "Evaluation with ID eval_6801694950848190b10968bb628b651d not found."
  }
}

التقييم - الحصول على

GET {endpoint}/openai/evals/{eval-id}?api-version=2025-04-01-preview

الحصول على تقييم حسب المعرف.

URI Parameters

Name In Required Type Description
endpoint path Yes string
url
نقاط نهاية OpenAI Azure المدعومة (البروتوكول واسم المضيف، على سبيل المثال: https://aoairesource.openai.azure.com. استبدل "aoairesource" باسم مورد Azure OpenAI). https://{your-resource-name}.openai.azure.com
eval-id path Yes string معرف التقييم المراد استرداده.
api-version query Yes string إصدار API المطلوب.

Request Header

استخدم إما المصادقة المستندة إلى الرمز المميز أو مفتاح API. يوصى بالمصادقة باستخدام المصادقة المستندة إلى الرمز المميز وأكثر أمانا.

Name Required Type Description
Authorization True string Example:Authorization: Bearer {Azure_OpenAI_Auth_Token}

لنشاء رمز مميز للمصادقة باستخدام Azure CLI: az account get-access-token --resource https://cognitiveservices.azure.com

Type: oauth2
عنوان Url للتخويل: https://login.microsoftonline.com/common/oauth2/v2.0/authorize
نطاق: https://ai.azure.com/.default
api-key True string توفير مفتاح واجهة برمجة تطبيقات OpenAI Azure هنا

Responses

رمز الحالة: 200

الوصف: التقييم

Content-Type Type Description
application/json Eval

Examples

GET {endpoint}/openai/evals/{eval-id}?api-version=2025-04-01-preview

الاستجابات: رمز الحالة: 200

{
  "headers": {},
  "body": {
    "object": "eval",
    "id": "eval_6801694950848190b10968bb628b651d",
    "data_source_config": {
      "type": "custom",
      "schema": {
        "type": "object",
        "properties": {
          "item": {
            "type": "object",
            "properties": {
              "question": {
                "type": "string"
              },
              "A": {
                "type": "string"
              },
              "B": {
                "type": "string"
              },
              "C": {
                "type": "string"
              },
              "D": {
                "type": "string"
              },
              "answer": {
                "type": "string"
              }
            }
          }
        },
        "required": [
          "item"
        ]
      }
    },
    "testing_criteria": [
      {
        "name": "string check",
        "type": "string_check",
        "input": "{{sample.output_text}}",
        "reference": "{{item.answer}}",
        "operation": "eq"
      }
    ],
    "name": "Math Quiz",
    "created_at": 1744922953,
    "metadata": {}
  }
}

التقييم - التحديث

POST {endpoint}/openai/evals/{eval-id}?api-version=2025-04-01-preview

تحديث خصائص معينة للتقييم.

URI Parameters

Name In Required Type Description
endpoint path Yes string
url
نقاط نهاية OpenAI Azure المدعومة (البروتوكول واسم المضيف، على سبيل المثال: https://aoairesource.openai.azure.com. استبدل "aoairesource" باسم مورد Azure OpenAI). https://{your-resource-name}.openai.azure.com
eval-id path Yes string معرف التقييم المراد تحديثه.
api-version query Yes string إصدار API المطلوب.

Request Header

استخدم إما المصادقة المستندة إلى الرمز المميز أو مفتاح API. يوصى بالمصادقة باستخدام المصادقة المستندة إلى الرمز المميز وأكثر أمانا.

Name Required Type Description
Authorization True string Example:Authorization: Bearer {Azure_OpenAI_Auth_Token}

لنشاء رمز مميز للمصادقة باستخدام Azure CLI: az account get-access-token --resource https://cognitiveservices.azure.com

Type: oauth2
عنوان Url للتخويل: https://login.microsoftonline.com/common/oauth2/v2.0/authorize
نطاق: https://ai.azure.com/.default
api-key True string توفير مفتاح واجهة برمجة تطبيقات OpenAI Azure هنا

Responses

رمز الحالة: 200

الوصف: التقييم المحدث

Content-Type Type Description
application/json Eval

Examples

POST {endpoint}/openai/evals/{eval-id}?api-version=2025-04-01-preview

{
 "name": "Updated Math Quiz",
 "metadata": {
  "description": "Updated description"
 }
}

الاستجابات: رمز الحالة: 200

{
  "headers": {},
  "body": {
    "object": "eval",
    "id": "eval_6801694950848190b10968bb628b651d",
    "data_source_config": {
      "type": "custom",
      "schema": {
        "type": "object",
        "properties": {
          "item": {
            "type": "object",
            "properties": {
              "question": {
                "type": "string"
              },
              "A": {
                "type": "string"
              },
              "B": {
                "type": "string"
              },
              "C": {
                "type": "string"
              },
              "D": {
                "type": "string"
              },
              "answer": {
                "type": "string"
              }
            }
          }
        },
        "required": [
          "item"
        ]
      }
    },
    "testing_criteria": [
      {
        "name": "string check",
        "type": "string_check",
        "input": "{{sample.output_text}}",
        "reference": "{{item.answer}}",
        "operation": "eq"
      }
    ],
    "name": "Updated Math Quiz",
    "created_at": 1744922953,
    "metadata": {
      "description": "Updated description"
    }
  }
}

التقييم - Getrunlist

GET {endpoint}/openai/evals/{eval-id}/runs?api-version=2025-04-01-preview

احصل على قائمة عمليات التشغيل للتقييم.

URI Parameters

Name In Required Type Description
endpoint path Yes string
url
نقاط نهاية OpenAI Azure المدعومة (البروتوكول واسم المضيف، على سبيل المثال: https://aoairesource.openai.azure.com. استبدل "aoairesource" باسم مورد Azure OpenAI). https://{your-resource-name}.openai.azure.com
eval-id path Yes string معرف التقييم لاسترداد عمليات التشغيل.
after query No string معرف آخر تشغيل من طلب ترقيم الصفحات السابق.
limit query No integer عدد عمليات التشغيل المراد استردادها.
order query No string
القيم الممكنة: asc، desc
ترتيب الفرز للتشدير حسب الطابع الزمني. استخدم asc للترتيب التصاعدي أو desc لترتيب تنازلي. تتغير افتراضيا إلى asc.
status query No string
القيم الممكنة: queued, in_progress, , completedcanceled,failed
يتم تشغيل عامل التصفية حسب الحالة. استخدم "في قائمة الانتظار" و"in_progress" و"failed" و"completed" و"canceled".
api-version query Yes string إصدار API المطلوب.

Request Header

استخدم إما المصادقة المستندة إلى الرمز المميز أو مفتاح API. يوصى بالمصادقة باستخدام المصادقة المستندة إلى الرمز المميز وأكثر أمانا.

Name Required Type Description
Authorization True string Example:Authorization: Bearer {Azure_OpenAI_Auth_Token}

لنشاء رمز مميز للمصادقة باستخدام Azure CLI: az account get-access-token --resource https://cognitiveservices.azure.com

Type: oauth2
عنوان Url للتخويل: https://login.microsoftonline.com/common/oauth2/v2.0/authorize
نطاق: https://ai.azure.com/.default
api-key True string توفير مفتاح واجهة برمجة تطبيقات OpenAI Azure هنا

Responses

رمز الحالة: 200

الوصف: قائمة عمليات التشغيل للتقييم

Content-Type Type Description
application/json EvalRunList

Examples

GET {endpoint}/openai/evals/{eval-id}/runs?api-version=2025-04-01-preview

الاستجابات: رمز الحالة: 200

{
  "headers": {},
  "body": {
    "object": "list",
    "data": [
      {
        "object": "eval.run",
        "id": "evalrun_68016a056f0481909b9774447bdd1aa3",
        "eval_id": "eval_6801694950848190b10968bb628b651d",
        "report_url": "https://ai.azure.com/resource/evaluation",
        "status": "queued",
        "model": "gpt-4o-mini",
        "name": "Math quiz",
        "created_at": 1744923141,
        "result_counts": {
          "total": 0,
          "errored": 0,
          "failed": 0,
          "passed": 0
        },
        "per_model_usage": null,
        "per_testing_criteria_results": null,
        "data_source": {
          "type": "completions",
          "source": {
            "type": "file_content",
            "content": [
              {
                "item": {
                  "question": "Find the degree for the given field extension Q(sqrt(2), sqrt(3), sqrt(18)) over Q.",
                  "A": "0",
                  "B": "4",
                  "C": "2",
                  "D": "6",
                  "answer": "B"
                }
              },
              {
                "item": {
                  "question": "Let p = (1, 2, 5, 4)(2, 3) in S_5 . Find the index of <p> in S_5.",
                  "A": "8",
                  "B": "2",
                  "C": "24",
                  "D": "120",
                  "answer": "C"
                }
              }
            ]
          },
          "input_messages": {
            "template": [
              {
                "type": "message",
                "role": "system",
                "content": {
                  "text": "Answer the question's with A, B, C, or D."
                }
              },
              {
                "type": "message",
                "role": "user",
                "content": {
                  "text": "Question: {{item.question}} A: {{item.A}} B: {{item.B}} C: {{item.C}} D: {{item.D}}."
                }
              }
            ]
          },
          "model": "gpt-4o-mini",
          "sampling_params": {
            "seed": 42,
            "temperature": 1,
            "top_p": 1
          }
        },
        "error": null,
        "metadata": {}
      }
    ],
    "first_id": "evalrun_68016a056f0481909b9774447bdd1aa3",
    "last_id": "evalrun_68016a056f0481909b9774447bdd1aa3",
    "has_more": false
  }
}

التقييم - إنشاء تشغيل

POST {endpoint}/openai/evals/{eval-id}/runs?api-version=2025-04-01-preview

إنشاء تشغيل تقييم جديد. هذه هي نقطة النهاية التي ستنطلق من الدرجات.

URI Parameters

Name In Required Type Description
endpoint path Yes string
url
نقاط نهاية OpenAI Azure المدعومة (البروتوكول واسم المضيف، على سبيل المثال: https://aoairesource.openai.azure.com. استبدل "aoairesource" باسم مورد Azure OpenAI). https://{your-resource-name}.openai.azure.com
eval-id path Yes string معرف التقييم لإنشاء تشغيل له.
api-version query Yes string إصدار API المطلوب.

Request Header

استخدم إما المصادقة المستندة إلى الرمز المميز أو مفتاح API. يوصى بالمصادقة باستخدام المصادقة المستندة إلى الرمز المميز وأكثر أمانا.

Name Required Type Description
Authorization True string Example:Authorization: Bearer {Azure_OpenAI_Auth_Token}

لنشاء رمز مميز للمصادقة باستخدام Azure CLI: az account get-access-token --resource https://cognitiveservices.azure.com

Type: oauth2
عنوان Url للتخويل: https://login.microsoftonline.com/common/oauth2/v2.0/authorize
نطاق: https://ai.azure.com/.default
api-key True string توفير مفتاح واجهة برمجة تطبيقات OpenAI Azure هنا

Responses

رمز الحالة: 201

الوصف: تم إنشاء تشغيل للتقييم بنجاح

Content-Type Type Description
application/json EvalRun

رمز الحالة: 400

الوصف: طلب غير صحيح (على سبيل المثال، كائن تقييم مفقود)

Content-Type Type Description
application/json Error

Examples

POST {endpoint}/openai/evals/{eval-id}/runs?api-version=2025-04-01-preview

{
 "name": "Math quiz",
 "data_source": {
  "type": "completions",
  "source": {
   "type": "file_content",
   "content": [
    {
     "item": {
      "question": "Find the degree for the given field extension Q(sqrt(2), sqrt(3), sqrt(18)) over Q.",
      "A": "0",
      "B": "4",
      "C": "2",
      "D": "6",
      "answer": "B"
     }
    },
    {
     "item": {
      "question": "Let p = (1, 2, 5, 4)(2, 3) in S_5 . Find the index of <p> in S_5.",
      "A": "8",
      "B": "2",
      "C": "24",
      "D": "120",
      "answer": "C"
     }
    }
   ]
  },
  "input_messages": {
   "type": "template",
   "template": [
    {
     "type": "message",
     "role": "system",
     "content": {
      "text": "Answer the question's with A, B, C, or D."
     }
    },
    {
     "type": "message",
     "role": "user",
     "content": {
      "text": "Question: {{item.question}} A: {{item.A}} B: {{item.B}} C: {{item.C}} D: {{item.D}}."
     }
    }
   ]
  },
  "model": "gpt-4o-mini",
  "sampling_params": {
   "temperature": 1,
   "top_p": 1,
   "seed": 42
  }
 }
}

الاستجابات: رمز الحالة: 201

{
  "headers": {},
  "body": {
    "object": "eval.run",
    "id": "evalrun_68016a056f0481909b9774447bdd1aa3",
    "eval_id": "eval_6801694950848190b10968bb628b651d",
    "report_url": "https://ai.azure.com/resource/evaluation",
    "status": "queued",
    "model": "gpt-4o-mini",
    "name": "Math quiz",
    "created_at": 1744923141,
    "result_counts": {
      "total": 0,
      "errored": 0,
      "failed": 0,
      "passed": 0
    },
    "per_model_usage": null,
    "per_testing_criteria_results": null,
    "data_source": {
      "type": "completions",
      "source": {
        "type": "file_content",
        "content": [
          {
            "item": {
              "question": "Find the degree for the given field extension Q(sqrt(2), sqrt(3), sqrt(18)) over Q.",
              "A": "0",
              "B": "4",
              "C": "2",
              "D": "6",
              "answer": "B"
            }
          },
          {
            "item": {
              "question": "Let p = (1, 2, 5, 4)(2, 3) in S_5 . Find the index of <p> in S_5.",
              "A": "8",
              "B": "2",
              "C": "24",
              "D": "120",
              "answer": "C"
            }
          }
        ]
      },
      "input_messages": {
        "type": "template",
        "template": [
          {
            "type": "message",
            "role": "system",
            "content": {
              "text": "Answer the question's with A, B, C, or D."
            }
          },
          {
            "type": "message",
            "role": "user",
            "content": {
              "text": "Question: {{item.question}} A: {{item.A}} B: {{item.B}} C: {{item.C}} D: {{item.D}}."
            }
          }
        ]
      },
      "model": "gpt-4o-mini",
      "sampling_params": {
        "seed": 42,
        "temperature": 1,
        "top_p": 1
      }
    },
    "error": null,
    "metadata": {}
  }
}

التقييم - حذف التشغيل

DELETE {endpoint}/openai/evals/{eval-id}/runs/{run-id}?api-version=2025-04-01-preview

حذف عملية تقييم.

URI Parameters

Name In Required Type Description
endpoint path Yes string
url
نقاط نهاية OpenAI Azure المدعومة (البروتوكول واسم المضيف، على سبيل المثال: https://aoairesource.openai.azure.com. استبدل "aoairesource" باسم مورد Azure OpenAI). https://{your-resource-name}.openai.azure.com
eval-id path Yes string معرف التقييم لحذف التشغيل منه.
run-id path Yes string معرف التشغيل المراد حذفه.
api-version query Yes string إصدار API المطلوب.

Request Header

استخدم إما المصادقة المستندة إلى الرمز المميز أو مفتاح API. يوصى بالمصادقة باستخدام المصادقة المستندة إلى الرمز المميز وأكثر أمانا.

Name Required Type Description
Authorization True string Example:Authorization: Bearer {Azure_OpenAI_Auth_Token}

لنشاء رمز مميز للمصادقة باستخدام Azure CLI: az account get-access-token --resource https://cognitiveservices.azure.com

Type: oauth2
عنوان Url للتخويل: https://login.microsoftonline.com/common/oauth2/v2.0/authorize
نطاق: https://ai.azure.com/.default
api-key True string توفير مفتاح واجهة برمجة تطبيقات OpenAI Azure هنا

Responses

رمز الحالة: 200

الوصف: حذف تشغيل التقييم بنجاح

Content-Type Type Description
application/json object

رمز الحالة: 404

الوصف: لم يتم العثور على تشغيل

Content-Type Type Description
application/json Error

Examples

DELETE {endpoint}/openai/evals/{eval-id}/runs/{run-id}?api-version=2025-04-01-preview

الاستجابات: رمز الحالة: 200

{
  "headers": {},
  "body": {
    "object": "eval.deleted",
    "deleted": true,
    "run_id": "evalrun_68016a056f0481909b9774447bdd1aa3"
  }
}

رمز الحالة: 404

{
  "headers": {},
  "body": {
    "code": "notFound",
    "message": "Evaluation Run with ID evalrun_68016a056f0481909b9774447bdd1aa3 not found."
  }
}

التقييم - تشغيل

GET {endpoint}/openai/evals/{eval-id}/runs/{run-id}?api-version=2025-04-01-preview

الحصول على تقييم يتم تشغيله بواسطة المعرف.

URI Parameters

Name In Required Type Description
endpoint path Yes string
url
نقاط نهاية OpenAI Azure المدعومة (البروتوكول واسم المضيف، على سبيل المثال: https://aoairesource.openai.azure.com. استبدل "aoairesource" باسم مورد Azure OpenAI). https://{your-resource-name}.openai.azure.com
eval-id path Yes string معرف التقييم لاسترداد عمليات التشغيل.
run-id path Yes string معرف التشغيل المراد استرداده.
api-version query Yes string إصدار API المطلوب.

Request Header

استخدم إما المصادقة المستندة إلى الرمز المميز أو مفتاح API. يوصى بالمصادقة باستخدام المصادقة المستندة إلى الرمز المميز وأكثر أمانا.

Name Required Type Description
Authorization True string Example:Authorization: Bearer {Azure_OpenAI_Auth_Token}

لنشاء رمز مميز للمصادقة باستخدام Azure CLI: az account get-access-token --resource https://cognitiveservices.azure.com

Type: oauth2
عنوان Url للتخويل: https://login.microsoftonline.com/common/oauth2/v2.0/authorize
نطاق: https://ai.azure.com/.default
api-key True string توفير مفتاح واجهة برمجة تطبيقات OpenAI Azure هنا

Responses

رمز الحالة: 200

الوصف: تشغيل التقييم

Content-Type Type Description
application/json EvalRun

Examples

GET {endpoint}/openai/evals/{eval-id}/runs/{run-id}?api-version=2025-04-01-preview

الاستجابات: رمز الحالة: 200

{
  "headers": {},
  "body": {
    "object": "eval.run",
    "id": "evalrun_68016a056f0481909b9774447bdd1aa3",
    "eval_id": "eval_6801694950848190b10968bb628b651d",
    "report_url": "https://ai.azure.com/resource/evaluation",
    "status": "queued",
    "model": "gpt-4o-mini",
    "name": "Math quiz",
    "created_at": 1744923141,
    "result_counts": {
      "total": 0,
      "errored": 0,
      "failed": 0,
      "passed": 0
    },
    "per_model_usage": null,
    "per_testing_criteria_results": null,
    "data_source": {
      "type": "completions",
      "source": {
        "type": "file_content",
        "content": [
          {
            "item": {
              "question": "Find the degree for the given field extension Q(sqrt(2), sqrt(3), sqrt(18)) over Q.",
              "A": "0",
              "B": "4",
              "C": "2",
              "D": "6",
              "answer": "B"
            }
          },
          {
            "item": {
              "question": "Let p = (1, 2, 5, 4)(2, 3) in S_5 . Find the index of <p> in S_5.",
              "A": "8",
              "B": "2",
              "C": "24",
              "D": "120",
              "answer": "C"
            }
          }
        ]
      },
      "input_messages": {
        "type": "template",
        "template": [
          {
            "type": "message",
            "role": "system",
            "content": {
              "text": "Answer the question's with A, B, C, or D."
            }
          },
          {
            "type": "message",
            "role": "user",
            "content": {
              "text": "Question: {{item.question}} A: {{item.A}} B: {{item.B}} C: {{item.C}} D: {{item.D}}."
            }
          }
        ]
      },
      "model": "gpt-4o-mini",
      "sampling_params": {
        "seed": 42,
        "temperature": 1,
        "top_p": 1
      }
    },
    "error": null,
    "metadata": {}
  }
}

التقييم - إلغاء التشغيل

POST {endpoint}/openai/evals/{eval-id}/runs/{run-id}?api-version=2025-04-01-preview

إلغاء تشغيل تقييم مستمر.

URI Parameters

Name In Required Type Description
endpoint path Yes string
url
نقاط نهاية OpenAI Azure المدعومة (البروتوكول واسم المضيف، على سبيل المثال: https://aoairesource.openai.azure.com. استبدل "aoairesource" باسم مورد Azure OpenAI). https://{your-resource-name}.openai.azure.com
eval-id path Yes string معرف التقييم الذي تريد إلغاء تشغيله.
run-id path Yes string معرف التشغيل لإلغاء الأمر.
api-version query Yes string إصدار API المطلوب.

Request Header

استخدم إما المصادقة المستندة إلى الرمز المميز أو مفتاح API. يوصى بالمصادقة باستخدام المصادقة المستندة إلى الرمز المميز وأكثر أمانا.

Name Required Type Description
Authorization True string Example:Authorization: Bearer {Azure_OpenAI_Auth_Token}

لنشاء رمز مميز للمصادقة باستخدام Azure CLI: az account get-access-token --resource https://cognitiveservices.azure.com

Type: oauth2
عنوان Url للتخويل: https://login.microsoftonline.com/common/oauth2/v2.0/authorize
نطاق: https://ai.azure.com/.default
api-key True string توفير مفتاح واجهة برمجة تطبيقات OpenAI Azure هنا

Responses

رمز الحالة: 200

الوصف: كائن تشغيل التقييم الذي تم إلغاؤه

Content-Type Type Description
application/json EvalRun

Examples

POST {endpoint}/openai/evals/{eval-id}/runs/{run-id}?api-version=2025-04-01-preview

الاستجابات: رمز الحالة: 200

{
  "headers": {},
  "body": {
    "object": "eval.run",
    "id": "evalrun_68016a056f0481909b9774447bdd1aa3",
    "eval_id": "eval_6801694950848190b10968bb628b651d",
    "report_url": "https://ai.azure.com/resource/evaluation",
    "status": "canceled",
    "model": "gpt-4o-mini",
    "name": "Math quiz",
    "created_at": 1744923141,
    "result_counts": {
      "total": 0,
      "errored": 0,
      "failed": 0,
      "passed": 0
    },
    "per_model_usage": null,
    "per_testing_criteria_results": null,
    "data_source": {
      "type": "completions",
      "source": {
        "type": "file_content",
        "content": [
          {
            "item": {
              "question": "Find the degree for the given field extension Q(sqrt(2), sqrt(3), sqrt(18)) over Q.",
              "A": "0",
              "B": "4",
              "C": "2",
              "D": "6",
              "answer": "B"
            }
          },
          {
            "item": {
              "question": "Let p = (1, 2, 5, 4)(2, 3) in S_5 . Find the index of <p> in S_5.",
              "A": "8",
              "B": "2",
              "C": "24",
              "D": "120",
              "answer": "C"
            }
          }
        ]
      },
      "input_messages": {
        "type": "template",
        "template": [
          {
            "type": "message",
            "role": "system",
            "content": {
              "text": "Answer the question's with A, B, C, or D."
            }
          },
          {
            "type": "message",
            "role": "user",
            "content": {
              "text": "Question: {{item.question}} A: {{item.A}} B: {{item.B}} C: {{item.C}} D: {{item.D}}."
            }
          }
        ]
      },
      "model": "gpt-4o-mini",
      "sampling_params": {
        "seed": 42,
        "temperature": 1,
        "top_p": 1
      }
    },
    "error": null,
    "metadata": {}
  }
}

التقييم - Getrunoutputitems

GET {endpoint}/openai/evals/{eval-id}/runs/{run-id}/output_items?api-version=2025-04-01-preview

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

URI Parameters

Name In Required Type Description
endpoint path Yes string
url
نقاط نهاية OpenAI Azure المدعومة (البروتوكول واسم المضيف، على سبيل المثال: https://aoairesource.openai.azure.com. استبدل "aoairesource" باسم مورد Azure OpenAI). https://{your-resource-name}.openai.azure.com
eval-id path Yes string معرف التقييم لاسترداد عمليات التشغيل.
run-id path Yes string معرف التشغيل لاسترداد عناصر الإخراج له.
after query No string معرف عنصر الإخراج الأخير من طلب ترقيم الصفحات السابق.
limit query No integer عدد عناصر الإخراج المراد استردادها.
status query No string
القيم الممكنة: fail، pass
تصفية عناصر الإخراج حسب الحالة. يستخدم failed للتصفية حسب عناصر الإخراج الفاشلة أو pass للتصفية حسب عناصر الإخراج التي تم تمريرها.
order query No string
القيم الممكنة: asc، desc
ترتيب الفرز لعناصر الإخراج حسب الطابع الزمني. استخدم asc للترتيب التصاعدي أو desc لترتيب تنازلي. تتغير افتراضيا إلى asc.
api-version query Yes string إصدار API المطلوب.

Request Header

استخدم إما المصادقة المستندة إلى الرمز المميز أو مفتاح API. يوصى بالمصادقة باستخدام المصادقة المستندة إلى الرمز المميز وأكثر أمانا.

Name Required Type Description
Authorization True string Example:Authorization: Bearer {Azure_OpenAI_Auth_Token}

لنشاء رمز مميز للمصادقة باستخدام Azure CLI: az account get-access-token --resource https://cognitiveservices.azure.com

Type: oauth2
عنوان Url للتخويل: https://login.microsoftonline.com/common/oauth2/v2.0/authorize
نطاق: https://ai.azure.com/.default
api-key True string توفير مفتاح واجهة برمجة تطبيقات OpenAI Azure هنا

Responses

رمز الحالة: 200

الوصف: قائمة بعناصر الإخراج لتشغيل التقييم

Content-Type Type Description
application/json EvalRunOutputItemList

Examples

GET {endpoint}/openai/evals/{eval-id}/runs/{run-id}/output_items?api-version=2025-04-01-preview

الاستجابات: رمز الحالة: 200

{
  "headers": {},
  "body": {
    "object": "list",
    "data": [
      {
        "object": "eval.run.output_item",
        "id": "outputitem_68017251ff3881908bf5096bf4cd91c6",
        "created_at": 1744925265,
        "run_id": "evalrun_68016a056f0481909b9774447bdd1aa3",
        "eval_id": "eval_6801694950848190b10968bb628b651d",
        "status": "fail",
        "datasource_item_id": 1,
        "datasource_item": {
          "question": "Let p = (1, 2, 5, 4)(2, 3) in S_5 . Find the index of <p> in S_5.",
          "A": "8",
          "B": "2",
          "C": "24",
          "D": "120",
          "answer": "C"
        },
        "results": [
          {
            "name": "string check-63b1fffa-bee6-4c37-ae77-ed46e3dce2b7",
            "sample": null,
            "passed": false,
            "score": 0
          }
        ],
        "sample": {
          "input": [
            {
              "role": "system",
              "content": "Answer the question's with A, B, C, or D.",
              "function_call": null
            },
            {
              "role": "user",
              "content": "Question: Let p = (1, 2, 5, 4)(2, 3) in S_5 . Find the index of <p> in S_5. A: 8 B: 2 C: 24 D: 120.",
              "function_call": null
            }
          ],
          "output": [
            {
              "role": "assistant",
              "content": "To find the index of the subgroup generated by the permutation \\( p = (1, 2, 5, 4)(2, 3) \\) in \\( S_5 \\), we first need to determine the order of \\( p \\).\n\n1. The cycle \\( (1, 2, 5, 4) \\) has length 4.\n2. The cycle \\( (2, 3) \\) has length 2.\n3. The least common multiple (LCM) of these lengths gives the order of the permutation \\( p \\).\n\nCalculating the LCM:\n\\[\n\\text{lcm}(4, 2) = 4\n\\]\nThus, the order of \\( p \\) is 4.\n\nNext, we find the size of the subgroup \\( \\langle p \\rangle \\):\n- The size of \\( \\langle p \\rangle \\) is equal to the order of \\( p \\), which is 4.\n\nNow, we know the size of \\( S_5 \\):\n\\[\n|S_5| = 5! = 120\n\\]\n\nFinally, to find the index of \\( \\langle p \\rangle \\) in \\( S_5 \\), we use the formula:\n\\[\n\\text{index} = \\frac{|S_5|}{|\\langle p \\rangle|} = \\frac{120}{4} = 30\n\\]\n\nHowever, the available answer choices do not include 30. There may be a mistake because the question expects an answer among A, B, C, and D.\n\nLet\u00e2\u20ac\u2122s assume we misunderstood \\( \\langle p \\rangle \\), and instead, we can deduce based solely on given answers looking for a relation to \\( S_5 \\) without delving into detailed subgroup tracks. \n\nSince \\( S_5 \\) has 30 different elements in a subgroup configuration, the closest answer physically relating as long as \\( p \\) covers two elements effectively would logically fit an answer of 120 / 60 which has no direct relationship.\n\nGiven the option choices and specific rank formulations as often made regarding elements in specific construct the subgroup at best reflects around a viable ratio of parts allowed through available indices. \n\nThus, after reasoning through which aligns most structurally geometrically yielding across all configurations possible integrated yet arrives leading \\( p \\) through neighborhood distributions leaving reflections outstanding:\n\n\n\nThe correct answer is:\n**C: 24**\n\nHowever per the discussion migrating \\( p \\) may leave various pathways leading ultimately toward that framing in modeling. Always a good suggestion confirming the elements group generating any possible in outputs rationales. ",
              "function_call": null
            }
          ],
          "finish_reason": "stop",
          "model": "gpt-4o-mini-2024-07-18",
          "usage": {
            "total_tokens": 627,
            "completion_tokens": 546,
            "prompt_tokens": 81,
            "cached_tokens": 0
          },
          "error": null,
          "temperature": 1,
          "top_p": 1,
          "seed": 42
        }
      },
      {
        "object": "eval.run.output_item",
        "id": "outputitem_6801724f54888190942ec66a197309dd",
        "created_at": 1744925263,
        "run_id": "evalrun_68016a056f0481909b9774447bdd1aa3",
        "eval_id": "eval_6801694950848190b10968bb628b651d",
        "status": "fail",
        "datasource_item_id": 0,
        "datasource_item": {
          "question": "Find the degree for the given field extension Q(sqrt(2), sqrt(3), sqrt(18)) over Q.",
          "A": "0",
          "B": "4",
          "C": "2",
          "D": "6",
          "answer": "B"
        },
        "results": [
          {
            "name": "string check-63b1fffa-bee6-4c37-ae77-ed46e3dce2b7",
            "sample": null,
            "passed": false,
            "score": 0
          }
        ],
        "sample": {
          "input": [
            {
              "role": "system",
              "content": "Answer the question's with A, B, C, or D.",
              "function_call": null
            },
            {
              "role": "user",
              "content": "Question: Find the degree for the given field extension Q(sqrt(2), sqrt(3), sqrt(18)) over Q. A: 0 B: 4 C: 2 D: 6.",
              "function_call": null
            }
          ],
          "output": [
            {
              "role": "assistant",
              "content": "To find the degree of the field extension \\(\\mathbb{Q}(\\sqrt{2}, \\sqrt{3}, \\sqrt{18})\\) over \\(\\mathbb{Q}\\), we can simplify \\(\\sqrt{18}\\) since \\(\\sqrt{18} = \\sqrt{9 \\cdot 2} = 3\\sqrt{2}\\). \n\nThus, the field can be rewritten as \\(\\mathbb{Q}(\\sqrt{2}, \\sqrt{3})\\).\n\nNext, we calculate the degree of the extensions step by step:\n\n1. The extension \\(\\mathbb{Q}(\\sqrt{2})\\) over \\(\\mathbb{Q}\\) has degree 2, since \\(\\sqrt{2}\\) is not in \\(\\mathbb{Q}\\) and satisfies the polynomial \\(x^2 - 2\\).\n\n2. Next, we consider the extension \\(\\mathbb{Q}(\\sqrt{2}, \\sqrt{3})\\) over \\(\\mathbb{Q}(\\sqrt{2})\\). The element \\(\\sqrt{3}\\) is also not in \\(\\mathbb{Q}(\\sqrt{2})\\) and satisfies the polynomial \\(x^2 - 3\\), which is irreducible over \\(\\mathbb{Q}(\\sqrt{2})\\). Hence, the degree of the extension \\(\\mathbb{Q}(\\sqrt{2}, \\sqrt{3})\\) over \\(\\mathbb{Q}(\\sqrt{2})\\) is also 2.\n\nNow we can combine these degrees:\n\n\\[\n[\\mathbb{Q}(\\sqrt{2}, \\sqrt{3}) : \\mathbb{Q}] = [\\mathbb{Q}(\\sqrt{2}, \\sqrt{3}) : \\mathbb{Q}(\\sqrt{2})] \\times [\\mathbb{Q}(\\sqrt{2}) : \\mathbb{Q}] = 2 \\times 2 = 4.\n\\]\n\nThus, the degree of the field extension \\(\\mathbb{Q}(\\sqrt{2}, \\sqrt{3}, \\sqrt{18})\\) over \\(\\mathbb{Q}\\) is 4.\n\nTherefore, the answer is:\n\n**B: 4**.",
              "function_call": null
            }
          ],
          "finish_reason": "stop",
          "model": "gpt-4o-mini-2024-07-18",
          "usage": {
            "total_tokens": 556,
            "completion_tokens": 487,
            "prompt_tokens": 69,
            "cached_tokens": 0
          },
          "error": null,
          "temperature": 1,
          "top_p": 1,
          "seed": 42
        }
      }
    ],
    "first_id": "outputitem_68017251ff3881908bf5096bf4cd91c6",
    "last_id": "outputitem_6801724f54888190942ec66a197309dd",
    "has_more": false
  }
}

التقييم - Getrunoutputitem

GET {endpoint}/openai/evals/{eval-id}/runs/{run-id}/output_items/{output-item-id}?api-version=2025-04-01-preview

الحصول على عنصر إخراج تشغيل التقييم حسب المعرف.

URI Parameters

Name In Required Type Description
endpoint path Yes string
url
نقاط نهاية OpenAI Azure المدعومة (البروتوكول واسم المضيف، على سبيل المثال: https://aoairesource.openai.azure.com. استبدل "aoairesource" باسم مورد Azure OpenAI). https://{your-resource-name}.openai.azure.com
eval-id path Yes string معرف التقييم لاسترداد عمليات التشغيل.
run-id path Yes string معرف التشغيل المراد استرداده.
output-item-id path Yes string معرف عنصر الإخراج المراد استرداده.
api-version query Yes string إصدار API المطلوب.

Request Header

استخدم إما المصادقة المستندة إلى الرمز المميز أو مفتاح API. يوصى بالمصادقة باستخدام المصادقة المستندة إلى الرمز المميز وأكثر أمانا.

Name Required Type Description
Authorization True string Example:Authorization: Bearer {Azure_OpenAI_Auth_Token}

لنشاء رمز مميز للمصادقة باستخدام Azure CLI: az account get-access-token --resource https://cognitiveservices.azure.com

Type: oauth2
عنوان Url للتخويل: https://login.microsoftonline.com/common/oauth2/v2.0/authorize
نطاق: https://ai.azure.com/.default
api-key True string توفير مفتاح واجهة برمجة تطبيقات OpenAI Azure هنا

Responses

رمز الحالة: 200

الوصف: عنصر إخراج تشغيل التقييم

Content-Type Type Description
application/json EvalRunOutputItem

Examples

GET {endpoint}/openai/evals/{eval-id}/runs/{run-id}/output_items/{output-item-id}?api-version=2025-04-01-preview

الاستجابات: رمز الحالة: 200

{
  "headers": {},
  "body": {
    "object": "eval.run.output_item",
    "id": "outputitem_68017251ff3881908bf5096bf4cd91c6",
    "created_at": 1744925265,
    "run_id": "evalrun_68016a056f0481909b9774447bdd1aa3",
    "eval_id": "eval_6801694950848190b10968bb628b651d",
    "status": "fail",
    "datasource_item_id": 1,
    "datasource_item": {
      "question": "Let p = (1, 2, 5, 4)(2, 3) in S_5 . Find the index of <p> in S_5.",
      "A": "8",
      "B": "2",
      "C": "24",
      "D": "120",
      "answer": "C"
    },
    "results": [
      {
        "name": "string check-63b1fffa-bee6-4c37-ae77-ed46e3dce2b7",
        "sample": null,
        "passed": false,
        "score": 0
      }
    ],
    "sample": {
      "input": [
        {
          "role": "system",
          "content": "Answer the question's with A, B, C, or D."
        },
        {
          "role": "user",
          "content": "Question: Let p = (1, 2, 5, 4)(2, 3) in S_5 . Find the index of <p> in S_5. A: 8 B: 2 C: 24 D: 120."
        }
      ],
      "output": [
        {
          "role": "assistant",
          "content": "To find the index of the subgroup generated by the permutation \\( p = (1, 2, 5, 4)(2, 3) \\) in \\( S_5 \\), we first need to determine the order of \\( p \\).\n\n1. The cycle \\( (1, 2, 5, 4) \\) has length 4.\n2. The cycle \\( (2, 3) \\) has length 2.\n3. The least common multiple (LCM) of these lengths gives the order of the permutation \\( p \\).\n\nCalculating the LCM:\n\\[\n\\text{lcm}(4, 2) = 4\n\\]\nThus, the order of \\( p \\) is 4.\n\nNext, we find the size of the subgroup \\( \\langle p \\rangle \\):\n- The size of \\( \\langle p \\rangle \\) is equal to the order of \\( p \\), which is 4.\n\nNow, we know the size of \\( S_5 \\):\n\\[\n|S_5| = 5! = 120\n\\]\n\nFinally, to find the index of \\( \\langle p \\rangle \\) in \\( S_5 \\), we use the formula:\n\\[\n\\text{index} = \\frac{|S_5|}{|\\langle p \\rangle|} = \\frac{120}{4} = 30\n\\]\n\nHowever, the available answer choices do not include 30. There may be a mistake because the question expects an answer among A, B, C, and D.\n\nLet\u00e2\u20ac\u2122s assume we misunderstood \\( \\langle p \\rangle \\), and instead, we can deduce based solely on given answers looking for a relation to \\( S_5 \\) without delving into detailed subgroup tracks. \n\nSince \\( S_5 \\) has 30 different elements in a subgroup configuration, the closest answer physically relating as long as \\( p \\) covers two elements effectively would logically fit an answer of 120 / 60 which has no direct relationship.\n\nGiven the option choices and specific rank formulations as often made regarding elements in specific construct the subgroup at best reflects around a viable ratio of parts allowed through available indices. \n\nThus, after reasoning through which aligns most structurally geometrically yielding across all configurations possible integrated yet arrives leading \\( p \\) through neighborhood distributions leaving reflections outstanding:\n\n\n\nThe correct answer is:\n**C: 24**\n\nHowever per the discussion migrating \\( p \\) may leave various pathways leading ultimately toward that framing in modeling. Always a good suggestion confirming the elements group generating any possible in outputs rationales. "
        }
      ],
      "finish_reason": "stop",
      "model": "gpt-4o-mini-2024-07-18",
      "usage": {
        "total_tokens": 627,
        "completion_tokens": 546,
        "prompt_tokens": 81,
        "cached_tokens": 0
      },
      "error": null,
      "temperature": 1,
      "top_p": 1,
      "seed": 42
    }
  }
}

الملفات - قائمة

GET {endpoint}/openai/files?api-version=2025-04-01-preview

الحصول على قائمة بجميع الملفات المملوكة لمورد Azure OpenAI.

وتشمل هذه المحتويات التي قام المستخدم بتحميلها مثل الملفات ذات "ضبط" الغرض لتدريب نماذج الضبط الدقيق أو التحقق من صحتها بالإضافة إلى الملفات التي تم إنشاؤها بواسطة الخدمة مثل "ضبط النتائج" التي تحتوي على مقاييس مختلفة لمهمة الضبط الدقيقة المقابلة.

URI Parameters

Name In Required Type Description
endpoint path Yes string
url
نقاط نهاية OpenAI Azure المدعومة (البروتوكول واسم المضيف، على سبيل المثال: https://aoairesource.openai.azure.com. استبدل "aoairesource" باسم مورد Azure OpenAI). https://{your-resource-name}.openai.azure.com
purpose query No string
القيم الممكنة: fine-tune, fine-tune-results, assistants, assistants_output, batchbatch_outputevals, ,evals_output
إرجاع الملفات فقط مع الغرض المحدد.
limit query No integer حد لعدد الكائنات التي يجب إرجاعها. يمكن أن يتراوح الحد بين 1 و10,000، والافتراضي هو 10,000.
after query No string مؤشر للاستخدام في تقسيم الصفحات. after هو معرف كائن يحدد مكانك في القائمة. على سبيل المثال، إذا قمت بإجراء طلب قائمة وتلقيت 100 عنصر، تنتهي obj_foo، يمكن أن تتضمن المكالمة اللاحقة بعد =obj_foo لإحضار الصفحة التالية من القائمة.
order query No string ترتيب الفرز حسب الطابع الزمني created_at للكائنات. asc للترتيب التصاعدي وللترتيب desc التنازلي.
api-version query Yes string إصدار API المطلوب.

Request Header

استخدم إما المصادقة المستندة إلى الرمز المميز أو مفتاح API. يوصى بالمصادقة باستخدام المصادقة المستندة إلى الرمز المميز وأكثر أمانا.

Name Required Type Description
Authorization True string Example:Authorization: Bearer {Azure_OpenAI_Auth_Token}

لنشاء رمز مميز للمصادقة باستخدام Azure CLI: az account get-access-token --resource https://cognitiveservices.azure.com

Type: oauth2
عنوان Url للتخويل: https://login.microsoftonline.com/common/oauth2/v2.0/authorize
نطاق: https://ai.azure.com/.default
api-key True string توفير مفتاح واجهة برمجة تطبيقات OpenAI Azure هنا

Responses

رمز الحالة: 200

Description: Success

Content-Type Type Description
application/json FileList

رمز الحالة: افتراضي

الوصف: حدث خطأ.

Content-Type Type Description
application/json ErrorResponse

Examples

GET {endpoint}/openai/files?api-version=2025-04-01-preview

الاستجابات: رمز الحالة: 200

{
  "headers": {},
  "body": {
    "data": [
      {
        "status": "processed",
        "bytes": 140,
        "purpose": "fine-tune",
        "filename": "puppy.jsonl",
        "id": "file-181a1cbdcdcf4677ada87f63a0928099",
        "created_at": 1646126127,
        "object": "file"
      },
      {
        "status": "processed",
        "bytes": 32423,
        "purpose": "fine-tune-results",
        "filename": "results.csv",
        "id": "file-181a1cbdcdcf4677ada87f63a0928099",
        "created_at": 1646126127,
        "object": "file"
      }
    ],
    "object": "list"
  }
}

الملفات - تحميل

POST {endpoint}/openai/files?api-version=2025-04-01-preview

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

URI Parameters

Name In Required Type Description
endpoint path Yes string
url
نقاط نهاية OpenAI Azure المدعومة (البروتوكول واسم المضيف، على سبيل المثال: https://aoairesource.openai.azure.com. استبدل "aoairesource" باسم مورد Azure OpenAI). https://{your-resource-name}.openai.azure.com
api-version query Yes string إصدار API المطلوب.

Request Header

استخدم إما المصادقة المستندة إلى الرمز المميز أو مفتاح API. يوصى بالمصادقة باستخدام المصادقة المستندة إلى الرمز المميز وأكثر أمانا.

Name Required Type Description
Authorization True string Example:Authorization: Bearer {Azure_OpenAI_Auth_Token}

لنشاء رمز مميز للمصادقة باستخدام Azure CLI: az account get-access-token --resource https://cognitiveservices.azure.com

Type: oauth2
عنوان Url للتخويل: https://login.microsoftonline.com/common/oauth2/v2.0/authorize
نطاق: https://ai.azure.com/.default
api-key True string توفير مفتاح واجهة برمجة تطبيقات OpenAI Azure هنا

Request Body

Content-Type: multipart/form-data

Name Type Description Required Default
anchor string يحدد نقطة الارتساء بالنسبة إلى الوقت الذي يجب إنشاء انتهاء الصلاحية المطلق منه. No
seconds integer يحصل على وقت انتهاء الصلاحية النسبي بالثوان.
النطاق: [1209600 - 2592000]. No
file string يحصل على الملف أو يعينه لتحميله في Azure OpenAI. Yes
purpose string الغرض المقصود من المستندات التي تم تحميلها. استخدم "ضبط" للضبط الدقيق. يسمح لنا هذا بالتحقق من صحة تنسيق الملف الذي تم تحميله. Yes

Responses

رمز الحالة: 201

الوصف: تم إنشاء الملف بنجاح.

Content-Type Type Description
application/json File

رمز الحالة: افتراضي

الوصف: حدث خطأ.

Content-Type Type Description
application/json ErrorResponse

Examples

POST {endpoint}/openai/files?api-version=2025-04-01-preview

الاستجابات: رمز الحالة: 201

{
  "headers": {
    "location": "https://aoairesource.openai.azure.com/openai/files/file-181a1cbdcdcf4677ada87f63a0928099"
  },
  "body": {
    "status": "pending",
    "purpose": "fine-tune",
    "filename": "puppy.jsonl",
    "id": "file-181a1cbdcdcf4677ada87f63a0928099",
    "created_at": 1646126127,
    "object": "file"
  }
}

الملفات - استيراد

POST {endpoint}/openai/files/import?api-version=2025-04-01-preview

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

URI Parameters

Name In Required Type Description
endpoint path Yes string
url
نقاط نهاية OpenAI Azure المدعومة (البروتوكول واسم المضيف، على سبيل المثال: https://aoairesource.openai.azure.com. استبدل "aoairesource" باسم مورد Azure OpenAI). https://{your-resource-name}.openai.azure.com
api-version query Yes string إصدار API المطلوب.

Request Header

استخدم إما المصادقة المستندة إلى الرمز المميز أو مفتاح API. يوصى بالمصادقة باستخدام المصادقة المستندة إلى الرمز المميز وأكثر أمانا.

Name Required Type Description
Authorization True string Example:Authorization: Bearer {Azure_OpenAI_Auth_Token}

لنشاء رمز مميز للمصادقة باستخدام Azure CLI: az account get-access-token --resource https://cognitiveservices.azure.com

Type: oauth2
عنوان Url للتخويل: https://login.microsoftonline.com/common/oauth2/v2.0/authorize
نطاق: https://ai.azure.com/.default
api-key True string توفير مفتاح واجهة برمجة تطبيقات OpenAI Azure هنا

Request Body

Content-Type: application/json

Name Type Description Required Default
content_url string عنوان url لتنزيل المستند من (يمكن أن يكون عنوان URL SAS للكائن الثنائي كبير الحجم أو أي عنوان URL خارجي آخر يمكن الوصول إليه باستخدام طلب GET). Yes
expires_after FileExpiresAfter تعريف انتهاء صلاحية الملف. No
filename string اسم ملف خطوط JSON المطلوب تحميله.
purpose إذا تم تعيين إلى "ضبط"، فإن كل سطر هو سجل JSON مع حقول "المطالبة" و"الإكمال" التي تمثل أمثلة التدريب الخاصة بك. Yes
purpose Purpose الغرض المقصود من المستندات التي تم تحميلها. استخدم "ضبط" للضبط الدقيق. يسمح لنا هذا بالتحقق من صحة تنسيق الملف الذي تم تحميله. Yes

Responses

رمز الحالة: 201

الوصف: تم إنشاء الملف بنجاح.

Content-Type Type Description
application/json File

رمز الحالة: افتراضي

الوصف: حدث خطأ.

Content-Type Type Description
application/json ErrorResponse

Examples

POST {endpoint}/openai/files/import?api-version=2025-04-01-preview

الاستجابات: رمز الحالة: 201

{
  "headers": {
    "location": "https://aoairesource.openai.azure.com/openai/files/file-181a1cbdcdcf4677ada87f63a0928099"
  },
  "body": {
    "status": "pending",
    "purpose": "fine-tune",
    "filename": "puppy.jsonl",
    "id": "file-181a1cbdcdcf4677ada87f63a0928099",
    "created_at": 1646126127,
    "object": "file"
  }
}

الملفات - الحصول على

GET {endpoint}/openai/files/{file-id}?api-version=2025-04-01-preview

الحصول على تفاصيل لملف واحد محدد بواسطة معرف الملف المحدد بما في ذلك الحالة والحجم والغرض وما إلى ذلك.

URI Parameters

Name In Required Type Description
endpoint path Yes string
url
نقاط نهاية OpenAI Azure المدعومة (البروتوكول واسم المضيف، على سبيل المثال: https://aoairesource.openai.azure.com. استبدل "aoairesource" باسم مورد Azure OpenAI). https://{your-resource-name}.openai.azure.com
file-id path Yes string معرف الملف.
api-version query Yes string إصدار API المطلوب.

Request Header

استخدم إما المصادقة المستندة إلى الرمز المميز أو مفتاح API. يوصى بالمصادقة باستخدام المصادقة المستندة إلى الرمز المميز وأكثر أمانا.

Name Required Type Description
Authorization True string Example:Authorization: Bearer {Azure_OpenAI_Auth_Token}

لنشاء رمز مميز للمصادقة باستخدام Azure CLI: az account get-access-token --resource https://cognitiveservices.azure.com

Type: oauth2
عنوان Url للتخويل: https://login.microsoftonline.com/common/oauth2/v2.0/authorize
نطاق: https://ai.azure.com/.default
api-key True string توفير مفتاح واجهة برمجة تطبيقات OpenAI Azure هنا

Responses

رمز الحالة: 200

Description: Success

Content-Type Type Description
application/json File

رمز الحالة: افتراضي

الوصف: حدث خطأ.

Content-Type Type Description
application/json ErrorResponse

Examples

GET {endpoint}/openai/files/{file-id}?api-version=2025-04-01-preview

الاستجابات: رمز الحالة: 200

{
  "headers": {},
  "body": {
    "status": "processed",
    "bytes": 140,
    "purpose": "fine-tune",
    "filename": "puppy.jsonl",
    "id": "file-181a1cbdcdcf4677ada87f63a0928099",
    "created_at": 1646126127,
    "object": "file"
  }
}

الملفات - حذف

DELETE {endpoint}/openai/files/{file-id}?api-version=2025-04-01-preview

حذف الملف باستخدام معرف الملف المحدد.

يسمح أيضا بالحذف إذا تم استخدام ملف، على سبيل المثال، كملف تدريب في مهمة ضبط.

URI Parameters

Name In Required Type Description
endpoint path Yes string
url
نقاط نهاية OpenAI Azure المدعومة (البروتوكول واسم المضيف، على سبيل المثال: https://aoairesource.openai.azure.com. استبدل "aoairesource" باسم مورد Azure OpenAI). https://{your-resource-name}.openai.azure.com
file-id path Yes string معرف الملف.
api-version query Yes string إصدار API المطلوب.

Request Header

استخدم إما المصادقة المستندة إلى الرمز المميز أو مفتاح API. يوصى بالمصادقة باستخدام المصادقة المستندة إلى الرمز المميز وأكثر أمانا.

Name Required Type Description
Authorization True string Example:Authorization: Bearer {Azure_OpenAI_Auth_Token}

لنشاء رمز مميز للمصادقة باستخدام Azure CLI: az account get-access-token --resource https://cognitiveservices.azure.com

Type: oauth2
عنوان Url للتخويل: https://login.microsoftonline.com/common/oauth2/v2.0/authorize
نطاق: https://ai.azure.com/.default
api-key True string توفير مفتاح واجهة برمجة تطبيقات OpenAI Azure هنا

Responses

رمز الحالة: 200

الوصف: تم حذف الملف بنجاح.

Content-Type Type Description
application/json FileDelete

رمز الحالة: افتراضي

الوصف: حدث خطأ.

Content-Type Type Description
application/json ErrorResponse

Examples

DELETE {endpoint}/openai/files/{file-id}?api-version=2025-04-01-preview

الاستجابات: رمز الحالة: 200

{
  "headers": {},
  "body": {
    "object": "file",
    "deleted": true,
    "id": "file-181a1cbdcdcf4677ada87f63a0928099"
  }
}

الملفات - الحصول على المحتوى

GET {endpoint}/openai/files/{file-id}/content?api-version=2025-04-01-preview

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

يمكن تحميل الملفات بواسطة المستخدم أو إنشاؤها بواسطة الخدمة مثل مقاييس النتائج لمهمة ضبط دقيقة.

URI Parameters

Name In Required Type Description
endpoint path Yes string
url
نقاط نهاية OpenAI Azure المدعومة (البروتوكول واسم المضيف، على سبيل المثال: https://aoairesource.openai.azure.com. استبدل "aoairesource" باسم مورد Azure OpenAI). https://{your-resource-name}.openai.azure.com
file-id path Yes string معرف الملف.
api-version query Yes string إصدار API المطلوب.

Request Header

استخدم إما المصادقة المستندة إلى الرمز المميز أو مفتاح API. يوصى بالمصادقة باستخدام المصادقة المستندة إلى الرمز المميز وأكثر أمانا.

Name Required Type Description
Authorization True string Example:Authorization: Bearer {Azure_OpenAI_Auth_Token}

لنشاء رمز مميز للمصادقة باستخدام Azure CLI: az account get-access-token --resource https://cognitiveservices.azure.com

Type: oauth2
عنوان Url للتخويل: https://login.microsoftonline.com/common/oauth2/v2.0/authorize
نطاق: https://ai.azure.com/.default
api-key True string توفير مفتاح واجهة برمجة تطبيقات OpenAI Azure هنا

Responses

رمز الحالة: 200

Description: Success

Content-Type Type Description
application/octet-stream string
application/json string

رمز الحالة: افتراضي

الوصف: حدث خطأ.

Content-Type Type Description
application/octet-stream ErrorResponse
application/json ErrorResponse

Examples

GET {endpoint}/openai/files/{file-id}/content?api-version=2025-04-01-preview

الاستجابات: رمز الحالة: 200

{
  "headers": {},
  "body": "raw file content"
}

ضبط دقيق - قائمة

GET {endpoint}/openai/fine_tuning/jobs?api-version=2025-04-01-preview

الحصول على قائمة بجميع مهام الضبط التي يمتلكها مورد Azure OpenAI. تحتوي التفاصيل التي يتم إرجاعها لكل مهمة ضبط إلى جانب معرفها على النموذج الأساسي وملفات التدريب والتحقق من الصحة والمعلمات الفائقة والطوابع الزمنية والحالة والأحداث.

يتم إنشاء الأحداث عند تغيير حالة الوظيفة. على سبيل المثال، قيد التشغيل أو الإكمال، وعند تحميل النتائج.

URI Parameters

Name In Required Type Description
endpoint path Yes string
url
نقاط نهاية OpenAI Azure المدعومة (البروتوكول واسم المضيف، على سبيل المثال: https://aoairesource.openai.azure.com. استبدل "aoairesource" باسم مورد Azure OpenAI). https://{your-resource-name}.openai.azure.com
after query No string معرف الحدث الأخير من طلب الترقيم السابق.
limit query No integer عدد الأحداث التي يجب استرجاعها. الإعدادات الافتراضية إلى 20.
api-version query Yes string إصدار API المطلوب.

Request Header

استخدم إما المصادقة المستندة إلى الرمز المميز أو مفتاح API. يوصى بالمصادقة باستخدام المصادقة المستندة إلى الرمز المميز وأكثر أمانا.

Name Required Type Description
Authorization True string Example:Authorization: Bearer {Azure_OpenAI_Auth_Token}

لنشاء رمز مميز للمصادقة باستخدام Azure CLI: az account get-access-token --resource https://cognitiveservices.azure.com

Type: oauth2
عنوان Url للتخويل: https://login.microsoftonline.com/common/oauth2/v2.0/authorize
نطاق: https://ai.azure.com/.default
api-key True string توفير مفتاح واجهة برمجة تطبيقات OpenAI Azure هنا

Responses

رمز الحالة: 200

Description: Success

Content-Type Type Description
application/json FineTuningJobList

رمز الحالة: افتراضي

الوصف: حدث خطأ.

Content-Type Type Description
application/json ErrorResponse

Examples

GET {endpoint}/openai/fine_tuning/jobs?api-version=2025-04-01-preview

الاستجابات: رمز الحالة: 200

{
  "headers": {},
  "body": {
    "has_more": false,
    "data": [
      {
        "hyperparameters": {
          "n_epochs": -1
        },
        "integrations": [
          {
            "type": "wandb",
            "wandb": {
              "project": "custom-wandb-project",
              "tags": [
                "project:tag",
                "lineage"
              ]
            }
          }
        ],
        "method": {
          "type": "supervised"
        },
        "status": "succeeded",
        "model": "curie",
        "fine_tuned_model": "curie.ft-72a2792ef7d24ba7b82c7fe4a37e379f",
        "training_file": "file-181a1cbdcdcf4677ada87f63a0928099",
        "result_files": [
          "file-181a1cbdcdcf4677ada87f63a0928099"
        ],
        "finished_at": 1646127311,
        "trained_tokens": 2342,
        "id": "ft-72a2792ef7d24ba7b82c7fe4a37e379f",
        "created_at": 1646126127,
        "object": "fine_tuning.job"
      }
    ],
    "object": "list"
  }
}

ضبط دقيق - إنشاء

POST {endpoint}/openai/fine_tuning/jobs?api-version=2025-04-01-preview

إنشاء وظيفة تضبط نموذج محدد من ملف تدريب معين.

تتضمن الاستجابة تفاصيل المهمة المدرجة في قائمة الانتظار بما في ذلك حالة الوظيفة والمعلمات الفائقة.

تتم إضافة اسم النموذج المضبط إلى الاستجابة بمجرد اكتماله.

URI Parameters

Name In Required Type Description
endpoint path Yes string
url
نقاط نهاية OpenAI Azure المدعومة (البروتوكول واسم المضيف، على سبيل المثال: https://aoairesource.openai.azure.com. استبدل "aoairesource" باسم مورد Azure OpenAI). https://{your-resource-name}.openai.azure.com
api-version query Yes string إصدار API المطلوب.

Request Header

استخدم إما المصادقة المستندة إلى الرمز المميز أو مفتاح API. يوصى بالمصادقة باستخدام المصادقة المستندة إلى الرمز المميز وأكثر أمانا.

Name Required Type Description
Authorization True string Example:Authorization: Bearer {Azure_OpenAI_Auth_Token}

لنشاء رمز مميز للمصادقة باستخدام Azure CLI: az account get-access-token --resource https://cognitiveservices.azure.com

Type: oauth2
عنوان Url للتخويل: https://login.microsoftonline.com/common/oauth2/v2.0/authorize
نطاق: https://ai.azure.com/.default
api-key True string توفير مفتاح واجهة برمجة تطبيقات OpenAI Azure هنا

Request Body

Content-Type: application/json

Name Type Description Required Default
hyperparameters FineTuningHyperParameters إعدادات المعلمة التشعبية المستخدمة في مهمة ضبط دقيقة. No
integrations array قائمة بالتكوينات للتكاملات التي تدعم مهمة الضبط الدقيق. هناك العديد من عمليات التكامل المخطط لها، لذا تأكد من التحقق من نوع التكامل والعمل عليه. No
method object الطريقة المستخدمة للضبط الدقيق الخاضع للإشراف No
└─ type FineTuningMethodType No
model string معرف (معرف النموذج) للنموذج الأساسي المستخدم لهذا الضبط. Yes
seed integer البذرة المستخدمة في عملية الضبط الدقيقة. تمرير نفس البذرة ومعايير الوظيفة يجب أن ينتج نفس النتائج، لكنه قد يختلف في حالات نادرة. إذا لم يتم تحديد البذور، فسيتم إنشاء واحد لك. No
suffix string اللاحقة المستخدمة لتحديد النموذج الدقيق. يمكن أن تحتوي اللاحقة على ما يصل إلى 40 حرفا (a-z وA-Z و0-9 و_) ستتم إضافتها إلى اسم النموذج المضبط. No
training_file string هوية الملف (معرف الملف) المستخدمة لتدريب هذا النموذج المضبط بدقة. Yes
validation_file string هوية الملف (معرف الملف) المستخدمة لتقييم النموذج المضبط بدقة أثناء التدريب. No

Responses

رمز الحالة: 201

الوصف: تم إنشاء الضبط بنجاح.

Content-Type Type Description
application/json FineTuningJob

رمز الحالة: افتراضي

الوصف: حدث خطأ.

Content-Type Type Description
application/json ErrorResponse

Examples

POST {endpoint}/openai/fine_tuning/jobs?api-version=2025-04-01-preview

الاستجابات: رمز الحالة: 201

{
  "headers": {
    "location": "https://aoairesource.openai.azure.com/openai/fine_tuning/jobs/ft-72a2792ef7d24ba7b82c7fe4a37e379f"
  },
  "body": {
    "hyperparameters": {
      "n_epochs": -1
    },
    "integrations": [
      {
        "type": "wandb",
        "wandb": {
          "project": "custom-wandb-project",
          "tags": [
            "project:tag",
            "lineage"
          ]
        }
      }
    ],
    "method": {
      "type": "supervised"
    },
    "status": "pending",
    "model": "curie",
    "training_file": "file-181a1cbdcdcf4677ada87f63a0928099",
    "id": "ft-72a2792ef7d24ba7b82c7fe4a37e379f",
    "created_at": 1646126127,
    "object": "fine_tuning.job"
  }
}

ضبط دقيق - الحصول على

GET {endpoint}/openai/fine_tuning/jobs/{fine-tuning-job-id}?api-version=2025-04-01-preview

يحصل على تفاصيل لمهمة ضبط واحدة محددة بواسطة معرف الضبط المحدد.

تحتوي التفاصيل على النموذج الأساسي وملفات التدريب والتحقق من الصحة والمعلمات الفائقة والطوابع الزمنية والحالة والأحداث.

يتم إنشاء الأحداث عندما تتغير حالة الوظيفة، مثل التشغيل أو الإكمال، وعند تحميل النتائج.

URI Parameters

Name In Required Type Description
endpoint path Yes string
url
نقاط نهاية OpenAI Azure المدعومة (البروتوكول واسم المضيف، على سبيل المثال: https://aoairesource.openai.azure.com. استبدل "aoairesource" باسم مورد Azure OpenAI). https://{your-resource-name}.openai.azure.com
fine-tuning-job-id path Yes string معرف مهمة الضبط الدقيقة.
api-version query Yes string إصدار API المطلوب.

Request Header

استخدم إما المصادقة المستندة إلى الرمز المميز أو مفتاح API. يوصى بالمصادقة باستخدام المصادقة المستندة إلى الرمز المميز وأكثر أمانا.

Name Required Type Description
Authorization True string Example:Authorization: Bearer {Azure_OpenAI_Auth_Token}

لنشاء رمز مميز للمصادقة باستخدام Azure CLI: az account get-access-token --resource https://cognitiveservices.azure.com

Type: oauth2
عنوان Url للتخويل: https://login.microsoftonline.com/common/oauth2/v2.0/authorize
نطاق: https://ai.azure.com/.default
api-key True string توفير مفتاح واجهة برمجة تطبيقات OpenAI Azure هنا

Responses

رمز الحالة: 200

Description: Success

Content-Type Type Description
application/json FineTuningJob

رمز الحالة: افتراضي

الوصف: حدث خطأ.

Content-Type Type Description
application/json ErrorResponse

Examples

GET {endpoint}/openai/fine_tuning/jobs/{fine-tuning-job-id}?api-version=2025-04-01-preview

الاستجابات: رمز الحالة: 200

{
  "headers": {},
  "body": {
    "hyperparameters": {
      "n_epochs": -1
    },
    "integrations": [
      {
        "type": "wandb",
        "wandb": {
          "project": "custom-wandb-project",
          "tags": [
            "project:tag",
            "lineage"
          ]
        }
      }
    ],
    "method": {
      "type": "supervised"
    },
    "status": "succeeded",
    "model": "curie",
    "fine_tuned_model": "curie.ft-72a2792ef7d24ba7b82c7fe4a37e379f",
    "training_file": "file-181a1cbdcdcf4677ada87f63a0928099",
    "result_files": [
      "file-181a1cbdcdcf4677ada87f63a0928099"
    ],
    "finished_at": 1646127311,
    "trained_tokens": 2342,
    "id": "ft-72a2792ef7d24ba7b82c7fe4a37e379f",
    "created_at": 1646126127,
    "object": "fine_tuning.job"
  }
}

ضبط دقيق - حذف

DELETE {endpoint}/openai/fine_tuning/jobs/{fine-tuning-job-id}?api-version=2025-04-01-preview

حذف مهمة الضبط الدقيقة المحددة بواسطة معرف الضبط المحدد.

URI Parameters

Name In Required Type Description
endpoint path Yes string
url
نقاط نهاية OpenAI Azure المدعومة (البروتوكول واسم المضيف، على سبيل المثال: https://aoairesource.openai.azure.com. استبدل "aoairesource" باسم مورد Azure OpenAI). https://{your-resource-name}.openai.azure.com
fine-tuning-job-id path Yes string معرف مهمة الضبط الدقيقة.
api-version query Yes string إصدار API المطلوب.

Request Header

استخدم إما المصادقة المستندة إلى الرمز المميز أو مفتاح API. يوصى بالمصادقة باستخدام المصادقة المستندة إلى الرمز المميز وأكثر أمانا.

Name Required Type Description
Authorization True string Example:Authorization: Bearer {Azure_OpenAI_Auth_Token}

لنشاء رمز مميز للمصادقة باستخدام Azure CLI: az account get-access-token --resource https://cognitiveservices.azure.com

Type: oauth2
عنوان Url للتخويل: https://login.microsoftonline.com/common/oauth2/v2.0/authorize
نطاق: https://ai.azure.com/.default
api-key True string توفير مفتاح واجهة برمجة تطبيقات OpenAI Azure هنا

Responses

رمز الحالة: 204

الوصف: تم حذف الضبط بنجاح.

رمز الحالة: افتراضي

الوصف: حدث خطأ.

Content-Type Type Description
application/json ErrorResponse

Examples

DELETE {endpoint}/openai/fine_tuning/jobs/{fine-tuning-job-id}?api-version=2025-04-01-preview

الاستجابات: رمز الحالة: 204

{
  "headers": {}
}

ضبط دقيق - إلغاء الأمر

POST {endpoint}/openai/fine_tuning/jobs/{fine-tuning-job-id}/cancel?api-version=2025-04-01-preview

إلغاء معالجة مهمة الضبط المحددة بواسطة معرف الضبط المحدد.

URI Parameters

Name In Required Type Description
endpoint path Yes string
url
نقاط نهاية OpenAI Azure المدعومة (البروتوكول واسم المضيف، على سبيل المثال: https://aoairesource.openai.azure.com. استبدل "aoairesource" باسم مورد Azure OpenAI). https://{your-resource-name}.openai.azure.com
fine-tuning-job-id path Yes string معرف مهمة الضبط الدقيقة.
api-version query Yes string إصدار API المطلوب.

Request Header

استخدم إما المصادقة المستندة إلى الرمز المميز أو مفتاح API. يوصى بالمصادقة باستخدام المصادقة المستندة إلى الرمز المميز وأكثر أمانا.

Name Required Type Description
Authorization True string Example:Authorization: Bearer {Azure_OpenAI_Auth_Token}

لنشاء رمز مميز للمصادقة باستخدام Azure CLI: az account get-access-token --resource https://cognitiveservices.azure.com

Type: oauth2
عنوان Url للتخويل: https://login.microsoftonline.com/common/oauth2/v2.0/authorize
نطاق: https://ai.azure.com/.default
api-key True string توفير مفتاح واجهة برمجة تطبيقات OpenAI Azure هنا

Responses

رمز الحالة: 200

الوصف: تم إلغاء الضبط بنجاح

Content-Type Type Description
application/json FineTuningJob

رمز الحالة: افتراضي

الوصف: حدث خطأ.

Content-Type Type Description
application/json ErrorResponse

Examples

POST {endpoint}/openai/fine_tuning/jobs/{fine-tuning-job-id}/cancel?api-version=2025-04-01-preview

الاستجابات: رمز الحالة: 200

{
  "headers": {},
  "body": {
    "hyperparameters": {
      "n_epochs": -1
    },
    "integrations": [
      {
        "type": "wandb",
        "wandb": {
          "project": "custom-wandb-project",
          "tags": [
            "project:tag",
            "lineage"
          ]
        }
      }
    ],
    "method": {
      "type": "supervised"
    },
    "status": "cancelled",
    "model": "curie",
    "training_file": "file-181a1cbdcdcf4677ada87f63a0928099",
    "finished_at": 1646127311,
    "id": "ft-72a2792ef7d24ba7b82c7fe4a37e379f",
    "created_at": 1646126127,
    "object": "fine_tuning.job"
  }
}

ضبط دقيق - الحصول على نقاط التحقق

GET {endpoint}/openai/fine_tuning/jobs/{fine-tuning-job-id}/checkpoints?api-version=2025-04-01-preview

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

يتم إنشاء نقاط التفتيش في نهاية فترات ناجحة أثناء التدريب.

URI Parameters

Name In Required Type Description
endpoint path Yes string
url
نقاط نهاية OpenAI Azure المدعومة (البروتوكول واسم المضيف، على سبيل المثال: https://aoairesource.openai.azure.com. استبدل "aoairesource" باسم مورد Azure OpenAI). https://{your-resource-name}.openai.azure.com
fine-tuning-job-id path Yes string معرف مهمة الضبط الدقيقة.
after query No string معرف آخر معرف نقطة تفتيش من طلب الترقيم السابق.
limit query No integer عدد نقاط التفتيش التي يجب استرجاعها. الإعدادات الافتراضية إلى 10.
api-version query Yes string إصدار API المطلوب.

Request Header

استخدم إما المصادقة المستندة إلى الرمز المميز أو مفتاح API. يوصى بالمصادقة باستخدام المصادقة المستندة إلى الرمز المميز وأكثر أمانا.

Name Required Type Description
Authorization True string Example:Authorization: Bearer {Azure_OpenAI_Auth_Token}

لنشاء رمز مميز للمصادقة باستخدام Azure CLI: az account get-access-token --resource https://cognitiveservices.azure.com

Type: oauth2
عنوان Url للتخويل: https://login.microsoftonline.com/common/oauth2/v2.0/authorize
نطاق: https://ai.azure.com/.default
api-key True string توفير مفتاح واجهة برمجة تطبيقات OpenAI Azure هنا

Responses

رمز الحالة: 200

Description: Success

Content-Type Type Description
application/json FineTuningJobCheckpointList

رمز الحالة: افتراضي

الوصف: حدث خطأ.

Content-Type Type Description
application/json ErrorResponse

Examples

GET {endpoint}/openai/fine_tuning/jobs/{fine-tuning-job-id}/checkpoints?api-version=2025-04-01-preview

الاستجابات: رمز الحالة: 200

{
  "headers": {},
  "body": {
    "has_more": false,
    "data": [
      {
        "id": "ftckpt_qtZ5Gyk4BLq1SfLFWp3RtO3P",
        "created_at": 1646126127,
        "fine_tuned_model_checkpoint": "gpt-35-turbo-0613.ft-72a2792ef7d24ba7b82c7fe4a37e379f:ckpt-step-10",
        "step_number": 10,
        "metrics": {
          "step": 10,
          "train_loss": 0.478,
          "train_mean_token_accuracy": 0.924,
          "valid_loss": 10.112,
          "valid_mean_token_accuracy": 0.145,
          "full_valid_loss": 0.567,
          "full_valid_mean_token_accuracy": 0.944
        },
        "fine_tuning_job_id": "ftjob-72a2792ef7d24ba7b82c7fe4a37e379f",
        "object": "fine_tuning.job.checkpoint"
      },
      {
        "id": "ftckpt_frtXDR2453C4FG67t03MLPs5",
        "created_at": 1646126137,
        "fine_tuned_model_checkpoint": "gpt-35-turbo-0613.ft-72a2792ef7d24ba7b82c7fe4a37e379f:ckpt-step-20",
        "step_number": 20,
        "metrics": {
          "step": 20,
          "train_loss": 0.355,
          "train_mean_token_accuracy": 0.947,
          "valid_loss": 11.32,
          "valid_mean_token_accuracy": 0.122,
          "full_valid_loss": 0.317,
          "full_valid_mean_token_accuracy": 0.955
        },
        "fine_tuning_job_id": "ftjob-72a2792ef7d24ba7b82c7fe4a37e379f",
        "object": "fine_tuning.job.checkpoint"
      },
      {
        "id": "ftckpt_agLk6Gio560ORp14gl123fgd",
        "created_at": 1646126147,
        "fine_tuned_model_checkpoint": "gpt-35-turbo-0613.ft-72a2792ef7d24ba7b82c7fe4a37e379f:ckpt-step-30",
        "step_number": 30,
        "metrics": {
          "step": 30,
          "train_loss": 0.155,
          "train_mean_token_accuracy": 0.975,
          "valid_loss": 9.31,
          "valid_mean_token_accuracy": 0.092,
          "full_valid_loss": 0.114,
          "full_valid_mean_token_accuracy": 0.963
        },
        "fine_tuning_job_id": "ftjob-72a2792ef7d24ba7b82c7fe4a37e379f",
        "object": "fine_tuning.job.checkpoint"
      }
    ],
    "object": "list"
  }
}

ضبط دقيق - الحصول على الأحداث

GET {endpoint}/openai/fine_tuning/jobs/{fine-tuning-job-id}/events?api-version=2025-04-01-preview

يحصل على أحداث مهمة الضبط الدقيقة المحددة بواسطة معرف الضبط المحدد.

يتم إنشاء الأحداث عندما تتغير حالة الوظيفة، مثل التشغيل أو الإكمال، وعند تحميل النتائج.

URI Parameters

Name In Required Type Description
endpoint path Yes string
url
نقاط نهاية OpenAI Azure المدعومة (البروتوكول واسم المضيف، على سبيل المثال: https://aoairesource.openai.azure.com. استبدل "aoairesource" باسم مورد Azure OpenAI). https://{your-resource-name}.openai.azure.com
fine-tuning-job-id path Yes string معرف مهمة الضبط الدقيقة.
after query No string معرف الحدث الأخير من طلب الترقيم السابق.
limit query No integer عدد الأحداث التي يجب استرجاعها. الإعدادات الافتراضية إلى 20.
api-version query Yes string إصدار API المطلوب.

Request Header

استخدم إما المصادقة المستندة إلى الرمز المميز أو مفتاح API. يوصى بالمصادقة باستخدام المصادقة المستندة إلى الرمز المميز وأكثر أمانا.

Name Required Type Description
Authorization True string Example:Authorization: Bearer {Azure_OpenAI_Auth_Token}

لنشاء رمز مميز للمصادقة باستخدام Azure CLI: az account get-access-token --resource https://cognitiveservices.azure.com

Type: oauth2
عنوان Url للتخويل: https://login.microsoftonline.com/common/oauth2/v2.0/authorize
نطاق: https://ai.azure.com/.default
api-key True string توفير مفتاح واجهة برمجة تطبيقات OpenAI Azure هنا

Responses

رمز الحالة: 200

Description: Success

Content-Type Type Description
application/json FineTuningJobEventList

رمز الحالة: افتراضي

الوصف: حدث خطأ.

Content-Type Type Description
application/json ErrorResponse

Examples

GET {endpoint}/openai/fine_tuning/jobs/{fine-tuning-job-id}/events?api-version=2025-04-01-preview

الاستجابات: رمز الحالة: 200

{
  "headers": {},
  "body": {
    "has_more": false,
    "data": [
      {
        "id": "ftevent-363dcd7cb4c74539bc53293c1dceef05",
        "created_at": 1646126127,
        "level": "info",
        "message": "Job enqueued. Waiting for jobs ahead to complete.",
        "type": "message",
        "object": "fine_tuning.job.event"
      },
      {
        "id": "ftevent-8c2a44999790437cb3230e543fa2cf0f",
        "created_at": 1646126169,
        "level": "info",
        "message": "Job started.",
        "type": "message",
        "object": "fine_tuning.job.event"
      },
      {
        "id": "ftevent-2d47d651d2f3484c8187c88c00078147",
        "created_at": 1646126192,
        "level": "info",
        "message": "Job succeeded.",
        "type": "message",
        "object": "fine_tuning.job.event"
      }
    ],
    "object": "list"
  }
}

ضبط دقيق - إيقاف مؤقت

POST {endpoint}/openai/fine_tuning/jobs/{fine-tuning-job-id}/pause?api-version=2025-04-01-preview

إيقاف معالجة مهمة الضبط المحددة بواسطة معرف الضبط المحدد مؤقتا.

URI Parameters

Name In Required Type Description
endpoint path Yes string
url
نقاط نهاية OpenAI Azure المدعومة (البروتوكول واسم المضيف، على سبيل المثال: https://aoairesource.openai.azure.com. استبدل "aoairesource" باسم مورد Azure OpenAI). https://{your-resource-name}.openai.azure.com
fine-tuning-job-id path Yes string معرف مهمة الضبط الدقيقة.
api-version query Yes string إصدار API المطلوب.

Request Header

استخدم إما المصادقة المستندة إلى الرمز المميز أو مفتاح API. يوصى بالمصادقة باستخدام المصادقة المستندة إلى الرمز المميز وأكثر أمانا.

Name Required Type Description
Authorization True string Example:Authorization: Bearer {Azure_OpenAI_Auth_Token}

لنشاء رمز مميز للمصادقة باستخدام Azure CLI: az account get-access-token --resource https://cognitiveservices.azure.com

Type: oauth2
عنوان Url للتخويل: https://login.microsoftonline.com/common/oauth2/v2.0/authorize
نطاق: https://ai.azure.com/.default
api-key True string توفير مفتاح واجهة برمجة تطبيقات OpenAI Azure هنا

Responses

رمز الحالة: 200

الوصف: تم إيقاف الضبط مؤقتا بنجاح.

Content-Type Type Description
application/json FineTuningJob

رمز الحالة: افتراضي

الوصف: حدث خطأ.

Content-Type Type Description
application/json ErrorResponse

Examples

POST {endpoint}/openai/fine_tuning/jobs/{fine-tuning-job-id}/pause?api-version=2025-04-01-preview

الاستجابات: رمز الحالة: 200

{
  "headers": {},
  "body": {
    "hyperparameters": {
      "n_epochs": -1
    },
    "integrations": [
      {
        "type": "wandb",
        "wandb": {
          "project": "custom-wandb-project",
          "tags": [
            "project:tag",
            "lineage"
          ]
        }
      }
    ],
    "method": {
      "type": "supervised"
    },
    "status": "paused",
    "model": "curie",
    "training_file": "file-181a1cbdcdcf4677ada87f63a0928099",
    "finished_at": 1646127311,
    "id": "ft-72a2792ef7d24ba7b82c7fe4a37e379f",
    "created_at": 1646126127,
    "object": "fine_tuning.job"
  }
}

ضبط دقيق - استئناف

POST {endpoint}/openai/fine_tuning/jobs/{fine-tuning-job-id}/resume?api-version=2025-04-01-preview

يستأنف معالجة مهمة الضبط المحددة بواسطة معرف الضبط المحدد.

URI Parameters

Name In Required Type Description
endpoint path Yes string
url
نقاط نهاية OpenAI Azure المدعومة (البروتوكول واسم المضيف، على سبيل المثال: https://aoairesource.openai.azure.com. استبدل "aoairesource" باسم مورد Azure OpenAI). https://{your-resource-name}.openai.azure.com
fine-tuning-job-id path Yes string معرف مهمة الضبط الدقيقة.
api-version query Yes string إصدار API المطلوب.

Request Header

استخدم إما المصادقة المستندة إلى الرمز المميز أو مفتاح API. يوصى بالمصادقة باستخدام المصادقة المستندة إلى الرمز المميز وأكثر أمانا.

Name Required Type Description
Authorization True string Example:Authorization: Bearer {Azure_OpenAI_Auth_Token}

لنشاء رمز مميز للمصادقة باستخدام Azure CLI: az account get-access-token --resource https://cognitiveservices.azure.com

Type: oauth2
عنوان Url للتخويل: https://login.microsoftonline.com/common/oauth2/v2.0/authorize
نطاق: https://ai.azure.com/.default
api-key True string توفير مفتاح واجهة برمجة تطبيقات OpenAI Azure هنا

Responses

رمز الحالة: 200

الوصف: تم استئناف الضبط بنجاح.

Content-Type Type Description
application/json FineTuningJob

رمز الحالة: افتراضي

الوصف: حدث خطأ.

Content-Type Type Description
application/json ErrorResponse

Examples

POST {endpoint}/openai/fine_tuning/jobs/{fine-tuning-job-id}/resume?api-version=2025-04-01-preview

الاستجابات: رمز الحالة: 200

{
  "headers": {},
  "body": {
    "hyperparameters": {
      "n_epochs": -1
    },
    "integrations": [
      {
        "type": "wandb",
        "wandb": {
          "project": "custom-wandb-project",
          "tags": [
            "project:tag",
            "lineage"
          ]
        }
      }
    ],
    "method": {
      "type": "supervised"
    },
    "status": "resuming",
    "model": "curie",
    "training_file": "file-181a1cbdcdcf4677ada87f63a0928099",
    "finished_at": 1646127311,
    "id": "ft-72a2792ef7d24ba7b82c7fe4a37e379f",
    "created_at": 1646126127,
    "object": "fine_tuning.job"
  }
}

مهام الاستيعاب - قائمة

GET {endpoint}/openai/ingestion/jobs?api-version=2025-04-01-preview

يسرد مهام الاستيعاب.

URI Parameters

Name In Required Type Description
endpoint path Yes string
url
نقاط نهاية OpenAI Azure المدعومة (البروتوكول واسم المضيف، على سبيل المثال: https://aoairesource.openai.azure.com. استبدل "aoairesource" باسم مورد Azure OpenAI). https://{your-resource-name}.openai.azure.com
api-version query Yes string إصدار API المطلوب.
mgmt-user-token header No string الرمز المميز المستخدم للوصول إلى مساحة العمل (مطلوب فقط لمهام حساب المستخدم).

Request Header

استخدم إما المصادقة المستندة إلى الرمز المميز أو مفتاح API. يوصى بالمصادقة باستخدام المصادقة المستندة إلى الرمز المميز وأكثر أمانا.

Name Required Type Description
Authorization True string Example:Authorization: Bearer {Azure_OpenAI_Auth_Token}

لنشاء رمز مميز للمصادقة باستخدام Azure CLI: az account get-access-token --resource https://cognitiveservices.azure.com

Type: oauth2
عنوان Url للتخويل: https://login.microsoftonline.com/common/oauth2/v2.0/authorize
نطاق: https://ai.azure.com/.default
api-key True string توفير مفتاح واجهة برمجة تطبيقات OpenAI Azure هنا

Responses

رمز الحالة: 200

Description: Success

Content-Type Type Description
application/json IngestionJobList

رمز الحالة: افتراضي

الوصف: حدث خطأ.

Content-Type Type Description
application/json ErrorResponse

Examples

GET {endpoint}/openai/ingestion/jobs?api-version=2025-04-01-preview

الاستجابات: رمز الحالة: 200

{
  "body": {
    "value": [
      {
        "jobId": "usercompute-ingestion-job",
        "kind": "UserCompute",
        "workspaceId": "/subscriptions/f375b912-331c-4fc5-8e9f-2d7205e3e036/resourceGroups/adrama-copilot-demo/providers/Microsoft.MachineLearningServices/workspaces/adrama-rag-dev"
      },
      {
        "jobId": "syscompute-ingestion-job",
        "kind": "SystemCompute"
      }
    ]
  }
}

وظائف الاستيعاب - إنشاء

PUT {endpoint}/openai/ingestion/jobs/{job-id}?api-version=2025-04-01-preview

إنشاء مهمة استيعاب بمعرف الوظيفة المحدد.

URI Parameters

Name In Required Type Description
endpoint path Yes string
url
نقاط نهاية OpenAI Azure المدعومة (البروتوكول واسم المضيف، على سبيل المثال: https://aoairesource.openai.azure.com. استبدل "aoairesource" باسم مورد Azure OpenAI). https://{your-resource-name}.openai.azure.com
api-version query Yes string إصدار API المطلوب.
job-id path Yes string معرف الوظيفة التي سيتم إنشاؤها.
mgmt-user-token header No string الرمز المميز المستخدم للوصول إلى مساحة العمل (مطلوب فقط لمهام حساب المستخدم).
aml-user-token header No string الرمز المميز المستخدم للوصول إلى الموارد داخل الوظيفة في مساحة العمل (مطلوبة فقط لمهام حساب المستخدم).

Request Header

استخدم إما المصادقة المستندة إلى الرمز المميز أو مفتاح API. يوصى بالمصادقة باستخدام المصادقة المستندة إلى الرمز المميز وأكثر أمانا.

Name Required Type Description
Authorization True string Example:Authorization: Bearer {Azure_OpenAI_Auth_Token}

لنشاء رمز مميز للمصادقة باستخدام Azure CLI: az account get-access-token --resource https://cognitiveservices.azure.com

Type: oauth2
عنوان Url للتخويل: https://login.microsoftonline.com/common/oauth2/v2.0/authorize
نطاق: https://ai.azure.com/.default
api-key True string توفير مفتاح واجهة برمجة تطبيقات OpenAI Azure هنا

Request Body

Content-Type: application/json

Name Type Description Required Default
jobId string No
kind IngestionJobType نوع المهمة. Yes

Responses

رمز الحالة: 200

Description: Success

Content-Type Type Description
application/json IngestionJob

رمز الحالة: افتراضي

الوصف: حدث خطأ.

Content-Type Type Description
application/json ErrorResponse

Examples

PUT {endpoint}/openai/ingestion/jobs/{job-id}?api-version=2025-04-01-preview

الاستجابات: رمز الحالة: 200

{
  "headers": {
    "operation-location": "https://aoairesource.openai.azure.com/openai/ingestion/jobs/ingestion-job/runs/72a2792ef7d24ba7b82c7fe4a37e379f?api-version=2025-04-01-preview"
  },
  "body": {
    "kind": "SystemCompute",
    "jobId": "ingestion-job",
    "searchServiceConnection": {
      "kind": "EndpointWithManagedIdentity",
      "endpoint": "https://aykame-dev-search.search.windows.net"
    },
    "datasource": {
      "kind": "Storage",
      "connection": {
        "kind": "EndpointWithManagedIdentity",
        "endpoint": "https://mystorage.blob.core.windows.net/",
        "resourceId": "/subscriptions/1234567-abcd-1234-5678-1234abcd/resourceGroups/my-resource/providers/Microsoft.Storage/storageAccounts/mystorage"
      },
      "containerName": "container",
      "chunking": {
        "maxChunkSizeInTokens": 2048
      },
      "embeddings": [
        {
          "connection": {
            "kind": "RelativeConnection"
          },
          "deploymentName": "Ada"
        }
      ]
    },
    "dataRefreshIntervalInHours": 24,
    "completionAction": "keepAllAssets"
  }
}
PUT {endpoint}/openai/ingestion/jobs/{job-id}?api-version=2025-04-01-preview

الاستجابات: رمز الحالة: 200

{
  "headers": {
    "operation-location": "https://aoairesource.openai.azure.com/openai/ingestion/jobs/ingestion-job/runs/72a2792ef7d24ba7b82c7fe4a37e379f?api-version=2025-04-01-preview"
  },
  "body": {
    "kind": "UserCompute",
    "jobId": "ingestion-job",
    "workspaceId": "/subscriptions/f375b912-331c-4fc5-8e9f-2d7205e3e036/resourceGroups/adrama-copilot-demo/providers/Microsoft.MachineLearningServices/workspaces/adrama-rag-dev",
    "compute": {
      "kind": "ServerlessCompute"
    },
    "target": {
      "kind": "AzureAISearch",
      "connectionId": "/subscriptions/f375b912-331c-4fc5-8e9f-2d7205e3e036/resourceGroups/adrama-copilot-demo/providers/Microsoft.MachineLearningServices/workspaces/adrama-rag-dev/connections/search-connection"
    },
    "datasource": {
      "kind": "Dataset",
      "datasetId": "azureml://locations/centraluseuap/workspaces/83317fe6-efa6-4e4a-b020-d0edd11ec382/data/PlainText/versions/1",
      "datasetType": "uri_folder"
    }
  }
}

وظائف الاستيعاب - الحصول على

GET {endpoint}/openai/ingestion/jobs/{job-id}?api-version=2025-04-01-preview

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

URI Parameters

Name In Required Type Description
endpoint path Yes string
url
نقاط نهاية OpenAI Azure المدعومة (البروتوكول واسم المضيف، على سبيل المثال: https://aoairesource.openai.azure.com. استبدل "aoairesource" باسم مورد Azure OpenAI). https://{your-resource-name}.openai.azure.com
api-version query Yes string إصدار API المطلوب.
job-id path Yes string معرف الوظيفة.

Request Header

استخدم إما المصادقة المستندة إلى الرمز المميز أو مفتاح API. يوصى بالمصادقة باستخدام المصادقة المستندة إلى الرمز المميز وأكثر أمانا.

Name Required Type Description
Authorization True string Example:Authorization: Bearer {Azure_OpenAI_Auth_Token}

لنشاء رمز مميز للمصادقة باستخدام Azure CLI: az account get-access-token --resource https://cognitiveservices.azure.com

Type: oauth2
عنوان Url للتخويل: https://login.microsoftonline.com/common/oauth2/v2.0/authorize
نطاق: https://ai.azure.com/.default
api-key True string توفير مفتاح واجهة برمجة تطبيقات OpenAI Azure هنا

Responses

رمز الحالة: 200

Description: Success

Content-Type Type Description
application/json IngestionJob

رمز الحالة: افتراضي

الوصف: حدث خطأ.

Content-Type Type Description
application/json ErrorResponse

Examples

GET {endpoint}/openai/ingestion/jobs/{job-id}?api-version=2025-04-01-preview

الاستجابات: رمز الحالة: 200

{
  "body": {
    "kind": "UserCompute",
    "jobId": "ingestion-job",
    "workspaceId": "/subscriptions/f375b912-331c-4fc5-8e9f-2d7205e3e036/resourceGroups/adrama-copilot-demo/providers/Microsoft.MachineLearningServices/workspaces/adrama-rag-dev",
    "compute": {
      "kind": "ServerlessCompute"
    },
    "target": {
      "kind": "AzureAISearch",
      "connectionId": "/subscriptions/f375b912-331c-4fc5-8e9f-2d7205e3e036/resourceGroups/adrama-copilot-demo/providers/Microsoft.MachineLearningServices/workspaces/adrama-rag-dev/connections/search-connection"
    },
    "datasource": {
      "kind": "Dataset",
      "datasetId": "azureml://locations/centraluseuap/workspaces/83317fe6-efa6-4e4a-b020-d0edd11ec382/data/PlainText/versions/1",
      "datasetType": "uri_folder"
    }
  }
}

Ingestionjobruns - قائمة

GET {endpoint}/openai/ingestion/jobs/{job-id}/runs?api-version=2025-04-01-preview

يسرد عمليات تشغيل معرف الوظيفة المحدد.

URI Parameters

Name In Required Type Description
endpoint path Yes string
url
نقاط نهاية OpenAI Azure المدعومة (البروتوكول واسم المضيف، على سبيل المثال: https://aoairesource.openai.azure.com. استبدل "aoairesource" باسم مورد Azure OpenAI). https://{your-resource-name}.openai.azure.com
api-version query Yes string إصدار API المطلوب.
job-id path Yes string معرف الوظيفة.
mgmt-user-token header No string الرمز المميز المستخدم للوصول إلى مساحة العمل (مطلوب فقط لمهام حساب المستخدم).

Request Header

استخدم إما المصادقة المستندة إلى الرمز المميز أو مفتاح API. يوصى بالمصادقة باستخدام المصادقة المستندة إلى الرمز المميز وأكثر أمانا.

Name Required Type Description
Authorization True string Example:Authorization: Bearer {Azure_OpenAI_Auth_Token}

لنشاء رمز مميز للمصادقة باستخدام Azure CLI: az account get-access-token --resource https://cognitiveservices.azure.com

Type: oauth2
عنوان Url للتخويل: https://login.microsoftonline.com/common/oauth2/v2.0/authorize
نطاق: https://ai.azure.com/.default
api-key True string توفير مفتاح واجهة برمجة تطبيقات OpenAI Azure هنا

Responses

رمز الحالة: 200

Description: Success

Content-Type Type Description
application/json IngestionJobRunList

رمز الحالة: افتراضي

الوصف: حدث خطأ.

Content-Type Type Description
application/json ErrorResponse

Examples

GET {endpoint}/openai/ingestion/jobs/{job-id}/runs?api-version=2025-04-01-preview

الاستجابات: رمز الحالة: 200

{
  "body": {
    "value": [
      {
        "jobId": "ingestion-job",
        "runId": "f375b912-331c-4fc5-8e9f-2d7205e3e036",
        "status": "succeeded"
      },
      {
        "jobId": "ingestion-job",
        "runId": "07f2d192-add7-4202-a2e3-858c2577f4fd",
        "status": "failed"
      },
      {
        "jobId": "ingestion-job",
        "runId": "5ef7a436-1147-4cbb-82e0-3d502bcc6a7b",
        "status": "running"
      }
    ]
  }
}

Ingestionjobruns - الحصول على

GET {endpoint}/openai/ingestion/jobs/{job-id}/runs/{run-id}?api-version=2025-04-01-preview

يحصل على تفاصيل معرف التشغيل المحدد كجزء من معرف الوظيفة المحدد.

URI Parameters

Name In Required Type Description
endpoint path Yes string
url
نقاط نهاية OpenAI Azure المدعومة (البروتوكول واسم المضيف، على سبيل المثال: https://aoairesource.openai.azure.com. استبدل "aoairesource" باسم مورد Azure OpenAI). https://{your-resource-name}.openai.azure.com
api-version query Yes string إصدار API المطلوب.
job-id path Yes string معرف الوظيفة.
run-id path Yes string معرف التشغيل.
mgmt-user-token header No string الرمز المميز المستخدم للوصول إلى مساحة العمل (مطلوب فقط لمهام حساب المستخدم).

Request Header

استخدم إما المصادقة المستندة إلى الرمز المميز أو مفتاح API. يوصى بالمصادقة باستخدام المصادقة المستندة إلى الرمز المميز وأكثر أمانا.

Name Required Type Description
Authorization True string Example:Authorization: Bearer {Azure_OpenAI_Auth_Token}

لنشاء رمز مميز للمصادقة باستخدام Azure CLI: az account get-access-token --resource https://cognitiveservices.azure.com

Type: oauth2
عنوان Url للتخويل: https://login.microsoftonline.com/common/oauth2/v2.0/authorize
نطاق: https://ai.azure.com/.default
api-key True string توفير مفتاح واجهة برمجة تطبيقات OpenAI Azure هنا

Responses

رمز الحالة: 200

Description: Success

Content-Type Type Description
application/json IngestionJobRun

رمز الحالة: افتراضي

الوصف: حدث خطأ.

Content-Type Type Description
application/json ErrorResponse

Examples

GET {endpoint}/openai/ingestion/jobs/{job-id}/runs/{run-id}?api-version=2025-04-01-preview

الاستجابات: رمز الحالة: 200

{
  "body": {
    "jobId": "ingestion-job",
    "runId": "5ef7a436-1147-4cbb-82e0-3d502bcc6a7b",
    "status": "running",
    "progress": {
      "stageProgress": [
        {
          "name": "Preprocessing",
          "totalItems": 14,
          "processedItems": 0,
          "state": "notRunning"
        },
        {
          "name": "Indexing",
          "state": "notRunning"
        }
      ]
    }
  }
}

النماذج - قائمة

GET {endpoint}/openai/models?api-version=2025-04-01-preview

الحصول على قائمة بجميع النماذج التي يمكن الوصول إليها بواسطة مورد Azure OpenAI.

وتشمل هذه النماذج الأساسية بالإضافة إلى جميع النماذج الدقيقة المكتملة بنجاح المملوكة لمورد Azure OpenAI.

URI Parameters

Name In Required Type Description
endpoint path Yes string
url
نقاط نهاية OpenAI Azure المدعومة (البروتوكول واسم المضيف، على سبيل المثال: https://aoairesource.openai.azure.com. استبدل "aoairesource" باسم مورد Azure OpenAI). https://{your-resource-name}.openai.azure.com
api-version query Yes string إصدار API المطلوب.

Request Header

استخدم إما المصادقة المستندة إلى الرمز المميز أو مفتاح API. يوصى بالمصادقة باستخدام المصادقة المستندة إلى الرمز المميز وأكثر أمانا.

Name Required Type Description
Authorization True string Example:Authorization: Bearer {Azure_OpenAI_Auth_Token}

لنشاء رمز مميز للمصادقة باستخدام Azure CLI: az account get-access-token --resource https://cognitiveservices.azure.com

Type: oauth2
عنوان Url للتخويل: https://login.microsoftonline.com/common/oauth2/v2.0/authorize
نطاق: https://ai.azure.com/.default
api-key True string توفير مفتاح واجهة برمجة تطبيقات OpenAI Azure هنا

Responses

رمز الحالة: 200

Description: Success

Content-Type Type Description
application/json ModelList

رمز الحالة: افتراضي

الوصف: حدث خطأ.

Content-Type Type Description
application/json ErrorResponse

Examples

GET {endpoint}/openai/models?api-version=2025-04-01-preview

الاستجابات: رمز الحالة: 200

{
  "headers": {},
  "body": {
    "data": [
      {
        "status": "succeeded",
        "capabilities": {
          "fine_tune": true,
          "inference": true,
          "completion": true,
          "chat_completion": false,
          "embeddings": false
        },
        "lifecycle_status": `generally-available`,
        "deprecation": {
          "fine_tune": 1677662127,
          "inference": 1709284527
        },
        "id": "curie",
        "created_at": 1646126127,
        "object": "model"
      },
      {
        "status": "succeeded",
        "model": "curie",
        "fine_tune": "ft-72a2792ef7d24ba7b82c7fe4a37e379f",
        "capabilities": {
          "fine_tune": false,
          "inference": true,
          "completion": true,
          "chat_completion": false,
          "embeddings": false
        },
        "lifecycle_status": `generally-available`,
        "deprecation": {
          "inference": 1709284527
        },
        "id": "curie.ft-72a2792ef7d24ba7b82c7fe4a37e379f",
        "created_at": 1646126127,
        "object": "model"
      }
    ],
    "object": "list"
  }
}

النماذج - الحصول على

GET {endpoint}/openai/models/{model-id}?api-version=2025-04-01-preview

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

URI Parameters

Name In Required Type Description
endpoint path Yes string
url
نقاط نهاية OpenAI Azure المدعومة (البروتوكول واسم المضيف، على سبيل المثال: https://aoairesource.openai.azure.com. استبدل "aoairesource" باسم مورد Azure OpenAI). https://{your-resource-name}.openai.azure.com
model-id path Yes string معرف النموذج.
api-version query Yes string إصدار API المطلوب.

Request Header

استخدم إما المصادقة المستندة إلى الرمز المميز أو مفتاح API. يوصى بالمصادقة باستخدام المصادقة المستندة إلى الرمز المميز وأكثر أمانا.

Name Required Type Description
Authorization True string Example:Authorization: Bearer {Azure_OpenAI_Auth_Token}

لنشاء رمز مميز للمصادقة باستخدام Azure CLI: az account get-access-token --resource https://cognitiveservices.azure.com

Type: oauth2
عنوان Url للتخويل: https://login.microsoftonline.com/common/oauth2/v2.0/authorize
نطاق: https://ai.azure.com/.default
api-key True string توفير مفتاح واجهة برمجة تطبيقات OpenAI Azure هنا

Responses

رمز الحالة: 200

Description: Success

Content-Type Type Description
application/json Model

رمز الحالة: افتراضي

الوصف: حدث خطأ.

Content-Type Type Description
application/json ErrorResponse

Examples

GET {endpoint}/openai/models/{model-id}?api-version=2025-04-01-preview

الاستجابات: رمز الحالة: 200

{
  "headers": {},
  "body": {
    "status": "succeeded",
    "capabilities": {
      "fine_tune": true,
      "inference": true,
      "completion": true,
      "chat_completion": false,
      "embeddings": false
    },
    "lifecycle_status": `generally-available`,
    "deprecation": {
      "fine_tune": 1677662127,
      "inference": 1709284527
    },
    "id": "curie",
    "created_at": 1646126127,
    "object": "model"
  }
}
GET {endpoint}/openai/models/{model-id}?api-version=2025-04-01-preview

الاستجابات: رمز الحالة: 200

{
  "headers": {},
  "body": {
    "status": "succeeded",
    "model": "curie",
    "fine_tune": "ft-72a2792ef7d24ba7b82c7fe4a37e379f",
    "capabilities": {
      "fine_tune": false,
      "inference": true,
      "completion": true,
      "chat_completion": false,
      "embeddings": false
    },
    "lifecycle_status": `generally-available`,
    "deprecation": {
      "inference": 1709284527
    },
    "id": "curie.ft-72a2792ef7d24ba7b82c7fe4a37e379f",
    "created_at": 1646126127,
    "object": "model"
  }
}

تحميل الملف - البدء

POST {endpoint}/openai/uploads?api-version=2025-04-01-preview

يتم إنشاء كائن تحميل وسيط، مما يسمح لك بإضافة أجزاء إليه. حاليا، يمكن أن يكون حجم التحميل بحد أقصى 9 غيغابايت في المجموع وستنتهي صلاحيته بعد ساعتين من إنشائه.

بعد اكتمال التحميل، سيتم إنشاء كائن ملف، يحتوي على جميع الأجزاء التي تم تحميلها. يمكن بعد ذلك استخدام كائن File هذا عبر نظامنا الأساسي تماما مثل أي ملف آخر.

URI Parameters

Name In Required Type Description
endpoint path Yes string
url
نقاط نهاية OpenAI Azure المدعومة (البروتوكول واسم المضيف، على سبيل المثال: https://aoairesource.openai.azure.com. استبدل "aoairesource" باسم مورد Azure OpenAI). https://{your-resource-name}.openai.azure.com
api-version query Yes string إصدار API المطلوب.

Request Header

استخدم إما المصادقة المستندة إلى الرمز المميز أو مفتاح API. يوصى بالمصادقة باستخدام المصادقة المستندة إلى الرمز المميز وأكثر أمانا.

Name Required Type Description
Authorization True string Example:Authorization: Bearer {Azure_OpenAI_Auth_Token}

لنشاء رمز مميز للمصادقة باستخدام Azure CLI: az account get-access-token --resource https://cognitiveservices.azure.com

Type: oauth2
عنوان Url للتخويل: https://login.microsoftonline.com/common/oauth2/v2.0/authorize
نطاق: https://ai.azure.com/.default
api-key True string توفير مفتاح واجهة برمجة تطبيقات OpenAI Azure هنا

Request Body

Content-Type: application/json

Name Type Description Required Default
bytes integer Yes
filename string Yes
mime_type string Yes
purpose Purpose الغرض المقصود من المستندات التي تم تحميلها. استخدم "ضبط" للضبط الدقيق. يسمح لنا هذا بالتحقق من صحة تنسيق الملف الذي تم تحميله. Yes

Request Body

Content-Type: text/json

Name Type Description Required Default
bytes integer Yes
filename string Yes
mime_type string Yes
purpose Purpose الغرض المقصود من المستندات التي تم تحميلها. استخدم "ضبط" للضبط الدقيق. يسمح لنا هذا بالتحقق من صحة تنسيق الملف الذي تم تحميله. Yes

Request Body

Content-Type: application/*+json

Name Type Description Required Default
bytes integer Yes
filename string Yes
mime_type string Yes
purpose Purpose الغرض المقصود من المستندات التي تم تحميلها. استخدم "ضبط" للضبط الدقيق. يسمح لنا هذا بالتحقق من صحة تنسيق الملف الذي تم تحميله. Yes

Responses

رمز الحالة: 200

الوصف: تم إنشاء التحميل بنجاح.

Content-Type Type Description
application/json UploadResource

رمز الحالة: افتراضي

الوصف: حدث خطأ.

Content-Type Type Description
application/json ErrorResponse

Examples

POST {endpoint}/openai/uploads?api-version=2025-04-01-preview

{
 "purpose": "fine-tune",
 "filename": "training_data_v21.jsonl",
 "bytes": 2097152,
 "mime_type": "application/json"
}

الاستجابات: رمز الحالة: 200

{
  "headers": {
    "location": "https://aoairesource.openai.azure.com/openai/uploads/runs/fine-tune-72a2792ef7d24ba7b82c7fe4a37e379f"
  },
  "body": {
    "bytes": 2097152,
    "filename": "training_data_v21.jsonl",
    "purpose": "fine-tune",
    "status": "pending",
    "expires_at": 1646133327,
    "file": {
      "status": "pending",
      "bytes": 140,
      "purpose": "fine-tune",
      "filename": "puppy.jsonl",
      "id": "file-181a1cbdcdcf4677ada87f63a0928099",
      "created_at": 1646126127,
      "object": "file"
    },
    "id": "fine-tune-72a2792ef7d24ba7b82c7fe4a37e379f",
    "created_at": 1646126127,
    "object": "upload"
  }
}

تحميل الملف - إلغاء الأمر

POST {endpoint}/openai/uploads/{upload-id}/cancel?api-version=2025-04-01-preview

إلغاء التحميل، وسيؤدي إلى حذف جميع الأجزاء التي تم تحميلها بشكل غير متزامن.

لا يمكن إضافة أي أجزاء بعد إلغاء التحميل.

URI Parameters

Name In Required Type Description
endpoint path Yes string
url
نقاط نهاية OpenAI Azure المدعومة (البروتوكول واسم المضيف، على سبيل المثال: https://aoairesource.openai.azure.com. استبدل "aoairesource" باسم مورد Azure OpenAI). https://{your-resource-name}.openai.azure.com
upload-id path Yes string معرف التحميل.
api-version query Yes string إصدار API المطلوب.

Request Header

استخدم إما المصادقة المستندة إلى الرمز المميز أو مفتاح API. يوصى بالمصادقة باستخدام المصادقة المستندة إلى الرمز المميز وأكثر أمانا.

Name Required Type Description
Authorization True string Example:Authorization: Bearer {Azure_OpenAI_Auth_Token}

لنشاء رمز مميز للمصادقة باستخدام Azure CLI: az account get-access-token --resource https://cognitiveservices.azure.com

Type: oauth2
عنوان Url للتخويل: https://login.microsoftonline.com/common/oauth2/v2.0/authorize
نطاق: https://ai.azure.com/.default
api-key True string توفير مفتاح واجهة برمجة تطبيقات OpenAI Azure هنا

Responses

رمز الحالة: 200

Description: Success

Content-Type Type Description
application/json UploadResource

رمز الحالة: افتراضي

الوصف: حدث خطأ.

Content-Type Type Description
application/json ErrorResponse

Examples

POST {endpoint}/openai/uploads/{upload-id}/cancel?api-version=2025-04-01-preview

الاستجابات: رمز الحالة: 200

{
  "headers": {},
  "body": {
    "bytes": 2097152,
    "filename": "training_data_v21.jsonl",
    "purpose": "fine-tune",
    "status": "cancelled",
    "expires_at": 1646133327,
    "file": {
      "status": "pending",
      "bytes": 140,
      "purpose": "fine-tune",
      "filename": "puppy.jsonl",
      "id": "file-181a1cbdcdcf4677ada87f63a0928099",
      "created_at": 1646126127,
      "object": "file"
    },
    "id": "fine-tune-72a2792ef7d24ba7b82c7fe4a37e379f",
    "created_at": 1646126127,
    "object": "upload"
  }
}

تحميل الملف - مكتمل

POST {endpoint}/openai/uploads/{upload-id}/complete?api-version=2025-04-01-preview

يؤدي ذلك إلى إكمال Upload، ويحتوي كائن Upload الذي تم إرجاعه على كائن ملف متداخل جاهز للاستخدام عبر النظام الأساسي.

يمكنك تحديد ترتيب الأجزاء عن طريق توفير قائمة مرتبة بمعرفات الأجزاء.

يجب أن يتطابق إجمالي عدد وحدات البايت التي تم تحميلها مع الحجم المحدد في الأصل عند إنشاء كائن Upload.

بعد هذه العملية، لا يمكن إضافة أجزاء إضافية بمجرد اكتمال التحميل.

URI Parameters

Name In Required Type Description
endpoint path Yes string
url
نقاط نهاية OpenAI Azure المدعومة (البروتوكول واسم المضيف، على سبيل المثال: https://aoairesource.openai.azure.com. استبدل "aoairesource" باسم مورد Azure OpenAI). https://{your-resource-name}.openai.azure.com
upload-id path Yes string معرف التحميل.
api-version query Yes string إصدار API المطلوب.

Request Header

استخدم إما المصادقة المستندة إلى الرمز المميز أو مفتاح API. يوصى بالمصادقة باستخدام المصادقة المستندة إلى الرمز المميز وأكثر أمانا.

Name Required Type Description
Authorization True string Example:Authorization: Bearer {Azure_OpenAI_Auth_Token}

لنشاء رمز مميز للمصادقة باستخدام Azure CLI: az account get-access-token --resource https://cognitiveservices.azure.com

Type: oauth2
عنوان Url للتخويل: https://login.microsoftonline.com/common/oauth2/v2.0/authorize
نطاق: https://ai.azure.com/.default
api-key True string توفير مفتاح واجهة برمجة تطبيقات OpenAI Azure هنا

Request Body

Content-Type: application/json

Name Type Description Required Default
md5 string No
part_ids array Yes

Request Body

Content-Type: text/json

Name Type Description Required Default
md5 string No
part_ids array Yes

Request Body

Content-Type: application/*+json

Name Type Description Required Default
md5 string No
part_ids array Yes

Responses

رمز الحالة: 200

Description: Success

Content-Type Type Description
application/json UploadResource

رمز الحالة: افتراضي

الوصف: حدث خطأ.

Content-Type Type Description
application/json ErrorResponse

Examples

POST {endpoint}/openai/uploads/{upload-id}/complete?api-version=2025-04-01-preview

{
 "part_ids": [
  "LnmictL3p0u4LH/ko343nw==",
  "LmmictL3p0u4LH/ko343nw=="
 ]
}

الاستجابات: رمز الحالة: 200

{
  "headers": {},
  "body": {
    "bytes": 2097152,
    "filename": "training_data_v21.jsonl",
    "purpose": "fine-tune",
    "status": "completed",
    "expires_at": 1646133327,
    "file": {
      "status": "processed",
      "bytes": 140,
      "purpose": "fine-tune",
      "filename": "puppy.jsonl",
      "id": "file-181a1cbdcdcf4677ada87f63a0928099",
      "created_at": 1646126127,
      "object": "file"
    },
    "id": "fine-tune-72a2792ef7d24ba7b82c7fe4a37e379f",
    "created_at": 1646126127,
    "object": "upload"
  }
}

تحميل الملف - جزء

POST {endpoint}/openai/uploads/{upload-id}/parts?api-version=2025-04-01-preview

إضافة جزء إلى كائن تحميل، حيث يمثل كل جزء مقطعا من الملف الذي تقوم بتحميله.

يمكن أن يصل كل جزء إلى حد الحجم القياسي لتحميل الملف، استنادا إلى الغرض من الملف. يمكنك متابعة إضافة أجزاء حتى الوصول إلى حد حجم التحميل البالغ 9 غيغابايت.

URI Parameters

Name In Required Type Description
endpoint path Yes string
url
نقاط نهاية OpenAI Azure المدعومة (البروتوكول واسم المضيف، على سبيل المثال: https://aoairesource.openai.azure.com. استبدل "aoairesource" باسم مورد Azure OpenAI). https://{your-resource-name}.openai.azure.com
upload-id path Yes string معرف التحميل.
api-version query Yes string إصدار API المطلوب.

Request Header

استخدم إما المصادقة المستندة إلى الرمز المميز أو مفتاح API. يوصى بالمصادقة باستخدام المصادقة المستندة إلى الرمز المميز وأكثر أمانا.

Name Required Type Description
Authorization True string Example:Authorization: Bearer {Azure_OpenAI_Auth_Token}

لنشاء رمز مميز للمصادقة باستخدام Azure CLI: az account get-access-token --resource https://cognitiveservices.azure.com

Type: oauth2
عنوان Url للتخويل: https://login.microsoftonline.com/common/oauth2/v2.0/authorize
نطاق: https://ai.azure.com/.default
api-key True string توفير مفتاح واجهة برمجة تطبيقات OpenAI Azure هنا

Request Body

Content-Type: multipart/form-data

Name Type Description Required Default
data string Yes

Responses

رمز الحالة: 200

Description: Success

Content-Type Type Description
application/json UploadPartResource

رمز الحالة: افتراضي

الوصف: حدث خطأ.

Content-Type Type Description
application/json ErrorResponse

Examples

POST {endpoint}/openai/uploads/{upload-id}/parts?api-version=2025-04-01-preview

الاستجابات: رمز الحالة: 200

{
  "headers": {},
  "body": {
    "upload_id": "fine-tune-72a2792ef7d24ba7b82c7fe4a37e379f",
    "azure_block_id": "LnmictL3p0u4LH/ko343nw==",
    "id": "uplprt-72a2792ef7d24ba7b82c7fe4a37e379f",
    "created_at": 1646126127,
    "object": "upload.part"
  }
}

Components

AzureAISearchIndex

فهرس البحث باستخدام الذكاء الاصطناعي في Azure.

Name Type Description Required Default
connectionId string معرف الاتصال الذي يشير إلى فهرس البحث باستخدام الذكاء الاصطناعي في Azure. No
kind TargetType نوع الهدف. Yes

BaseConnection

اتصال بمورد.

تمييزي على BaseConnection

يستخدم هذا المكون الخاصية kind للتمييز بين الأنواع المختلفة:

Type Value Schema
Name Type Description Required Default
kind ConnectionType نوع الاتصال. Yes

Batch

تعريف قيم الدفعة.

Name Type Description Required Default
cancelled_at integer طابع زمني عند إلغاء هذه الدفعة (في فترات unix). No
cancelling_at integer طابع زمني عند بدء إلغاء هذه الدفعة (في فترات unix). No
completed_at integer طابع زمني عند اكتمال هذه الدفعة (في فترات unix). No
completion_window string الإطار الزمني الذي يجب أن تتم فيه معالجة الدفعة. No
created_at integer طابع زمني عند إنشاء هذه الدفعة (في فترات unix). No
endpoint string نقطة نهاية API المستخدمة من قبل الدفعة. No
error_blob string عنوان URL للكائن الثنائي كبير الحجم الذي يحتوي على مخرجات الطلبات ذات الأخطاء. No
error_file_id string معرف الملف الذي يحتوي على مخرجات الطلبات ذات الأخطاء. No
errors BatchErrors بالنسبة للدفعات التي فشلت، سيحتوي هذا على مزيد من المعلومات حول سبب الفشل. No
expired_at integer طابع زمني عند انتهاء صلاحية هذه الدفعة (في فترات unix). No
expires_at integer طابع زمني عندما تنتهي صلاحية هذه الدفعة (في فترات unix). No
failed_at integer طابع زمني عند فشل هذه الدفعة (في فترات unix). No
finalizing_at integer طابع زمني عند بدء إنهاء هذه الدفعة (في فترات unix). No
id string هوية هذا العنصر. Yes
in_progress_at integer طابع زمني عندما بدأت هذه الدفعة في التقدم (في فترات unix). No
input_blob string عنوان URL للكائن الثنائي كبير الحجم الذي يحتوي على ملف الإدخال للدفعة. No
input_file_id string معرف ملف الإدخال للدفعة. Yes
metadata object مجموعة من أزواج المفاتيح والقيم التي يمكن ربطها بالدفعة. يمكن أن يكون هذا مفيدا لتخزين معلومات إضافية حول الدفعة بتنسيق منظم. No
object TypeDiscriminator تعريف نوع الكائن. No
output_blob string عنوان URL للكائن الثنائي كبير الحجم الذي يحتوي على مخرجات الطلبات التي تم تنفيذها بنجاح. No
output_file_id string معرف الملف الذي يحتوي على مخرجات الطلبات التي تم تنفيذها بنجاح. No
request_counts BatchRequestCounts الطلب يحتسب لحالات مختلفة داخل الدفعة. No
status BatchStatus حالة الدفعة. No

BatchCreateRequest

تعريف طلب إنشاء دفعة.

Name Type Description Required Default
completion_window string الإطار الزمني الذي يجب أن تتم فيه معالجة الدفعة. Yes
endpoint string نقطة نهاية API المستخدمة من قبل الدفعة. Yes
input_blob string عنوان url تخزين Azure blob لاستخدامه كمدخل للدفعة. No
input_file_id string معرف ملف الإدخال للدفعة. No
metadata object مجموعة من أزواج المفاتيح والقيم التي يمكن ربطها بالدفعة. يمكن أن يكون هذا مفيدا لتخزين معلومات إضافية حول الدفعة بتنسيق منظم. No
output_expires_after FileExpiresAfter تعريف انتهاء صلاحية الملف. No
output_folder BatchOutputReference مجلد تخزين Azure لتخزين الإخراج. No

BatchErrorData

معلومات الخطأ لفشل في الدفعة.

Name Type Description Required Default
code string رمز خطأ يحدد نوع الخطأ. No
line string رقم السطر لملف الإدخال حيث حدث الخطأ، إن أمكن (يمكن أن يكون فارغا). No
message string رسالة يمكن للشخص القراءة تقدم مزيدا من التفاصيل حول الخطأ. No
param string اسم المعلمة التي تسببت في الخطأ، إن أمكن (يمكن أن تكون خالية). No

BatchErrors

بالنسبة للدفعات التي فشلت، سيحتوي هذا على مزيد من المعلومات حول سبب الفشل.

Name Type Description Required Default
data BatchErrorData معلومات الخطأ لفشل في الدفعة. No
object string نوع كائن الأخطاء. هذه دائما "قائمة". No

BatchRequestCounts

الطلب يحتسب لحالات مختلفة داخل الدفعة.

Name Type Description Required Default
completed integer عدد الطلبات في الدفعة التي تم إنجازها بنجاح. No
failed integer عدد الطلبات في الدفعة التي فشلت. No
total integer إجمالي عدد الطلبات في الدفعة. No

BatchOutputReference

مجلد تخزين Azure لتخزين الإخراج.

Name Type Description Required Default
delimiter string Optional. المحدد المستخدم في مسار المجلد، بشكل افتراضي /. No
url string عنوان url لمجلد تخزين Azure حيث سيتم حفظ إخراج الدفعة. No

BatchStatus

حالة الدفعة.

Property Value
Description حالة الدفعة.
Type string
Values validating
failed
in_progress
finalizing
completed
expired
cancelling
cancelled

BatchesList

يمثل قائمة بالدفعات.

Name Type Description Required Default
data array قائمة العناصر. No
first_id string معرف الدفعة الأولى في قائمة الدفعات التي تم إرجاعها. No
has_more boolean قيمة تشير إلى ما إذا كانت القائمة تحتوي على عناصر أكثر مما تم إرجاعه. No
last_id string معرف الدفعة الأخيرة في قائمة الدفعات التي تم إرجاعها. No
object TypeDiscriminator تعريف نوع الكائن. No

Capabilities

قدرات نموذج قاعدة أو ضبط دقيق.

Name Type Description Required Default
chat_completion boolean قيمة تشير إلى ما إذا كان النموذج يدعم إكمال الدردشة. Yes
completion boolean قيمة تشير إلى ما إذا كان النموذج يدعم الإكمال. Yes
embeddings boolean قيمة تشير إلى ما إذا كان النموذج يدعم التضمينات. Yes
fine_tune boolean قيمة تشير إلى ما إذا كان يمكن استخدام نموذج للضبط الدقيق. Yes
inference boolean قيمة تشير إلى ما إذا كان يمكن نشر نموذج. Yes

Choice

Name Type Description Required Default
finish_reason string سبب توقف النموذج عن إنشاء الرموز المميزة. No
index integer فهرس الاختيار في قائمة الاختيارات. No
logprobs object سجل معلومات الاحتمال للاختيار. No
message ChoiceMessage No

ChoiceMessage

Name Type Description Required Default
content string محتويات الرسالة. No
role string دور الكيان الذي ينشئ الرسالة. No
tool_calls array قائمة باستدعاءات الأدوات ذات الصلة. No

ChunkingSettings

Chunking settings

Name Type Description Required Default
maxChunkSizeInTokens integer No

CompletionAction

إجراء الإكمال.

Property Value
Description إجراء الإكمال.
Type string
Values cleanUpTempAssets
keepAllAssets

ComputeType

نوع الحساب.

Property Value
Description نوع الحساب.
Type string
Values ServerlessCompute
CustomCompute

ConnectionStringConnection

اتصال سلسلة الاتصال.

Name Type Description Required Default
connectionString string Connection string No
kind ConnectionType نوع الاتصال. Yes

ConnectionType

نوع الاتصال.

Property Value
Description نوع الاتصال.
Type string
Values EndpointWithKey
ConnectionString
EndpointWithManagedIdentity
WorkspaceConnection
RelativeConnection

CosmosDBIndex

CosmosDB Index.

Name Type Description Required Default
collectionName string اسم مجموعة cosmos DB. No
connectionId string معرف الاتصال الذي يشير إلى cosmos DB. No
databaseName string اسم قاعدة بيانات cosmos DB. No
kind TargetType نوع الهدف. Yes

CrawlingSettings

Crawling settings

Name Type Description Required Default
maxCrawlDepth integer No
maxCrawlTimeInMins integer No
maxDownloadTimeInMins integer No
maxFileSize integer No
maxFiles integer No
maxRedirects integer No

CreateEvalCompletionsRunDataSource

كائن CompletionsRunDataSource يصف تكوين أخذ عينات نموذجي.

Name Type Description Required Default
input_messages object No
└─ item_reference string مرجع إلى متغير في مساحة الاسم "العنصر"، على سبيل المثال، "item.name". No
└─ template array قائمة برسائل الدردشة التي تشكل الموضوع أو السياق. قد يتضمن مراجع متغيرة لمساحة الاسم "العنصر"، على سبيل المثال، {{item.name}}. No
└─ type enum نوع رسائل الإدخال. إما template أو item_reference.
القيم الممكنة: template، item_reference
No
model string اسم النموذج الذي يجب استخدامه لإنشاء الإكمال (على سبيل المثال، 'o3-mini'). No
sampling_params object No
└─ max_completion_tokens integer الحد الأقصى لعدد الرموز في الناتج المولد. No
└─ seed integer قيمة أولية لتهيئة العشوائية، أثناء أخذ العينات. No 42
└─ temperature number درجة الحرارة الأعلى تزيد من عشوائية المخرجات. No 1
└─ top_p number بديل لدرجة الحرارة في أخذ عينات النواة؛ يشمل 1.0 جميع الرموز. No 1
source object Yes
└─ type enum نوع المصدر. يمكن أن يكون واحدا من EvalJsonlFileContentSourceأو EvalJsonlFileIdSourceأو EvalStoredCompletionsSource.
القيم الممكنة: EvalJsonlFileContentSource, EvalJsonlFileIdSource, EvalStoredCompletionsSource
No
type enum نوع مصدر البيانات الذي يتم تشغيله. دائما completions.
القيم المحتملة: completions
Yes

CreateEvalCustomDataSourceConfig

كائن CustomDataSourceConfig يحدد مخطط مصدر البيانات المستخدم في عمليات التقييم. يتم استخدام هذا المخطط لتعريف شكل البيانات التي ستكون: - تستخدم لتعريف معايير الاختبار الخاصة بك و - ما هي البيانات المطلوبة عند إنشاء تشغيل

Name Type Description Required Default
include_sample_schema boolean هل يجب أن يتوقع التقييم منك ملء مساحة الأسماء العينة (أي عن طريق توليد ردود من مصدر بياناتك) No False
item_schema object مخطط json لكل صف في مصدر البيانات. Yes
type enum نوع مصدر البيانات. دائما custom.
القيم المحتملة: custom
Yes

CreateEvalItem

رسالة دردشة تشكل الموضوع أو السياق. قد يتضمن مراجع متغيرة لمساحة الاسم "العنصر"، أي {{item.name}}.

Name Type Description Required Default
content ['سلسلة', 'InputTextContent', 'object'] مدخلات النص إلى النموذج - يمكن أن تحتوي على سلاسل قالب. Yes
role enum دور إدخال الرسالة. واحد من user، assistant، system، أو developer.
القيم الممكنة: user, assistant, system, developer
Yes
type enum نوع إدخال الرسالة. دائما message.
القيم المحتملة: message
No

CreateEvalJsonlRunDataSource

كائن JsonlRunDataSource يحتوي على هذا يحدد ملف JSONL يطابق التقييم

Name Type Description Required Default
source object Yes
└─ content array محتوى ملف jsonl. No
└─ id string معرف الملف. No
└─ type enum نوع مصدر jsonl. دائما file_id.
القيم المحتملة: file_id
No
type enum نوع مصدر البيانات. دائما jsonl.
القيم المحتملة: jsonl
Yes

CreateEvalLabelModelGrader

كائن LabelModelGrader يستخدم نموذجا لتعيين التسميات لكل عنصر في التقييم.

Name Type Description Required Default
input array قائمة برسائل الدردشة التي تشكل الموضوع أو السياق. قد يتضمن مراجع متغيرة لمساحة الاسم "العنصر"، أي {{item.name}}. Yes
labels array الملصقات التي يجب تصنيفها لكل عنصر في التقييم. Yes
model string النموذج المستخدم في التقييم. يجب دعم المخرجات المنظمة. Yes
name string اسم المصحح. Yes
passing_labels array الملصقات التي تشير إلى نتيجة عابرة. يجب أن يكون هذا فرعا من التسميات. Yes
type enum نوع الكائن، والذي يكون دائما label_model.
القيم المحتملة: label_model
Yes

CreateEvalLogsDataSourceConfig

تكوين مصدر بيانات يحدد خاصية بيانات التعريف لاستعلام الإكمال المخزن. عادة ما تكون هذه البيانات الوصفية مثل usecase=chatbot أو prompt-version=v2، إلخ.

Name Type Description Required Default
metadata object تصفية البيانات الوصفية لمصدر بيانات السجلات. No
type enum نوع مصدر البيانات. دائما logs.
القيم المحتملة: logs
Yes

CreateEvalRequest

Name Type Description Required Default
data_source_config object كائن CustomDataSourceConfig يحدد مخطط مصدر البيانات المستخدم في عمليات التقييم. يتم استخدام هذا المخطط لتعريف شكل البيانات التي ستكون: - تستخدم لتعريف معايير الاختبار الخاصة بك و - ما هي البيانات المطلوبة عند إنشاء تشغيل Yes
└─ include_sample_schema boolean هل يجب أن يتوقع التقييم منك ملء مساحة الأسماء العينة (أي عن طريق توليد ردود من مصدر بياناتك) No False
└─ item_schema object مخطط json لكل صف في مصدر البيانات. No
└─ metadata object تصفية البيانات الوصفية لمصدر بيانات السجلات. No
└─ type enum نوع مصدر البيانات. دائما logs.
القيم المحتملة: logs
No
metadata Metadata مجموعة من 16 زوجا من مفاتيح-قيم يمكن ربطها بكائن. يمكن أن يكون هذا مفيدا لتخزين معلومات إضافية عن الكائن بصيغة منظمة، وللاستعلام عن الكائنات عبر واجهة برمجة التطبيقات أو لوحة التحكم. المفاتيح هي سلاسل سلاسل بطول أقصى يبلغ 64 حرفا. القيم هي سلاسل سلاسل بطول أقصى يبلغ 512 حرفا. No
name string اسم التقييم. No
testing_criteria array قائمة بالتقييمات لجميع التقييمات في هذه المجموعة. Yes

CreateEvalRunRequest

Name Type Description Required Default
data_source object كائن JsonlRunDataSource يحتوي على هذا يحدد ملف JSONL يطابق التقييم Yes
└─ input_messages object No
└─ item_reference string مرجع إلى متغير في مساحة الاسم "العنصر"، على سبيل المثال، "item.name". No
└─ template array قائمة برسائل الدردشة التي تشكل الموضوع أو السياق. قد يتضمن مراجع متغيرة لمساحة الاسم "العنصر"، على سبيل المثال، {{item.name}}. No
└─ type enum نوع رسائل الإدخال. إما template أو item_reference.
القيم الممكنة: template، item_reference
No
└─ model string اسم النموذج الذي يجب استخدامه لإنشاء الإكمال (على سبيل المثال، 'o3-mini'). No
└─ sampling_params object No
└─ max_completion_tokens integer الحد الأقصى لعدد الرموز في الناتج المولد. No
└─ seed integer قيمة أولية لتهيئة العشوائية، أثناء أخذ العينات. No 42
└─ temperature number درجة الحرارة الأعلى تزيد من عشوائية المخرجات. No 1
└─ top_p number بديل لدرجة الحرارة في أخذ عينات النواة؛ يشمل 1.0 جميع الرموز. No 1
└─ source object No
└─ type enum نوع المصدر. يمكن أن يكون واحدا من EvalJsonlFileContentSourceأو EvalJsonlFileIdSourceأو EvalStoredCompletionsSource.
القيم الممكنة: EvalJsonlFileContentSource, EvalJsonlFileIdSource, EvalStoredCompletionsSource
No
└─ type enum نوع مصدر البيانات الذي يتم تشغيله. دائما completions.
القيم المحتملة: completions
No
metadata Metadata مجموعة من 16 زوجا من مفاتيح-قيم يمكن ربطها بكائن. يمكن أن يكون هذا مفيدا لتخزين معلومات إضافية عن الكائن بصيغة منظمة، وللاستعلام عن الكائنات عبر واجهة برمجة التطبيقات أو لوحة التحكم. المفاتيح هي سلاسل سلاسل بطول أقصى يبلغ 64 حرفا. القيم هي سلاسل سلاسل بطول أقصى يبلغ 512 حرفا. No
name string اسم الجولة. No

CreateEvalStoredCompletionsRunDataSource

تكوين StoredCompletionsRunDataSource يصف مجموعة من الفلاتر

Name Type Description Required Default
created_after integer طابع زمني Unix اختياري لتصفية العناصر التي تم إنشاؤها بعد هذا الوقت. No
created_before integer طابع زمني Unix اختياري لتصفية العناصر التي تم إنشاؤها قبل هذا الوقت. No
limit integer الحد الأقصى الاختياري لعدد العناصر التي سيتم إرجاعها. No
metadata Metadata مجموعة من 16 زوجا من مفاتيح-قيم يمكن ربطها بكائن. يمكن أن يكون هذا مفيدا لتخزين معلومات إضافية عن الكائن بصيغة منظمة، وللاستعلام عن الكائنات عبر واجهة برمجة التطبيقات أو لوحة التحكم. المفاتيح هي سلاسل سلاسل بطول أقصى يبلغ 64 حرفا. القيم هي سلاسل سلاسل بطول أقصى يبلغ 512 حرفا. No
model string نموذج اختياري للتصفية حسب (على سبيل المثال، 'gpt-4o'). No
type enum نوع مصدر البيانات. دائما stored_completions.
القيم المحتملة: stored_completions
Yes

CustomCompute

Custom compute.

Name Type Description Required Default
computeId string معرف الحساب المخصص No
kind ComputeType نوع الحساب. Yes

DeploymentConnection

اتصال التوزيع النسبي.

Name Type Description Required Default
kind ConnectionType نوع الاتصال. Yes

Deprecation

يحدد تواريخ الإهمال لحالات الاستخدام المختلفة للنموذج.

عادة ما تدعم النماذج الأساسية سنة واحدة من الضبط الدقيق بعد الإنشاء. عادة ما يتم دعم الاستدلال بعد عامين من إنشاء نماذج أساسية أو دقيقة. يتم تحديد التواريخ الدقيقة في الخصائص.

Name Type Description Required Default
fine_tune integer تاريخ انتهاء دعم ضبط هذا النموذج. سيكون null لضبط النماذج. No
inference integer تاريخ انتهاء دعم الاستدلال لهذا النموذج. Yes

DpoHyperparamsRequest

Hyperparameters لأسلوب DPO للضبط الدقيق

Name Type Description Required Default
batch_size integer حجم الدفعة المستخدم في التدريب. حجم الدفعة هو عدد أمثلة التدريب المستخدمة لتدريب تمريرة واحدة للأمام والخلف. بشكل عام، وجدنا أن أحجام الدفعات الأكبر تميل إلى العمل بشكل أفضل لمجموعات البيانات الأكبر حجما. القيمة الافتراضية بالإضافة إلى القيمة القصوى لهذه الخاصية خاصة بنموذج أساسي. No
beta number قيمة بيتا DPO. No
l2_multiplier number مضاعف الانتظام L2 No
learning_rate_multiplier number مضاعف معدل التعلم الذي يجب استخدامه في التدريب. معدل التعلم الدقيق هو معدل التعلم الأصلي المستخدم للتدريب المسبق مضروبا في هذه القيمة. معدلات التعلم الأكبر تميل إلى الأداء بشكل أفضل مع أحجام الدفعات الأكبر. نوصي بتجربة القيم في النطاق من 0.02 إلى 0.2 لمعرفة ما ينتج أفضل النتائج. No
n_epochs integer عدد العصور التي يجب تدريب النموذج عليها. يشير العصر إلى دورة كاملة واحدة عبر مجموعة بيانات التدريب. No

DpoMethod

طلب ضبط أسلوب DPO

Name Type Description Required Default
dpo DpoMethodConfigRequest تكوين أسلوب dpo الضبط الدقيق. يتضمن معلمات تشعبية محددة ل DPO Yes
type FineTuningMethodType Yes

DpoMethodConfigRequest

تكوين أسلوب dpo الضبط الدقيق. يتضمن معلمات تشعبية محددة ل DPO

Name Type Description Required Default
hyperparameters DpoHyperparamsRequest Hyperparameters لأسلوب DPO للضبط الدقيق No

DpoMethodRequest

طلب ضبط أسلوب DPO

Name Type Description Required Default
dpo DpoMethodConfigRequest تكوين أسلوب dpo الضبط الدقيق. يتضمن معلمات تشعبية محددة ل DPO Yes
type FineTuningMethodType Yes

EndpointKeyConnection

اتصال مفتاح نقطة النهاية.

Name Type Description Required Default
endpoint string Endpoint No
key string Key No
kind ConnectionType نوع الاتصال. Yes

EndpointMIConnection

اتصال الهوية المدارة لنقطة النهاية.

Name Type Description Required Default
endpoint string Endpoint No
kind ConnectionType نوع الاتصال. Yes
resourceId string Resource Id No

Error

محتوى الخطأ كما هو محدد في إرشادات REST Microsoft.

Name Type Description Required Default
code ErrorCode رموز الخطأ كما هو محدد في إرشادات REST Microsoft. Yes
details array تفاصيل الخطأ إذا كانت متوفرة. No
innererror InnerError خطأ داخلي كما هو محدد في إرشادات REST Microsoft. No
message string رسالة هذا الخطأ. Yes
target string الموقع الذي حدث فيه الخطأ إذا كان متوفرا. No

ErrorCode

رموز الخطأ كما هو محدد في إرشادات REST Microsoft.

Property Value
Description رموز الخطأ كما هو محدد في إرشادات REST Microsoft.
Type string
Values conflict
invalidPayload
forbidden
notFound
unexpectedEntityState
itemDoesAlreadyExist
serviceUnavailable
internalFailure
quotaExceeded
jsonlValidationFailed
fileImportFailed
tooManyRequests
unauthorized
contentFilter

ErrorResponse

استجابة الخطأ كما هو محدد في إرشادات REST Microsoft.

Name Type Description Required Default
error Error محتوى الخطأ كما هو محدد في إرشادات REST Microsoft. Yes

Eval

كائن Eval مع تكوين مصدر بيانات ومعايير اختبار. يمثل التقييم مهمة يجب إنجازها من أجل تكامل نموذج اللغة الكبير الخاص بك. Like:

  • حسن جودة روبوتات الدردشة الخاصة بي
  • انظر كيف يتعامل روبوت الدردشة الخاص بي مع دعم العملاء بشكل جيد
  • تحقق مما إذا كان o3-mini أفضل في حالة الاستخدام من gpt-4o
Name Type Description Required Default
created_at integer طابع يونكس الزمني (بالثواني) لوقت إنشاء التقييم. Yes
data_source_config object CustomDataSourceConfig الذي يحدد مخطط المساحات الاسمية الخاصة بك item وإمكانية sample الاختيار في الفضاء. يحدد مخطط الاستجابة شكل البيانات التي ستكون: - تستخدم لتعريف معايير الاختبار الخاصة بك و - ما هي البيانات المطلوبة عند إنشاء تشغيل Yes
└─ metadata Metadata مجموعة من 16 زوجا من مفاتيح-قيم يمكن ربطها بكائن. يمكن أن يكون هذا مفيدا لتخزين معلومات إضافية عن الكائن بصيغة منظمة، وللاستعلام عن الكائنات عبر واجهة برمجة التطبيقات أو لوحة التحكم. المفاتيح هي سلاسل سلاسل بطول أقصى يبلغ 64 حرفا. القيم هي سلاسل سلاسل بطول أقصى يبلغ 512 حرفا. No
└─ schema object مخطط json لعناصر مصدر البيانات التي يتم تشغيلها. تعلم كيف تبني مخططات JSON هنا. No
└─ type enum نوع مصدر البيانات. دائما stored_completions.
القيم المحتملة: stored_completions
No
id string معرف فريد للتقييم. Yes
metadata Metadata مجموعة من 16 زوجا من مفاتيح-قيم يمكن ربطها بكائن. يمكن أن يكون هذا مفيدا لتخزين معلومات إضافية عن الكائن بصيغة منظمة، وللاستعلام عن الكائنات عبر واجهة برمجة التطبيقات أو لوحة التحكم. المفاتيح هي سلاسل سلاسل بطول أقصى يبلغ 64 حرفا. القيم هي سلاسل سلاسل بطول أقصى يبلغ 512 حرفا. Yes
name string اسم التقييم. Yes
object enum نوع الشيء.
القيم المحتملة: eval
Yes
testing_criteria array قائمة بمعايير الاختبار. Yes

EvalApiError

كائن يمثل استجابة خطأ من واجهة برمجة تطبيقات Eval.

Name Type Description Required Default
code string رمز الخطأ. Yes
message string رسالة الخطأ. Yes

EvalCustomDataSourceConfig

CustomDataSourceConfig الذي يحدد مخطط المساحات الاسمية الخاصة بك item وإمكانية sample الاختيار في الفضاء. يحدد مخطط الاستجابة شكل البيانات التي ستكون: - تستخدم لتعريف معايير الاختبار الخاصة بك و - ما هي البيانات المطلوبة عند إنشاء تشغيل

Name Type Description Required Default
schema object مخطط json لعناصر مصدر البيانات التي يتم تشغيلها. تعلم كيف تبني مخططات JSON هنا. Yes
type enum نوع مصدر البيانات. دائما custom.
القيم المحتملة: custom
Yes

EvalFileRunDataSource

تكوين FileRunDataSource مع معرف ملف

Name Type Description Required Default
file_id string معرف الملف. Yes
type enum نوع مصدر البيانات. دائما file.
القيم المحتملة: file
Yes

EvalItem

رسالة مدخلة للنموذج مع دور يشير إلى التعليمات التي تتبع التسلسل الهرمي. التعليمات المعطاة مع developer دور أو system لها الأولوية على التعليمات المعطاة مع الدور user . يفترض أن الرسائل التي تحمل هذا assistant الدور قد تم توليدها بواسطة النموذج في تفاعلات سابقة.

Name Type Description Required Default
content object إدخال نصي إلى النموذج. Yes
└─ text string النص الناتج من النموذج. No
└─ type enum نوع النص المخرج. دائما output_text.
القيم المحتملة: output_text
No
role enum دور إدخال الرسالة. واحد من user، assistant، system، أو developer.
القيم الممكنة: user, assistant, system, developer
Yes
type enum نوع إدخال الرسالة. دائما message.
القيم المحتملة: message
No

EvalJsonlFileContentSource

Name Type Description Required Default
content array محتوى ملف jsonl. Yes
type enum نوع مصدر jsonl. دائما file_content.
القيم المحتملة: file_content
Yes

EvalJsonlFileIdSource

Name Type Description Required Default
id string معرف الملف. Yes
type enum نوع مصدر jsonl. دائما file_id.
القيم المحتملة: file_id
Yes

EvalLabelModelGrader

كائن LabelModelGrader يستخدم نموذجا لتعيين التسميات لكل عنصر في التقييم.

Name Type Description Required Default
input array Yes
labels array التسميات التي يجب تعيينها لكل عنصر في التقييم. Yes
model string النموذج المستخدم في التقييم. يجب دعم المخرجات المنظمة. Yes
name string اسم المصحح. Yes
passing_labels array الملصقات التي تشير إلى نتيجة عابرة. يجب أن يكون هذا فرعا من التسميات. Yes
type enum نوع الكائن، والذي يكون دائما label_model.
القيم المحتملة: label_model
Yes

EvalList

كائن يمثل قائمة من التقييمات.

Name Type Description Required Default
data array مجموعة من الأشياء التقييمية. Yes
first_id string معرف التقييم الأول في مصفوفة البيانات. Yes
has_more boolean يشير إلى ما إذا كان هناك المزيد من التقييمات المتاحة. Yes
last_id string معرف آخر تقييم في مصفوفة البيانات. Yes
object enum نوع هذا الجسم. يتم تعيينه دائما إلى "قائمة".
القيم المحتملة: list
Yes

EvalRun

مخطط يمثل عملية تقييم.

Name Type Description Required Default
created_at integer طابع زمني يونكس (بالثواني) عند إنشاء عملية التقييم. Yes
data_source object كائن JsonlRunDataSource يحتوي على هذا يحدد ملف JSONL يطابق التقييم Yes
└─ input_messages object No
└─ item_reference string مرجع إلى متغير في مساحة الاسم "العنصر"، على سبيل المثال، "item.name". No
└─ template array قائمة برسائل الدردشة التي تشكل الموضوع أو السياق. قد يتضمن مراجع متغيرة لمساحة الاسم "العنصر"، على سبيل المثال، {{item.name}}. No
└─ type enum نوع رسائل الإدخال. إما template أو item_reference.
القيم الممكنة: template، item_reference
No
└─ model string اسم النموذج الذي يجب استخدامه لإنشاء الإكمال (على سبيل المثال، 'o3-mini'). No
└─ sampling_params object No
└─ max_completion_tokens integer الحد الأقصى لعدد الرموز في الناتج المولد. No
└─ seed integer قيمة أولية لتهيئة العشوائية، أثناء أخذ العينات. No 42
└─ temperature number درجة الحرارة الأعلى تزيد من عشوائية المخرجات. No 1
└─ top_p number بديل لدرجة الحرارة في أخذ عينات النواة؛ يشمل 1.0 جميع الرموز. No 1
└─ source object No
└─ type enum نوع المصدر. يمكن أن يكون واحدا من EvalJsonlFileContentSourceأو EvalJsonlFileIdSourceأو EvalStoredCompletionsSource.
القيم الممكنة: EvalJsonlFileContentSource, EvalJsonlFileIdSource, EvalStoredCompletionsSource
No
└─ type enum نوع مصدر البيانات الذي يتم تشغيله. دائما completions.
القيم المحتملة: completions
No
error EvalApiError كائن يمثل استجابة خطأ من واجهة برمجة تطبيقات Eval. Yes
eval_id string معرف التقييم المرتبط. Yes
id string معرف فريد لجولة التقييم. Yes
metadata Metadata مجموعة من 16 زوجا من مفاتيح-قيم يمكن ربطها بكائن. يمكن أن يكون هذا مفيدا لتخزين معلومات إضافية عن الكائن بصيغة منظمة، وللاستعلام عن الكائنات عبر واجهة برمجة التطبيقات أو لوحة التحكم. المفاتيح هي سلاسل سلاسل بطول أقصى يبلغ 64 حرفا. القيم هي سلاسل سلاسل بطول أقصى يبلغ 512 حرفا. Yes
model string النموذج الذي يتم تقييمه، إذا كان ذلك ممكنا. Yes
name string اسم جولة التقييم. Yes
object enum نوع الجسم. Always "eval.run".
القيم المحتملة: eval.run
Yes
per_model_usage array إحصائيات الاستخدام لكل نموذج أثناء عملية التقييم. Yes
per_testing_criteria_results array النتائج حسب معايير الاختبار المطبقة خلال فترة التقييم. Yes
report_url string رابط تقرير تشغيل التقييم المعروض على لوحة تحكم واجهة المستخدم. Yes
result_counts object عدادات تلخص نتائج تشغيل التقييم. Yes
└─ errored integer عدد عناصر الإخراج التي أدت إلى حدوث خطأ. No
└─ failed integer عدد عناصر الإخراج التي فشلت في اجتياز التقييم. No
└─ passed integer عدد عناصر الإخراج التي اجتازت التقييم. No
└─ total integer إجمالي عدد عناصر الإخراج المنفذة. No
status string حالة فترة التقييم. Yes

EvalRunList

كائن يمثل قائمة من المرات التي تشغل لتقييم.

Name Type Description Required Default
data array مجموعة من كائنات التقييم المستمرة. Yes
first_id string معرف أول تقييم يتم تشغيله في مصفوفة البيانات. Yes
has_more boolean يشير إلى ما إذا كان هناك المزيد من التقييمات المتاحة. Yes
last_id string معرف آخر تقييم يتم تشغيله في مصفوفة البيانات. Yes
object enum نوع هذا الجسم. يتم تعيينه دائما إلى "قائمة".
القيم المحتملة: list
Yes

EvalRunOutputItem

مخطط يمثل عنصر مخرجات يتم تشغيله في التقييم.

Name Type Description Required Default
created_at integer طابع زمني يونكس (بالثواني) عند إنشاء عملية التقييم. Yes
datasource_item object تفاصيل عنصر مصدر بيانات الإدخال. Yes
datasource_item_id integer المعرف الخاص بعنصر مصدر البيانات. Yes
eval_id string معرف مجموعة التقييم. Yes
id string معرف فريد لعنصر مخرجات تشغيل التقييم. Yes
object enum نوع الجسم. Always "eval.run.output_item".
القيم المحتملة: eval.run.output_item
Yes
results array قائمة بالنتائج من تشغيل التقييم. Yes
run_id string معرف التقييم يشغل مرتبطا بهذا العنصر المخرج. Yes
sample object عينة تحتوي على إدخال وإخراج تشغيل التقييم. Yes
└─ error EvalApiError كائن يمثل استجابة خطأ من واجهة برمجة تطبيقات Eval. No
└─ finish_reason string سبب انتهاء إنشاء العينة. No
└─ input array صفيف من رسائل الإدخال. No
└─ max_completion_tokens integer الحد الأقصى لعدد الرموز المميزة المسموح بإكمالها. No
└─ model string النموذج المستخدم لإنشاء العينة. No
└─ output array صفيف من رسائل الإخراج. No
└─ seed integer البذور المستخدمة لإنشاء العينة. No
└─ temperature number درجة حرارة أخذ العينات المستخدمة. No
└─ top_p number القيمة top_p المستخدمة لأخذ العينات. No
└─ usage object تفاصيل استخدام الرمز المميز للعينة. No
└─ cached_tokens integer عدد الرموز المميزة التي تم استردادها من ذاكرة التخزين المؤقت. No
└─ completion_tokens integer عدد رموز الإكمال المميزة التي تم إنشاؤها. No
└─ prompt_tokens integer عدد الرموز المميزة للمطالبة المستخدمة. No
└─ total_tokens integer إجمالي عدد الرموز المستخدمة. No
status string حالة فترة التقييم. Yes

EvalRunOutputItemList

كائن يمثل قائمة بعناصر الإخراج لتشغيل تقييم.

Name Type Description Required Default
data array مصفوفة من كائنات عناصر إخراج التقييم. Yes
first_id string معرف أول عنصر مخرج للتقييم يشغل في مصفوفة البيانات. Yes
has_more boolean يشير إلى ما إذا كان هناك المزيد من عناصر إنتاج التقييم المتاحة. Yes
last_id string معرف آخر عنصر مخرج للتقييم يشغل في مصفوفة البيانات. Yes
object enum نوع هذا الجسم. يتم تعيينه دائما إلى "قائمة".
القيم المحتملة: list
Yes

EvalScoreModelGrader

كائن ScoreModelGrader يستخدم نموذجا لتعيين درجة للمدخل.

Name Type Description Required Default
input array نص الإدخال. قد يشمل ذلك سلاسل القوالب. Yes
model string النموذج المستخدم في التقييم. Yes
name string اسم المصحح. Yes
pass_threshold number الحد الأدنى للنتيجة. No
range array مدى النوتة. تتغير افتراضيا إلى [0, 1]. No
sampling_params object معلمات أخذ العينات للنموذج. No
type enum نوع الكائن، والذي يكون دائما score_model.
القيم المحتملة: score_model
Yes

EvalStoredCompletionsDataSourceConfig

StoredCompletionsDataSourceConfig الذي يحدد خاصية بيانات التعريف لاستعلام الإكمال المخزن. عادة ما تكون هذه البيانات الوصفية مثل usecase=chatbot أو prompt-version=v2، إلخ. المخطط الذي يعيده هذا التكوين يستخدم لتعريف المتغيرات المتاحة في التقييمات الخاصة بك. item وكلاهما sample معرف عند استخدام تكوين مصدر البيانات هذا.

Name Type Description Required Default
metadata Metadata مجموعة من 16 زوجا من مفاتيح-قيم يمكن ربطها بكائن. يمكن أن يكون هذا مفيدا لتخزين معلومات إضافية عن الكائن بصيغة منظمة، وللاستعلام عن الكائنات عبر واجهة برمجة التطبيقات أو لوحة التحكم. المفاتيح هي سلاسل سلاسل بطول أقصى يبلغ 64 حرفا. القيم هي سلاسل سلاسل بطول أقصى يبلغ 512 حرفا. No
schema object مخطط json لعناصر مصدر البيانات التي يتم تشغيلها. تعلم كيف تبني مخططات JSON هنا. Yes
type enum نوع مصدر البيانات. دائما stored_completions.
القيم المحتملة: stored_completions
Yes

EvalStoredCompletionsSource

تكوين StoredCompletionsRunDataSource يصف مجموعة من الفلاتر

Name Type Description Required Default
created_after integer طابع زمني Unix اختياري لتصفية العناصر التي تم إنشاؤها بعد هذا الوقت. No
created_before integer طابع زمني Unix اختياري لتصفية العناصر التي تم إنشاؤها قبل هذا الوقت. No
limit integer الحد الأقصى الاختياري لعدد العناصر التي سيتم إرجاعها. No
metadata Metadata مجموعة من 16 زوجا من مفاتيح-قيم يمكن ربطها بكائن. يمكن أن يكون هذا مفيدا لتخزين معلومات إضافية عن الكائن بصيغة منظمة، وللاستعلام عن الكائنات عبر واجهة برمجة التطبيقات أو لوحة التحكم. المفاتيح هي سلاسل سلاسل بطول أقصى يبلغ 64 حرفا. القيم هي سلاسل سلاسل بطول أقصى يبلغ 512 حرفا. No
model string نموذج اختياري للتصفية حسب (على سبيل المثال، 'gpt-4o'). No
type enum نوع المصدر. دائما stored_completions.
القيم المحتملة: stored_completions
Yes

EvalStringCheckGrader

كائن StringCheckGrader يقوم بمقارنة سلاسل نصية بين الإدخال والمرجع باستخدام عملية محددة.

Name Type Description Required Default
input string نص الإدخال. قد يشمل ذلك سلاسل القوالب. Yes
name string اسم المصحح. Yes
operation enum عملية التحقق من السلسلة التي يجب تنفيذها. واحد من eq، ne، like، أو ilike.
القيم الممكنة: eq, ne, like, ilike
Yes
reference string النص المرجعي. قد يشمل ذلك سلاسل القوالب. Yes
type enum نوع الكائن، والذي يكون دائما string_check.
القيم المحتملة: string_check
Yes

EvalTextSimilarityGrader

كائن TextSimilarityGrader يقوم بتقييم النص بناء على مقاييس التشابه.

Name Type Description Required Default
evaluation_metric enum مقياس التقييم الذي يجب استخدامه. واحد من fuzzy_matchأو bleuأو gleuأو meteorأو rouge_1أو rouge_2أو rouge_3rouge_4rouge_5rouge_l.
القيم المحتملة: fuzzy_match، bleu، gleu، meteor، rouge_1، rouge_2، rouge_3، ، rouge_4، ، rouge_5rouge_l
Yes
input string النص الذي يتم تقييمه. Yes
name string اسم المصحح. No
pass_threshold number تشير درجة العائمة حيث تشير القيمة الأكبر من أو يساوي إلى درجة النجاح. Yes
reference string النص الذي تم تقييمه ضده. Yes
type enum نوع المصحح.
القيم المحتملة: text_similarity
Yes

EventType

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

Property Value
Description يحدد خطورة نتيجة عامل تصفية المحتوى.
Type string
Values message
metrics

File

الملف هو مستند قابل للاستخدام للتدريب والتحقق من الصحة. يمكن أن يكون أيضا مستند خدمة تم إنشاؤه مع تفاصيل النتائج.

Name Type Description Required Default
bytes integer حجم هذا الملف عند توفره (يمكن أن يكون فارغا). لا يتم دعم أحجام الملفات الأكبر من 2^53-1 لضمان التوافق مع أعداد JavaScript الصحيحة. No
created_at integer طابع زمني عند إنشاء هذه الوظيفة أو العنصر (في فترات unix). No
expires_at integer طابع زمني Unix (عدد الثوان التي انقضت منذ 1 يناير 1970) عند انتهاء صلاحية الملف. No
filename string اسم الملف. Yes
id string هوية هذا العنصر. No
object TypeDiscriminator تعريف نوع الكائن. No
purpose Purpose الغرض المقصود من المستندات التي تم تحميلها. استخدم "ضبط" للضبط الدقيق. يسمح لنا هذا بالتحقق من صحة تنسيق الملف الذي تم تحميله. Yes
status FileState حالة الملف. No
status_details string رسالة الخطأ مع تفاصيل في حالة فشل معالجة هذا الملف. Deprecated. No

FileCreate

تعريف مستند للاستيراد من عنوان URL للمحتوى الخارجي ليكون قابلا للاستخدام مع Azure OpenAI.

Name Type Description Required Default
content_url string عنوان url لتنزيل المستند من (يمكن أن يكون عنوان URL SAS للكائن الثنائي كبير الحجم أو أي عنوان URL خارجي آخر يمكن الوصول إليه باستخدام طلب GET). Yes
purpose Purpose الغرض المقصود من المستندات التي تم تحميلها. استخدم "ضبط" للضبط الدقيق. يسمح لنا هذا بالتحقق من صحة تنسيق الملف الذي تم تحميله. Yes

FileDelete

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

Name Type Description Required Default
deleted boolean قيمة تشير إلى ما إذا كان الملف قد تم حذفه أم لا. Yes
id string معرف الملف الذي تم حذفه. Yes
object string إذا تم حذف الملف. Yes

FileDetails

تفاصيل الملف هي مستند تستخدمه خدمة الدفعات لجلب تفاصيل كائن ثنائي كبير الحجم للملف.

Name Type Description Required Default
filename string اسم الملف. Yes
id string هوية هذا العنصر. No
path string المسار النسبي إلى الملف داخل الحاوية. No
purpose Purpose الغرض المقصود من المستندات التي تم تحميلها. استخدم "ضبط" للضبط الدقيق. يسمح لنا هذا بالتحقق من صحة تنسيق الملف الذي تم تحميله. Yes
storage_account_uri string عنوان URL لحساب التخزين لهذا الملف. No
storage_container_name string اسم حاوية التخزين للكائن الثنائي كبير الحجم للملف هذا. No

FileExpiresAfter

تعريف انتهاء صلاحية الملف.

Name Type Description Required Default
anchor FileExpiryAnchor يحدد نقطة الارتساء بالنسبة إلى الوقت الذي يجب إنشاء انتهاء الصلاحية المطلق منه. No
seconds integer وقت انتهاء الصلاحية النسبي بالثوان. النطاق: [1209600 - 2592000]. No

FileExpiryAnchor

يحدد نقطة الارتساء بالنسبة إلى الوقت الذي يجب إنشاء انتهاء الصلاحية المطلق منه.

Property Value
Description يحدد نقطة الارتساء بالنسبة إلى الوقت الذي يجب إنشاء انتهاء الصلاحية المطلق منه.
Type string
Values created_at

FileImport

تعريف مستند للاستيراد من عنوان URL للمحتوى الخارجي ليكون قابلا للاستخدام مع Azure OpenAI.

Name Type Description Required Default
content_url string عنوان url لتنزيل المستند من (يمكن أن يكون عنوان URL SAS للكائن الثنائي كبير الحجم أو أي عنوان URL خارجي آخر يمكن الوصول إليه باستخدام طلب GET). Yes
expires_after FileExpiresAfter تعريف انتهاء صلاحية الملف. No
filename string اسم ملف خطوط JSON المطلوب تحميله. purpose إذا تم تعيين إلى "ضبط"، فإن كل سطر هو سجل JSON مع حقول "المطالبة" و"الإكمال" التي تمثل أمثلة التدريب الخاصة بك. Yes
purpose Purpose الغرض المقصود من المستندات التي تم تحميلها. استخدم "ضبط" للضبط الدقيق. يسمح لنا هذا بالتحقق من صحة تنسيق الملف الذي تم تحميله. Yes

FileList

يمثل قائمة بالملفات.

Name Type Description Required Default
data array قائمة العناصر. No
object TypeDiscriminator تعريف نوع الكائن. No

FileState

حالة الملف.

Property Value
Description حالة الملف.
Type string
Values uploaded
pending
running
processed
error
deleting
deleted

FineTuneMethod

تمييزي ل FineTuneMethod

يستخدم هذا المكون الخاصية type للتمييز بين الأنواع المختلفة:

Type Value Schema
Name Type Description Required Default
type FineTuningMethodType Yes

FineTuneMethodRequest

تمييز ل FineTuneMethodRequest

يستخدم هذا المكون الخاصية type للتمييز بين الأنواع المختلفة:

Type Value Schema
Name Type Description Required Default
type FineTuningMethodType Yes

FineTuningHyperParameters

إعدادات المعلمة التشعبية المستخدمة في مهمة ضبط دقيقة.

Name Type Description Required Default
batch_size integer حجم الدفعة المستخدم في التدريب. حجم الدفعة هو عدد أمثلة التدريب المستخدمة لتدريب تمريرة واحدة للأمام والخلف. بشكل عام، وجدنا أن أحجام الدفعات الأكبر تميل إلى العمل بشكل أفضل لمجموعات البيانات الأكبر حجما. القيمة الافتراضية بالإضافة إلى القيمة القصوى لهذه الخاصية خاصة بنموذج أساسي. No
learning_rate_multiplier number مضاعف معدل التعلم الذي يجب استخدامه في التدريب. معدل التعلم الدقيق هو معدل التعلم الأصلي المستخدم للتدريب المسبق مضروبا في هذه القيمة. معدلات التعلم الأكبر تميل إلى الأداء بشكل أفضل مع أحجام الدفعات الأكبر. نوصي بتجربة القيم في النطاق من 0.02 إلى 0.2 لمعرفة ما ينتج أفضل النتائج. No
n_epochs integer عدد العصور التي يجب تدريب النموذج عليها. يشير العصر إلى دورة كاملة واحدة عبر مجموعة بيانات التدريب. No

FineTuningJob

يحدد قيم مهمة ضبط دقيقة.

Name Type Description Required Default
created_at integer طابع زمني عند إنشاء هذه الوظيفة أو العنصر (في فترات unix). No
error FineTuningJobError بالنسبة إلى مهام ضبط الضبط التي فشلت، سيحتوي هذا على مزيد من المعلومات حول سبب الفشل. No
estimated_finish integer الطابع الزمني Unix (بالثوان) عند تقدير انتهاء مهمة الضبط الدقيقة. ستكون القيمة فارغة إذا لم تكن مهمة الضبط قيد التشغيل. No
fine_tuned_model string معرف (معرف النموذج) للنموذج المضبط الدقيق الناتج. يتم ملء هذه الخاصية فقط لتشغيلات الضبط الدقيق المكتملة بنجاح. استخدم هذا المعرف لإنشاء نشر للاستدلال. No
finished_at integer طابع زمني عند انتهاء هذه المهمة أو العنصر بنجاح (في فترات unix). No
hyperparameters FineTuningHyperParameters إعدادات المعلمة التشعبية المستخدمة في مهمة ضبط دقيقة. No
id string هوية هذا العنصر. No
integrations array قائمة بالتكوينات للتكاملات التي تدعم مهمة الضبط الدقيق. هناك العديد من عمليات التكامل المخطط لها، لذا تأكد من التحقق من نوع التكامل والعمل عليه. No
method object الطريقة المستخدمة للضبط الدقيق الخاضع للإشراف No
└─ type FineTuningMethodType No
model string معرف (معرف النموذج) للنموذج الأساسي المستخدم لضبط. Yes
object TypeDiscriminator تعريف نوع الكائن. No
organisation_id string معرف المؤسسة لمهمة الضبط الدقيقة هذه. غير مستخدم على Azure OpenAI؛ التوافق مع OpenAI فقط. No
result_files array هويات ملف النتيجة (معرف الملف) التي تحتوي على مقاييس التدريب والتقييم بتنسيق csv. يتوفر الملف فقط لتشغيلات الضبط الدقيقة المكتملة بنجاح. No
seed integer البذرة المستخدمة في عملية الضبط الدقيقة. No
status FineTuningState حالة عنصر ضبط أو مهمة ضبط دقيقة. No
suffix string اللاحقة المستخدمة لتحديد النموذج الدقيق. يمكن أن تحتوي اللاحقة على ما يصل إلى 40 حرفا (a-z وA-Z و0-9 و_) ستتم إضافتها إلى اسم النموذج المضبط. No
trained_tokens integer إجمالي عدد الرموز المميزة القابلة للفوترة التي تمت معالجتها بواسطة مهمة الضبط الدقيقة هذه. No
training_file string الملف المستخدم للتدريب. Yes
validation_file string الملف المستخدم لتقييم النموذج المضبط بدقة أثناء التدريب. No

FineTuningJobCheckpoint

Name Type Description Required Default
created_at integer الطابع الزمني ليونكس (بالثواني) لوقت إنشاء نقطة التحقق. Yes
fine_tuned_model_checkpoint string اسم نموذج نقاط التحقق المضبوط بدقة الذي يتم إنشاؤه. Yes
fine_tuning_job_id string اسم مهمة الضبط الدقيق التي تم إنشاء نقطة الحفظ من خلالها. Yes
id string هوية نقطة التحقق هذه. No
metrics object المقاييس في رقم الخطوة أثناء مهمة الضبط الدقيقة. Yes
object TypeDiscriminator تعريف نوع الكائن. No
step_number integer رقم الخطوة الذي تم إنشاء نقطة التفتيش. Yes

FineTuningJobCheckpointList

يمثل قائمة نقاط التحقق.

Name Type Description Required Default
data array قائمة العناصر. No
has_more boolean قيمة تشير إلى ما إذا كانت القائمة تحتوي على عناصر أكثر مما تم إرجاعه. No
object TypeDiscriminator تعريف نوع الكائن. No

FineTuningJobCreation

يحدد قيم مهمة ضبط دقيقة.

Name Type Description Required Default
hyperparameters FineTuningHyperParameters إعدادات المعلمة التشعبية المستخدمة في مهمة ضبط دقيقة. No
integrations array قائمة بالتكوينات للتكاملات التي تدعم مهمة الضبط الدقيق. هناك العديد من عمليات التكامل المخطط لها، لذا تأكد من التحقق من نوع التكامل والعمل عليه. No
method object الطريقة المستخدمة للضبط الدقيق الخاضع للإشراف No
└─ type FineTuningMethodType No
model string معرف (معرف النموذج) للنموذج الأساسي المستخدم لهذا الضبط. Yes
seed integer البذرة المستخدمة في عملية الضبط الدقيقة. تمرير نفس البذرة ومعايير الوظيفة يجب أن ينتج نفس النتائج، لكنه قد يختلف في حالات نادرة. إذا لم يتم تحديد البذور، فسيتم إنشاء واحد لك. No
suffix string اللاحقة المستخدمة لتحديد النموذج الدقيق. يمكن أن تحتوي اللاحقة على ما يصل إلى 40 حرفا (a-z وA-Z و0-9 و_) ستتم إضافتها إلى اسم النموذج المضبط. No
training_file string هوية الملف (معرف الملف) المستخدمة لتدريب هذا النموذج المضبط بدقة. Yes
validation_file string هوية الملف (معرف الملف) المستخدمة لتقييم النموذج المضبط بدقة أثناء التدريب. No

FineTuningJobError

بالنسبة إلى مهام ضبط الضبط التي فشلت، سيحتوي هذا على مزيد من المعلومات حول سبب الفشل.

Name Type Description Required Default
code string رمز الخطأ القابل للقراءة آليا. No
message string رسالة الخطأ التي يمكن للبشر قراءتها. No
param string المعلمة غير الصالحة، عادة ما training_file أو validation_file. سيكون هذا الحقل فارغا إذا لم يكن الفشل خاصا بالمعلمات. No

FineTuningJobEvent

Name Type Description Required Default
created_at integer طابع زمني عند إنشاء هذا الحدث (في فترات unix). Yes
data بيانات قابلة للقراءة آليا لهذا الحدث. No
id string هوية هذا الحدث. No
level LogLevel مستوى الإسهاب للحدث. Yes
message string الرسالة التي تصف الحدث. يمكن أن يكون هذا تغييرا في الحالة، على سبيل المثال، مدرجا في قائمة الانتظار أو بدأ أو فشل أو مكتمل أو أحداثا أخرى مثل النتائج التي تم تحميلها. Yes
object TypeDiscriminator تعريف نوع الكائن. No
type EventType يحدد خطورة نتيجة عامل تصفية المحتوى. Yes

FineTuningJobEventList

يمثل قائمة بالأحداث.

Name Type Description Required Default
data array قائمة العناصر. No
has_more boolean قيمة تشير إلى ما إذا كانت القائمة تحتوي على عناصر أكثر مما تم إرجاعه. No
object TypeDiscriminator تعريف نوع الكائن. No

FineTuningJobList

يمثل قائمة من نغمات غرامة.

Name Type Description Required Default
data array قائمة العناصر. No
has_more boolean قيمة تشير إلى ما إذا كانت القائمة تحتوي على عناصر أكثر مما تم إرجاعه. No
object TypeDiscriminator تعريف نوع الكائن. No

FineTuningMethodType

Property Value
Type string
Values dpo
supervised

FineTuningState

حالة عنصر ضبط أو مهمة ضبط دقيقة.

Property Value
Description حالة عنصر ضبط أو مهمة ضبط دقيقة.
Type string
Values created
pending
running
pausing
paused
resuming
succeeded
cancelled
failed

FunctionCallFunction

Name Type Description Required Default
arguments string الوسيطات التي يتوقع منك النموذج تمريرها إلى الدالة . No
name string اسم الوظيفة. No

FunctionDefinition

Name Type Description Required Default
description string وصف لما تفعله الدالة، يستخدمه النموذج لاختيار متى وكيفية استدعاء الدالة. No
name string اسم الدالة التي سيتم استدعاؤها. No
parameters المعلمات التي تقبلها الدوال، وصفت ككائن مخطط JSON. No

GenericEmbeddingSettings

إعدادات تضمين الاتصال

Name Type Description Required Default
connection BaseConnection اتصال بمورد. No
deploymentName string No
modelName string No

IngestionError

تفاصيل خطأ الاستيعاب

Name Type Description Required Default
innerErrors array No
message string No

IngestionJob

يمثل تفاصيل الوظيفة.

تمييزي ل IngestionJob

يستخدم هذا المكون الخاصية kind للتمييز بين الأنواع المختلفة:

Type Value Schema
Name Type Description Required Default
jobId string No
kind IngestionJobType نوع المهمة. Yes

IngestionJobList

يمثل قائمة بوظائف الاستيعاب.

Name Type Description Required Default
nextLink string الارتباط إلى الصفحة التالية. No
value array قائمة العناصر. No

IngestionJobProgress

Name Type Description Required Default
stageProgress array Yes

IngestionJobRun

تفاصيل تشغيل الوظيفة

Name Type Description Required Default
error IngestionError تفاصيل خطأ الاستيعاب No
jobId string No
progress IngestionJobProgress No
runId string No
status OperationState حالة الوظيفة أو العنصر. No
warnings array No

IngestionJobRunList

يمثل قائمة بتشغيل مهمة الاستيعاب.

Name Type Description Required Default
nextLink string الارتباط إلى الصفحة التالية. No
value array قائمة العناصر. No

IngestionJobStageProgress

Name Type Description Required Default
name string No
processedItems integer No
state OperationState حالة الوظيفة أو العنصر. No
subStageProgress array No
totalItems integer No

IngestionJobSystemCompute

Name Type Description Required Default
completionAction CompletionAction إجراء الإكمال. No
dataRefreshIntervalInHours integer No
datasource SystemComputeDatasource No
jobId string No
kind IngestionJobType نوع المهمة. Yes
searchServiceConnection BaseConnection اتصال بمورد. No

IngestionJobType

نوع المهمة.

Property Value
Description نوع المهمة.
Type string
Values SystemCompute
UserCompute

IngestionJobUserCompute

Name Type Description Required Default
compute JobCompute إعدادات الحساب للوظيفة. No
dataRefreshIntervalInHours integer No
datasource UserComputeDatasource No
jobId string No
kind IngestionJobType نوع المهمة. Yes
target TargetIndex معلومات حول الفهرس الذي سيتم إنشاؤه. No
workspaceId string No

InnerError

خطأ داخلي كما هو محدد في إرشادات REST Microsoft.

Name Type Description Required Default
code InnerErrorCode رموز الخطأ الداخلية كما هو محدد في إرشادات REST Microsoft. No
innererror InnerError خطأ داخلي كما هو محدد في إرشادات REST Microsoft. No

InnerErrorCode

رموز الخطأ الداخلية كما هو محدد في إرشادات REST Microsoft.

Property Value
Description رموز الخطأ الداخلية كما هو محدد في إرشادات REST Microsoft.
Type string
Values invalidPayload

InputMessage

Name Type Description Required Default
content string محتويات الرسالة. No
id string هوية الرسالة. No
name string اسم اختياري للمشارك. يوفر معلومات النموذج للتمييز بين المشاركين في نفس الدور. No
role string دور الكيان الذي ينشئ الرسالة. No

InputTextContent

إدخال نصي إلى النموذج.

Name Type Description Required Default
text string إدخال النص إلى النموذج. Yes
type enum نوع عنصر الإدخال. دائما input_text.
القيم المحتملة: input_text
Yes

IntegrationTypes

قائمة بالتكاملات الدقيقة المتوفرة.

Property Value
Description قائمة بالتكاملات الدقيقة المتوفرة.
Type string
Values wandb

JobCompute

إعدادات الحساب للوظيفة.

تمييزي لحساب الوظيفة

يستخدم هذا المكون الخاصية kind للتمييز بين الأنواع المختلفة:

Type Value Schema
Name Type Description Required Default
kind ComputeType نوع الحساب. Yes

LifeCycleStatus

حالة دورة حياة النموذج.

ملاحظة: يمكن ترقية النموذج من preview إلى generally-available، ولكن ليس من generally-available إلى preview.

Property Value
Description حالة دورة حياة النموذج. ملاحظة: يمكن ترقية النموذج من preview إلى generally-available، ولكن ليس من generally-available إلى preview.
Type string
Values preview
generally-available
deprecating
deprecated

LogLevel

مستوى الإسهاب للحدث.

Property Value
Description مستوى الإسهاب للحدث.
Type string
Values info
warning
error

Logprob

Name Type Description Required Default
logprob number احتمال السجل لهذا الرمز، إذا كان ضمن أفضل 20 رمزا احتمالا. وإلا، تستخدم القيمة -9999.0 للدلالة على أن الرمز غير محتمل جدا. No
token string The token. No

Metadata

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

لا توجد خصائص معرفة لهذا المكون.

Model

النموذج هو إما نموذج أساسي أو نتيجة مهمة ضبط ناجحة.

Name Type Description Required Default
capabilities Capabilities قدرات نموذج قاعدة أو ضبط دقيق. Yes
created_at integer طابع زمني عند إنشاء هذه الوظيفة أو العنصر (في فترات unix). No
deprecation Deprecation يحدد تواريخ الإهمال لحالات الاستخدام المختلفة للنموذج. عادة ما تدعم النماذج الأساسية سنة واحدة من الضبط الدقيق بعد الإنشاء يتم دعم الاستدلال عادة بعد عامين من إنشاء النماذج الأساسية أو النماذج الدقيقة المضبطة. يتم تحديد التواريخ الدقيقة في الخصائص. Yes
fine_tune string ضبط هوية الوظيفة (معرف ضبط دقيق) إذا كان هذا نموذج ضبط دقيق؛ خلاف ذلك null. No
id string هوية هذا العنصر. No
lifecycle_status LifeCycleStatus حالة دورة حياة النموذج. ملاحظة: يمكن ترقية النموذج من "معاينة" إلى generally-available، ولكن ليس من generally-available إلى "معاينة". Yes
model string هوية النموذج الأساسي (معرف النموذج) إذا كان هذا نموذج ضبط دقيق؛ خلاف ذلك null. No
object TypeDiscriminator تعريف نوع الكائن. No
status FineTuningState حالة عنصر ضبط أو مهمة ضبط دقيقة. No

ModelList

يمثل قائمة بالنماذج.

Name Type Description Required Default
data array قائمة العناصر. No
object TypeDiscriminator تعريف نوع الكائن. No

OperationState

حالة الوظيفة أو العنصر.

Property Value
Description حالة الوظيفة أو العنصر.
Type string
Values notRunning
running
succeeded
failed

Order

تعريف الغرض من ملف.

Property Value
Description تعريف الغرض من ملف.
Type string
Values desc
asc

OrderByOrder

Property Value
Type string
Values asc
desc

PineconeIndex

Pinecone Index.

Name Type Description Required Default
connectionId string معرف الاتصال الذي يشير إلى pinecone. No
kind TargetType نوع الهدف. Yes

Purpose

الغرض المقصود من المستندات التي تم تحميلها. استخدم "ضبط" للضبط الدقيق. يسمح لنا هذا بالتحقق من صحة تنسيق الملف الذي تم تحميله.

Property Value
Description الغرض المقصود من المستندات التي تم تحميلها. استخدم "ضبط" للضبط الدقيق. يسمح لنا هذا بالتحقق من صحة تنسيق الملف الذي تم تحميله.
Type string
Values fine-tune
fine-tune-results
assistants
assistants_output
batch
batch_output
evals
evals_output

ServerlessCompute

Serverless compute.

Name Type Description Required Default
instanceCount integer عدد المثيلات لتشغيل المهمة عليها. No
kind ComputeType نوع الحساب. Yes
sku string SKU Level No

StoredCompletion

Name Type Description Required Default
choices array قائمة بخيارات إكمال الدردشة. يمكن أن يكون أكثر من واحد إذا كان n أكبر من 1. No
created integer الطابع الزمني Unix (بالثوان) عند إنشاء إكمال الدردشة. No
frequency_penalty number الرقم بين -2.0 و2.0. القيم الإيجابية تعاقب الرموز الجديدة بناء على تكرارها الحالي في النص حتى الآن، مما يقلل من احتمالية تكرار النموذج لنفس السطر حرفيا. No
id string هوية الإكمال المخزن. No
input_user string مستخدم الإدخال لهذا الطلب. No
metadata object أزواج قيم المفاتيح العشوائية للحصول على معلومات إضافية. No
model string معرف النموذج الذي ستستخدمه. No
presence_penalty number الرقم بين -2.0 و2.0. القيم الإيجابية تعاقب الرموز الجديدة بناء على ظهورها في النص حتى الآن، مما يزيد من احتمال النموذج للحديث عن مواضيع جديدة. No
request_id string معرف فريد لطلب OpenAI API. الرجاء تضمين معرف الطلب هذا عند الاتصال بالدعم. No
seed integer إذا تم تحديده، سيبذل نظامنا أقصى جهد لأخذ عينات حتمية، بحيث يجب أن تعطي الطلبات المتكررة بنفس seed المعلمات نفس النتيجة. الحتمية غير مضمونة، ويجب عليك الرجوع إلى
system_fingerprint معلمة الاستجابة لمراقبة التغييرات في الخلفية. No
service_tier string تحديد طبقة زمن الانتقال لاستخدامها لمعالجة الطلب. No
system_fingerprint string تمثل بصمة الإصبع هذه تكوين الخلفية التي يعمل بها النموذج. يمكن استخدامها بالاقتران مع معلمة seed الطلب لفهم متى تم إجراء تغييرات الخلفية التي قد تؤثر على الحتمية. No
temperature number ما هي درجة حرارة العينة التي يجب استخدامها، بين 0 و2. القيم الأعلى مثل 0.8 ستجعل الناتج أكثر عشوائية، بينما القيم الأقل مثل 0.2 تجعله أكثر تركيزا وحتمية. نوصي عموما بتعديل هذا أو top_p ليس كلاهما. No
tool_choice string يتحكم في أي أداة (إن وجدت) يتم استدعاؤها بواسطة النموذج. No
tools array قائمة بالأدوات التي قد يستدعيها النموذج. حاليا، يتم دعم الوظائف فقط كأداة. استخدم هذا لتوفير قائمة بالوظائف التي قد ينشئ النموذج مدخلات JSON لها. يتم دعم 128 وظيفة كحد أقصى. No
top_p number بديل للعينات باستخدام درجة الحرارة يسمى أخذ العينات من النواة، حيث يأخذ النموذج نتائج الرموز ذات الكتلة الاحتمالية top_p. لذا فإن 0.1 يعني أن الرموز المميزة التي تتألف من أعلى 10% كتلة احتمالية فقط هي التي تعتبر. نوصي عموما بتعديل هذا أو temperature ليس كلاهما. No
usage Usage No

StoredCompletionDelete

Name Type Description Required Default
deleted boolean قيمة تشير إلى ما إذا كان قد تم حذف الإكمال المخزن أم لا. No
id string معرف الإكمال المخزن الذي تم حذفه. No
object string إذا تم حذف الإكمال المخزن. Yes

StoredCompletionList

Name Type Description Required Default
data array قائمة الكائنات التي تم استردادها. No
first_id string المعرف الأول في المسترد list No
has_more boolean has_more يتم استخدام الخاصية لفصل الصفحات للإشارة إلى وجود نتائج إضافية. No
last_id string المعرف الأخير في المسترد list No
object string نوع الكائن، وهو دائما list No
total integer إجمالي عدد العناصر. No

StoredCompletionMessages

Name Type Description Required Default
data array قائمة الكائنات التي تم استردادها. No
first_id string المعرف الأول في المسترد list No
has_more boolean has_more يتم استخدام الخاصية لفصل الصفحات للإشارة إلى وجود نتائج إضافية. No
last_id string المعرف الأخير في المسترد list No
object string نوع الكائن، وهو دائما list No
total integer إجمالي عدد العناصر. No

StoredCompletionResponse

Name Type Description Required Default
choices array قائمة بخيارات إكمال الدردشة. يمكن أن يكون أكثر من واحد إذا كان n أكبر من 1. No
created integer الطابع الزمني Unix (بالثوان) عند إنشاء إكمال الدردشة. No
frequency_penalty number الرقم بين -2.0 و2.0. القيم الإيجابية تعاقب الرموز الجديدة بناء على تكرارها الحالي في النص حتى الآن، مما يقلل من احتمالية تكرار النموذج لنفس السطر حرفيا. No
id string هوية الإكمال المخزن. No
input_user string مستخدم الإدخال لهذا الطلب. No
metadata object أزواج قيم المفاتيح العشوائية للحصول على معلومات إضافية. No
model string معرف النموذج الذي ستستخدمه. No
object string نوع هذا الجسم. No
presence_penalty number الرقم بين -2.0 و2.0. القيم الإيجابية تعاقب الرموز الجديدة بناء على ظهورها في النص حتى الآن، مما يزيد من احتمال النموذج للحديث عن مواضيع جديدة. No
request_id string معرف فريد لطلب OpenAI API. الرجاء تضمين معرف الطلب هذا عند الاتصال بالدعم. No
seed integer إذا تم تحديده، فسيبذل نظامنا أفضل جهد للعينة بشكل محدد، بحيث أن الطلبات المتكررة بنفسها seedوالمعلمات يجب أن ترجع نفس النتيجة. الحتمية غير مضمونة، ويجب عليك الرجوع إلى معلمة الاستجابة system_fingerprint لمراقبة التغييرات في الخلفية. No
service_tier string تحديد طبقة زمن الانتقال لاستخدامها لمعالجة الطلب. No
system_fingerprint string تمثل بصمة الإصبع هذه تكوين الخلفية التي يعمل بها النموذج. يمكن استخدامها بالاقتران مع معلمة seed الطلب لفهم متى تم إجراء تغييرات الخلفية التي قد تؤثر على الحتمية. No
temperature number ما هي درجة حرارة العينة التي يجب استخدامها، بين 0 و2. القيم الأعلى مثل 0.8 ستجعل الإخراج أكثر عشوائية، بينما القيم الأقل مثل 0.2 ستجعله أكثر تركيزا وحسما. نوصي عموما بتعديل هذا أو top_p ليس كلاهما. No
tool_choice string يتحكم في أي أداة (إن وجدت) يتم استدعاؤها بواسطة النموذج. No
tools array قائمة بالأدوات التي قد يستدعيها النموذج. حاليا، يتم دعم الوظائف فقط كأداة. استخدم هذا لتوفير قائمة بالوظائف التي قد ينشئ النموذج مدخلات JSON لها. يتم دعم 128 وظيفة كحد أقصى. No
top_p number بديل للعينات باستخدام درجة الحرارة يسمى أخذ العينات من النواة، حيث يأخذ النموذج نتائج الرموز ذات الكتلة الاحتمالية top_p. لذا فإن 0.1 يعني أن الرموز المميزة التي تتألف من أعلى 10% كتلة احتمالية فقط هي التي تعتبر. نوصي عموما بتعديل هذا أو temperature ليس كلاهما. No
usage Usage No

SupervisedMethod

الطريقة المستخدمة للضبط الدقيق الخاضع للإشراف

Name Type Description Required Default
type FineTuningMethodType Yes

SupervisedMethodRequest

الطريقة المستخدمة للضبط الدقيق الخاضع للإشراف

Name Type Description Required Default
type FineTuningMethodType Yes

SystemComputeDatasource

تمييز لمصدر SystemComputeDatasource

يستخدم هذا المكون الخاصية kind للتمييز بين الأنواع المختلفة:

Type Value Schema
Name Type Description Required Default
kind SystemComputeDatasourceType نوع مصدر البيانات. Yes

SystemComputeDatasourceType

نوع مصدر البيانات.

Property Value
Description نوع مصدر البيانات.
Type string
Values Storage
Urls

SystemComputeStorage

Storage account

Name Type Description Required Default
chunking ChunkingSettings Chunking settings No
connection BaseConnection اتصال بمورد. No
containerName string container name No
embeddings array No
kind SystemComputeDatasourceType نوع مصدر البيانات. Yes

SystemComputeUrl

Urls

Name Type Description Required Default
chunking ChunkingSettings Chunking settings No
connection BaseConnection اتصال بمورد. No
containerName string container name No
crawling CrawlingSettings Crawling settings No
embeddings array No
kind SystemComputeDatasourceType نوع مصدر البيانات. Yes
urls array No

TargetIndex

معلومات حول الفهرس الذي سيتم إنشاؤه.

تمييزي ل TargetIndex

يستخدم هذا المكون الخاصية kind للتمييز بين الأنواع المختلفة:

Type Value Schema
Name Type Description Required Default
kind TargetType نوع الهدف. Yes

TargetType

نوع الهدف.

Property Value
Description نوع الهدف.
Type string
Values AzureAISearch
CosmosDB
Pinecone

Tool

Name Type Description Required Default
function FunctionDefinition No
type string نوع استدعاء الأدوات. هذا دائما function سيكون لهذا النوع من استدعاء الأدوات. No

ToolCall

Name Type Description Required Default
function FunctionCallFunction No
id string معرف نداء الأداة. No
type string نوع استدعاء الأداة الذي يطلب من أجله الإخراج. في الوقت الحالي، هذا هو الحال دائما function. No

TypeDiscriminator

تعريف نوع الكائن.

Property Value
Description تعريف نوع الكائن.
Type string
Values list
fine_tuning.job
file
fine_tuning.job.event
fine_tuning.job.checkpoint
model
upload
upload.part
batch
wandb

UpdateStoredCompletionRequest

Name Type Description Required Default
metadata object أزواج قيم المفاتيح العشوائية للحصول على معلومات إضافية. No

UploadFileCompleteBody

Name Type Description Required Default
md5 string No
part_ids array Yes

UploadFileStartBody

Name Type Description Required Default
bytes integer Yes
filename string Yes
mime_type string Yes
purpose Purpose الغرض المقصود من المستندات التي تم تحميلها. استخدم "ضبط" للضبط الدقيق. يسمح لنا هذا بالتحقق من صحة تنسيق الملف الذي تم تحميله. Yes

UploadPartResource

Name Type Description Required Default
azure_block_id string No
created_at integer طابع زمني عند إنشاء هذه الوظيفة أو العنصر (في فترات unix). No
id string هوية هذا العنصر. No
object TypeDiscriminator تعريف نوع الكائن. No
upload_id string No

UploadResource

Name Type Description Required Default
bytes integer No
created_at integer طابع زمني عند إنشاء هذه الوظيفة أو العنصر (في فترات unix). No
expires_at integer No
file File الملف هو مستند قابل للاستخدام للتدريب والتحقق من الصحة. يمكن أن يكون أيضا مستند خدمة تم إنشاؤه مع تفاصيل النتائج. No
filename string No
id string هوية هذا العنصر. No
object TypeDiscriminator تعريف نوع الكائن. No
purpose Purpose الغرض المقصود من المستندات التي تم تحميلها. استخدم "ضبط" للضبط الدقيق. يسمح لنا هذا بالتحقق من صحة تنسيق الملف الذي تم تحميله. No
status UploadStatus No

UploadStatus

Property Value
Type string
Values pending
expired
completed
cancelled

Usage

Name Type Description Required Default
completion_tokens integer عدد الرموز في الإكمال المولد. No
prompt_tokens integer عدد الرموز في الطلب. No
total_tokens integer إجمالي عدد الرموز المستخدمة في الطلب (الطلب + الإكمال). No

UserComputeDataset

Storage account

Name Type Description Required Default
chunking ChunkingSettings Chunking settings No
datasetId string No
datasetType string No
embeddings array No
kind UserComputeDatasourceType نوع مصدر البيانات. Yes

UserComputeDatasource

تمييز لمصدر UserComputeDatasource

يستخدم هذا المكون الخاصية kind للتمييز بين الأنواع المختلفة:

Type Value Schema
Name Type Description Required Default
kind UserComputeDatasourceType نوع مصدر البيانات. Yes

UserComputeDatasourceType

نوع مصدر البيانات.

Property Value
Description نوع مصدر البيانات.
Type string
Values Dataset
Urls

UserComputeUrl

Urls

Name Type Description Required Default
chunking ChunkingSettings Chunking settings No
crawling CrawlingSettings Crawling settings No
embeddings array No
kind UserComputeDatasourceType نوع مصدر البيانات. Yes
urls array No

WandBIntegrationRequest

Name Type Description Required Default
entity string No
name string No
project string Yes
tags array No

WandBIntegrationRequestWrapper

Name Type Description Required Default
type IntegrationTypes قائمة بتكاملات الضبط الدقيقة المتوفرة. Yes
wandb WandBIntegrationRequest Yes

WorkspaceConnection

اتصال مساحة عمل AML.

Name Type Description Required Default
connectionId string ConnectionId No
kind ConnectionType نوع الاتصال. Yes

WorkspaceConnectionEmbeddingSettings

معرف الاتصال بنموذج التضمين

Name Type Description Required Default
connectionId string No
deploymentName string No
modelName string No

Next steps

تعرف على النماذج، والضبط الدقيق مع واجهة برمجة تطبيقات REST. تعرف أكثر على النماذج الأساسية التي تشغل Azure OpenAI.