Przegląd
Interfejs Freebase Search API zapewnia dostęp do danych Freebase w ramach zapytania tekstowego. Wyniki zapytania mają kolejność i mają trafność liczbową.
Deweloperzy mogą stosować filtry, aby ograniczać wyniki wyszukiwania do określonych typów danych. Więcej informacji o tworzeniu szczegółowych zapytań znajdziesz w książce kucharskiej na temat wyszukiwarki.
Oto kilka przykładów użycia interfejsu Search API:
- Automatyczne sugestie jednostek (np. widżet sugestii Freebase)
- Pobieram listę najbardziej znanych podmiotów o danej nazwie.
- Znajdowanie elementów za pomocą Search Metaschema.
Poniższe przykłady kodu w kilku obsługiwanych językach pokazują, jak przeprowadzić wyszukiwanie wykonawcy muzycznego zgodnego z tekstem „Cee Lo Green”. Dodatkową wskazówką jest tutaj utworzenie treści o nazwie „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'] }W tym przykładzie używane są biblioteki Httparty i 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>W tym przykładzie używamy biblioteki 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>
Sprawdź też stronę Biblioteki klienta, aby zobaczyć, czy Twój ulubiony język jest obsługiwany.
Dokumentacja interfejsu Search API
Zapoznaj się także z tą dokumentacją:
- Więcej informacji o korzystaniu z interfejsu API znajdziesz w dokumentacji referencyjnej wyszukiwarki.
- Więcej informacji o tworzeniu szczegółowych zapytań znajdziesz w książce kucharskiej na temat wyszukiwarki.
- Informacje o sposobie opisania relacji między elementami i usługami znajdziesz w dokumentacji Search Metaschema.
Bezpieczeństwo
Interfejs Search API indeksuje i przeszukuje treści użytkowników zapisane na wykresie Freebase. Oznacza to, że nie możesz bezpośrednio korzystać z zawartości na stronie internetowej bez bezpiecznej ucieczki.
Więcej informacji znajdziesz w artykule Pierwsze kroki: bezpieczeństwo.
Filtrowanie zaawansowane
Interfejs Search API obsługuje wiele ograniczeń filtra, aby lepiej ukierunkować wyszukiwanie na odpowiednie elementy.
Na przykład przy użyciu filtra „"type"” możemy wyświetlić listę najbardziej znanych osób w Freebase.
filter=(any type:/people/person)
Ograniczenia filtrowania akceptują różne dane wejściowe:
- Czytelne dla człowieka identyfikatory encji lub użytkowników schematu, na przykład:
/people/person
dla ograniczenia typu/film
dla ograniczenia domeny
- MID MID, np.:
/m/01g317
dla tego samego ograniczenia typu/people/person
/m/010s
dla powyższego ograniczenia domeny/film
- Nazwy jednostek, na przykład:
"person"
dla mniej dokładnego ograniczenia typu/people/person
"film"
w przypadku mniej dokładnego ograniczenia domeny/film
Ograniczenia filtrowania można podzielić na kilka kategorii. Więcej informacji znajdziesz w Książce kucharskiej w sieci wyszukiwania.
Ograniczenia filtrowania można dowolnie łączyć i powtarzać bezpośrednio w interfejsie SearchRequest
. Powtórzone parametry ograniczenia filtra są łączone w zapytaniu LUB. Wszystkie parametry lub grupy ograniczeń filtra są łączone w zapytaniu ORAZ.
Przykład:
Aby wyszukać &osoby lub miasta o nazwie Gore, spróbuj:
query=gore &filter=(any type:/people/person type:/location/citytown)
To połączone zachowanie można zastąpić i dokładniej kontrolować za pomocą parametru filtra, który udostępnia bogatszy interfejs do łączenia ograniczeń. Jest to wyrażenie S, prawdopodobnie arbitralne zagnieżdżone, gdzie operator jest jednym z:
any
, logicznie LUBall
, logicznie Inot
should
, którego można używać tylko na najwyższym poziomie i oznacza, że ograniczenie jest opcjonalne. Podczas punktacji oceny, które nie pasują do opcjonalnych ograniczeń, ich wynik jest podzielony na pół dla każdego opcjonalnego ograniczenia, którego nie udało się dopasować.
Przykład:
Aby dopasować do typu /people/person
lub domeny /film
, spróbuj:
query=gore &filter=(any type:/people/person domain:/film)