Package google.cloud.notebooklm.v1alpha

Índice

AudioOverviewService

Servicio para administrar resúmenes de audio.

CreateAudioOverview

rpc CreateAudioOverview(CreateAudioOverviewRequest) returns (CreateAudioOverviewResponse)

Genera un resumen de audio nuevo.

Permisos de autorización

Se necesita uno de los siguientes permisos de OAuth:

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

Para obtener más información, consulta Authentication Overview.

Permisos de IAM

Se requiere el siguiente permiso de IAM en el recurso parent:

  • discoveryengine.audioOverviews.create

Para obtener más información, consulta la documentación de IAM.
DeleteAudioOverview

rpc DeleteAudioOverview(DeleteAudioOverviewRequest) returns (Empty)

Borra un resumen de audio.

Permisos de autorización

Se necesita uno de los siguientes permisos de OAuth:

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

Para obtener más información, consulta Authentication Overview.

Permisos de IAM

Se requiere el siguiente permiso de IAM en el recurso name:

  • discoveryengine.audioOverviews.delete

Para obtener más información, consulta la documentación de IAM.

NotebookService

Servicio para administrar notebooks.

BatchDeleteNotebooks

rpc BatchDeleteNotebooks(BatchDeleteNotebooksRequest) returns (Empty)

Borra Notebooks por lotes.

Permisos de autorización

Se necesita uno de los siguientes permisos de OAuth:

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

Para obtener más información, consulta Authentication Overview.
CreateNotebook

rpc CreateNotebook(CreateNotebookRequest) returns (Notebook)

Crea un notebook.

Permisos de autorización

Se necesita uno de los siguientes permisos de OAuth:

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

Para obtener más información, consulta Authentication Overview.

Permisos de IAM

Se requiere el siguiente permiso de IAM en el recurso parent:

  • discoveryengine.notebooks.create

Para obtener más información, consulta la documentación de IAM.
GetNotebook

rpc GetNotebook(GetNotebookRequest) returns (Notebook)

Obtiene un notebook.

Permisos de autorización

Se necesita uno de los siguientes permisos de OAuth:

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

Para obtener más información, consulta Authentication Overview.

Permisos de IAM

Se requiere el siguiente permiso de IAM en el recurso name:

  • discoveryengine.notebooks.get

Para obtener más información, consulta la documentación de IAM.
ListRecentlyViewedNotebooks

rpc ListRecentlyViewedNotebooks(ListRecentlyViewedNotebooksRequest) returns (ListRecentlyViewedNotebooksResponse)

Enumera los notebooks ordenados por la fecha y hora de la última vista.

Permisos de autorización

Se necesita uno de los siguientes permisos de OAuth:

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

Para obtener más información, consulta Authentication Overview.

Permisos de IAM

Se requiere el siguiente permiso de IAM en el recurso parent:

  • discoveryengine.notebooks.list

Para obtener más información, consulta la documentación de IAM.
ShareNotebook

rpc ShareNotebook(ShareNotebookRequest) returns (ShareNotebookResponse)

Comparte un cuaderno con otras cuentas.

Permisos de autorización

Se necesita uno de los siguientes permisos de OAuth:

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

Para obtener más información, consulta Authentication Overview.

Permisos de IAM

Se requieren los siguientes permisos de IAM en el recurso name:

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

Para obtener más información, consulta la documentación de IAM.

SourceService

Servicio para administrar fuentes.

BatchCreateSources

rpc BatchCreateSources(BatchCreateSourcesRequest) returns (BatchCreateSourcesResponse)

Crea una lista de Sources.

Permisos de autorización

Se necesita uno de los siguientes permisos de OAuth:

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

Para obtener más información, consulta Authentication Overview.

Permisos de IAM

Se requiere el siguiente permiso de IAM en el recurso parent:

  • discoveryengine.sources.create

Para obtener más información, consulta la documentación de IAM.
BatchDeleteSources

rpc BatchDeleteSources(BatchDeleteSourcesRequest) returns (Empty)

Borra varias fuentes

Permisos de autorización

