FormRecognizerClient class
- Extends
المنشئون
| Form |
تهيئة مثيل جديد من فئة FormRecognizerClient. |
الخصائص الموروثة
| credentials | |
| endpoint |
الأساليب
الأساليب المتوارثة
| send |
أرسل طلب HTTP الذي يتم ملؤه باستخدام OperationSpec المتوفر. |
| send |
أرسل httpRequest المتوفر. |
تفاصيل المنشئ
FormRecognizerClient(ServiceClientCredentials, string, ServiceClientOptions)
تهيئة مثيل جديد من فئة FormRecognizerClient.
new FormRecognizerClient(credentials: ServiceClientCredentials, endpoint: string, options?: ServiceClientOptions)المعلمات
- credentials
- ServiceClientCredentials
بيانات اعتماد الاشتراك التي تحدد اشتراك العميل بشكل فريد.
- endpoint
-
string
نقاط نهاية الخدمات المعرفية المدعومة (البروتوكول واسم المضيف، على سبيل المثال: https://westus2.api.cognitive.microsoft.com).
- options
- ServiceClientOptions
خيارات المعلمة
تفاصيل الخاصية الموروثة
credentials
credentials: ServiceClientCredentialsقيمة الخاصية
endpoint
تفاصيل الأسلوب
analyzeWithCustomModel(string, HttpRequestBody, FormRecognizerClientAnalyzeWithCustomModelOptionalParams)
استخراج أزواج قيم المفاتيح من مستند معين. يجب أن يكون مستند الإدخال من أحد أنواع المحتوى المدعومة - "application/pdf" أو "image/jpeg" أو "image/png". يتم إرجاع استجابة النجاح في JSON.
function analyzeWithCustomModel(id: string, formStream: HttpRequestBody, options?: FormRecognizerClientAnalyzeWithCustomModelOptionalParams): Promise<AnalyzeWithCustomModelResponse>المعلمات
- id
-
string
معرف النموذج لتحليل المستند باستخدامه.
- formStream
- HttpRequestBody
مستند pdf أو ملف صورة (jpg,png) لتحليله.
المعلمات الاختيارية
المرتجعات
Promise<AnalyzeWithCustomModelResponse>
نماذج الوعد.AnalyzeWithCustomModelResponse<>
analyzeWithCustomModel(string, HttpRequestBody, FormRecognizerClientAnalyzeWithCustomModelOptionalParams, ServiceCallback<AnalyzeResult>)
function analyzeWithCustomModel(id: string, formStream: HttpRequestBody, options: FormRecognizerClientAnalyzeWithCustomModelOptionalParams, callback: ServiceCallback<AnalyzeResult>)المعلمات
- id
-
string
معرف النموذج لتحليل المستند باستخدامه.
- formStream
- HttpRequestBody
مستند pdf أو ملف صورة (jpg,png) لتحليله.
المعلمات الاختيارية
- callback
رد الاتصال
analyzeWithCustomModel(string, HttpRequestBody, ServiceCallback<AnalyzeResult>)
function analyzeWithCustomModel(id: string, formStream: HttpRequestBody, callback: ServiceCallback<AnalyzeResult>)المعلمات
- id
-
string
معرف النموذج لتحليل المستند باستخدامه.
- formStream
- HttpRequestBody
مستند pdf أو ملف صورة (jpg,png) لتحليله.
- callback
رد الاتصال
batchReadReceipt(string, RequestOptionsBase)
عملية إيصال قراءة الدفعة. تحتوي الاستجابة على حقل يسمى "Operation-Location"، والذي يحتوي على عنوان URL الذي يجب استخدامه لعملية "الحصول على نتيجة إيصال القراءة".
function batchReadReceipt(url: string, options?: RequestOptionsBase): Promise<BatchReadReceiptResponse>المعلمات
- url
-
string
عنوان URL يمكن الوصول إليه بشكل عام لصورة.
- options
- RequestOptionsBase
المعلمات الاختيارية
المرتجعات
Promise<BatchReadReceiptResponse>
وعد<Models.BatchReadReceiptResponse>
batchReadReceipt(string, RequestOptionsBase, ServiceCallback<void>)
function batchReadReceipt(url: string, options: RequestOptionsBase, callback: ServiceCallback<void>)المعلمات
- url
-
string
عنوان URL يمكن الوصول إليه بشكل عام لصورة.
- options
- RequestOptionsBase
المعلمات الاختيارية
- callback
-
ServiceCallback<void>
رد الاتصال
batchReadReceipt(string, ServiceCallback<void>)
function batchReadReceipt(url: string, callback: ServiceCallback<void>)المعلمات
- url
-
string
عنوان URL يمكن الوصول إليه بشكل عام لصورة.
- callback
-
ServiceCallback<void>
رد الاتصال
batchReadReceiptInStream(HttpRequestBody, RequestOptionsBase)
قراءة عملية الإيصال. عند استخدام واجهة "إيصال قراءة الدفعات"، تحتوي الاستجابة على حقل يسمى "Operation-Location". يحتوي الحقل "Operation-Location" على عنوان URL الذي يجب استخدامه لعملية "الحصول على نتيجة إيصال القراءة".
function batchReadReceiptInStream(image: HttpRequestBody, options?: RequestOptionsBase): Promise<BatchReadReceiptInStreamResponse>المعلمات
- image
- HttpRequestBody
دفق صورة.
- options
- RequestOptionsBase
المعلمات الاختيارية
المرتجعات
Promise<BatchReadReceiptInStreamResponse>
Promise<Models.BatchReadReceiptInStreamResponse>
batchReadReceiptInStream(HttpRequestBody, RequestOptionsBase, ServiceCallback<void>)
function batchReadReceiptInStream(image: HttpRequestBody, options: RequestOptionsBase, callback: ServiceCallback<void>)المعلمات
- image
- HttpRequestBody
دفق صورة.
- options
- RequestOptionsBase
المعلمات الاختيارية
- callback
-
ServiceCallback<void>
رد الاتصال
batchReadReceiptInStream(HttpRequestBody, ServiceCallback<void>)
function batchReadReceiptInStream(image: HttpRequestBody, callback: ServiceCallback<void>)المعلمات
- image
- HttpRequestBody
دفق صورة.
- callback
-
ServiceCallback<void>
رد الاتصال
deleteCustomModel(string, RequestOptionsBase)
حذف البيانات الاصطناعية للنموذج.
function deleteCustomModel(id: string, options?: RequestOptionsBase): Promise<RestResponse>المعلمات
- id
-
string
معرف النموذج المراد حذفه.
- options
- RequestOptionsBase
المعلمات الاختيارية
المرتجعات
Promise<RestResponse>
وعد<msRest.RestResponse>
deleteCustomModel(string, RequestOptionsBase, ServiceCallback<void>)
function deleteCustomModel(id: string, options: RequestOptionsBase, callback: ServiceCallback<void>)المعلمات
- id
-
string
معرف النموذج المراد حذفه.
- options
- RequestOptionsBase
المعلمات الاختيارية
- callback
-
ServiceCallback<void>
رد الاتصال
deleteCustomModel(string, ServiceCallback<void>)
function deleteCustomModel(id: string, callback: ServiceCallback<void>)المعلمات
- id
-
string
معرف النموذج المراد حذفه.
- callback
-
ServiceCallback<void>
رد الاتصال
getCustomModel(string, RequestOptionsBase)
الحصول على معلومات حول نموذج.
function getCustomModel(id: string, options?: RequestOptionsBase): Promise<GetCustomModelResponse>المعلمات
- id
-
string
معرف النموذج.
- options
- RequestOptionsBase
المعلمات الاختيارية
المرتجعات
Promise<GetCustomModelResponse>
Promise<Models.GetCustomModelResponse>
getCustomModel(string, RequestOptionsBase, ServiceCallback<ModelResult>)
function getCustomModel(id: string, options: RequestOptionsBase, callback: ServiceCallback<ModelResult>)المعلمات
- id
-
string
معرف النموذج.
- options
- RequestOptionsBase
المعلمات الاختيارية
- callback
رد الاتصال
getCustomModel(string, ServiceCallback<ModelResult>)
function getCustomModel(id: string, callback: ServiceCallback<ModelResult>)المعلمات
- id
-
string
معرف النموذج.
- callback
رد الاتصال
getCustomModels(RequestOptionsBase)
الحصول على معلومات حول جميع النماذج المخصصة المدربة
function getCustomModels(options?: RequestOptionsBase): Promise<GetCustomModelsResponse>المعلمات
- options
- RequestOptionsBase
المعلمات الاختيارية
المرتجعات
Promise<GetCustomModelsResponse>
Promise<Models.GetCustomModelsResponse>
getCustomModels(RequestOptionsBase, ServiceCallback<ModelsResult>)
function getCustomModels(options: RequestOptionsBase, callback: ServiceCallback<ModelsResult>)المعلمات
- options
- RequestOptionsBase
المعلمات الاختيارية
- callback
رد الاتصال
getCustomModels(ServiceCallback<ModelsResult>)
function getCustomModels(callback: ServiceCallback<ModelsResult>)المعلمات
- callback
رد الاتصال
getExtractedKeys(string, RequestOptionsBase)
استرداد المفاتيح التي تم استخراجها أثناء تدريب النموذج المحدد.
function getExtractedKeys(id: string, options?: RequestOptionsBase): Promise<GetExtractedKeysResponse>المعلمات
- id
-
string
معرف النموذج.
- options
- RequestOptionsBase
المعلمات الاختيارية
المرتجعات
Promise<GetExtractedKeysResponse>
Promise<Models.GetExtractedKeysResponse>
getExtractedKeys(string, RequestOptionsBase, ServiceCallback<KeysResult>)
function getExtractedKeys(id: string, options: RequestOptionsBase, callback: ServiceCallback<KeysResult>)المعلمات
- id
-
string
معرف النموذج.
- options
- RequestOptionsBase
المعلمات الاختيارية
- callback
رد الاتصال
getExtractedKeys(string, ServiceCallback<KeysResult>)
function getExtractedKeys(id: string, callback: ServiceCallback<KeysResult>)المعلمات
- id
-
string
معرف النموذج.
- callback
رد الاتصال
getReadReceiptResult(string, RequestOptionsBase)
يتم استخدام هذه الواجهة للحصول على نتائج التحليل لعملية "إيصال قراءة الدفعة". يجب استرداد عنوان URL لهذه الواجهة من حقل "Operation-Location" الذي تم إرجاعه من عملية "إيصال قراءة الدفعة".
function getReadReceiptResult(operationId: string, options?: RequestOptionsBase): Promise<GetReadReceiptResultResponse>المعلمات
- operationId
-
string
معرف عملية القراءة التي تم إرجاعها استجابة لعملية "إيصال قراءة الدفعة".
- options
- RequestOptionsBase
المعلمات الاختيارية
المرتجعات
Promise<GetReadReceiptResultResponse>
Promise<Models.GetReadReceiptResultResponse>
getReadReceiptResult(string, RequestOptionsBase, ServiceCallback<ReadReceiptResult>)
function getReadReceiptResult(operationId: string, options: RequestOptionsBase, callback: ServiceCallback<ReadReceiptResult>)المعلمات
- operationId
-
string
معرف عملية القراءة التي تم إرجاعها استجابة لعملية "إيصال قراءة الدفعة".
- options
- RequestOptionsBase
المعلمات الاختيارية
- callback
رد الاتصال
getReadReceiptResult(string, ServiceCallback<ReadReceiptResult>)
function getReadReceiptResult(operationId: string, callback: ServiceCallback<ReadReceiptResult>)المعلمات
- operationId
-
string
معرف عملية القراءة التي تم إرجاعها استجابة لعملية "إيصال قراءة الدفعة".
- callback
رد الاتصال
trainCustomModel(TrainRequest, RequestOptionsBase)
إنشاء نموذج مخصص وتدريبه. يجب أن يتضمن طلب التدريب معلمة مصدر إما Uri حاوية كائن ثنائي كبير الحجم ل Azure Storage يمكن الوصول إليها خارجيا (يفضل أن يكون Shared Access Signature Uri) أو مسارا صالحا إلى مجلد بيانات في محرك أقراص مثبت محليا. عند تحديد المسارات المحلية، يجب أن تتبع تنسيق مسار Linux/Unix وأن تكون مسارا مطلقا متجذرا في قيمة إعداد تكوين تحميل الإدخال، على سبيل المثال، إذا كانت قيمة إعداد التكوين '{Mounts:Input}' هي '/input' فسيكون مسار المصدر الصالح '/input/contosodataset'. من المتوقع أن تكون جميع البيانات التي سيتم تدريبها ضمن المجلد المصدر مباشرة. المجلدات الفرعية غير مدعومة. يتم تدريب النماذج باستخدام المستندات من نوع المحتوى التالي - "application/pdf" و"image/jpeg" و"image/png". يتم تجاهل نوع آخر من المحتوى.
function trainCustomModel(trainRequest: TrainRequest, options?: RequestOptionsBase): Promise<TrainCustomModelResponse>المعلمات
- trainRequest
- TrainRequest
طلب كائن للتدريب.
- options
- RequestOptionsBase
المعلمات الاختيارية
المرتجعات
Promise<TrainCustomModelResponse>
Promise<Models.TrainCustomModelResponse>
trainCustomModel(TrainRequest, RequestOptionsBase, ServiceCallback<TrainResult>)
function trainCustomModel(trainRequest: TrainRequest, options: RequestOptionsBase, callback: ServiceCallback<TrainResult>)المعلمات
- trainRequest
- TrainRequest
طلب كائن للتدريب.
- options
- RequestOptionsBase
المعلمات الاختيارية
- callback
رد الاتصال
trainCustomModel(TrainRequest, ServiceCallback<TrainResult>)
function trainCustomModel(trainRequest: TrainRequest, callback: ServiceCallback<TrainResult>)المعلمات
- trainRequest
- TrainRequest
طلب كائن للتدريب.
- callback
رد الاتصال
تفاصيل الأساليب المتوارثة
sendOperationRequest(OperationArguments, OperationSpec, ServiceCallback<any>)
أرسل طلب HTTP الذي يتم ملؤه باستخدام OperationSpec المتوفر.
function sendOperationRequest(operationArguments: OperationArguments, operationSpec: OperationSpec, callback?: ServiceCallback<any>): Promise<RestResponse>المعلمات
- operationArguments
- OperationArguments
سيتم ملء الوسيطات التي سيتم ملء القيم المقالب لطلب HTTP منها.
- operationSpec
- OperationSpec
OperationSpec لاستخدامه لملء httpRequest.
- callback
-
ServiceCallback<any>
رد الاتصال للاتصال عند تلقي الاستجابة.
المرتجعات
Promise<RestResponse>
sendRequest(RequestPrepareOptions | WebResourceLike)
أرسل httpRequest المتوفر.
function sendRequest(options: RequestPrepareOptions | WebResourceLike): Promise<HttpOperationResponse>المعلمات
- options
المرتجعات
Promise<HttpOperationResponse>
Azure SDK for JavaScript
الملاحظات
قريبًا: خلال عام 2024، سنتخلص تدريجيًا من GitHub Issues بوصفها آلية إرسال ملاحظات للمحتوى ونستبدلها بنظام ملاحظات جديد. لمزيد من المعلومات، راجع https://aka.ms/ContentUserFeedback.
إرسال الملاحظات وعرضها المتعلقة بـ