Document Models - Get Model
Ayrıntılı belge modeli bilgilerini alır.
GET {endpoint}/documentintelligence/documentModels/{modelId}?api-version=2024-02-29-preview
URI Parametreleri
Name | İçinde | Gerekli | Tür | Description |
---|---|---|---|---|
endpoint
|
path | True |
string |
Belge Yönetim Bilgileri hizmeti uç noktası. |
model
|
path | True |
string |
Benzersiz belge modeli adı. Regex pattern: |
api-version
|
query | True |
string |
Bu işlem için kullanılacak API sürümü. |
İstek Başlığı
Name | Gerekli | Tür | Description |
---|---|---|---|
x-ms-client-request-id |
string uuid |
İstek için opak, genel olarak benzersiz, istemci tarafından oluşturulan bir dize tanımlayıcısı. |
Yanıtlar
Name | Tür | Description |
---|---|---|
200 OK |
İstek başarılı oldu. Headers x-ms-client-request-id: string |
|
Other Status Codes |
Beklenmeyen bir hata yanıtı. |
Güvenlik
Ocp-Apim-Subscription-Key
Type:
apiKey
In:
header
OAuth2Auth
Type:
oauth2
Flow:
accessCode
Authorization URL:
https://login.microsoftonline.com/common/oauth2/authorize
Token URL:
https://login.microsoftonline.com/common/oauth2/token
Scopes
Name | Description |
---|---|
https://cognitiveservices.azure.com/.default |
Örnekler
Get Custom Document Model |
Get Prebuilt Document Model |
Get Custom Document Model
Sample Request
GET https://myendpoint.cognitiveservices.azure.com/documentintelligence/documentModels/myCustomModel?api-version=2024-02-29-preview
Sample Response
{
"modelId": "myCustomModel",
"description": "Custom model description",
"createdDateTime": "2021-09-24T12:54:35Z",
"expirationDateTime": "2023-01-01T00:00:00Z",
"apiVersion": "2024-02-29-preview",
"docTypes": {
"myForm": {
"fieldSchema": {
"Name": {
"type": "string"
},
"Date": {
"type": "date"
},
"Amount": {
"type": "number"
}
},
"buildMode": "template",
"fieldConfidence": {
"Name": 0.9,
"Date": 0.95,
"Amount": 0.93
}
}
},
"tags": {
"createdBy": "myUserId"
}
}
Get Prebuilt Document Model
Sample Request
GET https://myendpoint.cognitiveservices.azure.com/documentintelligence/documentModels/prebuilt-invoice?api-version=2024-02-29-preview
Sample Response
{
"modelId": "prebuilt-invoice",
"description": "Prebuilt model to extract key information from English invoices, including customer, vendor, invoice ID, due date, total, and more.",
"createdDateTime": "2021-07-30T00:00:00Z",
"apiVersion": "2024-02-29-preview",
"docTypes": {
"prebuilt:invoice": {
"fieldSchema": {
"CustomerName": {
"type": "string"
},
"CustomerId": {
"type": "string"
},
"PurchaseOrder": {
"type": "string"
},
"InvoiceId": {
"type": "string"
},
"InvoiceDate": {
"type": "date"
},
"DueDate": {
"type": "date"
},
"VendorName": {
"type": "string"
},
"VendorAddress": {
"type": "string"
},
"VendorAddressRecipient": {
"type": "string"
},
"CustomerAddress": {
"type": "string"
},
"CustomerAddressRecipient": {
"type": "string"
},
"BillingAddress": {
"type": "string"
},
"BillingAddressRecipient": {
"type": "string"
},
"ShippingAddress": {
"type": "string"
},
"ShippingAddressRecipient": {
"type": "string"
},
"SubTotal": {
"type": "number"
},
"TotalTax": {
"type": "number"
},
"InvoiceTotal": {
"type": "number"
},
"AmountDue": {
"type": "number"
},
"PreviousUnpaidBalance": {
"type": "number"
},
"RemittanceAddress": {
"type": "string"
},
"RemittanceAddressRecipient": {
"type": "string"
},
"ServiceAddress": {
"type": "string"
},
"ServiceAddressRecipient": {
"type": "string"
},
"ServiceStartDate": {
"type": "date"
},
"ServiceEndDate": {
"type": "date"
},
"Items": {
"type": "array",
"items": {
"type": "object",
"properties": {
"Amount": {
"type": "number"
},
"Date": {
"type": "date"
},
"Description": {
"type": "string"
},
"Quantity": {
"type": "number"
},
"ProductCode": {
"type": "string"
},
"Tax": {
"type": "number"
},
"Unit": {
"type": "string"
},
"UnitPrice": {
"type": "number"
}
}
}
}
}
}
},
"tags": {}
}
Tanımlar
Name | Description |
---|---|
Azure |
İçeriği Azure Blob Depolama. |
Azure |
Azure Blob Depolama dosya listesi. |
Document |
Özel belge modeli derleme modu. |
Document |
JSON Şeması stili söz dizimi kullanan alan anlam şemasının açıklaması. |
Document |
Alan değerinin anlamsal veri türü. |
Document |
Belge modeli bilgileri. |
Document |
Belge türü bilgileri. |
Error |
Hata nesnesi. |
Error |
Hata yanıtı nesnesi. |
Inner |
Hata hakkında daha ayrıntılı bilgi içeren bir nesne. |
Warning |
Hata nesnesi. |
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 |
Belgelerin bir alt kümesini belirten kapsayıcı içindeki JSONL dosyasının yolu. |
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. |
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 |
Her dizi öğesinin alan türü şeması. |
|
properties |
<string,
Document |
Nesne alanının adlandırılmış alt alanları. |
type |
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ı. |
selectionGroup |
string |
Seçili dize değerlerinin dizisi. |
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. |
DocumentModelDetails
Belge modeli bilgileri.
Name | Tür | Description |
---|---|---|
apiVersion |
string |
Bu belge modelini oluşturmak için kullanılan API sürümü. |
azureBlobFileListSource |
Eğitim verilerini belirten dosya listesini Azure Blob Depolama. azureBlobSource veya azureBlobFileListSource belirtilmelidir. |
|
azureBlobSource |
Eğitim verilerini içeren Azure Blob Depolama konum. azureBlobSource veya azureBlobFileListSource belirtilmelidir. |
|
buildMode |
Özel belge modeli derleme modu. |
|
createdDateTime |
string |
Belge modelinin oluşturulduğu tarih ve saat (UTC). |
description |
string |
Belge modeli açıklaması. |
docTypes |
<string,
Document |
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. |
warnings |
Warning[] |
Modeli oluştururken karşılaşılan uyarıların listesi. |
DocumentTypeDetails
Belge türü bilgileri.
Name | Tür | Description |
---|---|---|
buildMode |
Özel belge modeli derleme modu. |
|
description |
string |
Belge modeli açıklaması. |
fieldConfidence |
object |
Her alan için tahmini güvenilirlik. |
fieldSchema |
<string,
Document |
JSON Şeması stil söz dizimi kullanan belge semantik şemasının açıklaması. |
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 hatalarla ilgili ayrıntılar dizisi. |
innererror |
Hatayla ilgili geçerli nesneden daha özel bilgiler içeren bir nesne. |
|
message |
string |
Hatanın insan tarafından okunabilen bir gösterimi. |
target |
string |
Hatanın hedefi. |
ErrorResponse
Hata yanıtı nesnesi.
Name | Tür | Description |
---|---|---|
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 |
İç hata. |
|
message |
string |
Hatanın insan tarafından okunabilen bir gösterimi. |
Warning
Hata nesnesi.
Name | Tür | Description |
---|---|---|
code |
string |
Sunucu tanımlı uyarı kodları kümesinden biri. |
message |
string |
Uyarının insan tarafından okunabilen bir gösterimi. |
target |
string |
Hatanın hedefi. |