Se necesita uno de los siguientes permisos de OAuth:

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

Para obtener más información, consulta Authentication Overview.

Permisos de IAM

Se requiere el siguiente permiso de IAM en el recurso parent:

  • discoveryengine.sources.delete

Para obtener más información, consulta la documentación de IAM.
GetSource

rpc GetSource(GetSourceRequest) returns (Source)

Obtienes una Source.

Permisos de autorización

Se necesita uno de los siguientes permisos de OAuth:

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

Para obtener más información, consulta Authentication Overview.

Permisos de IAM

Se requiere el siguiente permiso de IAM en el recurso name:

  • discoveryengine.sources.get

Para obtener más información, consulta la documentación de IAM.

AccountAndRole

Información de la cuenta y el rol

Campos
email

string

Obligatorio. Es la dirección de correo electrónico asociada a la cuenta.
role

ProjectRole

Obligatorio. Es el rol en el notebook.

AgentspaceMetadata

Son los metadatos sobre una fuente de Agentspace.

Campos
document_name

string

Solo salida. Es el nombre completo del documento en Agentspace.
document_title

string

Solo salida. Es el título del documento.

AudioOverview

Un resumen de audio de un cuaderno. Este es un resumen del notebook en formato de audio.

Campos
name

string

Es el identificador. Es el nombre completo del recurso del notebook. Formato: projects/{project}/locations/{location}/notebooks/{notebook}/audioOverviews/{audio_overview_id}.

Este campo debe ser una cadena codificada en UTF-8 con un límite de longitud de 1,024 caracteres.
audio_overview_id

string

Solo salida. Es el ID único de la descripción general de audio.
status

AudioOverviewStatus

Es el estado del resumen de audio.
generation_options

AudioOverviewGenerationOptions

Son las opciones que se usan para generar el resumen de audio.
mime_type

MimeType

Es el tipo MIME del resumen de audio.
language_code

string

Es el código de idioma del resumen de audio generado. Usa el código de idioma BCP 47 (p. ej., "en", "es", "hi", etcétera).

MimeType

Son los tipos de MIME admitidos para los resúmenes de audio.

Enums
MIME_TYPE_UNKNOWN No se configuró el tipo de MIME.
MIME_TYPE_WAV El tipo de MIME es audio/wav.
MIME_TYPE_MP4 El tipo de MIME es audio/mp4.

AudioOverviewGenerationOptions

Son las opciones que se usan durante la generación del resumen de audio.

Campos
source_ids[]

SourceId

Opcional. Son las fuentes en las que se basa el resumen de audio.
episode_focus

string

En qué deberían enfocarse los presentadores del programa
language_code

string

Es el idioma en el que se solicitó el resumen de audio.

AudioOverviewStatus

Es el estado de un resumen de audio.

Enums
AUDIO_OVERVIEW_STATUS_UNSPECIFIED No se estableció el estado.
AUDIO_OVERVIEW_STATUS_NOT_STARTED No se comenzó a generar el resumen de audio.
AUDIO_OVERVIEW_STATUS_IN_PROGRESS Se está generando el resumen de audio.
AUDIO_OVERVIEW_STATUS_COMPLETE Se generó el resumen de audio y está disponible.
AUDIO_OVERVIEW_STATUS_FAILED No se pudo generar el resumen de audio.

BatchCreateSourcesRequest

Es la solicitud para el método SourceService.BatchCreateSources.

Campos
parent

string

Obligatorio. Es el recurso principal en el que se crearán las fuentes. Formato: projects/{project}/locations/{location}/notebooks/{notebook}
user_contents[]

UserContent

Obligatorio. Son los UserContent que se subirán.

BatchCreateSourcesResponse

Respuesta del método SourceService.BatchCreateSources.

Campos
sources[]

Source

Los Source.

BatchDeleteNotebooksRequest

Es la solicitud para el método NotebookService.BatchDeleteNotebooks.

Campos
parent

string

Obligatorio. Es el nombre del recurso de la rama principal, como projects/{project}/locations/{location}.
names[]

string

