O NotebookLM Enterprise é uma ferramenta poderosa para gerar insights e resumos dos seus documentos. Esta página descreve as APIs que permitem realizar as seguintes tarefas de gerenciamento de notebooks de forma programática:
- Criar um notebook
- Recuperar um notebook
- Listar notebooks visualizados recentemente
- Excluir um notebook
- Compartilhar um notebook
Antes de começar
Antes de começar a trabalhar com seus notebooks, faça o seguinte:
Criar um notebook
Para criar um notebook, use o
notebooks.create
método.
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 Google Cloud projeto.LOCATION: a localização geográfica do seu 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 receber 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 NotebookLM Enterprise, disponível em um dos seguintes URLs:
Se você usa uma identidade do Google, acesse:
https://notebooklm.cloud.google.com/LOCATION/?project=PROJECT_NUMBERSe você usa uma identidade de terceiros, acesse:
https://notebooklm.cloud.google/LOCATION/?project=PROJECT_NUMBER
Selecione o notebook criado. O URL do notebook selecionado tem o seguinte padrão:
Se você usa uma identidade do Google:
https://notebooklm.cloud.google.com/LOCATION/notebook/NOTEBOOK_ID?project=PROJECT_NUMBERSe você usa uma identidade de terceiros:
https://notebooklm.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, como compartilhamento.
Recuperar um notebook
Para recuperar um notebook específico usando o ID dele, use o
notebooks.get
método.
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 Google Cloud projeto.LOCATION: a localização geográfica do seu repositório de dados, comoglobal. Para mais informações, consulte Locais.NOTEBOOK_ID: o identificador exclusivo do notebook que você recebeu ao criar o notebook.
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, você receberá detalhes sobre todas as fontes adicionadas ao notebook recuperado. Se você tiver configurado 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 receber uma lista de todos os notebooks em um projeto que foram visualizados recentemente, use o
notebooks.listRecentlyViewed
método. Por padrão, a resposta lista os últimos 500 notebooks. Você pode optar por 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 Google Cloud projeto.LOCATION: a localização geográfica do seu 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 à seguinte. 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
notebooks.batchDelete
método.
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 Google Cloud projeto.LOCATION: a localização geográfica do seu 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
notebooks.share
método.
O usuário com quem você quer compartilhar o notebook precisa receber o papel de usuário do Cloud Notebook.
REST
Noprojeto, atribua o papel do Identity and Access Management (IAM) aos usuários com quem você quer compartilhar o Google Cloud notebook.
Cloud NotebookLM UserChame o seguinte método.
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 Google Cloud projeto.LOCATION: a localização geográfica do seu 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_OWNER: o usuário é proprietário do projeto.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 identidade do Google:
https://notebooklm.cloud.google.com/LOCATION/notebook/NOTEBOOK_ID?project=PROJECT_NUMBERSe você usa uma identidade de terceiros:
https://notebooklm.cloud.google/LOCATION/notebook/NOTEBOOK_ID?project=PROJECT_NUMBER
Clique em Compartilhar.
Verifique os usuários listados como Pessoas com acesso e os papéis atribuídos a eles.
A seguir
- Adicionar fontes de dados de diferentes tipos aos notebooks de forma programática.