Package google.cloud.notebooklm.v1alpha

Índice

AudioOverviewService

Servicio para gestionar resúmenes de audio.

CreateAudioOverview

rpc CreateAudioOverview(CreateAudioOverviewRequest) returns (CreateAudioOverviewResponse)

Genera un nuevo resumen de audio.

Permisos de autorización

Debes disponer de 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 el Authentication Overview.

Permisos de IAM

Requiere el siguiente permiso de gestión de identidades y accesos en el recurso parent:

  • discoveryengine.audioOverviews.create

Para obtener más información, consulta la documentación de gestión de identidades y accesos.
DeleteAudioOverview

rpc DeleteAudioOverview(DeleteAudioOverviewRequest) returns (Empty)

Elimina un resumen de audio.

Permisos de autorización

Debes disponer de 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 el Authentication Overview.

Permisos de IAM

Requiere el siguiente permiso de gestión de identidades y accesos en el recurso name:

  • discoveryengine.audioOverviews.delete

Para obtener más información, consulta la documentación de gestión de identidades y accesos.

NotebookService

Servicio para gestionar cuadernos.

BatchDeleteNotebooks

rpc BatchDeleteNotebooks(BatchDeleteNotebooksRequest) returns (Empty)

Elimina cuadernos por lotes.

Permisos de autorización

Debes disponer de 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 el Authentication Overview.
CreateNotebook

rpc CreateNotebook(CreateNotebookRequest) returns (Notebook)

Crea un cuaderno.

Permisos de autorización

Debes disponer de 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 el Authentication Overview.

Permisos de IAM

Requiere el siguiente permiso de gestión de identidades y accesos en el recurso parent:

  • discoveryengine.notebooks.create

Para obtener más información, consulta la documentación de gestión de identidades y accesos.
GetNotebook

rpc GetNotebook(GetNotebookRequest) returns (Notebook)

Obtiene un cuaderno.

Permisos de autorización

Debes disponer de 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 el Authentication Overview.

Permisos de IAM

Requiere el siguiente permiso de gestión de identidades y accesos en el recurso name:

  • discoveryengine.notebooks.get

Para obtener más información, consulta la documentación de gestión de identidades y accesos.
ListRecentlyViewedNotebooks

rpc ListRecentlyViewedNotebooks(ListRecentlyViewedNotebooksRequest) returns (ListRecentlyViewedNotebooksResponse)

Muestra los cuadernos ordenados por la hora de la última vista.

Permisos de autorización

Debes disponer de 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 el Authentication Overview.

Permisos de IAM

Requiere el siguiente permiso de gestión de identidades y accesos en el recurso parent:

  • discoveryengine.notebooks.list

Para obtener más información, consulta la documentación de gestión de identidades y accesos.
ShareNotebook

rpc ShareNotebook(ShareNotebookRequest) returns (ShareNotebookResponse)

Comparte un cuaderno con otras cuentas.

Permisos de autorización

Debes disponer de 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 el Authentication Overview.

Permisos de IAM

Requiere los siguientes permisos de gestión de identidades y accesos (IAM) en el recurso name:

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

Para obtener más información, consulta la documentación de gestión de identidades y accesos.

SourceService

Servicio para gestionar fuentes.

BatchCreateSources

rpc BatchCreateSources(BatchCreateSourcesRequest) returns (BatchCreateSourcesResponse)

Crea una lista de Sources.

Permisos de autorización

Debes disponer de 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 el Authentication Overview.

Permisos de IAM

Requiere el siguiente permiso de gestión de identidades y accesos en el recurso parent:

  • discoveryengine.sources.create

Para obtener más información, consulta la documentación de gestión de identidades y accesos.
BatchDeleteSources

rpc BatchDeleteSources(BatchDeleteSourcesRequest) returns (Empty)

Elimina varias fuentes

Permisos de autorización

Debes disponer de 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 el Authentication Overview.

Permisos de IAM

Requiere el siguiente permiso de gestión de identidades y accesos en el recurso parent:

  • discoveryengine.sources.delete

Para obtener más información, consulta la documentación de gestión de identidades y accesos.
GetSource

rpc GetSource(GetSourceRequest) returns (Source)

Obtiene un Source.

Permisos de autorización

Debes disponer de 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 el Authentication Overview.

Permisos de IAM

Requiere el siguiente permiso de gestión de identidades y accesos en el recurso name:

  • discoveryengine.sources.get

Para obtener más información, consulta la documentación de gestión de identidades y accesos.

AccountAndRole

Información de la cuenta y del rol.

Campos
email

string

Obligatorio. La dirección de correo asociada a la cuenta.
role

ProjectRole

Obligatorio. El rol en el cuaderno.