Obligatorio. Nombres de recursos completos de Notebook, como projects/{project}/locations/{location}/notebooks/{notebook_id}.

BatchDeleteSourcesRequest

Es la solicitud para el método [SourceService.BatchDeleteSourcesRequest][].

Campos
parent

string

Obligatorio. Es el recurso principal en el que se borrarán las fuentes. Formato: projects/{project}/locations/{location}/notebooks/{notebook}
names[]

string

Obligatorio. Nombres de las fuentes que se borrarán. Formato: projects/{project}/locations/{location}/notebooks/{notebook}/sources/{source}

CmekConfig

Es la configuración de la encriptación administrada por el cliente para Notebooks.

Campos
kms_key

string

Obligatorio. Es el nombre del recurso de la clave de KMS que se usará para encriptar los recursos projects/{project}/locations/{location}/keyRings/{keyRing}/cryptoKeys/{keyId}.

CreateAudioOverviewRequest

Es la solicitud para el método AudioOverviewService.CreateAudioOverview.

Campos
parent

string

Obligatorio. Es el recurso principal en el que se creará este notebook. Formato: projects/{project}/locations/{location}/notebooks/{notebook}
generation_options

AudioOverviewGenerationOptions

Son las opciones para la generación del resumen de audio.

CreateAudioOverviewResponse

Respuesta del método AudioOverviewService.CreateAudioOverview.

Campos
audio_overview

AudioOverview

Es el resumen de audio generado.

CreateNotebookRequest

Es la solicitud para el método NotebookService.CreateNotebook.

Campos
parent

string

Obligatorio. Es el nombre del recurso principal, como projects/{project}/locations/{location}.
notebook

Notebook

Obligatorio. Es el notebook que se creará.

DeleteAudioOverviewRequest

Es la solicitud para el método AudioOverviewService.DeleteAudioOverview.

Campos
name

string

Obligatorio. Es el nombre completo del recurso AudioOverview, como projects/{project}/locations/{location}/notebooks/{notebook}/audioOverviews/{audio_overview_id}.

FailureReason

Es el motivo del error que contiene detalles sobre por qué no se pudo completar la transferencia de una fuente.

Campos
Campo de unión error. Es el error específico. error puede ser solo uno de los siguientes:
unknown

Unknown

Indica que se produjo un error desconocido.
source_too_long

SourceTooLong

Indica que el recuento de palabras de la fuente superó el límite del usuario.
ingestion_error

IngestionError

Indica que se produjo un error durante la transferencia de la fuente.
source_empty

SourceEmpty

Indica que la fuente está vacía.
upload_error

UploadError

Indica que se produjo un error al subir la fuente.
paywall_error

PaywallError

Indica que la fuente está protegida por un muro de pago y no se puede transferir.
source_unreachable

SourceUnreachable

Indica que no se puede acceder a la fuente.
google_drive_error

GoogleDriveError

Es un error específico de Google Drive.
youtube_error

YoutubeError

Es un error específico de YouTube.
audio_transcription_error

AudioTranscriptionError

Es un error específico de la transcripción de un archivo de audio.
source_limit_exceeded

SourceLimitExceeded

Se produce un error si el usuario intenta actualizar más allá de sus límites.
domain_blocked

DomainBlocked

Se produce un error si el usuario intenta agregar una fuente desde un dominio bloqueado.

AudioTranscriptionError

Es un error específico de la transcripción de un archivo de audio.

Campos
Campo de unión error. Es el error específico de la transcripción del archivo de audio. error puede ser solo uno de los siguientes:
language_detection_failed

LanguageDetectionFailed

No se pudo detectar el idioma del archivo (es posible que no sea voz).
no_audio_detected

NoAudioDetected

No se detectó audio en el archivo de entrada (es posible que haya sido un video).

LanguageDetectionFailed

Este tipo no tiene campos.

No se pudo detectar el idioma del archivo (es posible que no sea voz).

NoAudioDetected

Este tipo no tiene campos.

No se detectó audio en el archivo de entrada.

DomainBlocked

Este tipo no tiene campos.

