O Gemini Notebook Enterprise é uma ferramenta poderosa para gerar insights e resumos dos seus documentos. Nesta página, descrevemos as APIs que permitem realizar as seguintes tarefas de gerenciamento de notebooks de maneira programática:
- Criar um notebook
- Recuperar um notebook
- Listar notebooks acessados recentemente
- Excluir um notebook
- Compartilhar um notebook
Antes de começar
Antes de começar a trabalhar com os notebooks, faça o seguinte:
- Configurar o Gemini Notebook Enterprise.
- Adquira licenças do Gemini Notebook Enterprise e atribua uma licença à sua conta de usuário.
- Conceda o papel de usuário do Cloud NotebookLM
(
roles/discoveryengine.notebookLmUser) à sua conta de usuário. Em um terminal local ou no Cloud Shell, faça login na Google Cloud CLI com suas credenciais de usuário executando o comando
gcloud auth login:gcloud auth loginFazer login com suas credenciais de usuário garante que
gcloud auth print-access-tokengere um token de acesso para sua conta de usuário. Os métodos da API REST doprojects.locations.notebooksnesta página exigem uma conta de usuário autenticada com uma licença ativa do Gemini Notebook Enterprise.
Usar o endpoint multirregional dos EUA
Se a assinatura do Gemini Notebook Enterprise estiver na multirregião dos EUA, envie as solicitações desta página para o endpoint multirregional dos EUA, discoveryengine.us.rep.googleapis.com. Um endpoint multirregional
processa suas solicitações e encerra o TLS na multirregião, para que os dados da
solicitação permaneçam nos EUA enquanto estão em trânsito. O uso desse endpoint não
muda o local de armazenamento dos notebooks. Para mais informações, consulte
Visão geral dos endpoints de API regionais e
multirregionais no guia de segurança do Google Cloud.
Para usar o endpoint multirregional dos EUA, faça as seguintes alterações em cada URL de solicitação nesta página:
Substitua o host
ENDPOINT_LOCATION-discoveryengine.googleapis.compordiscoveryengine.us.rep.googleapis.com.Defina
LOCATIONcomous.
O restante de cada solicitação permanece o mesmo. Para saber como escolher a multirregião da sua assinatura, consulte Criar uma assinatura. Para ver a lista de endpoints de serviço regionais e multirregionais, consulte Endpoints de serviço regionais e multirregionais no guia da nuvem privada virtual.
Criar um notebook
Para criar um notebook, use o método notebooks.create.
REST
curl -X POST \
-H "Authorization:Bearer $(gcloud auth print-access-token)" \
-H "Content-Type: application/json" \
"https://ENDPOINT_LOCATION-discoveryengine.googleapis.com/v1alpha/projects/PROJECT_NUMBER/locations/LOCATION/notebooks" \
-d '{
"title": "NOTEBOOK_TITLE",
}'
Substitua:
ENDPOINT_LOCATION: a multirregião da sua solicitação de API. Especifique um dos seguintes valores:uspara a multirregião dos EUAeupara a multirregião da UEglobalpara o local global
PROJECT_NUMBER: o número do projeto do Google Cloud .LOCATION: a localização geográfica do repositório de dados, comoglobal. Para mais informações, consulte Locais.NOTEBOOK_TITLE: uma string codificada em UTF-8 usada como título do notebook que você quer criar.
Se a solicitação for bem-sucedida, você vai receber um JSON semelhante ao seguinte.
{
"title": "NOTEBOOK_TITLE",
"notebookId": "NOTEBOOK_ID",
"emoji": "",
"metadata": {
"userRole": "PROJECT_ROLE_OWNER",
"isShared": false,
"isShareable": true
},
"name": "NOTEBOOK_NAME"
}
Observe o seguinte:
NOTEBOOK_ID: um ID exclusivo para identificar o notebook criado. Você precisa do ID do notebook para outras tarefas de gerenciamento, como compartilhamento ou recuperação.NOTEBOOK_NAME: o nome completo do recurso do notebook. Esse campo tem o seguinte padrão:projects/PROJECT_NUMBER/locations/LOCATION/notebooks/NOTEBOOK_ID
Acessar o notebook criado e conferir o ID dele em um navegador
Para acessar o notebook criado e receber o ID dele usando um navegador, faça o seguinte.
Acesse a página inicial do Gemini Notebook Enterprise, disponível em um dos seguintes URLs:
Se você estiver usando uma Google Identity, acesse:
https://notebook.cloud.google.com/LOCATION/?project=PROJECT_NUMBERSe você estiver usando uma identidade de terceiros, acesse:
https://notebook.cloud.google/LOCATION/?project=PROJECT_NUMBER
Selecione o notebook criado. O URL do notebook selecionado tem o seguinte padrão:
Se você usa uma Google Identity:
https://notebook.cloud.google.com/LOCATION/notebook/NOTEBOOK_ID?project=PROJECT_NUMBERSe você estiver usando uma identidade de terceiros:
https://notebook.cloud.google/LOCATION/notebook/NOTEBOOK_ID?project=PROJECT_NUMBER
Anote o URL e o ID do notebook, que são úteis para outras tarefas de gerenciamento de notebooks, como o compartilhamento.
Recuperar um notebook
Para recuperar um notebook específico usando o ID dele, use o método notebooks.get.
REST
curl -X GET \
-H "Authorization:Bearer $(gcloud auth print-access-token)" \
-H "Content-Type: application/json" \
"https://ENDPOINT_LOCATION-discoveryengine.googleapis.com/v1alpha/projects/PROJECT_NUMBER/locations/LOCATION/notebooks/NOTEBOOK_ID"
Substitua:
ENDPOINT_LOCATION: a multirregião da sua solicitação de API. Especifique um dos seguintes valores:uspara a multirregião dos EUAeupara a multirregião da UEglobalpara o local global
PROJECT_NUMBER: o número do projeto do Google Cloud .LOCATION: a localização geográfica do repositório de dados, comoglobal. Para mais informações, consulte Locais.NOTEBOOK_ID: o identificador exclusivo do notebook que você recebeu ao criá-lo.
Se a solicitação for bem-sucedida, você vai receber uma resposta JSON semelhante à seguinte para um notebook vazio. Se você chamar esse método depois de adicionar fontes ao notebook, vai receber detalhes sobre todas as fontes adicionadas ao notebook recuperado. Se você tiver configurado os detalhes da CMEK, também vai receber informações relacionadas à CMEK para o notebook.
{
"title": "NOTEBOOK_TITLE",
"notebookId": "NOTEBOOK_ID",
"emoji": "",
"metadata": {
"userRole": "PROJECT_ROLE_OWNER",
"isShared": false,
"isShareable": true,
"lastViewed": "LAST_VIEWED_TIME",
"createTime": "LAST_CREATED_TIME"
},
"name": "NOTEBOOK_NAME"
}
Listar notebooks visualizados recentemente
Para ver uma lista de todos os notebooks de um projeto que foram visualizados recentemente, use o método notebooks.listRecentlyViewed. Por padrão, a resposta lista os últimos 500 notebooks. É possível paginar
as respostas com o parâmetro de consulta pageSize.
REST
curl -X GET \
-H "Authorization:Bearer $(gcloud auth print-access-token)" \
-H "Content-Type: application/json" \
"https://ENDPOINT_LOCATION-discoveryengine.googleapis.com/v1alpha/projects/PROJECT_NUMBER/locations/LOCATION/notebooks:listRecentlyViewed"
Substitua:
ENDPOINT_LOCATION: a multirregião da sua solicitação de API. Especifique um dos seguintes valores:uspara a multirregião dos EUAeupara a multirregião da UEglobalpara o local global
PROJECT_NUMBER: o número do projeto do Google Cloud .LOCATION: a localização geográfica do repositório de dados, comoglobal. Para mais informações, consulte Locais.
Se a solicitação for bem-sucedida, você vai receber uma resposta JSON semelhante a esta: A resposta contém até os últimos 500 notebooks que um usuário acessou recentemente.
{
"notebooks": [
{
"title": "NOTEBOOK_TITLE_1",
"notebookId": "NOTEBOOK_ID_1",
"emoji": "",
"metadata": {
"userRole": "PROJECT_ROLE_OWNER",
"isShared": false,
"isShareable": true,
"lastViewed": "LAST_VIEWED_TIME",
"createTime": "LAST_CREATED_TIME"
},
"name": "NOTEBOOK_NAME_1"
},
{
"title": "NOTEBOOK_TITLE_2",
"notebookId": "NOTEBOOK_ID_2",
"emoji": "",
"metadata": {
"userRole": "PROJECT_ROLE_OWNER",
"isShared": false,
"isShareable": true,
"lastViewed": "LAST_VIEWED_TIME",
"createTime": "LAST_CREATED_TIME"
},
"name": "NOTEBOOK_NAME_2"
}
]
}
Excluir um notebook
Para excluir um notebook, use o método notebooks.batchDelete.
REST
curl -X POST \
-H "Authorization:Bearer $(gcloud auth print-access-token)" \
-H "Content-Type: application/json" \
"https://ENDPOINT_LOCATION-discoveryengine.googleapis.com/v1alpha/projects/PROJECT_NUMBER/locations/LOCATION/notebooks:batchDelete" \
-d '{
"names": [
"NOTEBOOK_NAME"
]
}'
Substitua:
ENDPOINT_LOCATION: a multirregião da sua solicitação de API. Especifique um dos seguintes valores:uspara a multirregião dos EUAeupara a multirregião da UEglobalpara o local global
PROJECT_NUMBER: o número do projeto do Google Cloud .LOCATION: a localização geográfica do repositório de dados, comoglobal. Para mais informações, consulte Locais.NOTEBOOK_NAME: o nome completo do recurso do notebook a ser excluído. Esse campo tem o padrão:projects/PROJECT_NUMBER/locations/LOCATION/notebooks/NOTEBOOK_ID.Se a solicitação for bem-sucedida, você vai receber um objeto JSON vazio. Se o notebook não existir, você também vai receber um objeto JSON vazio. Portanto, especifique o nome do notebook corretamente.
Compartilhar um notebook
Para compartilhar um novo notebook, use o método notebooks.share.
O usuário com quem você quer compartilhar o notebook precisa receber o papel de Usuário do Cloud NotebookLM.
REST
No projeto do Google Cloud , atribua o papel do Identity and Access Management (IAM)
Cloud NotebookLM Useraos usuários com quem você quer compartilhar o notebook.Chame o método a seguir.
curl -X POST \ -H "Authorization:Bearer $(gcloud auth print-access-token)" \ -H "Content-Type: application/json" \ "https://ENDPOINT_LOCATION-discoveryengine.googleapis.com/v1alpha/projects/PROJECT_NUMBER/locations/LOCATION/notebooks/NOTEBOOK_ID:share" \ -d '{ "accountAndRoles": [ { "email":"USER_EMAIL_1", "role":"USER_ROLE_1", }, { "email":"USER_EMAIL_2", "role":"USER_ROLE_2", }, ] }'Substitua:
ENDPOINT_LOCATION: a multirregião da sua solicitação de API. Especifique um dos seguintes valores:uspara a multirregião dos EUAeupara a multirregião da UEglobalpara o local global
PROJECT_NUMBER: o número do projeto do Google Cloud .LOCATION: a localização geográfica do repositório de dados, comoglobal. Para mais informações, consulte Locais.NOTEBOOK_ID: um ID exclusivo para identificar o notebook que você quer compartilhar. Você precisa do ID do notebook para outras tarefas de gerenciamento, como compartilhamento ou recuperação.USER_EMAIL: o endereço de e-mail do usuário com quem você quer compartilhar o notebook.USER_ROLE: um papel que você quer atribuir ao usuário. Pode ser um destes:PROJECT_ROLE_WRITER: o usuário tem permissões de gravação no projeto.PROJECT_ROLE_READER: o usuário tem permissões de leitura no projeto.PROJECT_ROLE_NOT_SHARED:o usuário não tem acesso ao projeto.
Se a solicitação for bem-sucedida, você vai receber um objeto JSON vazio.
Verificar usuários usando um navegador
Para verificar se você compartilhou o notebook com os usuários corretos e atribuiu os papéis corretos a eles, faça o seguinte:
Abra o notebook no navegador. Um notebook tem o seguinte padrão do URL:
Se você usa uma Google Identity:
https://notebook.cloud.google.com/LOCATION/notebook/NOTEBOOK_ID?project=PROJECT_NUMBERSe você estiver usando uma identidade de terceiros:
https://notebook.cloud.google/LOCATION/notebook/NOTEBOOK_ID?project=PROJECT_NUMBER
Clique em Compartilhar.
Verifique os usuários listados como Pessoas com acesso e as funções atribuídas a eles.
A seguir
- Adicionar fontes de dados de diferentes tipos aos seus notebooks de forma programática.