AgentspaceMetadata

Metadatos sobre una fuente de espacio de agentes.

Campos
document_name

string

Solo de salida. El nombre completo del documento en Agentspace.
document_title

string

Solo de salida. El título del documento.

AudioOverview

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

Campos
name

string

Identificador. Nombre completo del recurso del cuaderno. 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 1024 caracteres.
audio_overview_id

string

Solo de salida. ID único del resumen de audio.
status

AudioOverviewStatus

El estado del resumen de audio.
generation_options

AudioOverviewGenerationOptions

Las opciones que se han usado para generar el resumen de audio.
mime_type

MimeType

El tipo MIME del resumen de audio.
language_code

string

El código de idioma del resumen de audio generado. Usa el código de idioma BCP 47 (por ejemplo, "en", "es", "hi", etc.).

MimeType

Tipos MIME admitidos para los resúmenes de audio.

Enumeraciones
MIME_TYPE_UNKNOWN No se ha definido el tipo MIME.
MIME_TYPE_WAV El tipo MIME es audio/wav.
MIME_TYPE_MP4 El tipo MIME es audio/mp4.

AudioOverviewGenerationOptions

Opciones usadas durante la generación del resumen de audio.

Campos
source_ids[]

SourceId

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

string

En qué deben centrarse los presentadores del programa.
language_code

string

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

AudioOverviewStatus

El estado de un resumen de audio.

Enumeraciones
AUDIO_OVERVIEW_STATUS_UNSPECIFIED No se ha definido el estado.
AUDIO_OVERVIEW_STATUS_NOT_STARTED No se ha empezado a generar el resumen de audio.
AUDIO_OVERVIEW_STATUS_IN_PROGRESS Se está generando el resumen de audio.
AUDIO_OVERVIEW_STATUS_COMPLETE Se ha generado el resumen de audio y ya está disponible.
AUDIO_OVERVIEW_STATUS_FAILED No se ha podido generar el resumen de audio.

BatchCreateSourcesRequest

Solicitud del método SourceService.BatchCreateSources.

Campos
parent

string

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

UserContent

Obligatorio. Los UserContent que se van a subir.

BatchCreateSourcesResponse

Respuesta del método SourceService.BatchCreateSources.

Campos
sources[]

Source

Los Source.

BatchDeleteNotebooksRequest

Solicitud del método NotebookService.BatchDeleteNotebooks.

Campos
parent

string

Obligatorio. Nombre de recurso de la rama superior, como projects/{project}/locations/{location}.
names[]

string

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

BatchDeleteSourcesRequest

Solicitud del método [SourceService.BatchDeleteSourcesRequest][].

Campos
parent

string

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

string

Obligatorio. Nombres de las fuentes que se van a eliminar. Formato: projects/{project}/locations/{location}/notebooks/{notebook}/sources/{source}

CmekConfig

Configuración del cifrado gestionado por el cliente para cuadernos.

Campos
kms_key

string

Obligatorio. Nombre del recurso de clave de KMS que se usará para cifrar recursos projects/{project}/locations/{location}/keyRings/{keyRing}/cryptoKeys/{keyId}.

CreateAudioOverviewRequest

Solicitud del método AudioOverviewService.CreateAudioOverview.

Campos
parent

string

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

AudioOverviewGenerationOptions

Opciones para generar el resumen de audio.

CreateAudioOverviewResponse

Respuesta del método AudioOverviewService.CreateAudioOverview.

Campos
audio_overview

AudioOverview

El resumen de audio generado.

CreateNotebookRequest

Solicitud del método NotebookService.CreateNotebook.

Campos
parent

string

Obligatorio. Nombre del recurso superior, como projects/{project}/locations/{location}.
notebook

Notebook

Obligatorio. El cuaderno que se va a crear.

DeleteAudioOverviewRequest

Solicitud del método AudioOverviewService.DeleteAudioOverview.

Campos
name

string

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

FailureReason

Motivo del fallo que contiene detalles sobre por qué no se ha podido ingerir una fuente.

Campos
Campo de unión error. El error específico. error solo puede ser una de estas dos opciones:
unknown

Unknown

Indica que se ha producido un error desconocido.
source_too_long

SourceTooLong

Indica que el recuento de palabras de origen ha superado el límite del usuario.
ingestion_error

IngestionError

Indica que se ha producido un error al ingerir la fuente.
source_empty

SourceEmpty

Indica que la fuente está vacía.
upload_error

UploadError

Indica que se ha producido un error al subir la fuente.
paywall_error

PaywallError

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

SourceUnreachable

Indica que no se puede acceder a la fuente.
google_drive_error

GoogleDriveError

Error específico de Google Drive.
youtube_error

