Skip to content

Commit bfe7f38

Browse files
authored
Update read.md
1 parent 28be008 commit bfe7f38

File tree

1 file changed

+147
-2
lines changed
  • articles/ai-services/document-intelligence/prebuilt

1 file changed

+147
-2
lines changed

articles/ai-services/document-intelligence/prebuilt/read.md

Lines changed: 147 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -105,7 +105,7 @@ To use searchable PDF, make a `POST` request using the `Analyze` operation and s
105105

106106
```bash
107107

108-
POST /documentModels/prebuilt-read:analyze?output=pdf
108+
POST {endpoint}/documentintelligence/documentModels/prebuilt-read:analyze?_overload=analyzeDocument&api-version=2024-11-30&output=pdf
109109
{...}
110110
202
111111
```
@@ -122,7 +122,152 @@ Upon successful completion, the PDF can be retrieved and downloaded as `applicat
122122
{...}
123123

124124
// Upon successful completion, retrieve the PDF as application/pdf.
125-
GET /documentModels/prebuilt-read/analyzeResults/{resultId}/pdf
125+
GET {endpoint}/documentintelligence/documentModels/prebuilt-read/analyzeResults/{resultId}/pdf?api-version=2024-11-30
126+
URI Parameters
127+
Name In Required Type Description
128+
endpoint path True
129+
string
130+
131+
uri
132+
The Document Intelligence service endpoint.
133+
134+
modelId path True
135+
string
136+
137+
Unique document model name.
138+
139+
Regex pattern: ^[a-zA-Z0-9][a-zA-Z0-9._~-]{1,63}$
140+
141+
resultId path True
142+
string
143+
144+
uuid
145+
Analyze operation result ID.
146+
147+
api-version query True
148+
string
149+
150+
The API version to use for this operation.
151+
152+
Responses
153+
Name Type Description
154+
200 OK
155+
file
156+
157+
The request has succeeded.
158+
159+
Media Types: "application/pdf", "application/json"
160+
161+
Other Status Codes
162+
DocumentIntelligenceErrorResponse
163+
164+
An unexpected error response.
165+
166+
Media Types: "application/pdf", "application/json"
167+
168+
Security
169+
Ocp-Apim-Subscription-Key
170+
Type: apiKey
171+
In: header
172+
173+
OAuth2Auth
174+
Type: oauth2
175+
Flow: accessCode
176+
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize
177+
Token URL: https://login.microsoftonline.com/common/oauth2/token
178+
179+
Scopes
180+
Name Description
181+
https://cognitiveservices.azure.com/.default
182+
Examples
183+
Get Analyze Document Result PDF
184+
Sample request
185+
HTTP
186+
HTTP
187+
188+
Copy
189+
GET https://myendpoint.cognitiveservices.azure.com/documentintelligence/documentModels/prebuilt-invoice/analyzeResults/3b31320d-8bab-4f88-b19c-2322a7f11034/pdf?api-version=2024-11-30
190+
Sample response
191+
Status code:
192+
200
193+
JSON
194+
195+
Copy
196+
"{pdfBinary}"
197+
Definitions
198+
Name Description
199+
DocumentIntelligenceError
200+
The error object.
201+
202+
DocumentIntelligenceErrorResponse
203+
Error response object.
204+
205+
DocumentIntelligenceInnerError
206+
An object containing more specific information about the error.
207+
208+
DocumentIntelligenceError
209+
The error object.
210+
211+
Name Type Description
212+
code
213+
string
214+
215+
One of a server-defined set of error codes.
216+
217+
details
218+
DocumentIntelligenceError[]
219+
220+
An array of details about specific errors that led to this reported error.
221+
222+
innererror
223+
DocumentIntelligenceInnerError
224+
225+
An object containing more specific information than the current object about the error.
226+
227+
message
228+
string
229+
230+
A human-readable representation of the error.
231+
232+
target
233+
string
234+
235+
The target of the error.
236+
237+
DocumentIntelligenceErrorResponse
238+
Error response object.
239+
240+
Name Type Description
241+
error
242+
DocumentIntelligenceError
243+
244+
Error info.
245+
246+
DocumentIntelligenceInnerError
247+
An object containing more specific information about the error.
248+
249+
Name Type Description
250+
code
251+
string
252+
253+
One of a server-defined set of error codes.
254+
255+
innererror
256+
DocumentIntelligenceInnerError
257+
258+
Inner error.
259+
260+
message
261+
string
262+
263+
A human-readable representation of the error.
264+
265+
In this article
266+
URI Parameters
267+
Responses
268+
Security
269+
Examples
270+
126271
200 OK
127272
Content-Type: application/pdf
128273
```

0 commit comments

Comments
 (0)