Exemplo: Criar uma habilidade personalizada usando a API de Pesquisa de Entidade do Bing
Neste exemplo, saiba como criar uma habilidade personalizada de API da Web. Essa habilidade aceitará locais, figuras públicas e organizações, e retornará descrições para eles. O exemplo usa uma Função do Azure para encapsular a API de Pesquisa de Entidade do Bing para que ela implemente a interface de habilidade personalizada.
Pré-requisitos
Leia o artigo sobre interface de habilidade personalizada se você não estiver familiarizado com a interface de entrada/saída que uma habilidade personalizada deve implementar.
Crie um recurso de Pesquisa do Bing através do portal do Azure. Um nível gratuito está disponível e é suficiente para este exemplo.
Instale o Visual Studio ou posterior.
Criar uma Função do Azure
Embora este exemplo use uma Função do Azure para hospedar uma API Web, ele não é necessário. Contanto que você atenda aos requisitos de interface para uma habilidade cognitiva, a abordagem que você adota é imaterial. No entanto, o Azure Functions facilita a criação de uma habilidade personalizada.
Criar um projeto
No Visual Studio, selecione Novo Projeto no menu Arquivo>.
Escolha Azure Functions como modelo e selecione Avançar. Digite um nome para seu projeto e selecione Criar. O nome do aplicativo de função deve ser válido como um namespace C#, portanto, não use sublinhados, hífenes ou quaisquer outros caracteres não alfanuméricos.
Selecione uma estrutura que tenha suporte a longo prazo.
Escolha HTTP Trigger para o tipo de função a ser adicionada ao projeto.
Escolha Função para o nível de autorização.
Selecione Criar para criar o projeto de função e a função acionada por HTTP.
Adicionar código para chamar a API de Entidade do Bing
Visual Studio cria um projeto com código clichê para o tipo de função escolhido. O atributo FunctionName nos conjuntos define o nome da função. O atributo HttpTrigger especifica que a função é acionada por um pedido de HTTP.
Substitua o conteúdo do Function1.cs pelo seguinte código:
using System;
using System.Collections.Generic;
using System.IO;
using System.Linq;
using System.Net.Http;
using System.Threading.Tasks;
using Microsoft.AspNetCore.Mvc;
using Microsoft.Azure.WebJobs;
using Microsoft.Azure.WebJobs.Extensions.Http;
using Microsoft.AspNetCore.Http;
using Microsoft.Extensions.Logging;
using Newtonsoft.Json;
namespace SampleSkills
{
/// <summary>
/// Sample custom skill that wraps the Bing entity search API to connect it with a
/// AI enrichment pipeline.
/// </summary>
public static class BingEntitySearch
{
#region Credentials
// IMPORTANT: Make sure to enter your credential and to verify the API endpoint matches yours.
static readonly string bingApiEndpoint = "https://api.bing.microsoft.com/v7.0/entities";
static readonly string key = "<enter your api key here>";
#endregion
#region Class used to deserialize the request
private class InputRecord
{
public class InputRecordData
{
public string Name { get; set; }
}
public string RecordId { get; set; }
public InputRecordData Data { get; set; }
}
private class WebApiRequest
{
public List<InputRecord> Values { get; set; }
}
#endregion
#region Classes used to serialize the response
private class OutputRecord
{
public class OutputRecordData
{
public string Name { get; set; } = "";
public string Description { get; set; } = "";
public string Source { get; set; } = "";
public string SourceUrl { get; set; } = "";
public string LicenseAttribution { get; set; } = "";
public string LicenseUrl { get; set; } = "";
}
public class OutputRecordMessage
{
public string Message { get; set; }
}
public string RecordId { get; set; }
public OutputRecordData Data { get; set; }
public List<OutputRecordMessage> Errors { get; set; }
public List<OutputRecordMessage> Warnings { get; set; }
}
private class WebApiResponse
{
public List<OutputRecord> Values { get; set; }
}
#endregion
#region Classes used to interact with the Bing API
private class BingResponse
{
public BingEntities Entities { get; set; }
}
private class BingEntities
{
public BingEntity[] Value { get; set; }
}
private class BingEntity
{
public class EntityPresentationinfo
{
public string[] EntityTypeHints { get; set; }
}
public class License
{
public string Url { get; set; }
}
public class ContractualRule
{
public string _type { get; set; }
public License License { get; set; }
public string LicenseNotice { get; set; }
public string Text { get; set; }
public string Url { get; set; }
}
public ContractualRule[] ContractualRules { get; set; }
public string Description { get; set; }
public string Name { get; set; }
public EntityPresentationinfo EntityPresentationInfo { get; set; }
}
#endregion
#region The Azure Function definition
[FunctionName("EntitySearch")]
public static async Task<IActionResult> Run(
[HttpTrigger(AuthorizationLevel.Function, "post", Route = null)] HttpRequest req,
ILogger log)
{
log.LogInformation("Entity Search function: C# HTTP trigger function processed a request.");
var response = new WebApiResponse
{
Values = new List<OutputRecord>()
};
string requestBody = new StreamReader(req.Body).ReadToEnd();
var data = JsonConvert.DeserializeObject<WebApiRequest>(requestBody);
// Do some schema validation
if (data == null)
{
return new BadRequestObjectResult("The request schema does not match expected schema.");
}
if (data.Values == null)
{
return new BadRequestObjectResult("The request schema does not match expected schema. Could not find values array.");
}
// Calculate the response for each value.
foreach (var record in data.Values)
{
if (record == null || record.RecordId == null) continue;
OutputRecord responseRecord = new OutputRecord
{
RecordId = record.RecordId
};
try
{
responseRecord.Data = GetEntityMetadata(record.Data.Name).Result;
}
catch (Exception e)
{
// Something bad happened, log the issue.
var error = new OutputRecord.OutputRecordMessage
{
Message = e.Message
};
responseRecord.Errors = new List<OutputRecord.OutputRecordMessage>
{
error
};
}
finally
{
response.Values.Add(responseRecord);
}
}
return (ActionResult)new OkObjectResult(response);
}
#endregion
#region Methods to call the Bing API
/// <summary>
/// Gets metadata for a particular entity based on its name using Bing Entity Search
/// </summary>
/// <param name="entityName">The name of the entity to extract data for.</param>
/// <returns>Asynchronous task that returns entity data. </returns>
private async static Task<OutputRecord.OutputRecordData> GetEntityMetadata(string entityName)
{
var uri = bingApiEndpoint + "?q=" + entityName + "&mkt=en-us&count=10&offset=0&safesearch=Moderate";
var result = new OutputRecord.OutputRecordData();
using (var client = new HttpClient())
using (var request = new HttpRequestMessage {
Method = HttpMethod.Get,
RequestUri = new Uri(uri)
})
{
request.Headers.Add("Ocp-Apim-Subscription-Key", key);
HttpResponseMessage response = await client.SendAsync(request);
string responseBody = await response?.Content?.ReadAsStringAsync();
BingResponse bingResult = JsonConvert.DeserializeObject<BingResponse>(responseBody);
if (bingResult != null)
{
// In addition to the list of entities that could match the name, for simplicity let's return information
// for the top match as additional metadata at the root object.
return AddTopEntityMetadata(bingResult.Entities?.Value);
}
}
return result;
}
private static OutputRecord.OutputRecordData AddTopEntityMetadata(BingEntity[] entities)
{
if (entities != null)
{
foreach (BingEntity entity in entities.Where(
entity => entity?.EntityPresentationInfo?.EntityTypeHints != null
&& (entity.EntityPresentationInfo.EntityTypeHints[0] == "Person"
|| entity.EntityPresentationInfo.EntityTypeHints[0] == "Organization"
|| entity.EntityPresentationInfo.EntityTypeHints[0] == "Location")
&& !String.IsNullOrEmpty(entity.Description)))
{
var rootObject = new OutputRecord.OutputRecordData
{
Description = entity.Description,
Name = entity.Name
};
if (entity.ContractualRules != null)
{
foreach (var rule in entity.ContractualRules)
{
switch (rule._type)
{
case "ContractualRules/LicenseAttribution":
rootObject.LicenseAttribution = rule.LicenseNotice;
rootObject.LicenseUrl = rule.License.Url;
break;
case "ContractualRules/LinkAttribution":
rootObject.Source = rule.Text;
rootObject.SourceUrl = rule.Url;
break;
}
}
}
return rootObject;
}
}
return new OutputRecord.OutputRecordData();
}
#endregion
}
}
Certifique-se de inserir seu próprio valor de key chave na constante com base na chave que você obteve ao se inscrever na API de pesquisa de entidade do Bing.
Testar a função do Visual Studio
Pressione F5 para executar o programa e testar comportamentos de função. Neste caso, usaremos a função abaixo para procurar duas entidades. Use um cliente REST para emitir uma chamada como a mostrada abaixo:
POST https://localhost:7071/api/EntitySearch
Corpo do pedido
{
"values": [
{
"recordId": "e1",
"data":
{
"name": "Pablo Picasso"
}
},
{
"recordId": "e2",
"data":
{
"name": "Microsoft"
}
}
]
}
Resposta
Você verá uma resposta semelhante ao exemplo a seguir:
{
"values": [
{
"recordId": "e1",
"data": {
"name": "Pablo Picasso",
"description": "Pablo Ruiz Picasso was a Spanish painter [...]",
"source": "Wikipedia",
"sourceUrl": "http://en.wikipedia.org/wiki/Pablo_Picasso",
"licenseAttribution": "Text under CC-BY-SA license",
"licenseUrl": "http://creativecommons.org/licenses/by-sa/3.0/"
},
"errors": null,
"warnings": null
},
"..."
]
}
Publicar a função no Azure
Quando estiver satisfeito com o comportamento da função, você poderá publicá-la.
No Explorador de Soluções, clique com o botão direito do rato no projeto e selecione Publicar. Escolha Criar nova>publicação.
Se ainda não tiver associado o Visual Studio à sua conta do Azure, selecione Adicionar uma conta....
Siga as instruções no ecrã. Você é solicitado a especificar um nome exclusivo para seu serviço de aplicativo, a assinatura do Azure, o grupo de recursos, o plano de hospedagem e a conta de armazenamento que deseja usar. Você pode criar um novo grupo de recursos, um novo plano de hospedagem e uma conta de armazenamento, se ainda não tiver esses recursos. Quando terminar, selecione Criar
Após a conclusão da implantação, observe a URL do site. É o endereço do seu aplicativo de função no Azure.
No portal do Azure, navegue até o Grupo de Recursos e procure a
EntitySearchFunção que você publicou. Na seção Gerenciar, você verá Chaves de host. Selecione o ícone Copiar para a chave de host padrão .
Testar a função no Azure
Agora que você tem a chave de host padrão, teste sua função da seguinte maneira:
POST https://[your-entity-search-app-name].azurewebsites.net/api/EntitySearch?code=[enter default host key here]
Corpo do Pedido
{
"values": [
{
"recordId": "e1",
"data":
{
"name": "Pablo Picasso"
}
},
{
"recordId": "e2",
"data":
{
"name": "Microsoft"
}
}
]
}
Este exemplo deve produzir o mesmo resultado que você viu anteriormente ao executar a função no ambiente local.
Conecte-se ao seu pipeline
Agora que você tem uma nova habilidade personalizada, você pode adicioná-la ao seu conjunto de habilidades. O exemplo abaixo mostra como chamar a habilidade para adicionar descrições às organizações no documento (isso pode ser estendido para também trabalhar em locais e pessoas). Substitua [your-entity-search-app-name] pelo nome do seu aplicativo.
{
"skills": [
"[... your existing skills remain here]",
{
"@odata.type": "#Microsoft.Skills.Custom.WebApiSkill",
"description": "Our new Bing entity search custom skill",
"uri": "https://[your-entity-search-app-name].azurewebsites.net/api/EntitySearch?code=[enter default host key here]",
"context": "/document/merged_content/organizations/*",
"inputs": [
{
"name": "name",
"source": "/document/merged_content/organizations/*"
}
],
"outputs": [
{
"name": "description",
"targetName": "description"
}
]
}
]
}
Aqui, contamos com a habilidade de reconhecimento de entidades embutida para estar presente no conjunto de habilidades e ter enriquecido o documento com a lista de organizações. Para referência, aqui está uma configuração de habilidade de extração de entidade que seria suficiente para gerar os dados de que precisamos:
{
"@odata.type": "#Microsoft.Skills.Text.V3.EntityRecognitionSkill",
"name": "#1",
"description": "Organization name extraction",
"context": "/document/merged_content",
"categories": [ "Organization" ],
"defaultLanguageCode": "en",
"inputs": [
{
"name": "text",
"source": "/document/merged_content"
},
{
"name": "languageCode",
"source": "/document/language"
}
],
"outputs": [
{
"name": "organizations",
"targetName": "organizations"
}
]
},
Próximos passos
Parabéns! Você criou sua primeira habilidade personalizada. Agora você pode seguir o mesmo padrão para adicionar sua própria funcionalidade personalizada. Clique nos links a seguir para saber mais.