Package google.cloud.notebooklm.v1alpha

Índice

AudioOverviewService

Serviço para gerenciar resumos em áudio.

CreateAudioOverview

rpc CreateAudioOverview(CreateAudioOverviewRequest) returns (CreateAudioOverviewResponse)

Gera um novo Resumo em Áudio.

Escopos de autorização

Requer um dos seguintes escopos do OAuth:

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

Para mais informações, consulte Authentication Overview.

Permissões do IAM

Requer a seguinte permissão do IAM no recurso parent:

  • discoveryengine.audioOverviews.create

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

rpc DeleteAudioOverview(DeleteAudioOverviewRequest) returns (Empty)

Exclui um Resumo em Áudio.

Escopos de autorização

Requer um dos seguintes escopos do OAuth:

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

Para mais informações, consulte Authentication Overview.

Permissões do IAM

Requer a seguinte permissão do IAM no recurso name:

  • discoveryengine.audioOverviews.delete

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

NotebookService

Serviço para gerenciar notebooks.

BatchDeleteNotebooks

rpc BatchDeleteNotebooks(BatchDeleteNotebooksRequest) returns (Empty)

Exclui notebooks em lote.

Escopos de autorização

Requer um dos seguintes escopos do OAuth:

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

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

rpc CreateNotebook(CreateNotebookRequest) returns (Notebook)

Cria um notebook.

Escopos de autorização

Requer um dos seguintes escopos do OAuth:

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

Para mais informações, consulte Authentication Overview.

Permissões do IAM

Requer a seguinte permissão do 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.

Escopos de autorização

Requer um dos seguintes escopos do OAuth:

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

Para mais informações, consulte Authentication Overview.

Permissões do IAM

Requer a seguinte permissão do IAM no recurso name:

  • discoveryengine.notebooks.get

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

rpc ListRecentlyViewedNotebooks(ListRecentlyViewedNotebooksRequest) returns (ListRecentlyViewedNotebooksResponse)

Lista os notebooks ordenados pelo horário da última visualização.

Escopos de autorização

Requer um dos seguintes escopos do OAuth:

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

Para mais informações, consulte Authentication Overview.

Permissões do IAM

Requer a seguinte permissão do IAM no recurso parent:

  • discoveryengine.notebooks.list

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

rpc ShareNotebook(ShareNotebookRequest) returns (ShareNotebookResponse)

Compartilha um notebook com outras contas.

Escopos de autorização

Requer um dos seguintes escopos do OAuth:

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

Para mais informações, consulte Authentication Overview.

Permissões do IAM

Requer as seguintes permissões do IAM no recurso name:

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

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

SourceService

Serviço para gerenciar fontes.

BatchCreateSources

rpc BatchCreateSources(BatchCreateSourcesRequest) returns (BatchCreateSourcesResponse)

Cria uma lista de Sources.

Escopos de autorização

Requer um dos seguintes escopos do OAuth:

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

Para mais informações, consulte Authentication Overview.

Permissões do IAM

Requer a seguinte permissão do IAM no recurso parent:

  • discoveryengine.sources.create

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

rpc BatchDeleteSources(BatchDeleteSourcesRequest) returns (Empty)

Exclui várias fontes.

Escopos de autorização

Requer um dos seguintes escopos do OAuth:

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

Para mais informações, consulte Authentication Overview.

Permissões do IAM

Requer a seguinte permissão do IAM no recurso parent:

  • discoveryengine.sources.delete

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

rpc GetSource(GetSourceRequest) returns (Source)

Recebe um Source.

Escopos de autorização

Requer um dos seguintes escopos do OAuth:

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

Para mais informações, consulte Authentication Overview.

Permissões do IAM

Requer a seguinte permissão do 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 e-mail associado à conta.
role

ProjectRole

Obrigatório. A função no notebook.

AgentspaceMetadata

Metadados sobre uma origem do espaço de trabalho 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

Um Resumo em Áudio de um notebook. Este é um resumo do notebook em formato de áudio.

Campos
name

string

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

Este campo precisa ser uma string codificada em UTF-8 com um limite de 1.024 caracteres.
audio_overview_id

string

Apenas saída. ID exclusivo da visão geral em áudio.
status

AudioOverviewStatus

O status do Resumo em Áudio.
generation_options

AudioOverviewGenerationOptions

As opções usadas para gerar o Resumo em Áudio.
mime_type

