Miscellaneous - Get Operation

Başvuru

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

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

endpoint

path

True

string

url

Desteklenen Bilişsel Hizmetler uç noktaları (protokol ve ana bilgisayar adı, örneğin: https://westus2.api.cognitive.microsoft.com).

operationId

path

True

string

uuid

Benzersiz işlem kimliği.

Normal ifade deseni: ^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$

api-version

query

True

string

api sürümü istendi.

İ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 ögesini seçin.
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	İçeriği Azure Blob Depolama.
AzureBlobFileListContentSource	Azure Blob Depolama 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 kullanan 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

İçeriği Azure Blob Depolama.

Name	Tür	Description
containerUrl	string	Kapsayıcı URL'sini Azure Blob Depolama.
prefix	string	Blob adı ön eki.

AzureBlobFileListContentSource

Azure Blob Depolama dosya listesi.

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

ClassifierDocumentTypeDetails

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 konum. azureBlobSource veya azureBlobFileListSource belirtilmelidir.

DocumentBuildMode

Özel belge modeli derleme modu.

Name	Tür	Description
neural	string	Çeşitli görsel şablonları olan belgeleri destekleyin.
template	string	Benzer görsel şablonları olan hedef belgeler.

DocumentClassifierBuildOperationDetails

İş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	İşlemin oluşturulduğu tarih ve saat (UTC).
error	Error	Hatayla karşılaşıldı.
kind	string: documentClassifierBuild	İşlem türü.
lastUpdatedDateTime	string	Durumun son güncelleştirildiği tarih ve saat (UTC).
operationId	string	İşlem Kimliği
percentCompleted	integer	İşlem ilerleme durumu (0-100).
resourceLocation	string	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

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	Benzersiz belge sınıflandırıcı adı.
createdDateTime	string	Belge sınıflandırıcısının oluşturulduğu tarih ve saat (UTC).
description	string	Belge sınıflandırıcı açıklaması.
docTypes	<string, ClassifierDocumentTypeDetails>	Sınıflandırılacak belge türlerinin listesi.
expirationDateTime	string	Belge sınıflandırıcısının süresinin dolacağı tarih ve saat (UTC).

DocumentFieldSchema

JSON Şeması stili söz dizimi kullanan 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

Alan değerinin anlamsal veri türü.

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

DocumentModelBuildOperationDetails

İş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	İşlemin oluşturulduğu tarih ve saat (UTC).
error	Error	Hatayla karşılaşıldı.
kind	string: documentModelBuild	İşlem türü.
lastUpdatedDateTime	string	Durumun son güncelleştirildiği tarih ve saat (UTC).
operationId	string	İşlem Kimliği
percentCompleted	integer	İşlem ilerleme durumu (0-100).
resourceLocation	string	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

İş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	İşlemin oluşturulduğu tarih ve saat (UTC).
error	Error	Hatayla karşılaşıldı.
kind	string: documentModelCompose	İşlem türü.
lastUpdatedDateTime	string	Durumun son güncelleştirildiği tarih ve saat (UTC).
operationId	string	İşlem Kimliği
percentCompleted	integer	İşlem ilerleme durumu (0-100).
resourceLocation	string	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

İş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	İşlemin oluşturulduğu tarih ve saat (UTC).
error	Error	Hatayla karşılaşıldı.
kind	string: documentModelCopyTo	İşlem türü.
lastUpdatedDateTime	string	Durumun son güncelleştirildiği tarih ve saat (UTC).
operationId	string	İşlem Kimliği
percentCompleted	integer	İşlem ilerleme durumu (0-100).
resourceLocation	string	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

Belge modeli bilgileri.

Name	Tür	Description
apiVersion	string	Bu belge modelini oluşturmak için kullanılan API sürümü.
createdDateTime	string	Belge modelinin oluşturulduğu tarih ve saat (UTC).
description	string	Belge modeli açıklaması.
docTypes	<string, DocumentTypeDetails>	Desteklenen belge türleri.
expirationDateTime	string	Belge modelinin süresinin dolacağı tarih ve saat (UTC).
modelId	string	Benzersiz belge modeli adı.
tags	object	Belge modeliyle ilişkili anahtar-değer etiketi özniteliklerinin listesi.

DocumentTypeDetails

Belge türü bilgileri.

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

Error

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 iletisi.
target	string	Hatanın hedefi.

ErrorResponse

Hata yanıtı nesnesi.

Name	Tür	Description
error	Error	Hata bilgileri.

InnerError

Ayrıntılı hata.

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

OperationStatus

İşlem durumu.

Name	Tür	Description
canceled	string	İşlem iptal edildi.
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ş

Miscellaneous - Get Operation

URI Parametreleri

İstek Başlığı

Yanıtlar

Güvenlik

Ocp-Apim-Subscription-Key

Örnekler

Get Operation

Örnek isteği

Örnek yanıt

Tanımlar

AzureBlobContentSource

AzureBlobFileListContentSource

ClassifierDocumentTypeDetails

DocumentBuildMode

DocumentClassifierBuildOperationDetails

DocumentClassifierDetails

DocumentFieldSchema

DocumentFieldType

DocumentModelBuildOperationDetails

DocumentModelComposeOperationDetails

DocumentModelCopyToOperationDetails

DocumentModelDetails

DocumentTypeDetails

Error

ErrorResponse

InnerError

OperationStatus

Ek kaynaklar