Início Rápido: Obter informações de imagens com a API REST da Pesquisa Visual do Bing e C#

Artigo
05/22/2020

Aviso

A 30 de outubro de 2020, as APIs de Pesquisa do Bing passaram dos serviços de IA do Azure para os Serviços Pesquisa do Bing. Esta documentação é fornecida apenas para referência. Para obter documentação atualizada, veja a documentação da API de pesquisa do Bing. Para obter instruções sobre como criar novos recursos do Azure para a pesquisa do Bing, veja Criar um recurso de Pesquisa do Bing através do Azure Marketplace.

Este início rápido demonstra como carregar uma imagem para a API de Pesquisa Visual do Bing e ver as informações que devolve.

Pré-requisitos

Qualquer edição do Visual Studio 2019.
A arquitetura Json.NET, disponível como um pacote NuGet.
Se estiver a utilizar o Linux/MacOS, pode executar esta aplicação com o Mono.

Criar um recurso do Azure

Comece a utilizar a API de Pesquisa Visual do Bing ao criar um dos seguintes recursos do Azure:

Pesquisa do Bing recurso v7

Disponível através do portal do Azure até eliminar o recurso.
Selecione o S9 escalão de preço.

Recurso de vários serviços

Disponível através do portal do Azure até eliminar o recurso.
Utilize a mesma chave e ponto final para as suas aplicações, em vários serviços de IA do Azure.

Criar e inicializar um projeto

No Visual Studio, crie uma nova solução de consola com o nome BingSearchApisQuickStart. Adicione os seguintes espaços de nomes ao ficheiro de código principal:
```
using System;
using System.Text;
using System.Net;
using System.IO;
using System.Collections.Generic;
```
Adicione variáveis para a chave de subscrição, o ponto final e o caminho para a imagem que pretende carregar. Para o uriBase valor, pode utilizar o ponto final global no seguinte código ou utilizar o ponto final de subdomínio personalizado apresentado no portal do Azure do recurso.
```
    const string accessKey = "<my_subscription_key>";
    const string uriBase = "https://api.cognitive.microsoft.com/bing/v7.0/images/visualsearch";
    static string imagePath = @"<path_to_image>";
```

Crie um método com o nome GetImageFileName() para obter o caminho para a sua imagem.

static string GetImageFileName(string path)
        {
            return new FileInfo(path).Name;
        }

Crie um método para obter os dados binários da imagem.

static byte[] GetImageBinary(string path)
{
    return File.ReadAllBytes(path);
}

Criar os dados do formulário

Para carregar uma imagem local, crie primeiro os dados do formulário para enviar para a API. Os dados do formulário incluem o Content-Disposition cabeçalho, o name parâmetro definido como "imagem" e o filename parâmetro definido para o nome de ficheiro da imagem. Os conteúdos do formulário contêm os dados binários da imagem. O tamanho máximo da imagem que pode carregar é de 1 MB.
```
--boundary_1234-abcd
Content-Disposition: form-data; name="image"; filename="myimagefile.jpg"

ÿØÿà JFIF ÖÆ68g-¤CWŸþ29ÌÄøÖ‘º«™æ±èuZiÀ)"óÓß°Î= ØJ9á+*G¦...

--boundary_1234-abcd--
```

Adicione cadeias de limite para formatar os dados do formulário POST. As cadeias de limite determinam os carateres de início, fim e nova linha dos dados.

// Boundary strings for form data in body of POST.
const string CRLF = "\r\n";
static string BoundaryTemplate = "batch_{0}";
static string StartBoundaryTemplate = "--{0}";
static string EndBoundaryTemplate = "--{0}--";

Utilize as seguintes variáveis para adicionar parâmetros aos dados do formulário:

const string CONTENT_TYPE_HEADER_PARAMS = "multipart/form-data; boundary={0}";
const string POST_BODY_DISPOSITION_HEADER = "Content-Disposition: form-data; name=\"image\"; filename=\"{0}\"" + CRLF +CRLF;

Crie uma função com o nome BuildFormDataStart() para criar o início dos dados do formulário com as cadeias de limite e o caminho da imagem.

    static string BuildFormDataStart(string boundary, string filename)
    {
        var startBoundary = string.Format(StartBoundaryTemplate, boundary);

        var requestBody = startBoundary + CRLF;
        requestBody += string.Format(POST_BODY_DISPOSITION_HEADER, filename);

        return requestBody;
    }

Crie uma função com o nome BuildFormDataEnd() para criar o fim dos dados do formulário com as cadeias de limite.

    static string BuildFormDataEnd(string boundary)
    {
        return CRLF + CRLF + string.Format(EndBoundaryTemplate, boundary) + CRLF;
    }

Chamar a API de Pesquisa Visual do Bing

Crie uma função para chamar o ponto final da Pesquisa Visual do Bing e devolver a resposta JSON. A função utiliza o início e o fim dos dados do formulário, uma matriz de bytes que contém os dados da imagem e um contentType valor.
Utilize um WebRequest para armazenar o URI, o valor contentType e os cabeçalhos.

