Package google.cloud.notebooklm.v1alpha

Índice

AudioOverviewService

Serviço para gerir Resumos de áudio.

CreateAudioOverview

rpc CreateAudioOverview(CreateAudioOverviewRequest) returns (CreateAudioOverviewResponse)

Gera um novo Resumo de áudio.

Âmbitos de autorização

Requer um dos seguintes âmbitos do OAuth:

  • https://www.googleapis.com/auth/cloud-platform
  • https://www.googleapis.com/auth/discoveryengine.readwrite

Para mais informações, consulte o Authentication Overview.

Autorizações de IAM

Requer a seguinte autorização de IAM no recurso parent:

  • discoveryengine.audioOverviews.create

Para mais informações, consulte a documentação do IAM.
DeleteAudioOverview

rpc DeleteAudioOverview(DeleteAudioOverviewRequest) returns (Empty)

Elimina um Resumo de áudio.

Âmbitos de autorização

Requer um dos seguintes âmbitos do OAuth:

  • https://www.googleapis.com/auth/cloud-platform
  • https://www.googleapis.com/auth/discoveryengine.readwrite

Para mais informações, consulte o Authentication Overview.

Autorizações de IAM

Requer a seguinte autorização de IAM no recurso name:

  • discoveryengine.audioOverviews.delete

Para mais informações, consulte a documentação do IAM.

NotebookService

Serviço para gerir notebooks.

BatchDeleteNotebooks

rpc BatchDeleteNotebooks(BatchDeleteNotebooksRequest) returns (Empty)

Elimina notebooks em lote.

Âmbitos de autorização

Requer um dos seguintes âmbitos do OAuth:

  • https://www.googleapis.com/auth/cloud-platform
  • https://www.googleapis.com/auth/discoveryengine.readwrite

Para mais informações, consulte o Authentication Overview.
CreateNotebook

rpc CreateNotebook(CreateNotebookRequest) returns (Notebook)

Cria um bloco de notas.

Âmbitos de autorização

Requer um dos seguintes âmbitos do OAuth:

  • https://www.googleapis.com/auth/cloud-platform
  • https://www.googleapis.com/auth/discoveryengine.readwrite

Para mais informações, consulte o Authentication Overview.

Autorizações de IAM

Requer a seguinte autorização de IAM no recurso parent:

  • discoveryengine.notebooks.create

Para mais informações, consulte a documentação do IAM.
GetNotebook

rpc GetNotebook(GetNotebookRequest) returns (Notebook)

Recebe um notebook.

Âmbitos de autorização

Requer um dos seguintes âmbitos do OAuth:

  • https://www.googleapis.com/auth/cloud-platform
  • https://www.googleapis.com/auth/discoveryengine.readwrite

Para mais informações, consulte o Authentication Overview.

Autorizações de IAM

Requer a seguinte autorização de IAM no recurso name:

  • discoveryengine.notebooks.get

Para mais informações, consulte a documentação do IAM.
ListRecentlyViewedNotebooks

rpc ListRecentlyViewedNotebooks(ListRecentlyViewedNotebooksRequest) returns (ListRecentlyViewedNotebooksResponse)

Apresenta os blocos de notas ordenados pela hora da última visualização.

Âmbitos de autorização

Requer um dos seguintes âmbitos do OAuth:

  • https://www.googleapis.com/auth/cloud-platform
  • https://www.googleapis.com/auth/discoveryengine.readwrite

Para mais informações, consulte o Authentication Overview.

Autorizações de IAM

Requer a seguinte autorização de IAM no recurso parent:

  • discoveryengine.notebooks.list

Para mais informações, consulte a documentação do IAM.
ShareNotebook

rpc ShareNotebook(ShareNotebookRequest) returns (ShareNotebookResponse)

Partilha um bloco de notas com outras contas.

Âmbitos de autorização

Requer um dos seguintes âmbitos do OAuth:

  • https://www.googleapis.com/auth/cloud-platform
  • https://www.googleapis.com/auth/discoveryengine.readwrite

Para mais informações, consulte o Authentication Overview.

Autorizações de IAM

Requer as seguintes autorizações de IAM no recurso name:

  • discoveryengine.notebooks.getIamPolicy
  • discoveryengine.notebooks.setIamPolicy

