AnalysisResultPoller interface

الحزمة:

@azure/ai-content-understanding

يمتد

PollerLike<OperationState<AnalysisResult>, AnalysisResult>

الخصائص

operationId

عملية ID

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

isDone	هذا صحيح إذا كان المستطلع قد أنهى الاستطلاع.
operationState	حالة العملية. قد يكون غير محدد إذا لم يتم تقديم جهاز الاستطلاع بعد.
result	قيمة نتيجة العملية، بغض النظر عن حالة المستطلع. يمكن أن تكون غير معرفة أو غير مكتملة من قيمة TResult النهائية حسب التنفيذ.
[toStringTag]

الأساليب المتوارثة

catch<TResult>(null | (reason: any) => TResult | PromiseLike<TResult>)	يرفق استدعاء للرد فقط لرفض الوعد.
finally(null | () => void)	يرفق استدعاء استدعاء يتم تفعيله عند تسوية الوعد (سواء تم الوفاء أو رفضه). لا يمكن تعديل القيمة المحلولة من الاستدعاء المعاد الجديد.
onProgress((state: OperationState<AnalysisResult>) => void)	يستدعي الاستدعاء المقدم بعد الانتهاء من كل استطلاع، ويرسل الحالة الحالية لعملية المستطلع. يعيد طريقة يمكن استخدامها لإيقاف استقبال التحديثات على دالة إعادة الاتصال المحددة.
poll({ abortSignal?: AbortSignalLike })	يعيد وعدا سيحل بمجرد انتهاء طلب استطلاع واحد. يقوم بذلك عن طريق استدعاء طريقة التحديث لعملية البولر.
pollUntilDone({ abortSignal?: AbortSignalLike })	يعيد وعدا سيحل بمجرد اكتمال العملية الأساسية.
serialize()	يعيد وعدا يمكن استخدامه للنسخة التسلسلية من عملية المستطلع عن طريق استدعاء طريقة التسلسل الخاصة بالعملية.
submitted()	يعيد وعدا يمكن استخدامه للتحقق مما إذا كان المستطلع قد تم تقديمه.
then<TResult1, TResult2>(null | (value: AnalysisResult) => TResult1 | PromiseLike<TResult1>, null | (reason: any) => TResult2 | PromiseLike<TResult2>)	يرفق استدعاءات لحل و/أو رفض الوعد.

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

operationId

عملية ID

operationId?: string

قيمة الخاصية

string

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

isDone

هذا صحيح إذا كان المستطلع قد أنهى الاستطلاع.

isDone: boolean

قيمة الخاصية

boolean

الموروث من PollerLike.isDone

operationState

حالة العملية. قد يكون غير محدد إذا لم يتم تقديم جهاز الاستطلاع بعد.

operationState: undefined | OperationState<AnalysisResult>

قيمة الخاصية

undefined | OperationState<AnalysisResult>

الموروث من PollerLike.operationState

result

قيمة نتيجة العملية، بغض النظر عن حالة المستطلع. يمكن أن تكون غير معرفة أو غير مكتملة من قيمة TResult النهائية حسب التنفيذ.

result: undefined | AnalysisResult

قيمة الخاصية

undefined | AnalysisResult

الموروث من PollerLike.result

[toStringTag]

[toStringTag]: string

قيمة الخاصية

string

الموروث من PollerLike.__@toStringTag@401

تفاصيل الأساليب المتوارثة

catch<TResult>(null | (reason: any) => TResult | PromiseLike<TResult>)

يرفق استدعاء للرد فقط لرفض الوعد.

function catch<TResult>(onrejected?: null | (reason: any) => TResult | PromiseLike<TResult>): Promise<AnalysisResult | TResult>

المعلمات

onrejected

null | (reason: any) => TResult | PromiseLike<TResult>

الاستدعاء للتنفيذ عند رفض الوعد.

المرتجعات

Promise<AnalysisResult | TResult>

وعد بإكمال الاستدعاء المتكرر.

الموروث من PollerLike.catch

finally(null | () => void)

يرفق استدعاء استدعاء يتم تفعيله عند تسوية الوعد (سواء تم الوفاء أو رفضه). لا يمكن تعديل القيمة المحلولة من الاستدعاء المعاد الجديد.

function finally(onfinally?: null | () => void): Promise<AnalysisResult>

المعلمات

onfinally

null | () => void

الاستدعاء للتنفيذ عند تسوية الوعد (سواء تم الوفاء أو الرفض).

المرتجعات

Promise<AnalysisResult>

وعد بإكمال الاستدعاء المتكرر.

الموروث من PollerLike.أخيرا

onProgress((state: OperationState<AnalysisResult>) => void)

يستدعي الاستدعاء المقدم بعد الانتهاء من كل استطلاع، ويرسل الحالة الحالية لعملية المستطلع.

يعيد طريقة يمكن استخدامها لإيقاف استقبال التحديثات على دالة إعادة الاتصال المحددة.

function onProgress(callback: (state: OperationState<AnalysisResult>) => void): CancelOnProgress

المعلمات

callback

(state: OperationState<AnalysisResult>) => void

المرتجعات

CancelOnProgress

الموروث من PollerLike.onProgress

poll({ abortSignal?: AbortSignalLike })

يعيد وعدا سيحل بمجرد انتهاء طلب استطلاع واحد. يقوم بذلك عن طريق استدعاء طريقة التحديث لعملية البولر.

function poll(options?: { abortSignal?: AbortSignalLike }): Promise<OperationState<AnalysisResult>>

المعلمات

options

{ abortSignal?: AbortSignalLike }

المرتجعات

Promise<OperationState<AnalysisResult>>

الموروث من PollerLike.poll

pollUntilDone({ abortSignal?: AbortSignalLike })

يعيد وعدا سيحل بمجرد اكتمال العملية الأساسية.

function pollUntilDone(pollOptions?: { abortSignal?: AbortSignalLike }): Promise<AnalysisResult>

المعلمات

pollOptions

{ abortSignal?: AbortSignalLike }

المرتجعات

Promise<AnalysisResult>

الموروث من PollerLike.pollUntilDone

serialize()

يعيد وعدا يمكن استخدامه للنسخة التسلسلية من عملية المستطلع عن طريق استدعاء طريقة التسلسل الخاصة بالعملية.

function serialize(): Promise<string>

المرتجعات

Promise<string>

الموروث من PollerLike.serialize

submitted()

يعيد وعدا يمكن استخدامه للتحقق مما إذا كان المستطلع قد تم تقديمه.

function submitted(): Promise<void>

المرتجعات

Promise<void>

الموروث من PollerLike.submit

then<TResult1, TResult2>(null | (value: AnalysisResult) => TResult1 | PromiseLike<TResult1>, null | (reason: any) => TResult2 | PromiseLike<TResult2>)

يرفق استدعاءات لحل و/أو رفض الوعد.

function then<TResult1, TResult2>(onfulfilled?: null | (value: AnalysisResult) => TResult1 | PromiseLike<TResult1>, onrejected?: null | (reason: any) => TResult2 | PromiseLike<TResult2>): Promise<TResult1 | TResult2>

المعلمات

onfulfilled

null | (value: AnalysisResult) => TResult1 | PromiseLike<TResult1>

الاستدعاء للتنفيذ عند حل الوعد.

onrejected

null | (reason: any) => TResult2 | PromiseLike<TResult2>

الاستدعاء للتنفيذ عند رفض الوعد.

المرتجعات

Promise<TResult1 | TResult2>

وعد بإكمال أي مكالمة تنفذ.

الموروث من PollerLike.then