Crie e faça a gestão de notebooks (API)

O NotebookLM Enterprise é uma ferramenta poderosa para gerar estatísticas e resumos a partir dos seus documentos. Esta página descreve as APIs que lhe permitem realizar as seguintes tarefas de gestão de blocos de notas de forma programática:

Crie um notebook

Para criar um novo 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 o seguinte:

  • ENDPOINT_LOCATION: a região múltipla para o seu pedido de API. Atribua um dos seguintes valores:
    • us- para a multirregião dos EUA
    • eu- para a multirregião da UE
    • global- para a localização global
    Para mais informações, consulte o artigo Especifique várias regiões para o seu repositório de dados.
  • PROJECT_NUMBER: o número do seu projeto Google Cloud .
  • LOCATION: a localização geográfica do seu repositório de dados, como global. Para mais informações, consulte o artigo Localizações.
  • NOTEBOOK_TITLE: uma string codificada em UTF-8 usada como título para o bloco de notas que quer criar.

Se o pedido for bem-sucedido, deve 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"
}

Tenha em conta o seguinte:

  • NOTEBOOK_ID: um ID exclusivo para identificar o bloco de notas criado. Precisa do ID do bloco de notas para outras tarefas de gestão do bloco de notas, como partilhar ou obter.
  • NOTEBOOK_NAME: o nome completo dos recursos do bloco de notas. Este campo tem o seguinte padrão: projects/PROJECT_NUMBER/locations/LOCATION/notebooks/NOTEBOOK_ID

Aceda ao notebook criado e obtenha o respetivo ID num navegador

Para aceder ao notebook criado e obter o respetivo ID através de um navegador, faça o seguinte.

  1. Aceda à página inicial do NotebookLM Enterprise, disponível num dos seguintes URLs:

    1. Se estiver a usar uma identidade Google, aceda a:

      https://notebooklm.cloud.google.com/LOCATION/?project=PROJECT_NUMBER

    2. Se estiver a usar uma identidade de terceiros, aceda a:

      https://notebooklm.cloud.google/LOCATION/?project=PROJECT_NUMBER

  2. Selecione o bloco de notas criado. O URL do notebook selecionado tem o seguinte padrão:

    1. Se estiver a usar uma identidade Google:

      https://notebooklm.cloud.google.com/LOCATION/notebook/NOTEBOOK_ID?project=PROJECT_NUMBER

    2. Se estiver a usar uma identidade de terceiros:

      https://notebooklm.cloud.google/LOCATION/notebook/NOTEBOOK_ID?project=PROJECT_NUMBER

  3. Tenha em atenção o URL e o ID do notebook, que são úteis para outras tarefas de gestão do notebook, como a partilha.

Recupere um bloco de notas

Para obter um bloco de notas específico através do respetivo ID, 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 o seguinte:

  • ENDPOINT_LOCATION: a região múltipla para o seu pedido de API. Atribua um dos seguintes valores:
    • us- para a multirregião dos EUA
    • eu- para a multirregião da UE
    • global- para a localização global
    Para mais informações, consulte o artigo Especifique várias regiões para o seu repositório de dados.
  • PROJECT_NUMBER: o número do seu projeto Google Cloud .
  • LOCATION: a localização geográfica do seu repositório de dados, como global. Para mais informações, consulte o artigo Localizações.
  • NOTEBOOK_ID: o identificador exclusivo do notebook que recebeu quando criou o notebook.

Se o pedido for bem-sucedido, deve receber uma resposta JSON semelhante à seguinte para um bloco de notas vazio. Se chamar este método depois de adicionar fontes ao seu bloco de notas, recebe detalhes sobre todas as fontes adicionadas ao bloco de notas obtido. Se configurou detalhes da CMEK, também recebe informações relacionadas com a CMEK para o bloco de notas.