Para mais informações, consulte a documentação do IAM.

SourceService

Serviço para gerir origens.

BatchCreateSources

rpc BatchCreateSources(BatchCreateSourcesRequest) returns (BatchCreateSourcesResponse)

Cria uma lista de Sources.

Âmbitos de autorização

Requer um dos seguintes âmbitos do OAuth:

  • https://www.googleapis.com/auth/cloud-platform
  • https://www.googleapis.com/auth/discoveryengine.readwrite

Para mais informações, consulte o Authentication Overview.

Autorizações de IAM

Requer a seguinte autorização de IAM no recurso parent:

  • discoveryengine.sources.create

Para mais informações, consulte a documentação do IAM.
BatchDeleteSources

rpc BatchDeleteSources(BatchDeleteSourcesRequest) returns (Empty)

Elimina várias fontes

Âmbitos de autorização

Requer um dos seguintes âmbitos do OAuth:

  • https://www.googleapis.com/auth/cloud-platform
  • https://www.googleapis.com/auth/discoveryengine.readwrite

Para mais informações, consulte o Authentication Overview.

Autorizações de IAM

Requer a seguinte autorização de IAM no recurso parent:

  • discoveryengine.sources.delete

Para mais informações, consulte a documentação do IAM.
GetSource

rpc GetSource(GetSourceRequest) returns (Source)

Obtém um Source.

Âmbitos de autorização

Requer um dos seguintes âmbitos do OAuth:

  • https://www.googleapis.com/auth/cloud-platform
  • https://www.googleapis.com/auth/discoveryengine.readwrite

Para mais informações, consulte o Authentication Overview.

Autorizações de IAM

Requer a seguinte autorização de IAM no recurso name:

  • discoveryengine.sources.get

Para mais informações, consulte a documentação do IAM.

AccountAndRole

Informações da conta e da função.

Campos
email

string

Obrigatório. O endereço de email associado à conta.
role

ProjectRole

Obrigatório. A função no bloco de notas.

AgentspaceMetadata

Metadados sobre uma origem do espaço de agentes.

Campos
document_name

string

Apenas saída. O nome completo do documento no Agentspace.
document_title

string

Apenas saída. O título do documento.

AudioOverview

Uma Vista geral de áudio de um notebook. Este é um resumo do bloco de notas em formato de áudio.

Campos
name

string

Identificador. O nome de recurso completo do bloco de notas. Formato: projects/{project}/locations/{location}/notebooks/{notebook}/audioOverviews/{audio_overview_id}.

Este campo tem de ser uma string codificada em UTF-8 com um limite de comprimento de 1024 carateres.
audio_overview_id

string

Apenas saída. ID exclusivo da vista geral de áudio.
status

AudioOverviewStatus

O estado do Resumo de áudio.
generation_options

AudioOverviewGenerationOptions

As opções usadas para gerar o Resumo de áudio.
mime_type

MimeType

O tipo MIME da Vista geral de áudio.
language_code

string

O código do idioma do Resumo de áudio gerado. Use o código de idioma BCP 47 (por exemplo, "en", "es", "hi", etc.).

MimeType

Tipos MIME suportados para resumos de áudio.

Enumerações
MIME_TYPE_UNKNOWN O tipo MIME não foi definido.
MIME_TYPE_WAV O tipo MIME é audio/wav.
MIME_TYPE_MP4 O tipo MIME é audio/mp4.

AudioOverviewGenerationOptions

Opções usadas durante a geração do Resumo de áudio.

Campos
source_ids[]

SourceId

Opcional. As fontes nas quais o Resumo de áudio se baseia.
episode_focus

string

Em que os anfitriões do programa se devem focar.
language_code

string

O idioma em que o Resumo de áudio foi pedido.

AudioOverviewStatus

O estado de um Resumo de áudio.

Enumerações
AUDIO_OVERVIEW_STATUS_UNSPECIFIED O estado não foi definido.
AUDIO_OVERVIEW_STATUS_NOT_STARTED A geração do Resumo de áudio ainda não começou.
AUDIO_OVERVIEW_STATUS_IN_PROGRESS O Resumo de áudio está a ser gerado.
AUDIO_OVERVIEW_STATUS_COMPLETE O Resumo de áudio foi gerado e está disponível.
AUDIO_OVERVIEW_STATUS_FAILED Não foi possível gerar o Resumo de áudio.

