REST Resource: projects.locations.notebooks.sources

Recurso: Fuente

Source representa una sola fuente de contenido.

Representación JSON
{
  "name": string,
  "title": string,
  "sourceId": {
    object (SourceId)
  },
  "metadata": {
    object (SourceMetadata)
  },
  "settings": {
    object (SourceSettings)
  }
}
Campos
name

string

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

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.

sourceId

object (SourceId)

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

metadata

object (SourceMetadata)

Solo salida. Son los metadatos sobre la fuente.

settings

object (SourceSettings)

Solo salida. Es el estado de la fuente y los motivos de las fallas.

SourceMetadata

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

Representación 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
}
Campos
Campo de unión metadata. Son los metadatos de la fuente. metadata puede ser solo uno de los siguientes:
googleDocsMetadata

object (GoogleDocsSourceMetadata)

Son los metadatos de una fuente de documentos de Google.

youtubeMetadata

object (YoutubeMetadata)

Son los metadatos de una fuente de video de YouTube.

agentspaceMetadata

object (AgentspaceMetadata)

Son los metadatos de una fuente de Agentspace.

wordCount

integer

Es el recuento de palabras de la fuente.

tokenCount

integer

Es la cantidad de tokens en la fuente.

sourceAddedTimestamp

string (Timestamp format)

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

Usa el formato RFC 3339, en el que el resultado generado siempre estará normalizado a Z y usará 0, 3, 6 o 9 dígitos fraccionarios. También se aceptan otras compensaciones que no sean “Z”. Ejemplos: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" o "2014-10-02T15:01:23+05:30".

GoogleDocsSourceMetadata

Son los metadatos sobre una fuente de documentos de Google.

Representación JSON
{
  "documentId": string,
  "revisionId": string
}
Campos
documentId

string

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

revisionId

string

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

YoutubeMetadata

Son los metadatos sobre una fuente de video de YouTube.

Representación JSON
{
  "videoId": string,
  "channelName": string
}
Campos
videoId

string

Solo salida. Es el ID del video de YouTube.

channelName

string

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

AgentspaceMetadata

Son los metadatos sobre una fuente de Agentspace.

Representación JSON
{
  "documentName": string,
  "documentTitle": string
}
Campos
documentName

string

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

documentTitle

string

Solo salida. Es el título del documento.

SourceSettings

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

Representación JSON
{
  "status": enum (SourceStatus),
  "failureReason": {
    object (FailureReason)
  }
}
Campos
status

enum (SourceStatus)

Es el estado de la fuente.

failureReason

object (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.

FailureReason

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

Representación 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.
}
Campos
Campo de unión error. Es el error específico. error puede ser solo uno de los siguientes:
unknown

object (Unknown)

Indica que se produjo un error desconocido.

sourceTooLong

object (SourceTooLong)

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

ingestionError

object (IngestionError)

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

sourceEmpty

object (SourceEmpty)

Indica que la fuente está vacía.

uploadError

object (UploadError)

Indica que se produjo un error al subir la fuente.

paywallError

object (PaywallError)

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

sourceUnreachable

object (SourceUnreachable)

Indica que no se puede acceder a la fuente.

googleDriveError

object (GoogleDriveError)

Es un error específico de Google Drive.

youtubeError

object (YoutubeError)

Es un error específico de YouTube.

audioTranscriptionError

object (AudioTranscriptionError)

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

sourceLimitExceeded

object (SourceLimitExceeded)

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

domainBlocked

object (DomainBlocked)

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

Desconocido

Este tipo no tiene campos.

Indica que se produjo un error desconocido.

SourceTooLong

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

Representación JSON
{
  "wordCount": integer,
  "wordLimit": integer
}
Campos
wordCount

integer

Es la cantidad de palabras en la fuente.

wordLimit

integer

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

IngestionError

Este tipo no tiene campos.

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

SourceEmpty

Este tipo no tiene campos.

Indica que la fuente está vacía.

UploadError

Este tipo no tiene campos.

Indica que se produjo un error al subir la fuente.

PaywallError

Este tipo no tiene campos.

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

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.

Representación JSON
{
  "errorDetails": enum (SourceUnreachableErrorReason)
}
Campos
errorDetails

enum (SourceUnreachableErrorReason)

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

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.

GoogleDriveError

Es un error específico de Google Drive.

Representación JSON
{

  // Union field error can be only one of the following:
  "downloadPrevented": {
    object (DownloadPrevented)
  }
  // End of list of possible types for union field error.
}
Campos
Campo de unión error. Es el error específico de Drive. error puede ser solo uno de los siguientes:
downloadPrevented

object (DownloadPrevented)

Se impidió que el usuario descargara el archivo.

DownloadPrevented

Este tipo no tiene campos.

Se impidió que el usuario descargara el archivo.

YoutubeError

Es un error específico de YouTube.

Representación JSON
{

  // Union field error can be only one of the following:
  "videoDeleted": {
    object (VideoDeleted)
  }
  // End of list of possible types for union field error.
}
Campos
Campo de unión error. Es el error específico de YouTube. error puede ser solo uno de los siguientes:
videoDeleted

object (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.

AudioTranscriptionError

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

Representación 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.
}
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:
languageDetectionFailed

object (LanguageDetectionFailed)

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

noAudioDetected

object (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.

SourceLimitExceeded

Este tipo no tiene campos.

Indica que el usuario no tiene espacio para esta fuente.

DomainBlocked

Este tipo no tiene campos.

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

Métodos

batchCreate

Crea una lista de Sources.

batchDelete

Borra varias fuentes

get

Obtienes una Source.