範例:使用 Bing 實體搜尋 API 建立自定義技能
在此範例中,瞭解如何建立 Web API 自定義技能。 此技能將接受位置、公用數位和組織,並傳回其描述。 此範例會使用 Azure 函 式來包裝 Bing 實體搜尋 API ,以便實作自定義技能介面。
必要條件
透過 Azure 入口網站 建立 Bing 搜尋資源。 免費層可供使用,且足以供此範例使用。
安裝 Visual Studio 或更新版本。
建立 Azure 函式
雖然此範例會使用 Azure 函式來裝載 Web API,但並非必要。 只要您符合認知技能的介面需求,您採取的方法就不重要。 不過,Azure Functions 可讓您輕鬆地建立自定義技能。
建立專案
在 Visual Studio 中,從 [檔案] 選單中選取 [新增>專案]。
選擇 [Azure Functions ] 作為範本,然後選取 [ 下一步]。 輸入專案的名稱,然後選取 [ 建立]。 函式應用程式名稱必須是 C# 命名空間的有效名稱,因此請勿使用底線、連字元或任何其他非英數位元。
選取具有長期支持的架構。
針對要新增至專案的函式類型,選擇 [HTTP 觸發 程式]。
選擇 授權層級的 [函 式]。
選取 [建立 ] 以建立函式專案和 HTTP 觸發的函式。
新增程式代碼以呼叫 Bing 實體 API
Visual Studio 會為所選函式類型建立具有重複使用程式碼的專案。 方法 上的 FunctionName 屬性會設定函式的名稱。 HttpTrigger 屬性會指定函式是由 HTTP 要求觸發。
以下列程式代碼取代Function1.cs的內容:
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
}
}
請務必根據註冊 Bing 實體搜尋 API 時取得的金鑰,在常數中key
輸入您自己的金鑰值。
從 Visual Studio 測試函式
按 F5 執行程式和測試函式行為。 在此情況下,我們將使用下列函式來查閱兩個實體。 使用 REST 用戶端發出呼叫,如下所示:
POST https://localhost:7071/api/EntitySearch
要求本文
{
"values": [
{
"recordId": "e1",
"data":
{
"name": "Pablo Picasso"
}
},
{
"recordId": "e2",
"data":
{
"name": "Microsoft"
}
}
]
}
回應
您應該會看到類似下列範例的回應:
{
"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
},
"..."
]
}
將函式發佈至 Azure
當您滿意函式行為時,您可以發佈它。
在 [方案總管] 中,以滑鼠右鍵按一下專案並選取 [發行]。 選擇 [建立新的>發佈]。
如果您尚未將 Visual Studio 連線到 Azure 帳戶,請選取 [ 新增帳戶...]。
遵循畫面上的提示。 系統會要求您指定應用程式服務、Azure 訂用帳戶、資源群組、主控方案和您想要使用的記憶體帳戶的唯一名稱。 如果您還沒有這些資源群組,您可以建立新的資源群組、新的主控方案和儲存體帳戶。 完成後,選取 [ 建立]
部署完成之後,請注意網站 URL。 這是 Azure 中函式應用程式的位址。
在 Azure 入口網站 中,流覽至 [資源群組],然後尋找
EntitySearch
您發佈的函式。 在 [ 管理] 區段底下,您應該會看到主機密鑰。 選取預設主機金鑰的 [複製] 圖示。
在 Azure 中測試函式
現在您已擁有預設主機金鑰,請測試您的函式,如下所示:
POST https://[your-entity-search-app-name].azurewebsites.net/api/EntitySearch?code=[enter default host key here]
要求本文
{
"values": [
{
"recordId": "e1",
"data":
{
"name": "Pablo Picasso"
}
},
{
"recordId": "e2",
"data":
{
"name": "Microsoft"
}
}
]
}
此範例應該會產生您在本機環境中執行函式時先前看到的相同結果。
連線 至管線
現在您已擁有新的自定義技能,您可以將它新增至您的技能集。 下列範例示範如何呼叫技能,將描述新增至檔中的組織(這可以延伸為也適用於位置和人員)。 將取代 [your-entity-search-app-name]
為您應用程式的名稱。
{
"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"
}
]
}
]
}
在這裡,我們將仰賴內建 實體辨識技能 ,以在技能集中呈現,並透過組織清單來擴充檔。 如需參考,以下是產生我們需要數據的實體擷取技能組態:
{
"@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"
}
]
},
下一步
恭喜! 您已建立第一個自定義技能。 現在您可以遵循相同的模式來新增自己的自定義功能。 按兩下列連結以深入瞭解。