REST Resource: projects.locations.notebooks.sources

Ressource : Source

Une source représente une seule source de contenu.

Représentation JSON
{
  "name": string,
  "title": string,
  "sourceId": {
    object (SourceId)
  },
  "metadata": {
    object (SourceMetadata)
  },
  "settings": {
    object (SourceSettings)
  }
}
Champs
name

string

Identifiant. Nom complet de la ressource source. Format : projects/{project}/locations/{location}/notebooks/{notebook}/sources/{sourceId}.

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

string

Facultatif. Titre de la source.

sourceId

object (SourceId)

Facultatif. Uniquement en sortie. ID de la source, qui correspond au dernier segment du nom de ressource de la source.

metadata

object (SourceMetadata)

Uniquement en sortie. Métadonnées sur la source.

settings

object (SourceSettings)

Uniquement en sortie. État de la source et éventuels motifs d'échec.

SourceMetadata

Représente les métadonnées d'une source et des informations supplémentaires.

Représentation JSON
{

  // Union field metadata can be only one of the following:
  "googleDocsMetadata": {
    object (GoogleDocsSourceMetadata)
  },
  "youtubeMetadata": {
    object (YoutubeMetadata)
  },
  "agentspaceMetadata": {
    object (AgentspaceMetadata)
  }
  // End of list of possible types for union field metadata.
  "wordCount": integer,
  "tokenCount": integer,
  "sourceAddedTimestamp": string
}
Champs
Champ d'union metadata. Métadonnées de la source. metadata ne peut être qu'un des éléments suivants :
googleDocsMetadata

object (GoogleDocsSourceMetadata)

Métadonnées d'une source Google Docs.

youtubeMetadata

object (YoutubeMetadata)

Métadonnées d'une source vidéo YouTube.

agentspaceMetadata

object (AgentspaceMetadata)

métadonnées d'une source Agentspace.

wordCount

integer

Nombre de mots de la source.

tokenCount

integer

Nombre de jetons dans la source.

sourceAddedTimestamp

string (Timestamp format)

Code temporel de l'ajout de la source.

Utilise la norme RFC 3339, où la sortie générée utilise toujours le format UTC (indiqué par "Z" pour le temps universel coordonné) avec des secondes fractionnaires de 0, 3, 6 ou 9 chiffres décimaux. Des décalages horaires autres que "Z" (UTC) sont également acceptés. Exemples : "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" ou "2014-10-02T15:01:23+05:30".

GoogleDocsSourceMetadata

Métadonnées d'une source Google Docs.

Représentation JSON
{
  "documentId": string,
  "revisionId": string
}
Champs
documentId

string

Uniquement en sortie. ID du document Google Docs.

revisionId

string

Uniquement en sortie. ID de révision du document.

YoutubeMetadata

Métadonnées sur une source vidéo YouTube.

Représentation JSON
{
  "videoId": string,
  "channelName": string
}
Champs
videoId

string

Uniquement en sortie. ID de la vidéo YouTube.

channelName

string

Uniquement en sortie. Nom de la chaîne YouTube de la vidéo.

AgentspaceMetadata

métadonnées sur une source d'espace d'agent.

Représentation JSON
{
  "documentName": string,
  "documentTitle": string
}
Champs
documentName

string

Uniquement en sortie. Nom complet du document dans Agentspace.

documentTitle

string

Uniquement en sortie. Titre du document.

SourceSettings

Permet d'étendre les paramètres de source dans sources.batchCreate (anciennement la requête AddSource).

Représentation JSON
{
  "status": enum (SourceStatus),
  "failureReason": {
    object (FailureReason)
  }
}
Champs
status

enum (SourceStatus)

l'état de la source.

failureReason

object (FailureReason)

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.

FailureReason

Raison de l'échec contenant des informations sur la raison pour laquelle une source n'a pas pu être ingérée.

Représentation JSON
{

  // Union field error can be only one of the following:
  "unknown": {
    object (Unknown)
  },
  "sourceTooLong": {
    object (SourceTooLong)
  },
  "ingestionError": {
    object (IngestionError)
  },
  "sourceEmpty": {
    object (SourceEmpty)
  },
  "uploadError": {
    object (UploadError)
  },
  "paywallError": {
    object (PaywallError)
  },
  "sourceUnreachable": {
    object (SourceUnreachable)
  },
  "googleDriveError": {
    object (GoogleDriveError)
  },
  "youtubeError": {
    object (YoutubeError)
  },
  "audioTranscriptionError": {
    object (AudioTranscriptionError)
  },
  "sourceLimitExceeded": {
    object (SourceLimitExceeded)
  },
  "domainBlocked": {
    object (DomainBlocked)
  }
  // End of list of possible types for union field error.
}
Champs
Champ d'union error. Erreur spécifique. error ne peut être qu'un des éléments suivants :
unknown