MimeType

O tipo MIME do Resumo em Áudio.
language_code

string

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

MimeType

Tipos MIME compatíveis com os resumos em áudio.

Tipos enumerados
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 em Áudio.

Campos
source_ids[]

SourceId

Opcional. As fontes em que o Resumo em Áudio se baseia.
episode_focus

string

Em quais aspectos os apresentadores do programa devem se concentrar.
language_code

string

O idioma em que o Resumo em Áudio foi solicitado.

AudioOverviewStatus

O status de um Resumo em Áudio.

Tipos enumerados
AUDIO_OVERVIEW_STATUS_UNSPECIFIED O status não foi definido.
AUDIO_OVERVIEW_STATUS_NOT_STARTED O Resumo em Áudio ainda não começou a ser gerado.
AUDIO_OVERVIEW_STATUS_IN_PROGRESS O Resumo em Áudio está sendo gerado.
AUDIO_OVERVIEW_STATUS_COMPLETE O Resumo em Áudio foi gerado e está disponível.
AUDIO_OVERVIEW_STATUS_FAILED Não foi possível gerar o Resumo em Áudio.

BatchCreateSourcesRequest

Solicitação para o método SourceService.BatchCreateSources.

Campos
parent

string

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

UserContent

Obrigatório. Os UserContents a serem enviados.

BatchCreateSourcesResponse

Resposta para o método SourceService.BatchCreateSources.

Campos
sources[]

Source

Os Sources.

BatchDeleteNotebooksRequest

Solicitação 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 de recursos completos de Notebook, como projects/{project}/locations/{location}/notebooks/{notebook_id}.

BatchDeleteSourcesRequest

Solicitação para o método [SourceService.BatchDeleteSourcesRequest][].

Campos
parent

string

Obrigatório. O recurso pai em que as fontes serão excluídas. Formato: projects/{project}/locations/{location}/notebooks/{notebook}
names[]

string

Obrigatório. Nomes das fontes a serem excluídas. Formato: projects/{project}/locations/{location}/notebooks/{notebook}/sources/{source}

CmekConfig

Configuração de criptografia gerenciada pelo cliente para notebooks.

Campos
kms_key

string

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

CreateAudioOverviewRequest

Solicitação para o método AudioOverviewService.CreateAudioOverview.

Campos
parent

string

Obrigatório. O recurso pai em que o notebook será criado. Formato: projects/{project}/locations/{location}/notebooks/{notebook}
generation_options

AudioOverviewGenerationOptions

Opções para a geração do Resumo em Áudio.

CreateAudioOverviewResponse

Resposta para o método AudioOverviewService.CreateAudioOverview.

Campos
audio_overview

AudioOverview

O Resumo em Áudio gerado.

CreateNotebookRequest

Solicitação para o método NotebookService.CreateNotebook.

Campos
parent

string

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

Notebook

Obrigatório. O notebook a ser criado.

DeleteAudioOverviewRequest

Solicitação 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 por que uma origem não foi ingerida.

Campos
Campo de união error. O erro específico. error pode ser apenas de um dos tipos a seguir:
unknown

Unknown

Indica que ocorreu um erro desconhecido.
source_too_long

SourceTooLong

Indica que a contagem de palavras da fonte excedeu o limite do usuário.
ingestion_error

IngestionError

Indica que ocorreu um erro ao ingerir a origem.
source_empty

SourceEmpty

Indica que a origem está vazia.
upload_error

UploadError

Indica que ocorreu um erro ao fazer o upload da origem.
paywall_error

PaywallError

Indica que a fonte está protegida por paywall e não pode ser ingerida.
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 de transcrição de arquivo de áudio.
source_limit_exceeded

SourceLimitExceeded

Erro se o usuário tentar atualizar além dos limites.
domain_blocked

DomainBlocked

Erro se o usuário tentar adicionar uma fonte de um domínio bloqueado.

AudioTranscriptionError

Um erro específico de transcrição de arquivo de áudio.

Campos
Campo de união error. O erro específico da transcrição do arquivo de áudio. error pode ser apenas de um dos tipos a seguir:
language_detection_failed

LanguageDetectionFailed

Não foi possível detectar o idioma do arquivo. Talvez ele não seja de fala.
no_audio_detected

NoAudioDetected

Nenhum áudio foi detectado no arquivo de entrada (talvez fosse um vídeo).

