Index
AudioOverviewService
(interface)NotebookService
(interface)SourceService
(interface)AccountAndRole
(message)AgentspaceMetadata
(message)AudioOverview
(message)AudioOverview.MimeType
(enum)AudioOverviewGenerationOptions
(message)AudioOverviewStatus
(enum)BatchCreateSourcesRequest
(message)BatchCreateSourcesResponse
(message)BatchDeleteNotebooksRequest
(message)BatchDeleteSourcesRequest
(message)CmekConfig
(message)CreateAudioOverviewRequest
(message)CreateAudioOverviewResponse
(message)CreateNotebookRequest
(message)DeleteAudioOverviewRequest
(message)FailureReason
(message)FailureReason.AudioTranscriptionError
(message)FailureReason.AudioTranscriptionError.LanguageDetectionFailed
(message)FailureReason.AudioTranscriptionError.NoAudioDetected
(message)FailureReason.DomainBlocked
(message)FailureReason.GoogleDriveError
(message)FailureReason.GoogleDriveError.DownloadPrevented
(message)FailureReason.IngestionError
(message)FailureReason.PaywallError
(message)FailureReason.SourceEmpty
(message)FailureReason.SourceLimitExceeded
(message)FailureReason.SourceTooLong
(message)FailureReason.SourceUnreachable
(message)FailureReason.Unknown
(message)FailureReason.UploadError
(message)FailureReason.YoutubeError
(message)FailureReason.YoutubeError.VideoDeleted
(message)GetNotebookRequest
(message)GetSourceRequest
(message)GoogleDocsSourceMetadata
(message)ListRecentlyViewedNotebooksRequest
(message)ListRecentlyViewedNotebooksResponse
(message)Notebook
(message)NotebookMetadata
(message)ProjectRole
(enum)ShareNotebookRequest
(message)ShareNotebookResponse
(message)Source
(message)SourceId
(message)SourceMetadata
(message)SourceSettings
(message)SourceStatus
(enum)SourceUnreachableErrorReason
(enum)UserContent
(message)UserContent.AgentspaceContent
(message)UserContent.GoogleDriveContent
(message)UserContent.TextContent
(message)UserContent.VideoContent
(message)UserContent.WebContent
(message)YoutubeMetadata
(message)
AudioOverviewService
Service de gestion des résumés audio.
CreateAudioOverview |
---|
Génère un résumé audio.
|
DeleteAudioOverview |
---|
Supprime un résumé audio.
|
NotebookService
Service de gestion des notebooks.
BatchDeleteNotebooks |
---|
Supprime des notebooks par lot.
|
CreateNotebook |
---|
Crée un notebook.
|
GetNotebook |
---|
Récupère un notebook.
|
ListRecentlyViewedNotebooks |
---|
Liste les notebooks triés par date de dernière consultation.
|
SourceService
Service de gestion des sources.
BatchCreateSources |
---|
Crée une liste de
|
BatchDeleteSources |
---|
Supprime plusieurs sources
|
GetSource |
---|
Récupère un
|
AccountAndRole
Informations sur le compte et le rôle.
Champs | |
---|---|
email |
Obligatoire. Adresse e-mail associée au compte. |
role |
Obligatoire. Le rôle dans le notebook. |
AgentspaceMetadata
Métadonnées concernant une source d'espace d'agent.
Champs | |
---|---|
document_name |
Uniquement en sortie. Nom complet du document dans Agentspace. |
document_title |
Uniquement en sortie. Titre du document. |
AudioOverview
Résumé audio d'un notebook. Il s'agit d'un résumé du notebook au format audio.
Champs | |
---|---|
name |
Identifiant. Nom complet de la ressource du notebook. Format : Ce champ doit être une chaîne encodée au format UTF-8, dont la longueur ne doit pas dépasser 1 024 caractères. |
audio_overview_id |
Uniquement en sortie. Identifiant unique de l'aperçu audio. |
status |
État du résumé audio. |
generation_options |
Options utilisées pour générer le résumé audio. |
mime_type |
Type MIME de l'aperçu audio. |
language_code |
Code de langue du résumé audio généré. Utilisez le code de langue BCP 47 (par exemple, "en", "es", "hi", etc.). |
MimeType
Types MIME acceptés pour les résumés audio.
Enums | |
---|---|
MIME_TYPE_UNKNOWN |
Le type MIME n'a pas été défini. |
MIME_TYPE_WAV |
Le type MIME est audio/wav. |
MIME_TYPE_MP4 |
Le type MIME est audio/mp4. |
AudioOverviewGenerationOptions
Options utilisées lors de la génération du résumé audio.
Champs | |
---|---|
source_ids[] |
Facultatif. Sources sur lesquelles le résumé audio est basé. |
episode_focus |
Sur quoi les hôtes de l'émission doivent-ils se concentrer ? |
language_code |
Langue dans laquelle le résumé audio a été demandé. |
AudioOverviewStatus
État d'un résumé audio.
Enums | |
---|---|
AUDIO_OVERVIEW_STATUS_UNSPECIFIED |
L'état n'a pas été défini. |
AUDIO_OVERVIEW_STATUS_NOT_STARTED |
La génération du résumé audio n'a pas encore commencé. |
AUDIO_OVERVIEW_STATUS_IN_PROGRESS |
Le résumé audio est en cours de génération. |
AUDIO_OVERVIEW_STATUS_COMPLETE |
Le résumé audio a été généré et est disponible. |
AUDIO_OVERVIEW_STATUS_FAILED |
Échec de la génération du résumé audio. |
BatchCreateSourcesRequest
Requête pour la méthode SourceService.BatchCreateSources
.
Champs | |
---|---|
parent |
Obligatoire. Ressource parente dans laquelle les sources seront créées. Format : projects/{project}/locations/{location}/notebooks/{notebook} |
user_contents[] |
Obligatoire. |
BatchCreateSourcesResponse
Réponse pour la méthode SourceService.BatchCreateSources
.
Champs | |
---|---|
sources[] |
Les |
BatchDeleteNotebooksRequest
Requête pour la méthode NotebookService.BatchDeleteNotebooks
.
Champs | |
---|---|
parent |
Obligatoire. Nom de la ressource de branche parente, par exemple |
names[] |
Obligatoire. Noms complets des ressources |
BatchDeleteSourcesRequest
Requête pour la méthode [SourceService.BatchDeleteSourcesRequest][].
Champs | |
---|---|
parent |
Obligatoire. Ressource parente dans laquelle les sources seront supprimées. Format : projects/{project}/locations/{location}/notebooks/{notebook} |
names[] |
Obligatoire. Noms des sources à supprimer. Format : projects/{project}/locations/{location}/notebooks/{notebook}/sources/{source} |
CmekConfig
Configuration du chiffrement géré par le client pour les notebooks.
Champs | |
---|---|
kms_key |
Obligatoire. Nom de ressource de la clé KMS qui sera utilisée pour chiffrer les ressources |
CreateAudioOverviewRequest
Requête pour la méthode AudioOverviewService.CreateAudioOverview
.
Champs | |
---|---|
parent |
Obligatoire. Ressource parente dans laquelle ce notebook sera créé. Format : projects/{project}/locations/{location}/notebooks/{notebook} |
generation_options |
Options de génération du résumé audio. |
CreateAudioOverviewResponse
Réponse pour la méthode AudioOverviewService.CreateAudioOverview
.
Champs | |
---|---|
audio_overview |
Le résumé audio généré. |
CreateNotebookRequest
Requête pour la méthode NotebookService.CreateNotebook
.
Champs | |
---|---|
parent |
Obligatoire. Nom de la ressource parente, par exemple |
notebook |
Obligatoire. Notebook à créer. |
DeleteAudioOverviewRequest
Requête pour la méthode AudioOverviewService.DeleteAudioOverview
.
Champs | |
---|---|
name |
Obligatoire. Nom complet de la ressource |
FailureReason
Raison de l'échec contenant des informations sur la raison pour laquelle une source n'a pas pu être ingérée.
Champs | |
---|---|
Champ d'union error . Erreur spécifique. error ne peut être qu'un des éléments suivants : |
|
unknown |
Indique qu'une erreur inconnue s'est produite. |
source_too_long |
Indique que le nombre de mots sources a dépassé la limite de l'utilisateur. |
ingestion_error |
Indique qu'une erreur s'est produite lors de l'ingestion de la source. |
source_empty |
Indique que la source est vide. |
upload_error |
Indique qu'une erreur s'est produite lors de l'importation de la source. |
paywall_error |
Indique que la source est payante et ne peut pas être ingérée. |
source_unreachable |
Indique que la source est inaccessible. |
google_drive_error |
Erreur spécifique à Google Drive. |
youtube_error |
Erreur spécifique à YouTube. |
audio_transcription_error |
Erreur spécifique à la transcription d'un fichier audio. |
source_limit_exceeded |
Erreur si l'utilisateur tente de modifier des informations au-delà de ses limites. |
domain_blocked |
Erreur si l'utilisateur tente d'ajouter une source à partir d'un domaine bloqué. |
AudioTranscriptionError
Erreur spécifique à la transcription d'un fichier audio.
Champs | |
---|---|
Champ d'union error . Erreur spécifique à la transcription du fichier audio. error ne peut être qu'un des éléments suivants : |
|
language_detection_failed |
Impossible de détecter la langue du fichier (il ne s'agit peut-être pas d'un fichier audio). |
no_audio_detected |
Aucun contenu audio n'a été détecté dans le fichier d'entrée (il s'agissait peut-être d'une vidéo). |
LanguageDetectionFailed
Ce type ne comporte aucun champ.
Impossible de détecter la langue du fichier (il ne s'agit peut-être pas d'un fichier audio).
NoAudioDetected
Ce type ne comporte aucun champ.
Aucun contenu audio n'a été détecté dans le fichier d'entrée.
DomainBlocked
Ce type ne comporte aucun champ.
Erreur indiquant que la source a été supprimée, car le domaine a été bloqué.
GoogleDriveError
Erreur spécifique à Google Drive.
Champs | |
---|---|
Champ d'union error . Erreur spécifique à Drive. error ne peut être qu'un des éléments suivants : |
|
download_prevented |
L'utilisateur n'a pas pu télécharger le fichier. |
DownloadPrevented
Ce type ne comporte aucun champ.
L'utilisateur n'a pas pu télécharger le fichier.
IngestionError
Ce type ne comporte aucun champ.
Indique qu'une erreur s'est produite lors de l'ingestion de la source.
PaywallError
Ce type ne comporte aucun champ.
Indique que la source est payante et ne peut pas être ingérée.
SourceEmpty
Ce type ne comporte aucun champ.
Indique que la source est vide.
SourceLimitExceeded
Ce type ne comporte aucun champ.
Indique que l'utilisateur ne dispose pas d'espace pour cette source.
SourceTooLong
Indique que le nombre de mots sources a dépassé la limite de l'utilisateur.
Champs | |
---|---|
word_count |
Nombre de mots dans la source. |
word_limit |
Limite de nombre de mots pour l'utilisateur actuel au moment de l'importation. |
SourceUnreachable
Indique que la source est inaccessible. Cette option est principalement utilisée pour les sources ajoutées via une URL.
Champs | |
---|---|
error_details |
Décrit pourquoi la source est inaccessible. |
Inconnu
Ce type ne comporte aucun champ.
Indique qu'une erreur inconnue s'est produite.
UploadError
Ce type ne comporte aucun champ.
Indique qu'une erreur s'est produite lors de l'importation de la source.
YoutubeError
Erreur spécifique à YouTube.
Champs | |
---|---|
Champ d'union error . Erreur spécifique à YouTube. error ne peut être qu'un des éléments suivants : |
|
video_deleted |
Erreur indiquant que la source a été supprimée, car la vidéo a été supprimée. |
VideoDeleted
Ce type ne comporte aucun champ.
Erreur indiquant que la source a été supprimée, car la vidéo a été supprimée.
GetNotebookRequest
Requête pour la méthode NotebookService.GetNotebook
.
Champs | |
---|---|
name |
Obligatoire. Nom complet de la ressource |
GetSourceRequest
Requête pour la méthode SourceService.GetSource
.
Champs | |
---|---|
name |
Obligatoire. Nom de ressource de la source. Format : projects/{project}/locations/{location}/notebooks/{notebook}/sources/{source} |
GoogleDocsSourceMetadata
Métadonnées concernant une source Google Docs.
Champs | |
---|---|
document_id |
Uniquement en sortie. ID du document Google Docs. |
revision_id |
Uniquement en sortie. ID de révision du document. |
ListRecentlyViewedNotebooksRequest
Requête pour la méthode NotebookService.ListRecentlyViewedNotebooks
.
Champs | |
---|---|
parent |
Obligatoire. Nom de la ressource de branche parente, par exemple |
page_size |
Facultatif. Nombre maximal de |
page_token |
Facultatif. Jeton de page. Fournissez-le pour récupérer la page suivante. |
ListRecentlyViewedNotebooksResponse
Réponse pour la méthode NotebookService.ListRecentlyViewedNotebooks
.
Champs | |
---|---|
notebooks[] |
La liste des notebooks consultés récemment. |
next_page_token |
Jeton de page. Fournissez-le pour récupérer la page suivante. |
Notebook
Un notebook est une ressource où les utilisateurs peuvent stocker leur contenu (sous forme de sources) et interagir avec celui-ci.
Champs | |
---|---|
name |
Identifiant. Identifiant du notebook. Format : Ce champ doit être une chaîne encodée au format UTF-8. |
sources[] |
Uniquement en sortie. Liste des sources dans le notebook. Il s'agit d'un champ de sortie uniquement. |
cmek_config |
Uniquement en sortie. Informations liées à CMEK pour le notebook. |
title |
Facultatif. Titre du notebook. |
notebook_id |
Uniquement en sortie. ID du notebook, qui correspond au dernier segment du nom de ressource du notebook. |
emoji |
Uniquement en sortie. Émoji du notebook. |
metadata |
Uniquement en sortie. Métadonnées du notebook. |
NotebookMetadata
Métadonnées d'un notebook.
Champs | |
---|---|
is_shared |
"True" si ce projet est actuellement partagé avec d'autres personnes, "false" dans le cas contraire. |
is_shareable |
"True" si le projet peut être partagé. |
last_viewed |
Code temporel indiquant la dernière fois que l'utilisateur actuellement connecté a consulté le projet. |
create_time |
Heure à laquelle ce projet a été créé. |
ProjectRole
Rôle du projet.
Enums | |
---|---|
PROJECT_ROLE_UNKNOWN |
Rôle inconnu. |
PROJECT_ROLE_OWNER |
L'utilisateur est propriétaire du projet. |
PROJECT_ROLE_WRITER |
L'utilisateur dispose des autorisations d'écriture sur le projet. |
PROJECT_ROLE_READER |
L'utilisateur dispose des autorisations de lecteur sur le projet. |
PROJECT_ROLE_NOT_SHARED |
L'utilisateur n'a pas accès au projet. |
Source
Une source représente une seule source de contenu.
Champs | |
---|---|
name |
Identifiant. Nom complet de la ressource source. Format : Ce champ doit être une chaîne encodée au format UTF-8, dont la longueur ne doit pas dépasser 1 024 caractères. |
title |
Facultatif. Titre de la source. |
source_id |
Facultatif. Uniquement en sortie. ID de la source, qui correspond au dernier segment du nom de ressource de la source. |
metadata |
Uniquement en sortie. Métadonnées sur la source. |
settings |
Uniquement en sortie. État de la source et éventuels motifs d'échec. |
SourceId
SourceId correspond au dernier segment du nom de ressource de la source.
Champs | |
---|---|
id |
ID de la source. |
SourceMetadata
Représente les métadonnées d'une source et des informations supplémentaires.
Champs | |
---|---|
Champ d'union metadata . Métadonnées de la source. metadata ne peut être qu'un des éléments suivants : |
|
google_docs_metadata |
Métadonnées d'une source Google Docs. |
youtube_metadata |
Métadonnées pour une source vidéo YouTube. |
agentspace_metadata |
Métadonnées d'une source Agentspace. |
word_count |
Nombre de mots de la source. |
token_count |
Nombre de jetons dans la source. |
source_added_timestamp |
Code temporel de l'ajout de la source. |
SourceSettings
Permet d'étendre les paramètres de source dans BatchCreateSources (anciennement la requête AddSource).
Champs | |
---|---|
status |
État de la source. |
failure_reason |
Raison de l'échec contenant des informations sur la raison pour laquelle une source n'a pas pu être ingérée. |
SourceStatus
Liste des états possibles pour une source.
Enums | |
---|---|
SOURCE_STATUS_UNSPECIFIED |
État non spécifié. |
SOURCE_STATUS_PENDING |
L'ajout de la source est en attente. |
SOURCE_STATUS_COMPLETE |
L'ajout de la source est terminé et réussi. |
SOURCE_STATUS_ERROR |
L'ajout de la source a échoué de manière définitive. |
SOURCE_STATUS_PENDING_DELETION |
La source est en attente de suppression. |
SOURCE_STATUS_TENTATIVE |
L'utilisateur tente d'ajouter une source, mais nous ne l'avons pas encore importée ni vérifié les limites d'utilisateur. Ne sont pas comptabilisés dans la limite de sources de l'utilisateur. |
SourceUnreachableErrorReason
Détails expliquant pourquoi la source est inaccessible. Permet d'afficher le message approprié à l'utilisateur.
Enums | |
---|---|
ERROR_REASON_UNSPECIFIED |
Par défaut |
ERROR_REASON_INVALID_URL |
L'URL source n'est pas valide. |
ERROR_REASON_NOT_ACCESSIBLE |
L'URL source n'est pas accessible. |
ERROR_REASON_NOT_REACHABLE |
L'URL source n'est pas accessible. |
ERROR_REASON_URL_NOT_FOUND |
L'URL source a renvoyé une erreur 404. |
ERROR_REASON_TRANSIENT_ERROR |
L'URL source n'est pas accessible en raison d'une erreur réseau temporaire, d'un délai avant expiration de l'hôte, etc. |
ERROR_REASON_FETCH_FAILED |
L'URL source n'a pas pu être récupérée en raison d'une erreur interne. |
ERROR_REASON_NOT_SUPPORTED |
L'URL n'est pas encore acceptée. Par exemple, le contenu récupéré dépasse la taille maximale de récupération du robot d'exploration, le contenu récupéré est d'un type que nous ne prenons pas encore en charge, etc. |
UserContent
Les messages "Contenu" font référence aux données que l'utilisateur souhaite importer.
Champs | |
---|---|
Champ d'union content . Contenu utilisateur. content ne peut être qu'un des éléments suivants : |
|
google_drive_content |
Contenu de Google Drive. |
text_content |
Contenu textuel importé en tant que source. |
web_content |
Contenu Web importé en tant que source. |
video_content |
Contenu vidéo importé en tant que source. |
agentspace_content |
Contenu de l'espace agent importé en tant que source. |
AgentspaceContent
Contenu de l'espace agent importé en tant que source.
Champs | |
---|---|
document_name |
Facultatif. Nom complet de la ressource du document Agentspace. Format : |
engine_name |
Facultatif. Moteur permettant de vérifier l'autorisation du document. Format : |
ideaforge_idea_name |
Facultatif. Nom de ressource de l'instance Idea Forge. Format : |
GoogleDriveContent
Contenu de Google Drive.
Champs | |
---|---|
document_id |
ID du document sélectionné. |
mime_type |
Type MIME du document sélectionné. Cela permet de différencier le type de contenu sélectionné dans le sélecteur Drive. Utilisez application/vnd.google-apps.document pour Google Docs ou application/vnd.google-apps.presentation pour Google Slides. |
source_name |
Nom à afficher pour la source. |
TextContent
Contenu textuel importé en tant que source.
Champs | |
---|---|
source_name |
Nom à afficher de la source de texte. |
content |
Nom à afficher pour la source. |
VideoContent
Contenu vidéo importé en tant que source.
Champs | |
---|---|
Champ d'union format . Spécifie le format du contenu vidéo. format ne peut être que l'un des éléments suivants : |
|
youtube_url |
URL YouTube du contenu vidéo. |
WebContent
Contenu Web importé en tant que source.
Champs | |
---|---|
url |
Si une URL est fournie, la page Web sera récupérée dans le backend. |
source_name |
Nom à afficher pour la source. |
YoutubeMetadata
Métadonnées concernant une source vidéo YouTube.
Champs | |
---|---|
video_id |
Uniquement en sortie. ID de la vidéo YouTube. |
channel_name |
Uniquement en sortie. Nom de la chaîne YouTube de la vidéo. |