BatchCreateSourcesRequest

Pedido para o método SourceService.BatchCreateSources.

Campos
parent

string

Obrigatório. O recurso principal onde as fontes vão ser criadas. Formato: projects/{project}/locations/{location}/notebooks/{notebook}
user_contents[]

UserContent

Obrigatório. Os UserContents a carregar.

BatchCreateSourcesResponse

Resposta para o método SourceService.BatchCreateSources.

Campos
sources[]

Source

Os anos Source.

BatchDeleteNotebooksRequest

Pedido para o método NotebookService.BatchDeleteNotebooks.

Campos
parent

string

Obrigatório. O nome do recurso da ramificação principal, como projects/{project}/locations/{location}.
names[]

string

Obrigatório. Nomes completos dos recursos de Notebook, como projects/{project}/locations/{location}/notebooks/{notebook_id}.

BatchDeleteSourcesRequest

Pedido do método [SourceService.BatchDeleteSourcesRequest][].

Campos
parent

string

Obrigatório. O recurso principal onde as fontes vão ser eliminadas. Formato: projects/{project}/locations/{location}/notebooks/{notebook}
names[]

string

Obrigatório. Nomes das origens a eliminar. Formato: projects/{project}/locations/{location}/notebooks/{notebook}/sources/{source}

CmekConfig

Configuração de encriptação gerida pelo cliente para os blocos de notas.

Campos
kms_key

string

Obrigatório. Nome do recurso da chave do KMS que vai ser usado para encriptar recursos projects/{project}/locations/{location}/keyRings/{keyRing}/cryptoKeys/{keyId}.

CreateAudioOverviewRequest

Pedido para o método AudioOverviewService.CreateAudioOverview.

Campos
parent

string

Obrigatório. O recurso principal onde este bloco de notas vai ser criado. Formato: projects/{project}/locations/{location}/notebooks/{notebook}
generation_options

AudioOverviewGenerationOptions

Opções para a geração do Resumo de áudio.

CreateAudioOverviewResponse

Resposta para o método AudioOverviewService.CreateAudioOverview.

Campos
audio_overview

AudioOverview

O Resumo de áudio gerado.

CreateNotebookRequest

Pedido para o método NotebookService.CreateNotebook.

Campos
parent

string

Obrigatório. O nome do recurso principal, como projects/{project}/locations/{location}.
notebook

Notebook

Obrigatório. O notebook a criar.

DeleteAudioOverviewRequest

Pedido para o método AudioOverviewService.DeleteAudioOverview.

Campos
name

string

Obrigatório. O nome completo do recurso do AudioOverview, como projects/{project}/locations/{location}/notebooks/{notebook}/audioOverviews/{audio_overview_id}.

FailureReason

Motivo da falha com detalhes sobre o motivo pelo qual não foi possível carregar uma origem.

Campos
Campo de união error. O erro específico. error só pode ser uma das seguintes opções:
unknown

Unknown

Indica que ocorreu um erro desconhecido.
source_too_long

SourceTooLong

Indica que a contagem de palavras de origem excedeu o limite do utilizador.
ingestion_error

IngestionError

Indica que ocorreu um erro durante a ingestão da origem.
source_empty

SourceEmpty

Indica que a origem está vazia.
upload_error

UploadError

Indica que ocorreu um erro ao carregar a fonte.
paywall_error

PaywallError

Indica que a fonte está protegida por um paywall e não pode ser carregada.
source_unreachable

SourceUnreachable

Indica que a origem está inacessível.
google_drive_error

GoogleDriveError

Um erro específico do Google Drive.
youtube_error

YoutubeError

Um erro específico do YouTube.
audio_transcription_error

AudioTranscriptionError

Um erro específico da transcrição de um ficheiro de áudio.
source_limit_exceeded

SourceLimitExceeded

Erro se o utilizador tentar atualizar para além dos respetivos limites.
domain_blocked

DomainBlocked

Erro se o utilizador tentar adicionar uma fonte de um domínio bloqueado.

