Este guia de início rápido apresenta a API Google Knowledge Graph Search. Neste guia de início rápido, você vai usar a API para pesquisar ou consultar entidades no Mapa de informações do Google.
Se você estiver planejando um novo projeto, crie seu aplicativo com a edição Advanced do Cloud Knowledge Graph para aproveitar os novos recursos e melhorias de serviço. A edição Basic continua disponível, mas não oferece suporte a novos recursos, QPS alto ou padrões adicionais de segurança e compliance.
Pesquisar entidades do Mapa de informações da nuvem
Os exemplos a seguir mostram como pesquisar uma entidade no grafo de conhecimento.
Avançado
REST
Para pesquisar o grafo de conhecimento da Advanced Edition, chame o método projects.locations.cloudKnowledgeGraphEntities.search.
Antes de usar os dados da solicitação abaixo, faça as substituições a seguir:
- PROJECT_ID: o ID do projeto do Google Cloud .
- LOCATION: local do gráfico de conhecimento.
- Opções:
global- endpoint global
- Opções:
- SEARCH_QUERY: a string de consulta literal para pesquisa.
- LANGUAGES: (opcional) a lista de códigos de idioma (definidos na ISO 693) para executar a consulta. Se não for especificado, o valor padrão será
en. - TYPES: (opcional) restringe as entidades retornadas com esses tipos, conforme definido por "https://schema.org". Se vários tipos forem especificados, as entidades retornadas vão conter um ou mais deles. O valor padrão é vazio, o que retorna entidades sem restrições de tipo. Consulte a hierarquia completa do Schema.org para ver os tipos compatíveis.
- LIMIT: (opcional) limita o número de entidades a serem retornadas. O padrão é
20.
Método HTTP e URL:
GET https://enterpriseknowledgegraph.googleapis.com/v1/projects/PROJECT_ID/locations/LOCATION/cloudKnowledgeGraphEntities:Search?query=SEARCH_QUERY&limit=LIMIT
Para enviar a solicitação, escolha uma destas opções:
curl
Execute o seguinte comando:
curl -X GET \
-H "Authorization: Bearer $(gcloud auth print-access-token)" \
"https://enterpriseknowledgegraph.googleapis.com/v1/projects/PROJECT_ID/locations/LOCATION/cloudKnowledgeGraphEntities:Search?query=SEARCH_QUERY&limit=LIMIT"
PowerShell
Execute o seguinte comando:
$cred = gcloud auth print-access-token
$headers = @{ "Authorization" = "Bearer $cred" }
Invoke-WebRequest `
-Method GET `
-Headers $headers `
-Uri "https://enterpriseknowledgegraph.googleapis.com/v1/projects/PROJECT_ID/locations/LOCATION/cloudKnowledgeGraphEntities:Search?query=SEARCH_QUERY&limit=LIMIT" | Select-Object -Expand Content
A resposta contém uma lista de entidades, apresentada no formato JSON-LD e compatível com esquemas do schema.org com extensões externas limitadas.
Consulte Estrutura de resposta da entidade para mais informações sobre a estrutura da resposta.
O exemplo de JSON-LD a seguir mostra como o corpo da resposta é estruturado:
{
"@context": {
"@vocab": "http://schema.org/"
},
"@type": "ItemList",
"itemListElement": [
{
"result": {
"@id": "c-07xuup16g",
"name": "Stanford University",
"description": "Private university in Stanford, California",
"detailedDescription": {
"articleBody": "Stanford University, officially Leland Stanford Junior University, is a private research university in Stanford, California. The campus occupies 8,180 acres, among the largest in the United States, and enrolls over 17,000 students. ",
"url": "https://en.wikipedia.org/wiki/Stanford_University",
"license": "https://en.wikipedia.org/wiki/Wikipedia:Text_of_Creative_Commons_Attribution-ShareAlike_3.0_Unported_License"
},
"url": "http://www.stanford.edu/",
"image": {
"contentUrl": "https://encrypted-tbn1.gstatic.com/images?q=tbn:ANd9GcTfPPf-ker0y_892m1wu8-U89furQgQ67foDFncY3r9sREpeWxV",
"url": "https://es.wikipedia.org/wiki/Archivo:Logo_of_Stanford_University.png"
},
"identifier": [
{
"@type": "PropertyValue",
"propertyID": "googleKgMID",
"value": "/m/06pwq"
},
{
"@type": "PropertyValue",
"propertyID": "googlePlaceID",
"value": "ChIJneqLZyq7j4ARf2j8RBrwzSk"
},
{
"@type": "PropertyValue",
"propertyID": "wikidataQID",
"value": "Q41506"
}
],
"@type": [
"Place",
"Organization",
"MovieTheater",
"Corporation",
"EducationalOrganization",
"Thing",
"CollegeOrUniversity"
]
}
}
]
}
Python
Para mais informações, consulte a documentação de referência da API Enterprise Knowledge Graph Python.
Para autenticar no Enterprise Knowledge Graph, configure o Application Default Credentials. Para mais informações, consulte Configurar a autenticação para um ambiente de desenvolvimento local.
Básico
REST
Para pesquisar o grafo de conhecimento da edição Basic, chame o método projects.locations.publicKnowledgeGraphEntities.search.
Antes de usar os dados da solicitação abaixo, faça as substituições a seguir:
- PROJECT_ID: o ID do projeto do Google Cloud .
- LOCATION: local do gráfico de conhecimento.
- Opções:
global- endpoint global
- Opções:
- SEARCH_QUERY: a string de consulta literal para pesquisa.
- LANGUAGES: (opcional) a lista de códigos de idioma (definidos na ISO 693) para executar a consulta. Se não for especificado, o valor padrão será
en. - TYPES: (opcional) restringe as entidades retornadas com esses tipos, conforme definido por "https://schema.org". Se vários tipos forem especificados, as entidades retornadas vão conter um ou mais deles. O valor padrão é vazio, o que retorna entidades sem restrições de tipo. Consulte a hierarquia completa do Schema.org para ver os tipos compatíveis.
- LIMIT: (opcional) limita o número de entidades a serem retornadas. O padrão é
20.
Método HTTP e URL:
GET https://enterpriseknowledgegraph.googleapis.com/v1/projects/PROJECT_ID/locations/LOCATION/publicKnowledgeGraphEntities:Search?query=SEARCH_QUERY&limit=LIMIT
Para enviar a solicitação, escolha uma destas opções:
curl
Execute o seguinte comando:
curl -X GET \
-H "Authorization: Bearer $(gcloud auth print-access-token)" \
"https://enterpriseknowledgegraph.googleapis.com/v1/projects/PROJECT_ID/locations/LOCATION/publicKnowledgeGraphEntities:Search?query=SEARCH_QUERY&limit=LIMIT"
PowerShell
Execute o seguinte comando:
$cred = gcloud auth print-access-token
$headers = @{ "Authorization" = "Bearer $cred" }
Invoke-WebRequest `
-Method GET `
-Headers $headers `
-Uri "https://enterpriseknowledgegraph.googleapis.com/v1/projects/PROJECT_ID/locations/LOCATION/publicKnowledgeGraphEntities:Search?query=SEARCH_QUERY&limit=LIMIT" | Select-Object -Expand Content
A resposta contém uma lista de entidades, apresentada no formato JSON-LD e compatível com esquemas do schema.org com extensões externas limitadas.
Consulte Estrutura de resposta da entidade para mais informações sobre a estrutura da resposta.
O exemplo de JSON-LD a seguir mostra como o corpo da resposta é estruturado:
{
"@context": {
"@vocab": "http://schema.org/"
},
"@type": "ItemList",
"itemListElement": [
{
"result": {
"@id": "c-07xuup16g",
"name": "Stanford University",
"description": "Private university in Stanford, California",
"detailedDescription": {
"license": "https://en.wikipedia.org/wiki/Wikipedia:Text_of_Creative_Commons_Attribution-ShareAlike_3.0_Unported_License",
"url": "https://en.wikipedia.org/wiki/Stanford_University",
"articleBody": "Stanford University, officially Leland Stanford Junior University, is a private research university in Stanford, California. The campus occupies 8,180 acres, among the largest in the United States, and enrolls over 17,000 students. "
},
"url": "http://www.stanford.edu/",
"identifier": [
{
"@type": "PropertyValue",
"propertyID": "googleKgMID",
"value": "/m/06pwq"
}
],
"image": {
"contentUrl": "https://encrypted-tbn1.gstatic.com/images?q=tbn:ANd9GcTfPPf-ker0y_892m1wu8-U89furQgQ67foDFncY3r9sREpeWxV",
"url": "https://es.wikipedia.org/wiki/Archivo:Logo_of_Stanford_University.png"
},
"@type": [
"EducationalOrganization",
"CollegeOrUniversity",
"Thing",
"Place",
"Corporation",
"MovieTheater",
"Organization"
]
}
}
]
}
Python
Para mais informações, consulte a documentação de referência da API Enterprise Knowledge Graph Python.
Para autenticar no Enterprise Knowledge Graph, configure o Application Default Credentials. Para mais informações, consulte Configurar a autenticação para um ambiente de desenvolvimento local.
Pesquisar entidades do MID do Mapa de informações do Cloud
A API Google Knowledge Graph Search apresenta o novo formato de ID de máquina (MID) para facilitar a integração de produtos e aplicativos. A API lookup funciona tanto para o novo MID do Mapa de informações do Google Cloud (começa com c-) quanto para o MID do Mapa de informações do Google (começa com /m).
Avançado
REST
Para pesquisar uma entidade por MID na edição Advanced, chame o método projects.locations.cloudKnowledgeGraphEntities.lookup.
Antes de usar os dados da solicitação abaixo, faça as substituições a seguir:
- PROJECT_ID: o ID do projeto do Google Cloud .
- LOCATION: local do gráfico de conhecimento.
- Opções:
global- endpoint global
- Opções:
- LOOKUP_IDS: a lista de IDs de entidades a serem usadas na pesquisa.
- Exemplo:
/m/0dl567
- Exemplo:
- LANGUAGES: (opcional) a lista de códigos de idioma (definidos na ISO 693) para executar a consulta. Se não for especificado, o valor padrão será
en.
Método HTTP e URL:
GET https://enterpriseknowledgegraph.googleapis.com/v1/projects/PROJECT_ID/locations/LOCATION/cloudKnowledgeGraphEntities:Lookup?ids=LOOKUP_IDS
Para enviar a solicitação, escolha uma destas opções:
curl
Execute o seguinte comando:
curl -X GET \
-H "Authorization: Bearer $(gcloud auth print-access-token)" \
"https://enterpriseknowledgegraph.googleapis.com/v1/projects/PROJECT_ID/locations/LOCATION/cloudKnowledgeGraphEntities:Lookup?ids=LOOKUP_IDS"
PowerShell
Execute o seguinte comando:
$cred = gcloud auth print-access-token
$headers = @{ "Authorization" = "Bearer $cred" }
Invoke-WebRequest `
-Method GET `
-Headers $headers `
-Uri "https://enterpriseknowledgegraph.googleapis.com/v1/projects/PROJECT_ID/locations/LOCATION/cloudKnowledgeGraphEntities:Lookup?ids=LOOKUP_IDS" | Select-Object -Expand Content
A resposta contém uma lista de entidades, apresentada no formato JSON-LD e compatível com esquemas do schema.org com extensões externas limitadas.
Consulte Estrutura de resposta da entidade para mais informações sobre a estrutura da resposta.
O exemplo de JSON-LD a seguir mostra como o corpo da resposta é estruturado:
{
"@context": {
"@vocab": "http://schema.org/"
},
"@type": "ItemList",
"itemListElement": [
{
"result": {
"description": "American singer-songwriter",
"@type": [
"Person",
"Thing"
],
"name": "Taylor Swift",
"@id": "c-0260160kc",
"url": "http://www.taylorswift.com/",
"identifier": [
{
"@type": "PropertyValue",
"propertyID": "googleKgMID",
"value": "/m/0dl567"
},
{
"@type": "PropertyValue",
"propertyID": "wikidataQID",
"value": "Q26876"
}
],
"detailedDescription": {
"articleBody": "Taylor Alison Swift is an American singer-songwriter. Her discography spans multiple genres and her narrative songwriting—often inspired by her personal life—has received critical praise and widespread media coverage. ",
"license": "https://en.wikipedia.org/wiki/Wikipedia:Text_of_Creative_Commons_Attribution-ShareAlike_3.0_Unported_License",
"url": "https://en.wikipedia.org/wiki/Taylor_Swift"
},
"image": {
"contentUrl": "https://encrypted-tbn1.gstatic.com/images?q=tbn:ANd9GcSnsjOArwgD-bhyRslj_Qa7Z2tIPLRFU3VnEuLr1ybcyned49Pt",
"url": "https://pt.wikipedia.org/wiki/Ficheiro:191125_Taylor_Swift_at_the_2019_American_Music_Awards_(cropped).png"
}
}
}
]
}
https://enterpriseknowledgegraph.googleapis.com/v1/projects/PROJECT_ID/locations/LOCATION/cloudKnowledgeGraphEntities:Lookup?ids=LOOKUP_IDS&ids=LOOKUP_IDS
Python
Para mais informações, consulte a documentação de referência da API Enterprise Knowledge Graph Python.
Para autenticar no Enterprise Knowledge Graph, configure o Application Default Credentials. Para mais informações, consulte Configurar a autenticação para um ambiente de desenvolvimento local.
Básico
REST
Para pesquisar uma entidade por MID na edição Basic, chame o método projects.locations.publicKnowledgeGraphEntities.lookup.
Antes de usar os dados da solicitação abaixo, faça as substituições a seguir:
- PROJECT_ID: o ID do projeto do Google Cloud .
- LOCATION: local do gráfico de conhecimento.
- Opções:
global- endpoint global
- Opções:
- LOOKUP_IDS: a lista de IDs de entidades a serem usadas na pesquisa.
- Exemplo:
/m/0dl567
- Exemplo:
- LANGUAGES: (opcional) a lista de códigos de idioma (definidos na ISO 693) para executar a consulta. Se não for especificado, o valor padrão será
en.
Método HTTP e URL:
GET https://enterpriseknowledgegraph.googleapis.com/v1/projects/PROJECT_ID/locations/LOCATION/publicKnowledgeGraphEntities:Lookup?ids=LOOKUP_IDS
Para enviar a solicitação, escolha uma destas opções:
curl
Execute o seguinte comando:
curl -X GET \
-H "Authorization: Bearer $(gcloud auth print-access-token)" \
"https://enterpriseknowledgegraph.googleapis.com/v1/projects/PROJECT_ID/locations/LOCATION/publicKnowledgeGraphEntities:Lookup?ids=LOOKUP_IDS"
PowerShell
Execute o seguinte comando:
$cred = gcloud auth print-access-token
$headers = @{ "Authorization" = "Bearer $cred" }
Invoke-WebRequest `
-Method GET `
-Headers $headers `
-Uri "https://enterpriseknowledgegraph.googleapis.com/v1/projects/PROJECT_ID/locations/LOCATION/publicKnowledgeGraphEntities:Lookup?ids=LOOKUP_IDS" | Select-Object -Expand Content
A resposta contém uma lista de entidades, apresentada no formato JSON-LD e compatível com esquemas do schema.org com extensões externas limitadas.
Consulte Estrutura de resposta da entidade para mais informações sobre a estrutura da resposta.
O exemplo de JSON-LD a seguir mostra como o corpo da resposta é estruturado:
{
"@context": {
"@vocab": "http://schema.org/"
},
"@type": "ItemList",
"itemListElement": [
{
"result": {
"description": "American singer-songwriter",
"@type": [
"Person",
"Thing"
],
"name": "Taylor Swift",
"@id": "c-0260160kc",
"url": "http://www.taylorswift.com/",
"identifier": [
{
"@type": "PropertyValue",
"propertyID": "googleKgMID",
"value": "/m/0dl567"
}
],
"detailedDescription": {
"articleBody": "Taylor Alison Swift is an American singer-songwriter. Her discography spans multiple genres and her narrative songwriting—often inspired by her personal life—has received critical praise and widespread media coverage. ",
"license": "https://en.wikipedia.org/wiki/Wikipedia:Text_of_Creative_Commons_Attribution-ShareAlike_3.0_Unported_License",
"url": "https://en.wikipedia.org/wiki/Taylor_Swift"
},
"image": {
"contentUrl": "https://encrypted-tbn1.gstatic.com/images?q=tbn:ANd9GcSnsjOArwgD-bhyRslj_Qa7Z2tIPLRFU3VnEuLr1ybcyned49Pt",
"url": "https://pt.wikipedia.org/wiki/Ficheiro:191125_Taylor_Swift_at_the_2019_American_Music_Awards_(cropped).png"
}
}
}
]
}
https://enterpriseknowledgegraph.googleapis.com/v1/projects/PROJECT_ID/locations/LOCATION/publicKnowledgeGraphEntities:Lookup?ids=LOOKUP_IDS&ids=LOOKUP_IDS
Python
Para mais informações, consulte a documentação de referência da API Enterprise Knowledge Graph Python.
Para autenticar no Enterprise Knowledge Graph, configure o Application Default Credentials. Para mais informações, consulte Configurar a autenticação para um ambiente de desenvolvimento local.
Estrutura da entidade
| Nome do campo | Tipo | Descrição |
|---|---|---|
@id |
string |
O URI canônico da entidade. |
name |
string |
É o nome da entidade. |
@type |
array |
A lista de tipos compatíveis de schema.org que correspondem à entidade. |
description |
string |
Uma breve descrição da entidade. |
image |
URL |
Uma imagem para ajudar a identificar a entidade. |
detailedDescription |
string |
Uma descrição detalhada da entidade. |
url |
URL |
O URL do site oficial da entidade, se disponível. |
identifier |
array |
Uma lista de outros IDs vinculados, por exemplo, WikidataQID. |
Palavras-chave JSON-LD
Consulte a especificação do JSON-LD para palavras-chave como:
Compatibilidade com schema.org
Para cada um dos tipos (como Person) e propriedades (como name) do Schema.org, há um URI completo correspondente, como nos exemplos a seguir:
| Turma | Nome | URI |
|---|---|---|
| tipo | Person |
https://schema.org/Person |
| tipo | Thing |
https://schema.org/Thing |
| propriedade | name |
https://schema.org/name |
| propriedade | description |
https://schema.org/description |
Extensões de esquema
Os tipos e propriedades usados nesta API são hospedados em
https://schema.googleapis.com
como extensões externas.
A documentação de cada tipo e propriedade está disponível no URI correspondente.
| Turma | Nome | URI |
|---|---|---|
| tipo | EntitySearchResult |
https://schema.googleapis.com/EntitySearchResult |
| propriedade | detailedDescription |
https://schema.googleapis.com/detailedDescription |
Entidades do Mapa de informações
O Mapa de informações tem milhões de entradas que descrevem entidades do mundo real, como pessoas, lugares e objetos. Essas entidades formam os nós do gráfico.
Confira alguns dos tipos comuns de entidades encontradas no Grafo de conhecimento do Cloud:
BookBookSeriesEducationalOrganizationEventGovernmentOrganizationLocalBusinessMovieMovieSeriesMusicAlbumMusicGroupMusicRecordingOrganizationPeriodicalPersonPlaceSportsTeamTVEpisodeTVSeriesVideoGameVideoGameSeriesWebSite