object (Unknown)

Indique qu'une erreur inconnue s'est produite.

sourceTooLong

object (SourceTooLong)

Indique que le nombre de mots sources a dépassé la limite de l'utilisateur.

ingestionError

object (IngestionError)

Indique qu'une erreur s'est produite lors de l'ingestion de la source.

sourceEmpty

object (SourceEmpty)

Indique que la source est vide.

uploadError

object (UploadError)

Indique qu'une erreur s'est produite lors de l'importation de la source.

paywallError

object (PaywallError)

Indique que la source est payante et ne peut pas être ingérée.

sourceUnreachable

object (SourceUnreachable)

Indique que la source est inaccessible.

googleDriveError

object (GoogleDriveError)

Erreur spécifique à Google Drive.

youtubeError

object (YoutubeError)

Erreur spécifique à YouTube.

audioTranscriptionError

object (AudioTranscriptionError)

Erreur spécifique à la transcription d'un fichier audio.

sourceLimitExceeded

object (SourceLimitExceeded)

Erreur si l'utilisateur tente de modifier des informations au-delà de ses limites.

domainBlocked

object (DomainBlocked)

Erreur si l'utilisateur tente d'ajouter une source à partir d'un domaine bloqué.

Inconnu

Ce type ne comporte aucun champ.

Indique qu'une erreur inconnue s'est produite.

SourceTooLong

Indique que le nombre de mots sources a dépassé la limite de l'utilisateur.

Représentation JSON
{
  "wordCount": integer,
  "wordLimit": integer
}
Champs
wordCount

integer

Nombre de mots dans la source.

wordLimit

integer

Limite de nombre de mots pour l'utilisateur actuel au moment de l'importation.

IngestionError

Ce type ne comporte aucun champ.

Indique qu'une erreur s'est produite lors de l'ingestion de la source.

SourceEmpty

Ce type ne comporte aucun champ.

Indique que la source est vide.

UploadError

Ce type ne comporte aucun champ.

Indique qu'une erreur s'est produite lors de l'importation de la source.

PaywallError

Ce type ne comporte aucun champ.

Indique que la source est payante et ne peut pas être ingérée.

SourceUnreachable

Indique que la source est inaccessible. Cette option est principalement utilisée pour les sources ajoutées via une URL.

Représentation JSON
{
  "errorDetails": enum (SourceUnreachableErrorReason)
}
Champs
errorDetails

enum (SourceUnreachableErrorReason)

Décrit pourquoi la source est inaccessible.

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.

GoogleDriveError

Erreur spécifique à Google Drive.

Représentation JSON
{

  // Union field error can be only one of the following:
  "downloadPrevented": {
    object (DownloadPrevented)
  }
  // End of list of possible types for union field error.
}
Champs
Champ d'union error. Erreur spécifique à Drive. error ne peut être qu'un des éléments suivants :
downloadPrevented

object (DownloadPrevented)

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.

YoutubeError

Erreur spécifique à YouTube.

Représentation JSON
{

  // Union field error can be only one of the following:
  "videoDeleted": {
    object (VideoDeleted)
  }
  // End of list of possible types for union field error.
}
Champs
Champ d'union error. Erreur spécifique à YouTube. error ne peut être qu'un des éléments suivants :
videoDeleted

object (VideoDeleted)

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.

AudioTranscriptionError

Erreur spécifique à la transcription d'un fichier audio.

Représentation JSON
{

  // Union field error can be only one of the following:
  "languageDetectionFailed": {
    object (LanguageDetectionFailed)
  },
  "noAudioDetected": {
    object (NoAudioDetected)
  }
  // End of list of possible types for union field error.
}
Champs
Champ d'union error. Erreur spécifique à la transcription du fichier audio. error ne peut être qu'un des éléments suivants :
languageDetectionFailed

object (LanguageDetectionFailed)

Impossible de détecter la langue du fichier (il ne s'agit peut-être pas d'un fichier audio).

noAudioDetected

object (NoAudioDetected)

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.

SourceLimitExceeded

Ce type ne comporte aucun champ.

Indique que l'utilisateur ne dispose pas d'espace pour cette source.

DomainBlocked

Ce type ne comporte aucun champ.

Erreur indiquant que la source a été supprimée, car le domaine a été bloqué.

Méthodes

batchCreate

Crée une liste de Source.

batchDelete

Supprime plusieurs sources

get

Récupère un Source.