AudioTranscriptionError

Um erro específico da transcrição de um ficheiro de áudio.

Campos
Campo de união error. Erro específico da transcrição do ficheiro de áudio. error só pode ser uma das seguintes opções:
language_detection_failed

LanguageDetectionFailed

Não foi possível detetar o idioma do ficheiro (pode não ser voz).
no_audio_detected

NoAudioDetected

Não foi detetado áudio no ficheiro de entrada (pode ter sido um vídeo).

LanguageDetectionFailed

Este tipo não tem campos.

Não foi possível detetar o idioma do ficheiro (pode não ser voz).

NoAudioDetected

Este tipo não tem campos.

Não foi detetado áudio no ficheiro de entrada.

DomainBlocked

Este tipo não tem campos.

Erro para indicar que a origem foi removida porque o domínio foi bloqueado.

GoogleDriveError

Um erro específico do Google Drive.

Campos
Campo de união error. O erro específico do Drive. error só pode ser uma das seguintes opções:
download_prevented

DownloadPrevented

O utilizador foi impedido de transferir o ficheiro.

DownloadPrevented

Este tipo não tem campos.

O utilizador foi impedido de transferir o ficheiro.

IngestionError

Este tipo não tem campos.

Indica que ocorreu um erro durante a ingestão da origem.

PaywallError

Este tipo não tem campos.

Indica que a fonte está protegida por um paywall e não pode ser carregada.

SourceEmpty

Este tipo não tem campos.

Indica que a origem está vazia.

SourceLimitExceeded

Este tipo não tem campos.

Indica que o utilizador não tem espaço para esta fonte.

SourceTooLong

Indica que a contagem de palavras de origem excedeu o limite do utilizador.

Campos
word_count

int32

O número de palavras na fonte.
word_limit

int32

O limite de contagem de palavras para o utilizador atual no momento do carregamento.

SourceUnreachable

Indica que a origem está inacessível. Esta opção é usada principalmente para fontes adicionadas através de URL.

Campos
error_details

SourceUnreachableErrorReason

Descreve o motivo pelo qual a origem está inacessível.

Desconhecido

Este tipo não tem campos.

Indica que ocorreu um erro desconhecido.

UploadError

Este tipo não tem campos.

Indica que ocorreu um erro ao carregar a fonte.

YoutubeError

Um erro específico do YouTube.

Campos
Campo de união error. O erro específico do YouTube. error só pode ser uma das seguintes opções:
video_deleted

VideoDeleted

Erro para indicar que a origem foi removida porque o vídeo foi eliminado.

VideoDeleted

Este tipo não tem campos.

Erro para indicar que a origem foi removida porque o vídeo foi eliminado.

GetNotebookRequest

Pedido para o método NotebookService.GetNotebook.

Campos
name

string

Obrigatório. Nome completo do recurso de Notebook, como projects/{project}/locations/{location}/notebooks/{notebook_id}.

GetSourceRequest

Pedido para o método SourceService.GetSource.

Campos
name

string

Obrigatório. O nome do recurso para o formato de origem: projects/{project}/locations/{location}/notebooks/{notebook}/sources/{source}

GoogleDocsSourceMetadata

Metadados sobre uma origem de documentos do Google Docs.

Campos
document_id

string

Apenas saída. O ID do documento do Google Docs.
revision_id

string

Apenas saída. ID de revisão do documento.

ListRecentlyViewedNotebooksRequest

Pedido para o método NotebookService.ListRecentlyViewedNotebooks.

Campos
parent

string

Obrigatório. O nome do recurso da ramificação principal, como projects/{project}/locations/{location}.
page_size

int32

Opcional. Número máximo de Notebooks a devolver. Se não for especificado, a predefinição é "500". O valor máximo permitido é "500". Se este campo for negativo, é usado o valor predefinido.
page_token

string

Opcional. O token da página. Forneça-o para obter a página seguinte.

ListRecentlyViewedNotebooksResponse

Resposta para o método NotebookService.ListRecentlyViewedNotebooks.

Campos
notebooks[]

Notebook

A lista de blocos de notas vistos recentemente.
next_page_token

string

O token da página. Forneça-o para obter a página seguinte.