Es un error que indica que se quitó la fuente porque se bloqueó el dominio.

GoogleDriveError

Es un error específico de Google Drive.

Campos
Campo de unión error. Es el error específico de Drive. error puede ser solo uno de los siguientes:
download_prevented

DownloadPrevented

Se impidió que el usuario descargara el archivo.

DownloadPrevented

Este tipo no tiene campos.

Se impidió que el usuario descargara el archivo.

IngestionError

Este tipo no tiene campos.

Indica que se produjo un error durante la transferencia de la fuente.

PaywallError

Este tipo no tiene campos.

Indica que la fuente está protegida por un muro de pago y no se puede transferir.

SourceEmpty

Este tipo no tiene campos.

Indica que la fuente está vacía.

SourceLimitExceeded

Este tipo no tiene campos.

Indica que el usuario no tiene espacio para esta fuente.

SourceTooLong

Indica que el recuento de palabras de la fuente superó el límite del usuario.

Campos
word_count

int32

Es la cantidad de palabras en la fuente.
word_limit

int32

Es el límite de recuento de palabras para el usuario actual en el momento de la carga.

SourceUnreachable

Indica que no se puede acceder a la fuente. Se usa principalmente para las fuentes que se agregan a través de una URL.

Campos
error_details

SourceUnreachableErrorReason

Describe por qué no se puede acceder a la fuente.

Desconocido

Este tipo no tiene campos.

Indica que se produjo un error desconocido.

UploadError

Este tipo no tiene campos.

Indica que se produjo un error al subir la fuente.

YoutubeError

Es un error específico de YouTube.

Campos
Campo de unión error. Es el error específico de YouTube. error puede ser solo uno de los siguientes:
video_deleted

VideoDeleted

Es un error que indica que se quitó la fuente porque se borró el video.

VideoDeleted

Este tipo no tiene campos.

Es un error que indica que se quitó la fuente porque se borró el video.

GetNotebookRequest

Es la solicitud para el método NotebookService.GetNotebook.

Campos
name

string

Obligatorio. Nombre completo del recurso Notebook, como projects/{project}/locations/{location}/notebooks/{notebook_id}.

GetSourceRequest

Es la solicitud para el método SourceService.GetSource.

Campos
name

string

Obligatorio. Nombre del recurso para la fuente. El formato es projects/{project}/locations/{location}/notebooks/{notebook}/sources/{source}.

GoogleDocsSourceMetadata

Son los metadatos sobre una fuente de documentos de Google.

Campos
document_id

string

Solo salida. Es el ID del documento de Google Docs.
revision_id

string

Solo salida. Es el ID de revisión del documento.

ListRecentlyViewedNotebooksRequest

Es la solicitud para el método NotebookService.ListRecentlyViewedNotebooks.

Campos
parent

string

Obligatorio. Es el nombre del recurso de la rama principal, como projects/{project}/locations/{location}.
page_size

int32

Opcional. Cantidad máxima de Notebooks que se devolverán. Si no se especifica, el valor predeterminado es "500". El valor máximo permitido es "500". Si este campo es negativo, se usará el valor predeterminado.
page_token

string

Opcional. Es el token de página que se debe proporcionar para recuperar la página siguiente.

ListRecentlyViewedNotebooksResponse

Respuesta del método NotebookService.ListRecentlyViewedNotebooks.

Campos
notebooks[]

Notebook

Es la lista de notebooks vistos recientemente.
next_page_token

string

Es el token de página que se debe proporcionar para recuperar la página siguiente.

Notebook

Notebook es un recurso en el que los usuarios pueden almacenar su contenido (como fuentes) y, luego, interactuar con él.

Campos
name

string

Es el identificador. Es el identificador del notebook. Formato: projects/{project}/locations/{location}/notebooks/{notebook_id}.

Este campo debe ser una cadena codificada en UTF-8.
sources[]

Source

Solo salida. Lista de fuentes en el notebook. Este campo es solo de salida.
cmek_config

CmekConfig

Solo salida. Es la información relacionada con la CMEK del notebook.
title

