DocumentTranslationGetDocumentsStatus200Response interface

الحزمة:

@azure-rest/ai-document-translator

إرجاع حالة جميع المستندات في طلب ترجمة مستند دفعي.

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

يمكن استخدام معلمات الاستعلام $top $skip $maxpagesize لتحديد عدد من النتائج لإرجاعها وإزاحة للمجموعة.

يشير $top إلى إجمالي عدد السجلات التي يريد المستخدم إرجاعها عبر جميع الصفحات. يشير $skip إلى عدد السجلات التي يجب تخطيها من قائمة حالة المستند التي يحتفظ بها الخادم استنادا إلى طريقة الفرز المحددة. بشكل افتراضي، نقوم بالفرز حسب وقت البدء التنازلي. $maxpagesize هو الحد الأقصى للعناصر التي يتم إرجاعها في الصفحة. إذا تم طلب المزيد من العناصر عبر $top (أو لم يتم تحديد $top وكان هناك المزيد من العناصر التي سيتم إرجاعها)، فسيحتوي "@nextLink" على الارتباط بالصفحة التالية.

يمكن استخدام معلمة الاستعلام $orderBy لفرز القائمة التي تم إرجاعها (على سبيل المثال "$orderBy=createdDateTimeUtc asc" أو "$orderBy=createdDateTimeUtc desc"). الفرز الافتراضي تنازلي بواسطة createdDateTimeUtc. يمكن استخدام بعض معلمات الاستعلام لتصفية القائمة التي تم إرجاعها (على سبيل المثال: "status=Succeeded,Cancelled") ستقوم بإرجاع المستندات الناجحة والملغاة فقط. يمكن استخدام createdDateTimeUtcStart و createdDateTimeUtcEnd معا أو بشكل منفصل لتحديد نطاق من التاريخ والوقت لتصفية القائمة التي تم إرجاعها حسب. معلمات استعلام التصفية المدعومة هي (الحالة، المعرفات، تم إنشاؤهاTimeUtcStart، createdDateTimeUtcEnd).

عند تضمين كل من $top $skip، يجب أن يطبق الخادم أولا $skip ثم $top على المجموعة. ملاحظة: إذا لم يتمكن الخادم من احترام $top و/أو $skip، فيجب على الخادم إرجاع خطأ إلى العميل لإعلامه بذلك بدلا من مجرد تجاهل خيارات الاستعلام. وهذا يقلل من مخاطر وضع العميل افتراضات حول البيانات التي تم إرجاعها.

يمتد

HttpResponse

الخصائص

body
headers
status

الخصائص الموروثة

request

الطلب الذي أنشأ هذه الاستجابة.

تفاصيل الخاصية

body

body: DocumentsStatusOutput

قيمة الخاصية

DocumentsStatusOutput

headers

headers: RawHttpHeaders & DocumentTranslationGetDocumentsStatus200Headers

قيمة الخاصية

RawHttpHeaders & DocumentTranslationGetDocumentsStatus200Headers

status

status: "200"

قيمة الخاصية

"200"

تفاصيل الخاصية الموروثة

request

الطلب الذي أنشأ هذه الاستجابة.

request: PipelineRequest

قيمة الخاصية

PipelineRequest

موروث من HttpResponse.request