Bloco de notas

O Notebook é um recurso onde os utilizadores podem armazenar o respetivo conteúdo (como fontes) e interagir com o conteúdo.

Campos
name

string

Identificador. O identificador do bloco de notas. Formato: projects/{project}/locations/{location}/notebooks/{notebook_id}.

Este campo tem de ser uma string codificada em UTF-8.
sources[]

Source

Apenas saída. Lista de fontes no bloco de notas. Este é um campo apenas de saída.
cmek_config

CmekConfig

Apenas saída. Informações relacionadas com a CMEK para o notebook.
title

string

Opcional. O título do bloco de notas.
notebook_id

string

Apenas saída. O ID do bloco de notas, que é o último segmento do nome do recurso do bloco de notas.
emoji

string

Apenas saída. O emoji do notebook.
metadata

NotebookMetadata

Apenas saída. Os metadados do bloco de notas.

NotebookMetadata

Metadados de um bloco de notas.

Campos
is_shared

bool

Verdadeiro se este projeto estiver atualmente partilhado com outras pessoas, caso contrário, falso.
is_shareable

bool

Verdadeiro se o projeto for partilhável.
last_viewed

Timestamp

Uma data/hora que indica a hora em que o utilizador na sessão atual viu o projeto pela última vez.
create_time

Timestamp

A hora em que este projeto foi criado.

ProjectRole

A função do projeto.

Enumerações
PROJECT_ROLE_UNKNOWN Função desconhecida.
PROJECT_ROLE_OWNER O utilizador é proprietário do projeto.
PROJECT_ROLE_WRITER O utilizador tem autorizações de gravação no projeto.
PROJECT_ROLE_READER O utilizador tem autorizações de leitor no projeto.
PROJECT_ROLE_NOT_SHARED O utilizador não tem acesso ao projeto.

ShareNotebookRequest

Pedido para o método NotebookService.ShareNotebook.

Campos
name

string

Obrigatório. Nome completo do recurso de Notebook, como projects/{project}/locations/{location}/notebooks/{notebook_id}.
account_and_roles[]

AccountAndRole

Obrigatório. A lista de contas e funções com as quais quer partilhar o bloco de notas.
notify_via_email

bool

Obrigatório. Se deve notificar os utilizadores com quem partilhou por email.

ShareNotebookResponse

Este tipo não tem campos.

Resposta para o método NotebookService.ShareNotebook.

Origem

A origem representa uma única fonte de conteúdo.

Campos
name

string

Identificador. O nome de recurso completo da origem. Formato: projects/{project}/locations/{location}/notebooks/{notebook}/sources/{source_id}.

Este campo tem de ser uma string codificada em UTF-8 com um limite de comprimento de 1024 carateres.
title

string

Opcional. Título da fonte.
source_id

SourceId

Opcional. Apenas saída. O ID da origem, que é o último segmento do nome do recurso da origem.
metadata

SourceMetadata

Apenas saída. Metadados sobre a fonte.
settings

SourceSettings

Apenas saída. O estado da origem e os motivos de falha.

SourceId

SourceId é o último segmento do nome do recurso da origem.

Campos
id

string

O ID da origem.

SourceMetadata

Representa os metadados de uma origem e algumas informações adicionais.

Campos
Campo de união metadata. Metadados da fonte. metadata só pode ser uma das seguintes opções:
google_docs_metadata

GoogleDocsSourceMetadata

Metadados de uma origem do Google Docs.
youtube_metadata

YoutubeMetadata

Metadados para uma origem de vídeo do YouTube.
agentspace_metadata

AgentspaceMetadata

Metadados para uma origem do espaço do agente.
word_count

int32

A contagem de palavras da fonte.
token_count

int32

O número de tokens na origem.
source_added_timestamp

Timestamp

A indicação de tempo em que a fonte foi adicionada.

SourceSettings

Permite a extensão das definições de origem no BatchCreateSources (anteriormente, pedido AddSource).

Campos
status

SourceStatus

Estado da fonte.
failure_reason

FailureReason

Motivo da falha com detalhes sobre o motivo pelo qual não foi possível carregar uma origem.

SourceStatus

Lista de estados possíveis para uma origem.

