Document Models - Analyze Document

Service:

Azure AI Services

API Version:

2024-02-29-preview

Belge modelini kullanarak belgeyi analiz eder.

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

With optional parameters:

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

URI Parametreleri

Name	İçinde	Gerekli	Tür	Description
endpoint	path	True	string	Belge Yönetim Bilgileri hizmeti uç noktası.
modelId	path	True	string	Benzersiz belge modeli adı. Regex pattern: ^[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.
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. Örn. "1-3,5,7-9" Regex pattern: ^(\d+(-\d+)?)(,\s*(\d+(-\d+)?))*$
queryFields	query		string[]	Ayıklanması gereken ek alanların listesi. Örn. "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ı. Headers Operation-Location: string Retry-After: integer
Other Status Codes	ErrorResponse	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

Analyze Document from Base64

Analyze Document from Url

Analyze Document from Base64

Sample Request

HTTP

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

{
  "base64Source": "e2Jhc2U2NEVuY29kZWRQZGZ9"
}

Sample Response

Status code:

202

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

Analyze Document from Url

Sample Request

HTTP

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

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

Sample Response

Status code:

202

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

Tanımlar

Name	Description
AnalyzeDocumentRequest	Belge çözümleme parametreleri.
ContentFormat	Analiz edilen sonuç içindeki içeriğin biçimi.
DocumentAnalysisFeature	İsteğe bağlı analiz özelliklerinin listesi.
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.

ContentFormat

Analiz edilen sonuç içindeki 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

İsteğe bağlı analiz özelliklerinin listesi.

Name	Tür	Description
barcodes	string	Belgedeki barkodların algılanmasını etkinleştirin.
formulas	string	Belgede matematiksel ifadelerin algılanmasını etkinleştirin.
keyValuePairs	string	Belgede genel anahtar değer çiftlerinin (form alanları) algılanmasını etkinleştirin.
languages	string	Metin içerik dilinin algılanmasını etkinleştirin.
ocrHighResolution	string	Belgeleri düzgün 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ıksı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 hatalarla ilgili ayrıntılar dizisi.
innererror	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	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 okunabilen 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 grapheme 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.