Miscellaneous - Get Operation

Hizmet:

Azure AI Services

API Sürümü:

2023-07-31

İşlem bilgilerini alır.

GET {endpoint}/formrecognizer/operations/{operationId}?api-version=2023-07-31

URI Parametreleri

Name	İçinde	Gerekli	Tür	Description
endpoint	path	True	string (url)	Desteklenen Bilişsel Hizmetler uç noktaları (protokol ve konak adı, örneğin: https://westus2.api.cognitive.microsoft.com).
operationId	path	True	string (uuid) maxLength: 36 pattern: ^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$	Benzersiz işlem kimliği.
api-version	query	True	string	İstenen API sürümü.

İstek Başlığı

Name	Gerekli	Tür	Description
Ocp-Apim-Subscription-Key	True	string	Azure Bilişsel Hizmetler aboneliğinizin gizli anahtarı.

Yanıtlar

Name	Tür	Description
200 OK	OperationDetails: DocumentModelBuildOperationDetails DocumentModelComposeOperationDetails DocumentModelCopyToOperationDetails DocumentClassifierBuildOperationDetails	TAMAM.
Other Status Codes	ErrorResponse	Hatayla karşılaşıldı.

Güvenlik

Ocp-Apim-Subscription-Key

Azure Bilişsel Hizmetler aboneliğinizin gizli anahtarı.

Tür: apiKey
İçinde: header

Örnekler

Get Operation

Örnek isteği

HTTP

GET https://myendpoint.cognitiveservices.azure.com/formrecognizer/operations/b704bb00-d130-4f3f-a1d8-ca96de3eabb4?api-version=2023-07-31

Örnek yanıt

Durum kodu:

200

{
  "operationId": "31533879936_426a3e4c-c6fb-4c83-937c-a92414c371a4",
  "status": "succeeded",
  "percentCompleted": 100,
  "createdDateTime": "2021-09-23T09:12:57Z",
  "lastUpdatedDateTime": "2021-09-23T09:13:01Z",
  "kind": "documentModelBuild",
  "resourceLocation": "https://myendpoint.cognitiveservices.azure.com/formrecognizer/documentModels/myCustomModel",
  "result": {
    "modelId": "myCustomModel",
    "description": "Custom model description",
    "createdDateTime": "2021-09-23T09:13:01Z",
    "apiVersion": "2023-07-31"
  }
}

Tanımlar

Name	Description
AzureBlobContentSource	Azure Blob Depolama içeriği.
AzureBlobFileListContentSource	Azure Blob Depolama'daki dosya listesi.
ClassifierDocumentTypeDetails	Sınıflandırıcı belge türü bilgileri.
DocumentBuildMode	Özel belge modeli derleme modu.
DocumentClassifierBuildOperationDetails	İşlem yanıt nesnesini alma.
DocumentClassifierDetails	Belge sınıflandırıcı bilgileri.
DocumentFieldSchema	JSON Şeması stili söz dizimi kullanılarak alan anlam şemasının açıklaması.
DocumentFieldType	Alan değerinin anlamsal veri türü.
DocumentModelBuildOperationDetails	İşlem yanıt nesnesini alma.
DocumentModelComposeOperationDetails	İşlem yanıt nesnesini alma.
DocumentModelCopyToOperationDetails	İşlem yanıt nesnesini alma.
DocumentModelDetails	Belge modeli bilgileri.
DocumentTypeDetails	Belge türü bilgileri.
Error	Hata bilgileri.
ErrorResponse	Hata yanıtı nesnesi.
InnerError	Ayrıntılı hata.
OperationStatus	İşlem durumu.

AzureBlobContentSource

Object

Azure Blob Depolama içeriği.

Name	Tür	Description
containerUrl	string (url)	Azure Blob Depolama kapsayıcı URL'si.
prefix	string	Blob adı ön eki.

AzureBlobFileListContentSource

Object

Azure Blob Depolama'daki dosya listesi.

Name	Tür	Description
containerUrl	string (url)	Azure Blob Depolama kapsayıcı URL'si.
fileList	string	Eğitim için belgelerin bir alt kümesini belirten kapsayıcı içindeki bir JSONL dosyasının yolu.

ClassifierDocumentTypeDetails

Object

Sınıflandırıcı belge türü bilgileri.

Name	Tür	Description
azureBlobFileListSource	AzureBlobFileListContentSource	Sınıflandırıcı belge türü için eğitim verilerini belirten Azure Blob Depolama dosya listesi. azureBlobSource veya azureBlobFileListSource belirtilmelidir.
azureBlobSource	AzureBlobContentSource	Sınıflandırıcı belge türü için eğitim verilerini içeren Azure Blob Depolama konumu. azureBlobSource veya azureBlobFileListSource belirtilmelidir.

DocumentBuildMode

Listeleme

Özel belge modeli derleme modu.

Değer	Description
template	Benzer görsel şablonlara sahip belgeleri hedefle.
neural	Çeşitli görsel şablonları olan belgeleri destekleyin.

DocumentClassifierBuildOperationDetails

Object

İşlem yanıt nesnesini alma.

Name	Tür	Description
apiVersion	string	Bu işlemi oluşturmak için kullanılan API sürümü.
createdDateTime	string (date-time)	İşlemin oluşturulduğu tarih ve saat (UTC).
error	Error	Hatayla karşılaşıldı.
kind	string: documentClassifierBuild	İşlem türü.
lastUpdatedDateTime	string (date-time)	Durumun son güncelleştirildiği tarih ve saat (UTC).
operationId	string	İşlem Kimliği
percentCompleted	integer (int32) minimum: 0 maximum: 100	İşlem ilerleme durumu (0-100).
resourceLocation	string (url)	Bu işlem tarafından hedeflenen kaynağın URL'si.
result	DocumentClassifierDetails	İşlem başarılı olduğunda sonuçlanır.
status	OperationStatus	İşlem durumu.
tags	object	Belge modeliyle ilişkili anahtar-değer etiketi özniteliklerinin listesi.

DocumentClassifierDetails

Object

Belge sınıflandırıcı bilgileri.

Name	Tür	Description
apiVersion	string	Bu belge sınıflandırıcısını oluşturmak için kullanılan API sürümü.
classifierId	string pattern: ^[a-zA-Z0-9][a-zA-Z0-9._~-]{1,63}$	Benzersiz belge sınıflandırıcı adı.
createdDateTime	string (date-time)	Belge sınıflandırıcısının oluşturulduğu tarih ve saat (UTC).
description	string maxLength: 4096	Belge sınıflandırıcı açıklaması.
docTypes	<string,  ClassifierDocumentTypeDetails>	Sınıflandırılacak belge türlerinin listesi.
expirationDateTime	string (date-time)	Belge sınıflandırıcısının süresinin dolacağı tarih ve saat (UTC).

DocumentFieldSchema

Object

JSON Şeması stili söz dizimi kullanılarak alan anlam şemasının açıklaması.

Name	Tür	Description
description	string	Alan açıklaması.
example	string	Örnek alan içeriği.
items	DocumentFieldSchema	Her dizi öğesinin alan türü şeması.
properties	<string,  DocumentFieldSchema>	Nesne alanının adlandırılmış alt alanları.
type	DocumentFieldType	Alan değerinin anlamsal veri türü.

DocumentFieldType

Listeleme

Alan değerinin anlamsal veri türü.

Değer	Description
string	Düz metin.
date	Tarih, ISO 8601 (YYYY-MM-DD) biçiminde normalleştirilmiştir.
time	Iso 8601 (ss:mm:ss) biçiminde normalleştirilmiş zaman.
phoneNumber	E.164 (+{CountryCode}{SubscriberNumber}) biçiminde normalleştirilmiş telefon numarası.
number	Çift duyarlıklı kayan nokta olarak normalleştirilmiş kayan nokta sayısı.
integer	64 bit işaretli tamsayıya normalleştirilmiş tamsayı.
selectionMark	Alan seçili mi?
countryRegion	Ülke/bölge, ISO 3166-1 alfa-3 biçimine (örn. ABD) normalleştirilmiştir.
signature	İmza var mı?
array	Aynı türdeki alt alanlar listesi.
object	Farklı olabilecek türlerin alt alanlarının adlandırılmış listesi.
currency	İsteğe bağlı para birimi simgesi ve birimi olan para birimi tutarı.
address	Ayrıştırılan adres.
boolean	True veya false olarak normalleştirilmiş Boole değeri.

DocumentModelBuildOperationDetails

Object

İşlem yanıt nesnesini alma.

Name	Tür	Description
apiVersion	string	Bu işlemi oluşturmak için kullanılan API sürümü.
createdDateTime	string (date-time)	İşlemin oluşturulduğu tarih ve saat (UTC).
error	Error	Hatayla karşılaşıldı.
kind	string: documentModelBuild	İşlem türü.
lastUpdatedDateTime	string (date-time)	Durumun son güncelleştirildiği tarih ve saat (UTC).
operationId	string	İşlem Kimliği
percentCompleted	integer (int32) minimum: 0 maximum: 100	İşlem ilerleme durumu (0-100).
resourceLocation	string (url)	Bu işlem tarafından hedeflenen kaynağın URL'si.
result	DocumentModelDetails	İşlem başarılı olduğunda sonuçlanır.
status	OperationStatus	İşlem durumu.
tags	object	Belge modeliyle ilişkili anahtar-değer etiketi özniteliklerinin listesi.

DocumentModelComposeOperationDetails

Object

İşlem yanıt nesnesini alma.

Name	Tür	Description
apiVersion	string	Bu işlemi oluşturmak için kullanılan API sürümü.
createdDateTime	string (date-time)	İşlemin oluşturulduğu tarih ve saat (UTC).
error	Error	Hatayla karşılaşıldı.
kind	string: documentModelCompose	İşlem türü.
lastUpdatedDateTime	string (date-time)	Durumun son güncelleştirildiği tarih ve saat (UTC).
operationId	string	İşlem Kimliği
percentCompleted	integer (int32) minimum: 0 maximum: 100	İşlem ilerleme durumu (0-100).
resourceLocation	string (url)	Bu işlem tarafından hedeflenen kaynağın URL'si.
result	DocumentModelDetails	İşlem başarılı olduğunda sonuçlanır.
status	OperationStatus	İşlem durumu.
tags	object	Belge modeliyle ilişkili anahtar-değer etiketi özniteliklerinin listesi.

DocumentModelCopyToOperationDetails

Object

İşlem yanıt nesnesini alma.

Name	Tür	Description
apiVersion	string	Bu işlemi oluşturmak için kullanılan API sürümü.
createdDateTime	string (date-time)	İşlemin oluşturulduğu tarih ve saat (UTC).
error	Error	Hatayla karşılaşıldı.
kind	string: documentModelCopyTo	İşlem türü.
lastUpdatedDateTime	string (date-time)	Durumun son güncelleştirildiği tarih ve saat (UTC).
operationId	string	İşlem Kimliği
percentCompleted	integer (int32) minimum: 0 maximum: 100	İşlem ilerleme durumu (0-100).
resourceLocation	string (url)	Bu işlem tarafından hedeflenen kaynağın URL'si.
result	DocumentModelDetails	İşlem başarılı olduğunda sonuçlanır.
status	OperationStatus	İşlem durumu.
tags	object	Belge modeliyle ilişkili anahtar-değer etiketi özniteliklerinin listesi.

DocumentModelDetails

Object

Belge modeli bilgileri.

Name	Tür	Description
apiVersion	string	Bu belge modelini oluşturmak için kullanılan API sürümü.
createdDateTime	string (date-time)	Belge modelinin oluşturulduğu tarih ve saat (UTC).
description	string maxLength: 4096	Belge modeli açıklaması.
docTypes	<string,  DocumentTypeDetails>	Desteklenen belge türleri.
expirationDateTime	string (date-time)	Belge modelinin süresinin dolacağı tarih ve saat (UTC).
modelId	string pattern: ^[a-zA-Z0-9][a-zA-Z0-9._~-]{1,63}$	Benzersiz belge modeli adı.
tags	object	Belge modeliyle ilişkili anahtar-değer etiketi özniteliklerinin listesi.

DocumentTypeDetails

Object

Belge türü bilgileri.

Name	Tür	Description
buildMode	DocumentBuildMode	Özel belge modeli derleme modu.
description	string maxLength: 4096	Belge modeli açıklaması.
fieldConfidence	object	Her alan için tahmini güvenilirlik.
fieldSchema	<string,  DocumentFieldSchema>	JSON Şeması stili söz dizimi kullanılarak belge semantik şemasının açıklaması.

Error

Object

Hata bilgileri.

Name	Tür	Description
code	string	Hata kodu.
details	Error[]	Ayrıntılı hataların listesi.
innererror	InnerError	Ayrıntılı hata.
message	string	Hata mesajı.
target	string	Hatanın hedefi.

ErrorResponse

Object

Hata yanıtı nesnesi.

Name	Tür	Description
error	Error	Hata bilgileri.

InnerError

Object

Ayrıntılı hata.

Name	Tür	Description
code	string	Hata kodu.
innererror	InnerError	Ayrıntılı hata.
message	string	Hata mesajı.

OperationStatus

Listeleme

İşlem durumu.

Değer	Description
notStarted	İşlem henüz başlatılmadı.
running	İşlem devam ediyor.
failed	İşlem başarısız oldu.
succeeded	İşlem başarılı oldu.
canceled	İşlem iptal edildi.