string

Opcional. Es el título del notebook.
notebook_id

string

Solo salida. Es el ID del notebook, que es el último segmento del nombre del recurso del notebook.
emoji

string

Solo salida. Emoji del notebook.
metadata

NotebookMetadata

Solo salida. Son los metadatos del notebook.

NotebookMetadata

Son los metadatos de un notebook.

Campos
is_shared

bool

Es verdadero si este proyecto se comparte actualmente con otras personas y falso en caso contrario.
is_shareable

bool

Es verdadero si el proyecto se puede compartir.
last_viewed

Timestamp

Es una marca de tiempo que indica la hora en que el usuario actual que está en la sesión vio el proyecto por última vez.
create_time

Timestamp

Es la fecha y hora en la que se creó este proyecto.

ProjectRole

Es el rol del proyecto.

Enums
PROJECT_ROLE_UNKNOWN Rol desconocido.
PROJECT_ROLE_OWNER El usuario es propietario del proyecto.
PROJECT_ROLE_WRITER El usuario tiene permisos de escritura en el proyecto.
PROJECT_ROLE_READER El usuario tiene permisos de lector en el proyecto.
PROJECT_ROLE_NOT_SHARED El usuario no tiene acceso al proyecto.

ShareNotebookRequest

Es la solicitud para el método NotebookService.ShareNotebook.

Campos
name

string

Obligatorio. Nombre completo del recurso Notebook, como projects/{project}/locations/{location}/notebooks/{notebook_id}.
account_and_roles[]

AccountAndRole

Obligatorio. Es la lista de cuentas y roles con los que se compartirá el notebook.
notify_via_email

bool

Obligatorio. Indica si se debe notificar a los usuarios con los que se compartió el contenido por correo electrónico.

ShareNotebookResponse

Este tipo no tiene campos.

Respuesta del método NotebookService.ShareNotebook.

Fuente

Source representa una sola fuente de contenido.

Campos
name

string

Es el identificador. Es el nombre completo del recurso de la fuente. Formato: projects/{project}/locations/{location}/notebooks/{notebook}/sources/{source_id}.

Este campo debe ser una cadena codificada en UTF-8 con un límite de longitud de 1,024 caracteres.
title

string

Opcional. Es el título de la fuente.
source_id

SourceId

Opcional. Solo salida. Es el ID de la fuente, que es el último segmento del nombre del recurso de la fuente.
metadata

SourceMetadata

Solo salida. Son los metadatos sobre la fuente.
settings

SourceSettings

Solo salida. Es el estado de la fuente y los motivos de cualquier falla.

SourceId

SourceId es el último segmento del nombre del recurso de la fuente.

Campos
id

string

Es el ID de la fuente.

SourceMetadata

Representa los metadatos de una fuente y cierta información adicional.

Campos
Campo de unión metadata. Son los metadatos de la fuente. metadata puede ser solo uno de los siguientes:
google_docs_metadata

GoogleDocsSourceMetadata

Son los metadatos de una fuente de documentos de Google.
youtube_metadata

YoutubeMetadata

Son los metadatos de una fuente de video de YouTube.
agentspace_metadata

AgentspaceMetadata

Son los metadatos de una fuente de Agentspace.
word_count

int32

Es el recuento de palabras de la fuente.
token_count

int32

Es la cantidad de tokens en la fuente.
source_added_timestamp

Timestamp

Es la marca de tiempo en la que se agregó la fuente.

SourceSettings

Permite extender la configuración de la fuente en BatchCreateSources (anteriormente, solicitud AddSource).

Campos
status

SourceStatus

Es el estado de la fuente.
failure_reason

FailureReason

Es el motivo del error que contiene detalles sobre por qué no se pudo completar la transferencia de una fuente.

SourceStatus

Es la lista de estados posibles para una fuente.

