快速入门:使用必应图像搜索 API 和 Java 搜索图像
警告
2020 年 10 月 30 日,必应搜索 API 从 Azure AI 服务迁移到必应搜索服务。 本文档仅供参考。 有关更新的文档,请参阅必应搜索 API 文档。 关于为必应搜索创建新的 Azure 资源的说明,请参阅通过 Azure 市场创建必应搜索资源。
在 Azure AI 服务中使用本快速入门了解如何向必应图像搜索 API 发送搜索请求。 此 Java 应用程序会向 API 发送搜索查询,并在结果中显示第一个图像的 URL。 虽然此应用程序是使用 Java 编写的,但 API 是一种 RESTful Web 服务,与大多数编程语言兼容。
先决条件
创建并初始化项目
在你最喜欢的 IDE 或编辑器中新建一个 Java 项目,并导入以下库:
import java.net.*; import java.util.*; import java.io.*; import javax.net.ssl.HttpsURLConnection; import com.google.gson.Gson; import com.google.gson.GsonBuilder; import com.google.gson.JsonObject; import com.google.gson.JsonParser;
为 API 终结点、订阅密钥和搜索词创建变量。 对于
host
,你可以使用以下代码中的全局终结点,或者使用资源的 Azure 门户中显示的自定义子域终结点。static String subscriptionKey = "enter key here"; static String host = "https://api.cognitive.microsoft.com"; static String path = "/bing/v7.0/images/search"; static String searchTerm = "tropical ocean";
构造搜索请求和查询
使用前一个步骤中的变量来设置 API 请求的搜索 URL 的格式。 在将搜索词追加到请求之前,先对其进行 URL 编码。
// construct the search request URL (in the form of endpoint + query string)
URL url = new URL(host + path + "?q=" + URLEncoder.encode(searchQuery, "UTF-8"));
HttpsURLConnection connection = (HttpsURLConnection)url.openConnection();
connection.setRequestProperty("Ocp-Apim-Subscription-Key", subscriptionKey);
接收和处理 JSON 响应
接收来自必应图像搜索 API 的 JSON 响应,并构建结果对象。
// receive JSON body InputStream stream = connection.getInputStream(); String response = new Scanner(stream).useDelimiter("\\A").next(); // construct result object for return SearchResults results = new SearchResults(new HashMap<String, String>(), response);
从 JSON 正文中分离与必应相关的 HTTP 标头。
// extract Bing-related HTTP headers Map<String, List<String>> headers = connection.getHeaderFields(); for (String header : headers.keySet()) { if (header == null) continue; // may have null key if (header.startsWith("BingAPIs-") || header.startsWith("X-MSEdge-")) { results.relevantHeaders.put(header, headers.get(header).get(0)); } }
关闭流,然后分析响应。 获取返回的搜索结果总数和第一个图像结果的缩略图 URL。
stream.close(); JsonParser parser = new JsonParser(); JsonObject json = parser.parse(result.jsonResponse).getAsJsonObject(); //get the first image result from the JSON object, along with the total //number of images returned by the Bing Image Search API. String total = json.get("totalEstimatedMatches").getAsString(); JsonArray results = json.getAsJsonArray("value"); JsonObject first_result = (JsonObject)results.get(0); String resultURL = first_result.get("thumbnailUrl").getAsString();
示例 JSON 响应
来自必应图像搜索 API 的响应以 JSON 形式返回。 此示例响应已截断,仅显示了单个结果。
{
"_type":"Images",
"instrumentation":{
"_type":"ResponseInstrumentation"
},
"readLink":"images\/search?q=tropical ocean",
"webSearchUrl":"https:\/\/www.bing.com\/images\/search?q=tropical ocean&FORM=OIIARP",
"totalEstimatedMatches":842,
"nextOffset":47,
"value":[
{
"webSearchUrl":"https:\/\/www.bing.com\/images\/search?view=detailv2&FORM=OIIRPO&q=tropical+ocean&id=8607ACDACB243BDEA7E1EF78127DA931E680E3A5&simid=608027248313960152",
"name":"My Life in the Ocean | The greatest WordPress.com site in ...",
"thumbnailUrl":"https:\/\/tse3.mm.bing.net\/th?id=OIP.fmwSKKmKpmZtJiBDps1kLAHaEo&pid=Api",
"datePublished":"2017-11-03T08:51:00.0000000Z",
"contentUrl":"https:\/\/mylifeintheocean.files.wordpress.com\/2012\/11\/tropical-ocean-wallpaper-1920x12003.jpg",
"hostPageUrl":"https:\/\/mylifeintheocean.wordpress.com\/",
"contentSize":"897388 B",
"encodingFormat":"jpeg",
"hostPageDisplayUrl":"https:\/\/mylifeintheocean.wordpress.com",
"width":1920,
"height":1200,
"thumbnail":{
"width":474,
"height":296
},
"imageInsightsToken":"ccid_fmwSKKmK*mid_8607ACDACB243BDEA7E1EF78127DA931E680E3A5*simid_608027248313960152*thid_OIP.fmwSKKmKpmZtJiBDps1kLAHaEo",
"insightsMetadata":{
"recipeSourcesCount":0,
"bestRepresentativeQuery":{
"text":"Tropical Beaches Desktop Wallpaper",
"displayText":"Tropical Beaches Desktop Wallpaper",
"webSearchUrl":"https:\/\/www.bing.com\/images\/search?q=Tropical+Beaches+Desktop+Wallpaper&id=8607ACDACB243BDEA7E1EF78127DA931E680E3A5&FORM=IDBQDM"
},
"pagesIncludingCount":115,
"availableSizesCount":44
},
"imageId":"8607ACDACB243BDEA7E1EF78127DA931E680E3A5",
"accentColor":"0050B2"
}]
}