Document Models - Analyze Document
Belge modelini kullanarak belgeyi analiz eder.
POST {endpoint}/documentintelligence/documentModels/{modelId}:analyze?_overload=analyzeDocument&api-version=2024-02-29-preview
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 hizmet 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ü. |
features
|
query |
İ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 ("en", "fr") veya BCP 47 dil etiketini ("en-US") içerebilir. |
|
output
|
query |
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: |
|
query
|
query |
string[] |
Ayıklanması gereken ek alanların listesi. Örn. "NumberOfGuests,StoreNumber" |
|
string
|
query |
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şlenmek üzere kabul edildi, ancak işleme henüz tamamlanmadı. Headers
|
|
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
Analyze Document from Base64 |
Analyze Document from Url |
Analyze Document from Base64
Sample Request
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
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
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
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 |
---|---|
Analyze |
Belge çözümleme parametreleri. |
Content |
Analiz edilen sonuç içindeki içeriğin biçimi. |
Document |
İsteğe bağlı analiz özelliklerinin listesi. |
Error |
Hata nesnesi. |
Error |
Hata yanıtı nesnesi. |
Inner |
Hata hakkında daha ayrıntılı bilgi içeren bir nesne. |
String |
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 |
Belge içeriğinin biçimlendirme olmadan düz metin gösterimi. |
DocumentAnalysisFeature
İsteğe bağlı analiz özelliklerinin listesi.
Name | Tür | Description |
---|---|---|
barcodes |
string |
Belgede barkod algılamayı etkinleştirin. |
formulas |
string |
Belgede matematiksel ifadelerin algılanması için etkinleştirme. |
keyValuePairs |
string |
Belgede genel anahtar değer çiftlerini (form alanları) algılamayı etkinleştirin. |
languages |
string |
Metin içerik dilini algılamayı etkinleştirin. |
ocrHighResolution |
string |
Belgeleri düzgün yazdırarak 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 bir dizi ayrıntı. |
innererror |
Hatayla ilgili geçerli nesneden daha belirli bilgiler içeren bir nesne. |
|
message |
string |
Hatanın insanlar tarafından okunabilir 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 insanlar 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 |
Unicode 8.0.0 tarafından tanımlandığı gibi kullanıcı tarafından algılanan görüntüleme karakteri veya 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. |