Enumerações
SOURCE_STATUS_UNSPECIFIED Estado não especificado.
SOURCE_STATUS_PENDING A fonte está pendente de adição.
SOURCE_STATUS_COMPLETE A adição da origem está concluída e foi bem-sucedida.
SOURCE_STATUS_ERROR A adição da origem falhou permanentemente.
SOURCE_STATUS_PENDING_DELETION A origem está pendente de eliminação.
SOURCE_STATUS_TENTATIVE O utilizador está a tentar adicionar uma origem, mas ainda não a carregámos nem verificámos os limites de utilizadores. Não é contabilizado no limite de origens do utilizador.

SourceUnreachableErrorReason

Detalhes sobre o motivo pelo qual a origem está inacessível. Usado para apresentar a mensagem adequada ao utilizador.

Enumerações
ERROR_REASON_UNSPECIFIED Predefinição
ERROR_REASON_INVALID_URL O URL de origem é inválido.
ERROR_REASON_NOT_ACCESSIBLE Não é possível aceder ao URL de origem.
ERROR_REASON_NOT_REACHABLE Não é possível aceder ao URL de origem.
ERROR_REASON_URL_NOT_FOUND O URL de origem devolveu 404.
ERROR_REASON_TRANSIENT_ERROR O URL de origem não está acessível devido a um erro de rede temporário ou ao limite de tempo excedido do anfitrião, etc.
ERROR_REASON_FETCH_FAILED Não foi possível obter o URL de origem devido a um erro interno.
ERROR_REASON_NOT_SUPPORTED O URL ainda não é suportado. Os exemplos incluem: o conteúdo obtido excede o tamanho máximo de obtenção do rastreador, o conteúdo obtido é de um tipo que ainda não suportamos, etc.

UserContent

As mensagens "Conteúdo" referem-se aos dados que o utilizador quer carregar.

Campos
Campo de união content. O conteúdo do utilizador. content só pode ser uma das seguintes opções:
google_drive_content

GoogleDriveContent

O conteúdo do Google Drive.
text_content

TextContent

O conteúdo de texto carregado como origem.
web_content

WebContent

O conteúdo Web carregado como origem.
video_content

VideoContent

O conteúdo de vídeo carregado como origem.
agentspace_content

AgentspaceContent

Conteúdo do Agentspace carregado como origem.

AgentspaceContent

Conteúdo do Agentspace carregado como origem.

Campos
document_name

string

Opcional. O nome do recurso completo do documento Agentspace. Formato: projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/branches/{branch}/documents/{document_id}.
engine_name

string

Opcional. Motor para validar a autorização do documento. Formato: projects/{project}/locations/{location}/collections/{collection}/engines/{engine}.
ideaforge_idea_name

string

Opcional. Nome do recurso da instância do Idea Forge. Formato: projects/{project}/locations/{location}/collections/{collection}/engines/{engine}/sessions/{session}/ideaForgeInstances/{instance}

GoogleDriveContent

O conteúdo do Google Drive.

Campos
document_id

string

O ID do documento selecionado.
mime_type

string

O tipo MIME do documento selecionado.

Pode usar este parâmetro para diferenciar o tipo de conteúdo selecionado no selecionador do Drive. Use application/vnd.google-apps.document para o Google Docs ou application/vnd.google-apps.presentation para o Google Slides.
source_name

string

O nome a apresentar para a origem.

TextContent

O conteúdo de texto carregado como origem.

Campos
source_name

string

O nome a apresentar da origem de texto.
content

string

O nome a apresentar para a origem.

VideoContent

Conteúdo de vídeo carregado como origem.

Campos
Campo de união format. Especifica o formato do conteúdo de vídeo. formatSó pode ser um dos seguintes:
youtube_url

string

O URL do YouTube do conteúdo de vídeo.

WebContent

O conteúdo Web carregado como origem.

Campos
url

string

Se for fornecido um URL, a página Web é obtida no back-end.
source_name

string

O nome a apresentar para a origem.

YoutubeMetadata

Metadados sobre uma origem de vídeo do YouTube.

Campos
video_id

string

Apenas saída. O ID do vídeo do YouTube.
channel_name

string

Apenas saída. O nome do canal do vídeo do YouTube.