Document Models - Get Model

Başvuru

Hizmet:: Azure AI Services

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

Ayrıntılı belge modeli bilgilerini alır.

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

URI Parametreleri

Name İçinde Gerekli Tür Description

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}$`
api-version	query	True	string	Bu işlem için kullanılacak API sürümü.

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}$

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	DocumentModelDetails	İstek başarılı oldu. Üst Bilgiler x-ms-client-request-id: string
Other Status Codes	ErrorResponse	Beklenmeyen bir hata yanıtı.

Name

Tür

Description

200 OK

DocumentModelDetails

İstek başarılı oldu.

Üst Bilgiler

x-ms-client-request-id: string

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 Custom Document Model

Get Prebuilt Document Model

Get Custom Document Model

Örnek isteği

HTTP

GET https://myendpoint.cognitiveservices.azure.com/documentintelligence/documentModels/myCustomModel?api-version=2024-07-31-preview

Örnek yanıt

Durum kodu:: 200

{
  "modelId": "myCustomModel",
  "description": "Custom model description",
  "createdDateTime": "2021-09-24T12:54:35Z",
  "expirationDateTime": "2023-01-01T00:00:00Z",
  "apiVersion": "2024-07-31-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

Örnek isteği

HTTP

GET https://myendpoint.cognitiveservices.azure.com/documentintelligence/documentModels/prebuilt-invoice?api-version=2024-07-31-preview

Örnek yanıt

Durum kodu:: 200

{
  "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-07-31-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
AzureBlobContentSource	Azure Blob Depolama içeriği.
AzureBlobFileListContentSource	Azure Blob Depolama'daki dosya listesi.
DocumentAnalysisFeature	Etkinleştirecek belge çözümleme özellikleri.
DocumentBuildMode	Özel belge modeli derleme modu.
DocumentFieldSchema	JSON Şeması stili söz dizimi kullanılarak alan anlam şemasının açıklaması.
DocumentFieldType	Alan değerinin anlamsal veri türü.
DocumentModelDetails	Belge modeli bilgileri.
DocumentTypeDetails	Belge türü bilgileri.
Error	Hata nesnesi.
ErrorResponse	Hata yanıtı nesnesi.
InnerError	Hata hakkında daha ayrıntılı bilgi içeren bir nesne.
SplitMode	Dosya bölme davranışı.
Warning	Hata nesnesi.

AzureBlobContentSource

Azure Blob Depolama içeriği.

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

AzureBlobFileListContentSource

Azure Blob Depolama'daki dosya listesi.

Name	Tür	Description
containerUrl	string	Azure Blob Depolama kapsayıcı URL'si.
fileList	string	Belgelerin alt kümesini belirten kapsayıcı içindeki bir JSONL dosyasının yolu.

DocumentAnalysisFeature

Etkinleştirecek belge çözümleme özellikleri.

Name	Tür	Description
barcodes	string	Belgedeki barkodların algılanması özelliğini etkinleştirin.
formulas	string	Belgedeki matematiksel ifadelerin algılanması özelliğini etkinleştirin.
keyValuePairs	string	Belgede genel anahtar değer çiftlerinin (form alanları) algısını etkinleştirin.
languages	string	Metin içerik dilini algılamayı etkinleştirin.
ocrHighResolution	string	Belgeleri ince yazdırmayla işlemek için daha yüksek çözünürlükte OCR gerçekleştirin.
queryFields	string	queryFields sorgu parametresi aracılığıyla ek alanların ayıkını etkinleştirin.
styleFont	string	Çeşitli yazı tipi stillerinin tanınmasını etkinleştirin.

DocumentBuildMode

Özel belge modeli derleme modu.

Name	Tür	Description
generative	string	Üretken yapay zeka tekniklerini kullanarak tüm türlerdeki belgeleri etkinleştirin.
neural	string	Çeşitli görsel şablonları olan belgeleri destekleyin.
template	string	Benzer görsel şablonlara sahip belgeleri hedefle.

DocumentFieldSchema

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

Alan değerinin anlamsal veri türü.

Name	Tür	Description
address	string	Ayrıştırılan adres.
array	string	Aynı türdeki alt alanlar 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-MM-DD) biçiminde 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	Farklı olabilecek türlerin alt alanlarının adlandırılmış listesi.
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:mm:ss) biçiminde normalleştirilmiş zaman.

DocumentModelDetails

Belge modeli bilgileri.

Name	Tür	Default value	Description
apiVersion	string		Bu belge modelini oluşturmak için kullanılan API sürümü.
azureBlobFileListSource	AzureBlobFileListContentSource		Eğitim verilerini belirten Azure Blob Depolama dosya listesi. azureBlobSource veya azureBlobFileListSource belirtilmelidir.
azureBlobSource	AzureBlobContentSource		Eğitim verilerini içeren Azure Blob Depolama konumu. azureBlobSource veya azureBlobFileListSource belirtilmelidir.
buildMode	DocumentBuildMode		Özel belge modeli derleme modu.
classifierId	string		Oluşturulan modeller için, giriş dosyasını bölmek ve sınıflandırmak için özel sınıflandırıcı.
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ı.
split	SplitMode	none	Oluşturulan modeller için dosya bölme davranışı.
tags	object		Belge modeliyle ilişkili anahtar-değer etiketi özniteliklerinin listesi.
trainingHours	number		Model eğitimi için tüketilen V100 eşdeğer GPU saatlerinin sayısı.
warnings	Warning[]		Modeli oluştururken karşılaşılan uyarıların listesi.

DocumentTypeDetails

Belge türü bilgileri.

Name	Tür	Description
buildMode	DocumentBuildMode	Özel belge modeli derleme modu.
confidenceThreshold	number	Yalnızca docType güvenilirliği eşiğin üzerindeyse analiz gerçekleştirin.
description	string	Belge modeli açıklaması.
features	DocumentAnalysisFeature[]	İsteğe bağlı analiz özelliklerinin listesi.
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ı.
maxDocumentsToAnalyze	integer	Analiz etmek için belirtilen türde belge sayısı üst sınırı. Default=all.
modelId	string	Belirtilen türe sahip belgeleri analiz etmek için kullanılacak belge modeli.
queryFields	string[]	Ayıklanması gereken ek alanların listesi. Ex. "NumberOfGuests,StoreNumber"

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.

SplitMode

Dosya bölme davranışı.

Name	Tür	Description
auto	string	Dosyayı otomatik olarak belgelere bölün.
none	string	Dosyanın tamamını tek bir belge olarak değerlendirin.
perPage	string	Dosyadaki her sayfayı ayrı bir belge olarak ele alın.

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 okunabilir bir gösterimi.
target	string	Hatanın hedefi.

Aracılığıyla paylaş

Document Models - Get Model

URI Parametreleri

İstek Başlığı

Yanıtlar

Güvenlik

Ocp-Apim-Subscription-Key

OAuth2Auth

Kapsamlar

Örnekler

Get Custom Document Model

Örnek isteği

Örnek yanıt

Get Prebuilt Document Model

Örnek isteği

Örnek yanıt

Tanımlar

AzureBlobContentSource

AzureBlobFileListContentSource

DocumentAnalysisFeature

DocumentBuildMode

DocumentFieldSchema

DocumentFieldType

DocumentModelDetails

DocumentTypeDetails

Error

ErrorResponse

InnerError

SplitMode

Warning

Ek kaynaklar