Document Models - Get Analyze Batch Result

Başvuru

Hizmet:: Azure AI Services

API Sürümü:: 2024-07-31-preview

Toplu belge analizinin sonucunu alır.

GET {endpoint}/documentintelligence/documentModels/{modelId}/analyzeBatchResults/{resultId}?api-version=2024-07-31-preview

URI Parametreleri

Name	İçinde	Gerekli	Tür	Description
endpoint	path	True	string uri	Belge Yönetim Bilgileri hizmet uç noktası.
modelId	path	True	string	Benzersiz belge modeli adı. Normal ifade deseni: `^[a-zA-Z0-9][a-zA-Z0-9._~-]{1,63}$`
resultId	path	True	string uuid	Toplu işlem sonuç kimliğini analiz edin.
api-version	query	True	string	Bu işlem için kullanılacak API sürümü.

Yanıtlar

Name	Tür	Description
200 OK	AnalyzeBatchResultOperation	İstek başarılı oldu.
Other Status Codes	ErrorResponse	Beklenmeyen bir hata yanıtı.

Güvenlik

Ocp-Apim-Subscription-Key

Tür: apiKey
İçinde: header

OAuth2Auth

Tür: oauth2
Akış: accessCode
Yetkilendirme URL’si: https://login.microsoftonline.com/common/oauth2/authorize
Belirteç URL'si: https://login.microsoftonline.com/common/oauth2/token

Kapsamlar

Name	Description
https://cognitiveservices.azure.com/.default

Örnekler

Get Analyze Batch Documents Result

Örnek isteği

HTTP

GET https://myendpoint.cognitiveservices.azure.com/documentintelligence/documentModels/prebuilt-invoice/analyzeBatchResults/3b31320d-8bab-4f88-b19c-2322a7f11034?api-version=2024-07-31-preview

Örnek yanıt

Durum kodu:: 200

{
  "status": "completed",
  "percentCompleted": 100,
  "createdDateTime": "2021-09-24T13:00:46Z",
  "lastUpdatedDateTime": "2021-09-24T13:00:49Z",
  "result": {
    "succeededCount": 1,
    "failedCount": 1,
    "skippedCount": 1,
    "details": [
      {
        "sourceUrl": "https://myStorageAccount.blob.core.windows.net/myContainer/trainingDocs/file1.pdf",
        "resultUrl": "https://myStorageAccount.blob.core.windows.net/myOutputContainer/trainingDocsResult/file1.pdf.ocr.json",
        "status": "succeeded"
      },
      {
        "sourceUrl": "https://myStorageAccount.blob.core.windows.net/myContainer/trainingDocs/file2.jpg",
        "status": "failed",
        "error": {
          "code": "InvalidRequest",
          "message": "Invalid request.",
          "innererror": {
            "code": "InvalidContent",
            "message": "The file format is unsupported or corrupted. Refer to documentation for the list of supported formats."
          }
        }
      },
      {
        "sourceUrl": "https://myStorageAccount.blob.core.windows.net/myContainer/trainingDocs/file3.png",
        "status": "skipped"
      }
    ]
  }
}

Tanımlar

Name	Description
AnalyzeBatchOperationDetail	Toplu iş analizindeki bir belge için işlem ayrıntıları.
AnalyzeBatchResult	Toplu belge çözümleme sonucu.
AnalyzeBatchResultOperation	Toplu işlemi analiz etme işleminin durumu ve sonucu.
Error	Hata nesnesi.
ErrorResponse	Hata yanıtı nesnesi.
InnerError	Hata hakkında daha ayrıntılı bilgi içeren bir nesne.
OperationStatus	İşlem durumu.

AnalyzeBatchOperationDetail

Toplu iş analizindeki bir belge için işlem ayrıntıları.

Name	Tür	Description
error	Error	Hatayla karşılaşıldı.
resultUrl	string	Analiz sonucu JSON'un URL'si.
sourceUrl	string	Kaynak belgenin URL'si.
status	OperationStatus	Durumu analiz edin. başarılı, başarısız veya atlandı

AnalyzeBatchResult

Toplu belge çözümleme sonucu.

Name	Tür	Description
details	AnalyzeBatchOperationDetail[]	Toplu iş içindeki her belge için işlem ayrıntıları.
failedCount	integer	Başarısız durumla tamamlanan belge sayısı.
skippedCount	integer	Durumu atlanmış olarak tamamlanan belge sayısı.
succeededCount	integer	Durumu başarılı olarak tamamlanan belge sayısı.

AnalyzeBatchResultOperation

Toplu işlemi analiz etme işleminin durumu ve sonucu.

Name	Tür	Description
createdDateTime	string	İşlemin gönderildiği tarih ve saat (UTC).
error	Error	Toplu belge analizi sırasında hatayla karşılaşıldı.
lastUpdatedDateTime	string	Durumun son güncelleştirildiği tarih ve saat (UTC).
percentCompleted	integer	İşlem ilerleme durumu (0-100).
result	AnalyzeBatchResult	Toplu belge çözümleme sonucu.
status	OperationStatus	İşlem durumu. notStarted, running, completed veya failed

Error

Hata nesnesi.

Name	Tür	Description
code	string	Sunucu tanımlı hata kodları kümesinden biri.
details	Error[]	Bu bildirilen hataya yol açan belirli hatalar hakkında bir dizi ayrıntı.
innererror	InnerError	Hatayla ilgili geçerli nesneden daha belirli bilgiler içeren bir nesne.
message	string	Hatanın insan tarafından okunabilir bir gösterimi.
target	string	Hatanın hedefi.

ErrorResponse

Hata yanıtı nesnesi.

Name	Tür	Description
error	Error	Hata bilgileri.

InnerError

Hata hakkında daha ayrıntılı bilgi içeren bir nesne.

Name	Tür	Description
code	string	Sunucu tanımlı hata kodları kümesinden biri.
innererror	InnerError	İç hata.
message	string	Hatanın insan tarafından okunabilir bir gösterimi.

OperationStatus

İşlem durumu.

Name	Tür	Description
canceled	string	İşlem iptal edildi.
completed	string	İşlem tamamlandı.
failed	string	İşlem başarısız oldu.
notStarted	string	İşlem henüz başlatılmadı.
running	string	İşlem devam ediyor.
succeeded	string	İşlem başarılı oldu.

Aracılığıyla paylaş