ภาพรวมการค้นหา

ภาพรวม
- เอกสารประกอบของ Search API
ข้อควรพิจารณาด้านความปลอดภัย
การกรองขั้นสูง

ภาพรวม

Freebase Search API ให้การเข้าถึงข้อมูล Freebase จากการค้นหาข้อความฟรี ผลการค้นหาจะเรียงลําดับและมีคะแนนความเกี่ยวข้องเป็นตัวเลข

นักพัฒนาซอฟต์แวร์สามารถใช้ตัวกรองเพื่อจํากัดผลการค้นหากับข้อมูลบางประเภทได้ ดูข้อมูลเพิ่มเติมเกี่ยวกับวิธีสร้างคําค้นหาโดยละเอียดได้ในตําราค้นหาการค้นหา

ตัวอย่างวิธีที่นักพัฒนาซอฟต์แวร์อาจต้องการใช้ Search API มีดังนี้

เอนทิตีที่แนะนําอัตโนมัติ (เช่น วิดเจ็ตแนะนํา Freebase)
รับข้อมูลรายชื่อเอนทิตีที่มีการจัดอันดับมากที่สุดและมีชื่อตามการจัดอันดับ
การค้นหาเอนทิตีโดยใช้ Search Metaschema

ตัวอย่างโค้ดต่อไปนี้ในหลายภาษาที่รองรับจะแสดงวิธีการค้นหาศิลปินเพลงที่ตรงกับข้อความ "Cee Lo Green" ข้อจํากัดเพิ่มเติมคือครีเอเตอร์สร้างเนื้อหาที่เรียกว่า "The Lady Killer"

Python

import json
import urllib

api_key = open(".api_key").read()
query = 'blue bottle'
service_url = 'https://www.googleapis.com/freebase/v1/search'
params = {
 'query': query,
 'key': api_key
}
url = service_url + '?' + urllib.urlencode(params)
response = json.loads(urllib.urlopen(url).read())
for result in response['result']:
  print(result['name'] + ' (' + str(result['score']) + ')')

Ruby

require 'rubygems'
require 'cgi'
require 'httparty'
require 'json'
require 'addressable/uri'

API_KEY = open(".freebase_api_key").read()
url = Addressable::URI.parse('https://www.googleapis.com/freebase/v1/search')
url.query_values = {
	'query' => 'Blue Bottle',
	'key'=> API_KEY
}
response = HTTParty.get(url, :format => :json)
response['result'].each { |topic|
  puts topic['name']
}

ตัวอย่างนี้ใช้ไลบรารี Httparty และ Addressable

Java

package com.freebase.samples;

import com.google.api.client.http.GenericUrl;
import com.google.api.client.http.HttpRequest;
import com.google.api.client.http.HttpRequestFactory;
import com.google.api.client.http.HttpResponse;
import com.google.api.client.http.HttpTransport;
import com.google.api.client.http.javanet.NetHttpTransport;
import com.jayway.jsonpath.JsonPath;
import java.io.FileInputStream;
import java.util.Properties;
import org.json.simple.JSONArray;
import org.json.simple.JSONObject;
import org.json.simple.parser.JSONParser;

public class SearchExample {
  public static Properties properties = new Properties();
  public static void main(String[] args) {
    try {
      properties.load(new FileInputStream("freebase.properties"));
      HttpTransport httpTransport = new NetHttpTransport();
      HttpRequestFactory requestFactory = httpTransport.createRequestFactory();
      JSONParser parser = new JSONParser();
      GenericUrl url = new GenericUrl("https://www.googleapis.com/freebase/v1/search");
      url.put("query", "Cee Lo Green");
      url.put("filter", "(all type:/music/artist created:\"The Lady Killer\")");
      url.put("limit", "10");
      url.put("indent", "true");
      url.put("key", properties.get("API_KEY"));
      HttpRequest request = requestFactory.buildGetRequest(url);
      HttpResponse httpResponse = request.execute();
      JSONObject response = (JSONObject)parser.parse(httpResponse.parseAsString());
      JSONArray results = (JSONArray)response.get("result");
      for (Object result : results) {
        System.out.println(JsonPath.read(result,"$.name").toString());
      }
    } catch (Exception ex) {
      ex.printStackTrace();
    }
  }
}

JavaScript

<!DOCTYPE html>
<html>
<head>
    <script src="https://www.gstatic.com/external_hosted/jquery2.min.js"></script>
</head>
<body><aside class="warning"><strong>Warning: </strong>The Freebase API will be retired on June 30,
  2015.</aside>
<script>
  var service_url = 'https://www.googleapis.com/freebase/v1/search';
  var params = {
    'query': 'Cee Lo Green',
    'filter': '(all type:/music/artist created:"The Lady Killer")',
    'limit': 10,
    'indent': true
  };
  $.getJSON(service_url + '?callback=?', params).done(function(response) {
    $.each(response.result, function(i, result) {
      $('<div>', {text:result['name']}).appendTo(document.body);
    });
  });
</script>
</body>
</html>

ตัวอย่างนี้ใช้ไลบรารี jQuery

PHP