YoutubeError

Error específico de YouTube.
audio_transcription_error

AudioTranscriptionError

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

SourceLimitExceeded

Error si el usuario intenta actualizar más allá de sus límites.
domain_blocked

DomainBlocked

Error si el usuario intenta añadir una fuente de un dominio bloqueado.

AudioTranscriptionError

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

Campos
Campo de unión error. Error específico de la transcripción del archivo de audio. error solo puede ser una de estas dos opciones:
language_detection_failed

LanguageDetectionFailed

No se ha podido detectar el idioma del archivo (puede que no sea un archivo de voz).
no_audio_detected

NoAudioDetected

No se ha detectado audio en el archivo de entrada (puede que sea un vídeo).

LanguageDetectionFailed

Este tipo no tiene campos.

No se ha podido detectar el idioma del archivo (puede que no sea un archivo de voz).

NoAudioDetected

Este tipo no tiene campos.

No se ha detectado audio en el archivo de entrada.

DomainBlocked

Este tipo no tiene campos.

Error que indica que se ha quitado la fuente porque se ha bloqueado el dominio.

GoogleDriveError

Error específico de Google Drive.

Campos
Campo de unión error. El error específico de Drive. error solo puede ser una de estas dos opciones:
download_prevented

DownloadPrevented

No se ha permitido que el usuario descargue el archivo.

DownloadPrevented

Este tipo no tiene campos.

No se ha permitido que el usuario descargue el archivo.

IngestionError

Este tipo no tiene campos.

Indica que se ha producido un error al ingerir la fuente.

PaywallError

Este tipo no tiene campos.

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

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 origen ha superado el límite del usuario.

Campos
word_count

int32

El número de palabras de la fuente.
word_limit

int32

El límite de recuento de palabras del usuario actual en el momento de la subida.

SourceUnreachable

Indica que no se puede acceder a la fuente. Se usa principalmente en las fuentes que se añaden mediante 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 ha producido un error desconocido.

UploadError

Este tipo no tiene campos.

Indica que se ha producido un error al subir la fuente.

YoutubeError

Error específico de YouTube.

Campos
Campo de unión error. El error específico de YouTube. error solo puede ser una de estas dos opciones:
video_deleted

VideoDeleted

Error que indica que la fuente se ha retirado porque el vídeo se ha eliminado.

VideoDeleted

Este tipo no tiene campos.

Error que indica que la fuente se ha retirado porque el vídeo se ha eliminado.

GetNotebookRequest

Solicitud del método NotebookService.GetNotebook.

Campos
name

string

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

GetSourceRequest

Solicitud del método SourceService.GetSource.

Campos
name

string

Obligatorio. Nombre de recurso de origen. Formato: projects/{project}/locations/{location}/notebooks/{notebook}/sources/{source}

GoogleDocsSourceMetadata

Metadatos sobre una fuente de documentos de Google.

Campos
document_id

string

Solo de salida. El ID del documento de Google.
revision_id

string

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

ListRecentlyViewedNotebooksRequest

Solicitud del método NotebookService.ListRecentlyViewedNotebooks.

Campos
parent

string

Obligatorio. Nombre de recurso de la rama superior, como projects/{project}/locations/{location}.
page_size

int32

Opcional. Número máximo 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. Token de página. Proporciona este elemento para obtener la siguiente página.

ListRecentlyViewedNotebooksResponse

Respuesta del método NotebookService.ListRecentlyViewedNotebooks.

Campos
notebooks[]

Notebook

La lista de cuadernos vistos recientemente.
next_page_token

string

Token de página. Proporciona este elemento para obtener la siguiente página.

Cuaderno

Notebook es un recurso donde los usuarios pueden almacenar su contenido (como fuentes) e interactuar con él.

Campos
name

string

Identificador. Identificador del cuaderno. Formato: projects/{project}/locations/{location}/notebooks/{notebook_id}.

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

Source

Solo de salida. Lista de fuentes del cuaderno. Este campo es de solo salida.
cmek_config

CmekConfig

Solo de salida. Información relacionada con la CMEK del cuaderno.
title

string

Opcional. El título del cuaderno.
notebook_id

string

Solo de salida. ID del cuaderno, que es el último segmento del nombre de recurso del cuaderno.
emoji

string

Solo de salida. El emoji del cuaderno.
metadata

NotebookMetadata

Solo de salida. Los metadatos del cuaderno.

NotebookMetadata

Metadatos de un cuaderno.

Campos
is_shared

bool

True si este proyecto se comparte con otras personas; false en caso contrario.
is_shareable

bool

Devuelve el valor "true" si el proyecto se puede compartir.
last_viewed

Timestamp

