Document Models - Analyze Document

Hizmet:

Azure AI Services

API Sürümü:

2024-07-31-preview

Belgeyi belge modeliyle analiz eder.

POST {endpoint}/documentintelligence/documentModels/{modelId}:analyze?_overload=analyzeDocument&api-version=2024-07-31-preview

İsteğe bağlı parametrelerle:

POST {endpoint}/documentintelligence/documentModels/{modelId}:analyze?_overload=analyzeDocument&api-version=2024-07-31-preview&pages={pages}&locale={locale}&stringIndexType={stringIndexType}&features={features}&queryFields={queryFields}&outputContentFormat={outputContentFormat}&output={output}

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}$
api-version	query	True	string	Bu işlem için kullanılacak API sürümü.
features	query		DocumentAnalysisFeature[]	İsteğe bağlı analiz özelliklerinin listesi.
locale	query		string	Metin tanıma ve belge analizi için yerel ayar ipucu. Değer yalnızca dil kodunu (örn. "en", "fr") veya BCP 47 dil etiketini ("en-US") içerebilir.
output	query		AnalyzeOutputOption[]	Analiz sırasında oluşturulacak ek çıkışlar.
outputContentFormat	query		ContentFormat	Analiz sonucu üst düzey içeriğinin biçimi.
pages	query		string	Analiz etmek için 1 tabanlı sayfa numaralarının listesi. Ex. "1-3,5,7-9" Normal ifade deseni: ^(\d+(-\d+)?)(,\s*(\d+(-\d+)?))*$
queryFields	query		string[]	Ayıklanması gereken ek alanların listesi. Ex. "NumberOfGuests,StoreNumber"
stringIndexType	query		StringIndexType	Dize uzaklığını ve uzunluğunu hesaplamak için kullanılan yöntem.

İstek Gövdesi

Name	Tür	Description
base64Source	string	Analiz için belgenin Base64 kodlaması. urlSource veya base64Source belirtilmelidir.
urlSource	string	Analiz için belge URL'si. urlSource veya base64Source belirtilmelidir.

Yanıtlar

Name	Tür	Description
202 Accepted		İstek işleme için kabul edildi, ancak işleme henüz tamamlanmadı. Üst Bilgiler Operation-Location: string Retry-After: integer
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

Analyze Document from Base64

Analyze Document from Url

Analyze Document from Base64

Örnek isteği

HTTP

POST https://myendpoint.cognitiveservices.azure.com/documentintelligence/documentModels/prebuilt-layout:analyze?_overload=analyzeDocument&api-version=2024-07-31-preview&pages=1-2,4&locale=en-US&stringIndexType=textElements

{
  "base64Source": "e2Jhc2U2NEVuY29kZWRQZGZ9"
}

Örnek yanıt

Durum kodu:

202

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

Analyze Document from Url

Örnek isteği

HTTP

POST https://myendpoint.cognitiveservices.azure.com/documentintelligence/documentModels/customModel:analyze?_overload=analyzeDocument&api-version=2024-07-31-preview&pages=1-2,4&locale=en-US&stringIndexType=textElements

{
  "urlSource": "http://host.com/doc.pdf"
}

Örnek yanıt

Durum kodu:

202

Operation-Location: https://myendpoint.cognitiveservices.azure.com/documentintelligence/documentModels/customModel/analyzeResults/3b31320d-8bab-4f88-b19c-2322a7f11034?api-version=2024-07-31-preview

Tanımlar

Name	Description
AnalyzeDocumentRequest	Belge çözümleme parametreleri.
AnalyzeOutputOption	Analiz sırasında oluşturulacak ek çıkışlar.
ContentFormat	Analiz edilen sonuçtaki içeriğin biçimi.
DocumentAnalysisFeature	Etkinleştirecek belge çözümleme özellikleri.
Error	Hata nesnesi.
ErrorResponse	Hata yanıtı nesnesi.
InnerError	Hata hakkında daha ayrıntılı bilgi içeren bir nesne.
StringIndexType	Dize uzaklığını ve uzunluğunu hesaplamak için kullanılan yöntem.

AnalyzeDocumentRequest

Belge çözümleme parametreleri.

Name	Tür	Description
base64Source	string	Analiz için belgenin Base64 kodlaması. urlSource veya base64Source belirtilmelidir.
urlSource	string	Analiz için belge URL'si. urlSource veya base64Source belirtilmelidir.

AnalyzeOutputOption

Analiz sırasında oluşturulacak ek çıkışlar.

Name	Tür	Description
figures	string	Algılanan rakamların kırpılan görüntülerini oluşturun.
pdf	string	Aranabilir PDF çıktısı oluşturun.

ContentFormat

Analiz edilen sonuçtaki içeriğin biçimi.

Name	Tür	Description
markdown	string	Bölüm başlıkları, tablolar vb. içeren belge içeriğinin Markdown gösterimi.
text	string	Herhangi bir biçimlendirme olmadan belge içeriğinin düz metin gösterimi.

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.

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.

StringIndexType

Dize uzaklığını ve uzunluğunu hesaplamak için kullanılan yöntem.

Name	Tür	Description
textElements	string	Kullanıcı tarafından algılanan görüntüleme karakteri veya Unicode 8.0.0 tarafından tanımlanan grafeme kümesi.
unicodeCodePoint	string	Tek bir unicode kod noktasıyla temsil edilen karakter birimi. Python 3 tarafından kullanılır.
utf16CodeUnit	string	16 bit Unicode kod birimiyle temsil edilen karakter birimi. JavaScript, Java ve .NET tarafından kullanılır.