<!DOCTYPE html>
<html>
<body>
<?php
  include('.freebase-api-key');
  $service_url = 'https://www.googleapis.com/freebase/v1/search';
  $params = array(
    'query' => 'Blue Bottle',
    'key' => $freebase_api_key
  );
  $url = $service_url . '?' . http_build_query($params);
  $ch = curl_init();
  curl_setopt($ch, CURLOPT_URL, $url);
  curl_setopt($ch, CURLOPT_RETURNTRANSFER, 1);
  $response = json_decode(curl_exec($ch), true);
  curl_close($ch);
  foreach($response['result'] as $result) {
    echo $result['name'] . '<br/>';
  }
?>
</body>
</html>

นอกจากนี้ โปรดดูหน้าไลบรารีของไคลเอ็นต์เพื่อดูว่าระบบรองรับภาษาที่คุณชื่นชอบหรือไม่

เอกสารประกอบของ Search API

โปรดดูเอกสารประกอบต่อไปนี้

โปรดดูรายละเอียดเกี่ยวกับวิธีใช้ API ในเอกสารอ้างอิงในการค้นหา
ดูข้อมูลเพิ่มเติมเกี่ยวกับวิธีสร้างคําค้นหาโดยละเอียดได้ในตําราค้นหาการค้นหา
ดูข้อมูลเกี่ยวกับวิธีอธิบายความสัมพันธ์ระหว่างเอนทิตีกับพร็อพเพอร์ตี้ในเอกสาร Search Metaschema

ข้อควรพิจารณาด้านความปลอดภัย

Search API จะจัดทําดัชนีและค้นหาเนื้อหาที่ผู้ใช้สร้างซึ่งสร้างในกราฟ Freebase ซึ่งหมายความว่าคุณจะใช้เนื้อหาในหน้าเว็บโดยตรงไม่ได้หากไม่ได้ Escape เนื้อหาก่อน

โปรดดูข้อมูลเพิ่มเติมที่การเริ่มต้นใช้งาน: ความปลอดภัย

การกรองขั้นสูง

Search API รองรับข้อจํากัดตัวกรองจํานวนมากเพื่อให้ค้นหาได้ง่ายขึ้นในเอนทิตีที่ถูกต้อง

เช่น เมื่อใช้ข้อจํากัดตัวกรอง ""type" เราสามารถแสดงรายชื่อผู้คนที่โดดเด่นที่สุดใน Freebase ได้

filter=(any type:/people/person)

ข้อจํากัดของตัวกรองยอมรับอินพุตที่หลากหลาย ดังนี้

รหัสที่มนุษย์อ่านได้สําหรับเอนทิตีหรือผู้ใช้สคีมา เช่น
- /people/person สําหรับข้อจํากัดประเภท
- /film สําหรับข้อจํากัดของโดเมน
MID ของ Freebase เช่น
- /m/01g317 สําหรับข้อจํากัดประเภท /people/person เดียวกัน
- /m/010s สําหรับข้อจํากัดโดเมน /film ข้างต้น
ชื่อเอนทิตี เช่น
- "person" สําหรับข้อจํากัดประเภท /people/person ที่มีความแม่นยําน้อยกว่า
- "film" สําหรับข้อจํากัดของโดเมน /film ที่มีความแม่นยําน้อยกว่า

ข้อจํากัดของตัวกรองอาจแบ่งออกเป็น 2-3 หมวดหมู่ ดูรายละเอียดเพิ่มเติมในตําราอาหารสําหรับการค้นหา

คุณสามารถรวมข้อจํากัดของตัวกรองและทําซ้ําข้อจํากัดใน SearchRequest ได้โดยตรงโดยไม่เสียค่าใช้จ่าย พารามิเตอร์ข้อจํากัดด้านตัวกรองที่รวมกันเข้าด้วยกันเป็นคําค้นหา "หรือ" ระบบจะรวมพารามิเตอร์หรือกลุ่มตัวกรองที่แตกต่างกันไว้ในคําค้นหา "และ"

ตัวอย่าง

หากต้องการค้นหาด้วย "คนหรือเมืองชื่อกอร์" ให้ลองทําดังนี้

query=gore
&filter=(any type:/people/person type:/location/citytown)

พฤติกรรมการรวมนี้อาจถูกลบล้างและควบคุมได้ดีขึ้นด้วยพารามิเตอร์ตัวกรองซึ่งมีอินเทอร์เฟซที่สมบูรณ์ยิ่งขึ้นในการรวมข้อจํากัดต่างๆ นิพจน์ s อาจเป็นตัวแบบที่ฝังในตัว โดยโอเปอเรเตอร์จะเป็นค่าใดค่าหนึ่งต่อไปนี้

any ตามตรรกะ OR
all ตรรกะ AND
not
should ซึ่งใช้ได้ในระดับบนสุดเท่านั้น และแสดงให้เห็นว่าไม่บังคับ ในระหว่างการให้คะแนน รายการที่ตรงกันซึ่งไม่ตรงกับข้อจํากัดที่ไม่บังคับจะมีคะแนนหารด้วยครึ่งหนึ่งของข้อจํากัดที่ไม่บังคับแต่ละรายการที่ไม่ตรงกัน

ตัวอย่าง

หากต้องการจับคู่ประเภท /people/person หรือโดเมน /film ให้ลองทําดังนี้

query=gore
&filter=(any type:/people/person domain:/film)