Marca de tiempo que indica la hora en la que el usuario actual de la sesión vio el proyecto por última vez.
create_time

Timestamp

Hora a la que se creó este proyecto.

ProjectRole

El rol del proyecto.

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

ShareNotebookRequest

Solicitud del 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. La lista de cuentas y roles con los que compartir el cuaderno.
notify_via_email

bool

Obligatorio. Si quieres notificar a los usuarios con los que has compartido el archivo por correo electrónico.

ShareNotebookResponse

Este tipo no tiene campos.

Respuesta del método NotebookService.ShareNotebook.

Fuente

Source representa una única fuente de contenido.

Campos
name

string

Identificador. Nombre completo del recurso de origen. 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 1024 caracteres.
title

string

Opcional. Título de la fuente.
source_id

SourceId

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

SourceMetadata

Solo de salida. Metadatos sobre la fuente.
settings

SourceSettings

Solo de salida. Estado de la fuente y los motivos de los fallos.

SourceId

SourceId es el último segmento del nombre de 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. Metadatos de la fuente. metadata solo puede ser una de estas dos opciones:
google_docs_metadata

GoogleDocsSourceMetadata

Metadatos de una fuente de documentos de Google.
youtube_metadata

YoutubeMetadata

Metadatos de una fuente de vídeo de YouTube.
agentspace_metadata

AgentspaceMetadata

Metadatos de una fuente de Agentspace.
word_count

int32

El recuento de palabras de la fuente.
token_count

int32

Número de tokens de la fuente.
source_added_timestamp

Timestamp

Marca de tiempo en la que se añadió la fuente.

SourceSettings

Permite ampliar los ajustes de la fuente en BatchCreateSources (antes, solicitud AddSource).

Campos
status

SourceStatus

Estado de la fuente.
failure_reason

FailureReason

Motivo del fallo que contiene detalles sobre por qué no se ha podido ingerir una fuente.

SourceStatus

Lista de posibles estados de una fuente.

Enumeraciones
SOURCE_STATUS_UNSPECIFIED Estado no especificado.
SOURCE_STATUS_PENDING La fuente está pendiente de añadirse.
SOURCE_STATUS_COMPLETE La adición de la fuente se ha completado correctamente.
SOURCE_STATUS_ERROR No se ha podido añadir la fuente de forma permanente.
SOURCE_STATUS_PENDING_DELETION La fuente está pendiente de eliminación.
SOURCE_STATUS_TENTATIVE El usuario está intentando añadir una fuente, pero aún no la hemos subido ni hemos comprobado los límites de usuario. No se tiene en cuenta para calcular el límite de fuentes del usuario.

SourceUnreachableErrorReason

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

Enumeraciones
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 ha devuelto el 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.
ERROR_REASON_FETCH_FAILED No se ha podido obtener la URL de origen debido a un error interno.
ERROR_REASON_NOT_SUPPORTED La URL aún no se admite. Por ejemplo, el contenido obtenido supera el tamaño máximo de obtención del rastreador o es de un tipo que aún no admitimos.

UserContent

Los mensajes de "Contenido" hacen referencia a los datos que el usuario quiere subir.

Campos
Campo de unión content. El contenido del usuario. content solo puede ser una de estas dos opciones:
google_drive_content

GoogleDriveContent

El contenido de Google Drive.
text_content

TextContent

El contenido de texto subido como fuente.
web_content

WebContent

El contenido web subido como fuente.
video_content

VideoContent

El contenido de vídeo subido como fuente.
agentspace_content

AgentspaceContent

Contenido de Agentspace subido como fuente.

AgentspaceContent

Contenido de Agentspace subido como fuente.

Campos
document_name

string

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

string

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

string

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

GoogleDriveContent

El contenido de Google Drive.

Campos
document_id

string

Es el ID del documento seleccionado.
mime_type

string

El tipo MIME del documento seleccionado.

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

string

Nombre que se mostrará de la fuente.

TextContent

El contenido de texto subido como fuente.

Campos
source_name

string

Nombre visible de la fuente de texto.
content

string

Nombre que se mostrará de la fuente.

VideoContent

Contenido de vídeo subido como fuente.

Campos
Campo de unión format. Especifica el formato del contenido de vídeo. format solo puede ser una de estas dos opciones:
youtube_url

string

La URL de YouTube del contenido de vídeo.

WebContent

El contenido web subido como fuente.

Campos
url

string

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

string

Nombre que se mostrará de la fuente.

YoutubeMetadata

Metadatos sobre una fuente de vídeo de YouTube.

Campos
video_id

string

Solo de salida. El ID del vídeo de YouTube.
channel_name

string

Solo de salida. El nombre del canal del vídeo de YouTube.