Azure AI Document Intelligence 2023-10-31-preview
Azure AI Document Intelligence extracts information from forms and images into structured data. It includes the following options:
- Read - Extract text from documents.
- Layout - Extract text and layout information from documents.
- ID Document - Extract key information from passports and ID cards.
- Invoice - Extract key information from invoices.
- Receipt - Extract key information from receipts.
- Health Insurance Card - Extract key information from US health insurance cards.
- IRS Form W-2 - Extract key information from IRS US W2 tax forms (year 2018-current).
- IRS Form 1098 - Extract key information from United States Internal Revenue Service Form 1098 (2021-current).
- IRS Form 1098-E - Extract key information from United States Internal Revenue Service Form 1098-E (2021-current).
- IRS Form 1098-T - Extract key information from United States Internal Revenue Service Form 1098-T (2021-current).
- Contract - Extract key information from legal contracts.
- Custom - Extracts information from forms (PDFs and images) into structured data based on a model created from a set of representative training forms. Azure AI Document Intelligence learns the structure of your forms to intelligently extract text and data. It ingests text from forms, applies machine learning technology to identify keys, tables, and fields, and then outputs structured data that includes the relationships within the original file.
Chat - Complete chat
Complete a chat request.
Select the testing console in the region where you created your resource:
Open API testing consoleRequest URL
Request parameters
string
Format - [a-zA-Z0-9][a-zA-Z0-9._~-]{1,63}. Unique chat name.
Request headers
string
Media type of the body sent to the API.
string
Subscription key which provides access to this API. Found in your Cognitive Services accounts.
Request body
{
"messages": [
{
"role": "user",
"content": "describe this document"
}
]
}
{
"description": "Complete chat request parameters.",
"type": "object",
"required": [
"messages"
],
"properties": {
"message": {
"description": "Chat message.",
"type": "object",
"required": [
"role",
"content"
],
"properties": {
"role": {
"description": "Role of the chat message.",
"type": "string"
},
"content": {
"description": "Chat message content.",
"type": "string"
},
"citations": {
"description": "List of citations mentioned in message.",
"type": "array",
"items": {
"description": "Citation mention.",
"type": "object",
"required": [
"label",
"content"
],
"properties": {
"label": {
"description": "Display label for the citation.",
"type": "string"
},
"content": {
"description": "Snippet of cited text.",
"type": "string"
},
"filePath": {
"description": "Relative path of cited file. Omitted for single file index.",
"type": "string"
},
"boundingRegions": {
"description": "Bounding regions covering the cited text.",
"type": "array",
"items": {
"description": "Bounding polygon on a specific page of the input.",
"type": "object",
"required": [
"pageNumber",
"polygon"
],
"properties": {
"pageNumber": {
"description": "1-based page number of page containing the bounding region.",
"type": "integer",
"format": "int32",
"minimum": 1
},
"polygon": {
"description": "Bounding polygon, with coordinates specified relative to the top-left of the page. The numbers represent the x, y values of the polygon vertices, clockwise from the left (-180 degrees inclusive) relative to the element orientation.",
"type": "array",
"items": {
"type": "number",
"minimum": 0
}
}
}
}
}
}
}
}
}
}
}
}
Response 200
OK.
{
"TODO": "..."
}
{
"description": "Complete chat request parameters.",
"type": "object",
"required": [
"messages"
],
"properties": {
"message": {
"description": "Chat message.",
"type": "object",
"required": [
"role",
"content"
],
"properties": {
"role": {
"description": "Role of the chat message.",
"type": "string"
},
"content": {
"description": "Chat message content.",
"type": "string"
},
"citations": {
"description": "List of citations mentioned in message.",
"type": "array",
"items": {
"description": "Citation mention.",
"type": "object",
"required": [
"label",
"content"
],
"properties": {
"label": {
"description": "Display label for the citation.",
"type": "string"
},
"content": {
"description": "Snippet of cited text.",
"type": "string"
},
"filePath": {
"description": "Relative path of cited file. Omitted for single file index.",
"type": "string"
},
"boundingRegions": {
"description": "Bounding regions covering the cited text.",
"type": "array",
"items": {
"description": "Bounding polygon on a specific page of the input.",
"type": "object",
"required": [
"pageNumber",
"polygon"
],
"properties": {
"pageNumber": {
"description": "1-based page number of page containing the bounding region.",
"type": "integer",
"format": "int32",
"minimum": 1
},
"polygon": {
"description": "Bounding polygon, with coordinates specified relative to the top-left of the page. The numbers represent the x, y values of the polygon vertices, clockwise from the left (-180 degrees inclusive) relative to the element orientation.",
"type": "array",
"items": {
"type": "number",
"minimum": 0
}
}
}
}
}
}
}
}
}
}
}
}
Code samples
@ECHO OFF
curl -v -X POST "https://westus.api.cognitive.microsoft.com/documentintelligence/chat/{chatId}:complete?api-version=2023-10-31-preview"
-H "Content-Type: application/json"
-H "Ocp-Apim-Subscription-Key: {subscription key}"
--data-ascii "{body}"
using System;
using System.Net.Http.Headers;
using System.Text;
using System.Net.Http;
using System.Web;
namespace CSHttpClientSample
{
static class Program
{
static void Main()
{
MakeRequest();
Console.WriteLine("Hit ENTER to exit...");
Console.ReadLine();
}
static async void MakeRequest()
{
var client = new HttpClient();
var queryString = HttpUtility.ParseQueryString(string.Empty);
// Request headers
client.DefaultRequestHeaders.Add("Ocp-Apim-Subscription-Key", "{subscription key}");
var uri = "https://westus.api.cognitive.microsoft.com/documentintelligence/chat/{chatId}:complete?api-version=2023-10-31-preview&" + queryString;
HttpResponseMessage response;
// Request body
byte[] byteData = Encoding.UTF8.GetBytes("{body}");
using (var content = new ByteArrayContent(byteData))
{
content.Headers.ContentType = new MediaTypeHeaderValue("< your content type, i.e. application/json >");
response = await client.PostAsync(uri, content);
}
}
}
}
// // This sample uses the Apache HTTP client from HTTP Components (http://hc.apache.org/httpcomponents-client-ga/)
import java.net.URI;
import org.apache.http.HttpEntity;
import org.apache.http.HttpResponse;
import org.apache.http.client.HttpClient;
import org.apache.http.client.methods.HttpGet;
import org.apache.http.client.utils.URIBuilder;
import org.apache.http.impl.client.HttpClients;
import org.apache.http.util.EntityUtils;
public class JavaSample
{
public static void main(String[] args)
{
HttpClient httpclient = HttpClients.createDefault();
try
{
URIBuilder builder = new URIBuilder("https://westus.api.cognitive.microsoft.com/documentintelligence/chat/{chatId}:complete?api-version=2023-10-31-preview");
URI uri = builder.build();
HttpPost request = new HttpPost(uri);
request.setHeader("Content-Type", "application/json");
request.setHeader("Ocp-Apim-Subscription-Key", "{subscription key}");
// Request body
StringEntity reqEntity = new StringEntity("{body}");
request.setEntity(reqEntity);
HttpResponse response = httpclient.execute(request);
HttpEntity entity = response.getEntity();
if (entity != null)
{
System.out.println(EntityUtils.toString(entity));
}
}
catch (Exception e)
{
System.out.println(e.getMessage());
}
}
}
<!DOCTYPE html>
<html>
<head>
<title>JSSample</title>
<script src="http://ajax.googleapis.com/ajax/libs/jquery/1.9.0/jquery.min.js"></script>
</head>
<body>
<script type="text/javascript">
$(function() {
var params = {
// Request parameters
};
$.ajax({
url: "https://westus.api.cognitive.microsoft.com/documentintelligence/chat/{chatId}:complete?api-version=2023-10-31-preview&" + $.param(params),
beforeSend: function(xhrObj){
// Request headers
xhrObj.setRequestHeader("Content-Type","application/json");
xhrObj.setRequestHeader("Ocp-Apim-Subscription-Key","{subscription key}");
},
type: "POST",
// Request body
data: "{body}",
})
.done(function(data) {
alert("success");
})
.fail(function() {
alert("error");
});
});
</script>
</body>
</html>
#import <Foundation/Foundation.h>
int main(int argc, const char * argv[])
{
NSAutoreleasePool * pool = [[NSAutoreleasePool alloc] init];
NSString* path = @"https://westus.api.cognitive.microsoft.com/documentintelligence/chat/{chatId}:complete?api-version=2023-10-31-preview";
NSArray* array = @[
// Request parameters
@"entities=true",
];
NSString* string = [array componentsJoinedByString:@"&"];
path = [path stringByAppendingFormat:@"?%@", string];
NSLog(@"%@", path);
NSMutableURLRequest* _request = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:path]];
[_request setHTTPMethod:@"POST"];
// Request headers
[_request setValue:@"application/json" forHTTPHeaderField:@"Content-Type"];
[_request setValue:@"{subscription key}" forHTTPHeaderField:@"Ocp-Apim-Subscription-Key"];
// Request body
[_request setHTTPBody:[@"{body}" dataUsingEncoding:NSUTF8StringEncoding]];
NSURLResponse *response = nil;
NSError *error = nil;
NSData* _connectionData = [NSURLConnection sendSynchronousRequest:_request returningResponse:&response error:&error];
if (nil != error)
{
NSLog(@"Error: %@", error);
}
else
{
NSError* error = nil;
NSMutableDictionary* json = nil;
NSString* dataString = [[NSString alloc] initWithData:_connectionData encoding:NSUTF8StringEncoding];
NSLog(@"%@", dataString);
if (nil != _connectionData)
{
json = [NSJSONSerialization JSONObjectWithData:_connectionData options:NSJSONReadingMutableContainers error:&error];
}
if (error || !json)
{
NSLog(@"Could not parse loaded json with error:%@", error);
}
NSLog(@"%@", json);
_connectionData = nil;
}
[pool drain];
return 0;
}
<?php
// This sample uses the Apache HTTP client from HTTP Components (http://hc.apache.org/httpcomponents-client-ga/)
require_once 'HTTP/Request2.php';
$request = new Http_Request2('https://westus.api.cognitive.microsoft.com/documentintelligence/chat/{chatId}:complete?api-version=2023-10-31-preview');
$url = $request->getUrl();
$headers = array(
// Request headers
'Content-Type' => 'application/json',
'Ocp-Apim-Subscription-Key' => '{subscription key}',
);
$request->setHeader($headers);
$parameters = array(
// Request parameters
);
$url->setQueryVariables($parameters);
$request->setMethod(HTTP_Request2::METHOD_POST);
// Request body
$request->setBody("{body}");
try
{
$response = $request->send();
echo $response->getBody();
}
catch (HttpException $ex)
{
echo $ex;
}
?>
########### Python 2.7 #############
import httplib, urllib, base64
headers = {
# Request headers
'Content-Type': 'application/json',
'Ocp-Apim-Subscription-Key': '{subscription key}',
}
params = urllib.urlencode({
})
try:
conn = httplib.HTTPSConnection('westus.api.cognitive.microsoft.com')
conn.request("POST", "/documentintelligence/chat/{chatId}:complete?api-version=2023-10-31-preview&%s" % params, "{body}", headers)
response = conn.getresponse()
data = response.read()
print(data)
conn.close()
except Exception as e:
print("[Errno {0}] {1}".format(e.errno, e.strerror))
####################################
########### Python 3.2 #############
import http.client, urllib.request, urllib.parse, urllib.error, base64
headers = {
# Request headers
'Content-Type': 'application/json',
'Ocp-Apim-Subscription-Key': '{subscription key}',
}
params = urllib.parse.urlencode({
})
try:
conn = http.client.HTTPSConnection('westus.api.cognitive.microsoft.com')
conn.request("POST", "/documentintelligence/chat/{chatId}:complete?api-version=2023-10-31-preview&%s" % params, "{body}", headers)
response = conn.getresponse()
data = response.read()
print(data)
conn.close()
except Exception as e:
print("[Errno {0}] {1}".format(e.errno, e.strerror))
####################################
require 'net/http'
uri = URI('https://westus.api.cognitive.microsoft.com/documentintelligence/chat/{chatId}:complete?api-version=2023-10-31-preview')
uri.query = URI.encode_www_form({
})
request = Net::HTTP::Post.new(uri.request_uri)
# Request headers
request['Content-Type'] = 'application/json'
# Request headers
request['Ocp-Apim-Subscription-Key'] = '{subscription key}'
# Request body
request.body = "{body}"
response = Net::HTTP.start(uri.host, uri.port, :use_ssl => uri.scheme == 'https') do |http|
http.request(request)
end
puts response.body