Utilize request.GetRequestStream() para escrever os seus dados de formulário e imagem e, em seguida, obter a resposta. A função deve ser semelhante ao seguinte código:

    static string BingImageSearch(string startFormData, string endFormData, byte[] image, string contentTypeValue)
    {
        WebRequest request = HttpWebRequest.Create(uriBase);
        request.ContentType = contentTypeValue;
        request.Headers["Ocp-Apim-Subscription-Key"] = accessKey;
        request.Method = "POST";

        // Writes the boundary and Content-Disposition header, then writes
        // the image binary, and finishes by writing the closing boundary.
        using (Stream requestStream = request.GetRequestStream())
        {
            StreamWriter writer = new StreamWriter(requestStream);
            writer.Write(startFormData);
            writer.Flush();
            requestStream.Write(image, 0, image.Length);
            writer.Write(endFormData);
            writer.Flush();
            writer.Close();
        }

        HttpWebResponse response = (HttpWebResponse)request.GetResponseAsync().Result;
        string json = new StreamReader(response.GetResponseStream()).ReadToEnd();

        return json;
    }

Criar o método Main

No método da sua aplicação Main() , obtenha o nome de ficheiro e os dados binários da sua imagem.
```
var filename = GetImageFileName(imagePath);
var imageBinary = GetImageBinary(imagePath);
```

Configure o corpo POST formatando o respetivo limite. Em seguida, chame BuildFormDataStart() e BuildFormDataEnd() para criar os dados do formulário.

// Set up POST body.
var boundary = string.Format(BoundaryTemplate, Guid.NewGuid());
var startFormData = BuildFormDataStart(boundary, filename);
var endFormData = BuildFormDataEnd(boundary);

Crie o valor através da ContentType formatação CONTENT_TYPE_HEADER_PARAMS e do limite de dados do formulário.
```
var contentTypeHdrValue = string.Format(CONTENT_TYPE_HEADER_PARAMS, boundary);
```

Obtenha a resposta da API ao chamar BingImageSearch()e, em seguida, imprima a resposta.

var json = BingImageSearch(startFormData, endFormData, imageBinary, contentTypeHdrValue);
Console.WriteLine(json);
Console.WriteLine("enter any key to continue");
Console.readKey();

Utilizar HttpClient

Se utilizar HttpCliento , pode utilizar a MultipartFormDataContent classe para criar os dados do formulário. Utilize as seguintes secções de código para substituir os métodos correspondentes no exemplo anterior:

Substitua o método Main() pelo código abaixo:

        static void Main()
        {
            try
            {
                Console.OutputEncoding = System.Text.Encoding.UTF8;

                if (accessKey.Length == 32)
                {
                    if (IsImagePathSet(imagePath))
                    {
                        var filename = GetImageFileName(imagePath);
                        Console.WriteLine("Getting image insights for image: " + filename);
                        var imageBinary = GetImageBinary(imagePath);

                        var boundary = string.Format(BoundaryTemplate, Guid.NewGuid());
                        var json = BingImageSearch(imageBinary, boundary, uriBase, accessKey);

                        Console.WriteLine("\nJSON Response:\n");
                        Console.WriteLine(JsonPrettyPrint(json));
                    }
                }
                else
                {
                    Console.WriteLine("Invalid Bing Visual Search API subscription key!");
                    Console.WriteLine("Please paste yours into the source code.");
                }

                Console.Write("\nPress Enter to exit ");
                Console.ReadLine();
            }
            catch (Exception e)
            {
                Console.WriteLine(e.Message);
            }
        }

Substitua o método BingImageSearch() pelo código abaixo:

        /// <summary>
        /// Calls the Bing visual search endpoint and returns the JSON response.
        /// </summary>
        static string BingImageSearch(byte[] image, string boundary, string uri, string subscriptionKey)
        {
            var requestMessage = new HttpRequestMessage(HttpMethod.Post, uri);
            requestMessage.Headers.Add("Ocp-Apim-Subscription-Key", accessKey);

            var content = new MultipartFormDataContent(boundary);
            content.Add(new ByteArrayContent(image), "image", "myimage");
            requestMessage.Content = content;

            var httpClient = new HttpClient();

            Task<HttpResponseMessage> httpRequest = httpClient.SendAsync(requestMessage, HttpCompletionOption.ResponseContentRead, CancellationToken.None);
            HttpResponseMessage httpResponse = httpRequest.Result;
            HttpStatusCode statusCode = httpResponse.StatusCode;
            HttpContent responseContent = httpResponse.Content;

            string json = null;

            if (responseContent != null)
            {
                Task<String> stringContentsTask = responseContent.ReadAsStringAsync();
                json = stringContentsTask.Result;
            }

            return json;
        }

Passos seguintes

Criar uma aplicação Web de página única da Pesquisa Visual

Partilhar via