Enums
SOURCE_STATUS_UNSPECIFIED Indica que no se especificó el estado.
SOURCE_STATUS_PENDING La fuente está pendiente de agregarse.
SOURCE_STATUS_COMPLETE Se completó correctamente la adición de la fuente.
SOURCE_STATUS_ERROR No se pudo agregar la fuente de forma permanente.
SOURCE_STATUS_PENDING_DELETION La fuente está pendiente de eliminación.
SOURCE_STATUS_TENTATIVE El usuario intenta agregar una fuente, pero aún no la subimos ni verificamos los límites del usuario. No se tiene en cuenta para el límite de fuentes del usuario.

SourceUnreachableErrorReason

Son los detalles sobre por qué no se puede acceder a la fuente. Se usa para mostrar el mensaje adecuado al usuario.

Enums
ERROR_REASON_UNSPECIFIED Predeterminado
ERROR_REASON_INVALID_URL La URL de origen no es válida.
ERROR_REASON_NOT_ACCESSIBLE No se puede acceder a la URL de origen.
ERROR_REASON_NOT_REACHABLE No se puede acceder a la URL de origen.
ERROR_REASON_URL_NOT_FOUND La URL de origen devolvió un error 404.
ERROR_REASON_TRANSIENT_ERROR No se puede acceder a la URL de origen debido a un error de red transitorio, un tiempo de espera del host, etcétera.
ERROR_REASON_FETCH_FAILED No se pudo recuperar la URL de origen debido a un error interno.
ERROR_REASON_NOT_SUPPORTED Aún no se admite la URL. Entre los ejemplos, se incluyen los siguientes: el contenido recuperado supera el tamaño máximo de recuperación del rastreador, el contenido recuperado es de un tipo que aún no admitimos, etcétera.

UserContent

Los mensajes de "Content" hacen referencia a los datos que el usuario desea subir.

Campos
Campo de unión content. Es el contenido del usuario. content puede ser solo uno de los siguientes:
google_drive_content

GoogleDriveContent

Es el contenido de Google Drive.
text_content

TextContent

Es el contenido de texto que se subió como fuente.
web_content

WebContent

Es el contenido web que se subió como fuente.
video_content

VideoContent

Es el contenido de video que se subió como fuente.
agentspace_content

AgentspaceContent

Se subió contenido de Agentspace como fuente.

AgentspaceContent

Se subió contenido de Agentspace como fuente.

Campos
document_name

string

Opcional. Es el nombre completo del recurso del documento de Agentspace. Formato: projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/branches/{branch}/documents/{document_id}.
engine_name

string

Opcional. Es el motor para verificar el permiso del documento. Formato: projects/{project}/locations/{location}/collections/{collection}/engines/{engine}.
ideaforge_idea_name

string

Opcional. Es el nombre del recurso de la instancia de Idea Forge. Formato: projects/{project}/locations/{location}/collections/{collection}/engines/{engine}/sessions/{session}/ideaForgeInstances/{instance}

GoogleDriveContent

Es el contenido de Google Drive.

Campos
document_id

string

Es el ID del documento seleccionado.
mime_type

string

Es el tipo MIME del documento seleccionado.

Se puede usar para diferenciar el tipo de contenido seleccionado en el selector de Drive. Usa application/vnd.google-apps.document para Documentos de Google o application/vnd.google-apps.presentation para Presentaciones de Google.
source_name

string

Es el nombre que se mostrará para la fuente.

TextContent

Es el contenido de texto que se subió como fuente.

Campos
source_name

string

Es el nombre visible de la fuente de texto.
content

string

Es el nombre que se mostrará para la fuente.

VideoContent

Contenido de video subido como fuente.

Campos
Campo de unión format. Especifica el formato del contenido de video. format puede ser solo uno de los siguientes:
youtube_url

string

Es la URL de YouTube del contenido de video.

WebContent

Es el contenido web que se subió como fuente.

Campos
url

string

Si se proporciona la URL, se recuperará la página web en el backend.
source_name

string

Es el nombre que se mostrará para la fuente.

YoutubeMetadata

Son los metadatos sobre una fuente de video de YouTube.

Campos
video_id

string

Solo salida. Es el ID del video de YouTube.
channel_name

string

Solo salida. Es el nombre del canal del video de YouTube.