LanguageDetectionFailed

Esse tipo não tem campos.

Não foi possível detectar o idioma do arquivo. Talvez ele não seja de fala.

NoAudioDetected

Esse tipo não tem campos.

Nenhum áudio foi detectado no arquivo de entrada.

DomainBlocked

Esse 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 pode ser apenas de um dos tipos a seguir:
download_prevented

DownloadPrevented

O usuário não pôde fazer o download do arquivo.

DownloadPrevented

Esse tipo não tem campos.

O usuário não pôde fazer o download do arquivo.

IngestionError

Esse tipo não tem campos.

Indica que ocorreu um erro ao ingerir a origem.

PaywallError

Esse tipo não tem campos.

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

SourceEmpty

Esse tipo não tem campos.

Indica que a origem está vazia.

SourceLimitExceeded

Esse tipo não tem campos.

Indica que o usuário não tem espaço para essa fonte.

SourceTooLong

Indica que a contagem de palavras da fonte excedeu o limite do usuário.

Campos
word_count

int32

O número de palavras na fonte.
word_limit

int32

O limite de contagem de palavras para o usuário atual no momento do envio.

SourceUnreachable

Indica que a origem está inacessível. Isso é usado principalmente para fontes adicionadas por URL.

Campos
error_details

SourceUnreachableErrorReason

Descreve por que a origem está inacessível.

Desconhecido

Esse tipo não tem campos.

Indica que ocorreu um erro desconhecido.

UploadError

Esse tipo não tem campos.

Indica que ocorreu um erro ao fazer o upload da origem.

YoutubeError

Um erro específico do YouTube.

Campos
Campo de união error. O erro específico do YouTube. error pode ser apenas de um dos tipos a seguir:
video_deleted

VideoDeleted

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

VideoDeleted

Esse tipo não tem campos.

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

GetNotebookRequest

Solicitação 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

Solicitação para o método SourceService.GetSource.

Campos
name

string

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

GoogleDocsSourceMetadata

Metadados sobre uma fonte de documento Google.

Campos
document_id

string

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

string

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

ListRecentlyViewedNotebooksRequest

Solicitação 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 serem retornados. Se não for especificado, o padrão será "500". O valor máximo permitido é "500". Se esse campo for negativo, o valor padrão será usado.
page_token

string

Opcional. O token da página. Forneça isso para recuperar a página subsequente.

ListRecentlyViewedNotebooksResponse

Resposta para o método NotebookService.ListRecentlyViewedNotebooks.

Campos
notebooks[]

Notebook

A lista de notebooks acessados recentemente.
next_page_token

string

O token da página. Forneça isso para recuperar a página subsequente.

Notebook

O notebook é um recurso em que os usuários podem armazenar e interagir com o conteúdo (como fontes).

Campos
name

string

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

Esse campo precisa ser uma string codificada em UTF-8.
sources[]

Source

Apenas saída. Lista de fontes no notebook. Este é um campo somente saída.
cmek_config

CmekConfig

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

string

Opcional. O título do notebook.
notebook_id

string

Apenas saída. ID do notebook, que é o último segmento do nome do recurso do notebook.
emoji

string

Apenas saída. O emoji do notebook.
metadata

NotebookMetadata

Apenas saída. Os metadados do notebook.

NotebookMetadata

Metadados de um notebook.

Campos
is_shared

bool

True se o projeto estiver compartilhado com outras pessoas. Caso contrário, será false.
is_shareable

bool

Verdadeiro se o projeto puder ser compartilhado.
last_viewed

Timestamp

Um carimbo de data/hora que indica a última vez que o usuário na sessão visualizou o projeto.
create_time

Timestamp

O horário em que o projeto foi criado.

ProjectRole

A função do projeto.

Tipos enumerados
PROJECT_ROLE_UNKNOWN Função desconhecida.
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.

ShareNotebookRequest

Solicitação 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 papéis com que o notebook será compartilhado.
notify_via_email

bool

Obrigatório. Se os usuários compartilhados serão notificados por e-mail.

ShareNotebookResponse

Esse 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 completo do recurso da origem. Formato: projects/{project}/locations/{location}/notebooks/{notebook}/sources/{source_id}.

Este campo precisa ser uma string codificada em UTF-8 com um limite de 1.024 caracteres.
title

string

Opcional. Título da fonte.
source_id