{
"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 blocos de notas vistos recentemente

Para obter uma lista de todos os blocos de notas num projeto que foram visualizados recentemente, use o método notebooks.listRecentlyViewed. Por predefinição, a resposta apresenta os últimos 500 blocos de notas. 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 o seguinte:

  • ENDPOINT_LOCATION: a região múltipla para o seu pedido de API. Atribua um dos seguintes valores:
    • us- para a multirregião dos EUA
    • eu- para a multirregião da UE
    • global- para a localização global
    Para mais informações, consulte o artigo Especifique várias regiões para o seu repositório de dados.
  • PROJECT_NUMBER: o número do seu projeto Google Cloud .
  • LOCATION: a localização geográfica do seu repositório de dados, como global. Para mais informações, consulte o artigo Localizações.

Se o pedido for bem-sucedido, deve receber uma resposta JSON semelhante à seguinte. A resposta contém até aos 500 blocos de notas mais recentes aos quais um utilizador acedeu 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"
    }
  ]
}

Elimine notebooks em lote

Para eliminar blocos de notas em lote, 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_1",
      "NOTEBOOK_NAME_2"
    ]
  }'

Substitua o seguinte:

  • ENDPOINT_LOCATION: a região múltipla para o seu pedido de API. Atribua um dos seguintes valores:
    • us- para a multirregião dos EUA
    • eu- para a multirregião da UE
    • global- para a localização global
    Para mais informações, consulte o artigo Especifique várias regiões para o seu repositório de dados.
  • PROJECT_NUMBER: o número do seu projeto Google Cloud .
  • LOCATION: a localização geográfica do seu repositório de dados, como global. Para mais informações, consulte o artigo Localizações.

  • NOTEBOOK_NAME: o nome completo do recurso do bloco de notas a eliminar. Este campo tem o padrão: projects/PROJECT_NUMBER/locations/LOCATION/notebooks/NOTEBOOK_ID.

    Se o pedido for bem-sucedido, deve receber um objeto JSON vazio.

Partilhe um bloco de notas

Para partilhar um novo notebook, use o método notebooks.share.

O utilizador com quem quer partilhar o bloco de notas tem de ter a função de utilizador do Notebook no Google Cloud atribuída.

REST

  1. No seu Google Cloud projeto, atribua a função de gestão de identidade e de acesso (IAM) aos utilizadores com quem quer partilhar o bloco de notas.Cloud NotebookLM User

  2. Chame 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 o seguinte:

    • ENDPOINT_LOCATION: a região múltipla para o seu pedido de API. Atribua um dos seguintes valores:
      • us- para a multirregião dos EUA
      • eu- para a multirregião da UE
      • global- para a localização global
      Para mais informações, consulte o artigo Especifique várias regiões para o seu repositório de dados.
    • PROJECT_NUMBER: o número do seu projeto Google Cloud .
    • LOCATION: a localização geográfica do seu repositório de dados, como global. Para mais informações, consulte o artigo Localizações.
    • NOTEBOOK_ID: um ID exclusivo para identificar o bloco de notas que quer partilhar. Precisa do ID do bloco de notas para outras tarefas de gestão do bloco de notas, como partilhar ou obter.
    • USER_EMAIL: o endereço de email do utilizador com quem quer partilhar o bloco de notas.

    • USER_ROLE: uma função que quer atribuir ao utilizador. Pode ser uma das seguintes:

      • PROJECT_ROLE_OWNER: o utilizador é proprietário do projeto.
      • PROJECT_ROLE_WRITER: o utilizador tem autorizações de escrita no projeto.
      • PROJECT_ROLE_READER: o utilizador tem autorizações de leitura no projeto.
      • PROJECT_ROLE_NOT_SHARED:o utilizador não tem acesso ao projeto.

    Se o pedido for bem-sucedido, recebe um objeto JSON vazio.

Valide utilizadores através de um navegador

Para verificar se partilhou o bloco de notas com os utilizadores corretos e lhes atribuiu as funções corretas, faça o seguinte:

  1. Abra o bloco de notas no navegador. Um notebook tem o seguinte padrão de URL:

    1. Se estiver a usar uma identidade Google:

      https://notebooklm.cloud.google.com/LOCATION/notebook/NOTEBOOK_ID?project=PROJECT_NUMBER

    2. Se estiver a usar uma identidade de terceiros:

      https://notebooklm.cloud.google/LOCATION/notebook/NOTEBOOK_ID?project=PROJECT_NUMBER

  2. Clique em Partilhar.

  3. Valide os utilizadores listados como Pessoas com acesso e as respetivas funções atribuídas.

O que se segue?