Ingestion API (2024-03-01-preview)

The Computer Vision API provides state-of-the-art algorithms to process images and return information. For example, it can be used to determine if an image contains mature content, or it can be used to find all the people in an image. It also has other features like categorizing the content of images, and describing an image with complete English sentences.

CreateIndex

This method creates an index, which can then be used to ingest documents. An index needs to be created before ingestion can be performed.

Select the testing console in the region where you created your resource:

Open API testing console

Request URL

Request parameters

string

The name of the index to be created.

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

The request body containing the metadata that could be used for searching.

{
  "metadataSchema": {
    "fields": [
      {
        "name": "string",
        "searchable": true,
        "filterable": true,
        "type": "string"
      }
    ]
  },
  "features": [
    {
      "name": "vision",
      "modelVersion": "string",
      "domain": "generic"
    }
  ],
  "userData": {}
}
{
  "description": "Represents the create ingestion index request model for the JSON document.",
  "type": "object",
  "properties": {
    "metadataSchema": {
      "description": "Represents the metadata schema for the document.",
      "required": [
        "fields"
      ],
      "type": "object",
      "properties": {
        "fields": {
          "description": "Gets or sets the list of fields in the metadata schema.",
          "type": "array",
          "items": {
            "description": "Represents a field in the metadata schema.",
            "required": [
              "filterable",
              "name",
              "searchable",
              "type"
            ],
            "type": "object",
            "properties": {
              "name": {
                "description": "Gets or sets the name of the field.",
                "maxLength": 36,
                "minLength": 1,
                "type": "string"
              },
              "searchable": {
                "description": "Gets or sets a value indicating whether the field is searchable.",
                "type": "boolean"
              },
              "filterable": {
                "description": "Gets or sets a value indicating whether the field is filterable.",
                "type": "boolean"
              },
              "type": {
                "description": "Gets or sets the type of the field. It could be string or datetime.",
                "enum": [
                  "string",
                  "datetime"
                ],
                "type": "string"
              }
            }
          }
        }
      }
    },
    "features": {
      "description": "Gets or sets the list of features for the document. Default is \"vision\".",
      "type": "array",
      "items": {
        "description": "Represents a feature in the index.",
        "required": [
          "name"
        ],
        "type": "object",
        "properties": {
          "name": {
            "description": "Gets or sets the name of the feature.",
            "enum": [
              "vision",
              "speech",
              "ocr"
            ],
            "type": "string"
          },
          "modelVersion": {
            "description": "Gets or sets the model version of the feature.",
            "type": "string"
          },
          "domain": {
            "description": "Gets or sets the model domain of the feature.",
            "enum": [
              "generic",
              "medical",
              "surveillance",
              "egocentric"
            ],
            "type": "string"
          }
        }
      }
    },
    "userData": {
      "description": "Gets or sets the user data for the document.",
      "type": "object",
      "additionalProperties": {}
    }
  }
}

Response 201

Created

