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.

SearchByText

Performs a text-based search on the specified index.

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 search.

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 query and other parameters.

{
  "queryText": "string",
  "filters": {
    "stringFilters": [
      {
        "fieldName": "string",
        "values": [
          "string"
        ]
      }
    ],
    "datetimeFilters": [
      {
        "fieldName": "string",
        "startTime": "string",
        "endTime": "string"
      }
    ],
    "featureFilters": [
      "vision"
    ]
  },
  "moderation": true,
  "top": 0,
  "skip": 0,
  "additionalIndexNames": [
    "string"
  ],
  "disableMetadataSearch": true
}
{
  "description": "Represents a search query request model for text-based search.",
  "required": [
    "disableMetadataSearch",
    "queryText",
    "skip"
  ],
  "type": "object",
  "properties": {
    "queryText": {
      "description": "Gets or sets the query text.",
      "minLength": 1,
      "type": "string"
    },
    "filters": {
      "description": "Represents the filters to apply on a search query.",
      "type": "object",
      "properties": {
        "stringFilters": {
          "description": "Gets or sets the string filters to apply on the search query.",
          "type": "array",
          "items": {
            "description": "Represents a string filter to apply on a search query.",
            "required": [
              "fieldName",
              "values"
            ],
            "type": "object",
            "properties": {
              "fieldName": {
                "description": "Gets or sets the name of the field to filter on.",
                "maxLength": 36,
                "minLength": 1,
                "type": "string"
              },
              "values": {
                "description": "Gets or sets the values to filter on.",
                "type": "array",
                "items": {
                  "type": "string"
                }
              }
            }
          }
        },
        "datetimeFilters": {
          "description": "Gets or sets the datetime filters to apply on the search query.",
          "type": "array",
          "items": {
            "description": "Represents a datetime filter to apply on a search query.",
            "required": [
              "fieldName"
            ],
            "type": "object",
            "properties": {
              "fieldName": {
                "description": "Gets or sets the name of the field to filter on.",
                "maxLength": 36,
                "minLength": 1,
                "type": "string"
              },
              "startTime": {
                "description": "Gets or sets the start time of the range to filter on.",
                "type": "string"
              },
              "endTime": {
                "description": "Gets or sets the end time of the range to filter on.",
                "type": "string"
              }
            }
          }
        },
        "featureFilters": {
          "description": "Gets or sets the feature filters to apply on the search query.",
          "type": "array",
          "items": {
            "enum": [
              "vision",
              "speech",
              "ocr"
            ],
            "type": "string"
          }
        }
      }
    },
    "moderation": {
      "description": "Gets or sets a boolean value indicating whether the moderation is enabled or disabled.",
      "type": "boolean"
    },
    "top": {
      "format": "int32",
      "description": "Gets or sets the number of results to retrieve.",
      "minimum": 1,
      "type": "integer"
    },
    "skip": {
      "format": "int32",
      "description": "Gets or sets the number of results to skip.",
      "minimum": 0,
      "type": "integer"
    },
    "additionalIndexNames": {
      "description": "Gets or sets the additional index names to include in the search query.",
      "type": "array",
      "items": {
        "type": "string"
      }
    },
    "disableMetadataSearch": {
      "description": "Gets or sets a boolean value indicating whether metadata is disabled in the search or not.",
      "type": "boolean"
    }
  }
}

Response 200

Success

{
  "value": [
    {
      "documentId": "string",
      "documentKind": "string",
      "start": "string",
      "end": "string",
      "best": "string",
      "confidence": 0.0,
      "additionalMetadata": {}
    }
  ],
  "nextLink": "string"
}
{
  "description": "Contains an array of results that may be paginated.",
  "required": [
    "value"
  ],
  "type": "object",
  "properties": {
    "value": {
      "description": "The array of results.",
      "type": "array",
      "items": {
        "description": "Represents a search query response.",
        "required": [
          "confidence"
        ],
        "type": "object",
        "properties": {
          "documentId": {
            "description": "Gets or sets the ID of the document.",
            "type": "string"
          },
          "documentKind": {
            "description": "Gets or sets the kind of the document.",
            "type": "string"
          },
          "start": {
            "description": "Gets or sets the start time of the document. This property is only applicable for video documents.",
            "type": "string"
          },
          "end": {
            "description": "Gets or sets the end time of the document. This property is only applicable for video documents.",
            "type": "string"
          },
          "best": {
            "description": "Gets or sets the timestamp of the document with highest relevance score. This property is only applicable for video documents.",
            "type": "string"
          },
          "confidence": {
            "format": "double",
            "description": "Gets or sets the confidence score of the document.",
            "type": "number"
          },
          "additionalMetadata": {
            "description": "Gets or sets the additional metadata related to search.",
            "type": "object",
            "additionalProperties": {}
          }
        }
      }
    },
    "nextLink": {
      "description": "A link to the next set of paginated results, if there are more results available; not present otherwise.",
      "type": "string"
    }
  }
}

Response 500

Error

Code samples

@ECHO OFF

curl -v -X POST "https://norwayeast.api.cognitive.microsoft.com/computervision/retrieval/indexes/{indexName}:queryByText?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://norwayeast.api.cognitive.microsoft.com/computervision/retrieval/indexes/{indexName}:queryByText?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.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://norwayeast.api.cognitive.microsoft.com/computervision/retrieval/indexes/{indexName}:queryByText?api-version=2024-03-01-preview");


            URI uri = builder.build();
            HttpPost request = new HttpPost(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://norwayeast.api.cognitive.microsoft.com/computervision/retrieval/indexes/{indexName}:queryByText?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: "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://norwayeast.api.cognitive.microsoft.com/computervision/retrieval/indexes/{indexName}:queryByText?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:@"POST"];
    // 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://norwayeast.api.cognitive.microsoft.com/computervision/retrieval/indexes/{indexName}:queryByText?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_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-patch+json',
    'Ocp-Apim-Subscription-Key': '{subscription key}',
}

params = urllib.urlencode({
})

try:
    conn = httplib.HTTPSConnection('norwayeast.api.cognitive.microsoft.com')
    conn.request("POST", "/computervision/retrieval/indexes/{indexName}:queryByText?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('norwayeast.api.cognitive.microsoft.com')
    conn.request("POST", "/computervision/retrieval/indexes/{indexName}:queryByText?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://norwayeast.api.cognitive.microsoft.com/computervision/retrieval/indexes/{indexName}:queryByText?api-version=2024-03-01-preview')


request = Net::HTTP::Post.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