SourceId

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

SourceMetadata

Apenas saída. Metadados sobre a origem.
settings

SourceSettings

Apenas saída. Status da origem e 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 fonte e algumas informações adicionais.

Campos
Campo de união metadata. Metadados da origem. metadata pode ser apenas de um dos tipos a seguir:
google_docs_metadata

GoogleDocsSourceMetadata

Metadados de uma fonte de documento Google.
youtube_metadata

YoutubeMetadata

Metadados de uma fonte de vídeo do YouTube.
agentspace_metadata

AgentspaceMetadata

Metadados de uma fonte do Agentspace.
word_count

int32

A contagem de palavras da fonte.
token_count

int32

O número de tokens na origem.
source_added_timestamp

Timestamp

O carimbo de data/hora em que a fonte foi adicionada.

SourceSettings

Permite a extensão das configurações de origem em BatchCreateSources (antiga solicitação AddSource).

Campos
status

SourceStatus

Status da origem.
failure_reason

FailureReason

Motivo da falha com detalhes sobre por que uma origem não foi ingerida.

SourceStatus

Lista de possíveis status para uma fonte.

Tipos enumerados
SOURCE_STATUS_UNSPECIFIED Status não especificado.
SOURCE_STATUS_PENDING A fonte está pendente de adição.
SOURCE_STATUS_COMPLETE A adição de origem foi concluída e bem-sucedida.
SOURCE_STATUS_ERROR A adição da origem falhou permanentemente.
SOURCE_STATUS_PENDING_DELETION A exclusão da origem está pendente.
SOURCE_STATUS_TENTATIVE O usuário está tentando adicionar uma fonte, mas ainda não fizemos o upload nem verificamos os limites do usuário. Não conta para o limite de fontes do usuário.

SourceUnreachableErrorReason

Detalhes sobre por que a origem está inacessível. Usado para mostrar a mensagem adequada ao usuário.

Tipos enumerados
ERROR_REASON_UNSPECIFIED Padrão
ERROR_REASON_INVALID_URL O URL de origem é inválido.
ERROR_REASON_NOT_ACCESSIBLE Não é possível acessar o URL de origem.
ERROR_REASON_NOT_REACHABLE Não é possível acessar o URL de origem.
ERROR_REASON_URL_NOT_FOUND O URL de origem retornou o erro 404.
ERROR_REASON_TRANSIENT_ERROR O URL de origem não está acessível devido a um erro de rede temporário, um tempo limite do host etc.
ERROR_REASON_FETCH_FAILED Não foi possível buscar o URL de origem devido a um erro interno.
ERROR_REASON_NOT_SUPPORTED O URL ainda não é compatível. Por exemplo, o conteúdo buscado excede o tamanho máximo de busca do rastreador, o conteúdo buscado é de um tipo que ainda não oferecemos suporte etc.

UserContent

As mensagens de "Conteúdo" se referem aos dados que o usuário quer enviar.

Campos
Campo de união content. O conteúdo do usuário. content pode ser apenas de um dos tipos a seguir:
google_drive_content

GoogleDriveContent

O conteúdo do Google Drive.
text_content

TextContent

O conteúdo de texto enviado como fonte.
web_content

WebContent

O conteúdo da Web enviado como fonte.
video_content

VideoContent

O conteúdo de vídeo enviado como fonte.
agentspace_content

AgentspaceContent

Conteúdo do Agentspace enviado como fonte.

AgentspaceContent

Conteúdo do Agentspace enviado como fonte.

Campos
document_name

string

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

string

Opcional. Mecanismo para verificar a permissã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.

Isso pode ser usado para diferenciar o tipo de conteúdo selecionado no seletor do Drive. Use application/vnd.google-apps.document para o Google Docs ou application/vnd.google-apps.presentation para o Google Apresentações.
source_name

string

O nome a ser exibido para a origem.

TextContent

O conteúdo de texto enviado como fonte.

Campos
source_name

string

O nome de exibição da fonte de texto.
content

string

O nome a ser exibido para a origem.

VideoContent

Conteúdo de vídeo enviado como fonte.

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

string

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

WebContent

O conteúdo da Web enviado como fonte.

Campos
url

string

Se um URL for fornecido, a página da Web será buscada no back-end.
source_name

string

O nome a ser exibido para a origem.

YoutubeMetadata

Metadados sobre uma fonte 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.