{
  "name": "string",
  "metadataSchema": {
    "fields": [
      {
        "name": "string",
        "searchable": true,
        "filterable": true,
        "type": "string"
      }
    ]
  },
  "userData": {},
  "features": [
    {
      "name": "vision",
      "modelVersion": "string",
      "domain": "generic"
    }
  ],
  "eTag": "string",
  "createdAt": "string",
  "lastModifiedAt": "string"
}
{
  "description": "Represents the get ingestion index response model for the JSON document.",
  "required": [
    "createdAt",
    "eTag",
    "lastModifiedAt"
  ],
  "type": "object",
  "properties": {
    "name": {
      "description": "Gets or sets the index name property.",
      "type": "string"
    },
    "metadataSchema": {
      "description": "Represents the metadata schema for the document.",
      "required": [
        "fields"
      ],
      "type": "object",
      "properties": {
        "fields": {
          "description": "Gets or sets the list of fields in the metadata schema.",
          "type": "array",
          "items": {
            "description": "Represents a field in the metadata schema.",
            "required": [
              "filterable",
              "name",
              "searchable",
              "type"
            ],
            "type": "object",
            "properties": {
              "name": {
                "description": "Gets or sets the name of the field.",
                "maxLength": 36,
                "minLength": 1,
                "type": "string"
              },
              "searchable": {
                "description": "Gets or sets a value indicating whether the field is searchable.",
                "type": "boolean"
              },
              "filterable": {
                "description": "Gets or sets a value indicating whether the field is filterable.",
                "type": "boolean"
              },
              "type": {
                "description": "Gets or sets the type of the field. It could be string or datetime.",
                "enum": [
                  "string",
                  "datetime"
                ],
                "type": "string"
              }
            }
          }
        }
      }
    },
    "userData": {
      "description": "Gets or sets the user data for the document.",
      "type": "object",
      "additionalProperties": {}
    },
    "features": {
      "description": "Gets or sets the list of features in the index.",
      "type": "array",
      "items": {
        "description": "Represents a feature in the index.",
        "required": [
          "name"
        ],
        "type": "object",
        "properties": {
          "name": {
            "description": "Gets or sets the name of the feature.",
            "enum": [
              "vision",
              "speech",
              "ocr"
            ],
            "type": "string"
          },
          "modelVersion": {
            "description": "Gets or sets the model version of the feature.",
            "type": "string"
          },
          "domain": {
            "description": "Gets or sets the model domain of the feature.",
            "enum": [
              "generic",
              "medical",
              "surveillance",
              "egocentric"
            ],
            "type": "string"
          }
        }
      }
    },
    "eTag": {
      "description": "Gets or sets the etag.",
      "type": "string"
    },
    "createdAt": {
      "format": "date-time",
      "description": "Gets or sets the created date and time property.",
      "type": "string"
    },
    "lastModifiedAt": {
      "format": "date-time",
      "description": "Gets or sets the last modified date and time property.",
      "type": "string"
    }
  }
}

Code samples

@ECHO OFF

curl -v -X PUT "https://*.cognitiveservices.azure.com/computervision/retrieval/indexes/{indexName}?api-version=2024-03-01-preview"
-H "Content-Type: application/json-patch+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://*.cognitiveservices.azure.com/computervision/retrieval/indexes/{indexName}?api-version=2024-03-01-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.PutAsync(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://*.cognitiveservices.azure.com/computervision/retrieval/indexes/{indexName}?api-version=2024-03-01-preview");


            URI uri = builder.build();
            HttpPut request = new HttpPut(uri);
            request.setHeader("Content-Type", "application/json-patch+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://*.cognitiveservices.azure.com/computervision/retrieval/indexes/{indexName}?api-version=2024-03-01-preview&" + $.param(params),
            beforeSend: function(xhrObj){
                // Request headers
                xhrObj.setRequestHeader("Content-Type","application/json-patch+json");
                xhrObj.setRequestHeader("Ocp-Apim-Subscription-Key","{subscription key}");
            },
            type: "PUT",
            // 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://*.cognitiveservices.azure.com/computervision/retrieval/indexes/{indexName}?api-version=2024-03-01-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:@"PUT"];
    // Request headers
    [_request setValue:@"application/json-patch+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://*.cognitiveservices.azure.com/computervision/retrieval/indexes/{indexName}?api-version=2024-03-01-preview');
$url = $request->getUrl();

$headers = array(
    // Request headers
    'Content-Type' => 'application/json-patch+json',
    'Ocp-Apim-Subscription-Key' => '{subscription key}',
);

$request->setHeader($headers);

$parameters = array(
    // Request parameters
);

$url->setQueryVariables($parameters);

$request->setMethod(HTTP_Request2::METHOD_PUT);

// 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-patch+json',
    'Ocp-Apim-Subscription-Key': '{subscription key}',
}

params = urllib.urlencode({
})

try:
    conn = httplib.HTTPSConnection('*.cognitiveservices.azure.com')
    conn.request("PUT", "/computervision/retrieval/indexes/{indexName}?api-version=2024-03-01-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-patch+json',
    'Ocp-Apim-Subscription-Key': '{subscription key}',
}

params = urllib.parse.urlencode({
})

try:
    conn = http.client.HTTPSConnection('*.cognitiveservices.azure.com')
    conn.request("PUT", "/computervision/retrieval/indexes/{indexName}?api-version=2024-03-01-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://*.cognitiveservices.azure.com/computervision/retrieval/indexes/{indexName}?api-version=2024-03-01-preview')


request = Net::HTTP::Put.new(uri.request_uri)
# Request headers
request['Content-Type'] = 'application/json-patch+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