REST Resource: projects.locations.notebooks.sources

Recurso: fuente

Source representa una única fuente de contenido.

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

string

Identificador. Nombre completo del recurso de origen. Formato: projects/{project}/locations/{location}/notebooks/{notebook}/sources/{sourceId}.

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.

sourceId

object (SourceId)

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

metadata

object (SourceMetadata)

Solo de salida. Metadatos sobre la fuente.

settings

object (SourceSettings)

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

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. Metadatos de la fuente. metadata solo puede ser una de estas dos opciones:
googleDocsMetadata

object (GoogleDocsSourceMetadata)

Metadatos de una fuente de Documentos de Google.

youtubeMetadata

object (YoutubeMetadata)

Metadatos de una fuente de vídeo de YouTube.

agentspaceMetadata

object (AgentspaceMetadata)

Metadatos de una fuente de Agentspace.

wordCount

integer

El recuento de palabras de la fuente.

tokenCount

integer

Número de tokens de la fuente.

sourceAddedTimestamp

string (Timestamp format)

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

Usa RFC 3339, donde la salida generada siempre se normaliza con Z y usa 0, 3, 6 o 9 dígitos fraccionarios. También se aceptan otros desplazamientos distintos de "Z". Ejemplos: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" o "2014-10-02T15:01:23+05:30".

GoogleDocsSourceMetadata

Metadatos sobre una fuente de documentos de Google.

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

string

Solo de salida. El ID del documento de Google.

revisionId

string

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

YoutubeMetadata

Metadatos sobre una fuente de vídeo de YouTube.

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

string

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

channelName

string

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

AgentspaceMetadata

Metadatos sobre una fuente de Agentspace.

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

string

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

documentTitle

string

Solo de salida. El título del documento.

SourceSettings

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

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

enum (SourceStatus)

Estado de la fuente.

failureReason

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

FailureReason

Motivo del fallo que contiene detalles sobre por qué no se ha podido ingerir 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. El error específico. error solo puede ser una de estas dos opciones:
unknown

object (Unknown)

Indica que se ha producido un error desconocido.

sourceTooLong

object (SourceTooLong)

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

ingestionError

object (IngestionError)

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

sourceEmpty

object (SourceEmpty)

Indica que la fuente está vacía.

uploadError

object (UploadError)

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

paywallError

object (PaywallError)

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

sourceUnreachable

object (SourceUnreachable)

Indica que no se puede acceder a la fuente.

googleDriveError

object (GoogleDriveError)

Error específico de Google Drive.

youtubeError

object (YoutubeError)

Error específico de YouTube.

audioTranscriptionError

object (AudioTranscriptionError)

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

sourceLimitExceeded

object (SourceLimitExceeded)

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

domainBlocked

object (DomainBlocked)

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

Desconocido

Este tipo no tiene campos.

Indica que se ha producido un error desconocido.

SourceTooLong

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

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

integer

El número de palabras de la fuente.

wordLimit

integer

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

IngestionError

Este tipo no tiene campos.

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

SourceEmpty

Este tipo no tiene campos.

Indica que la fuente está vacía.

UploadError

Este tipo no tiene campos.

Indica que se ha producido 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 ingerir.

SourceUnreachable

Indica que no se puede acceder a la fuente. Se usa principalmente en las fuentes que se añaden mediante una URL.

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

enum (SourceUnreachableErrorReason)

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

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.

GoogleDriveError

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. El error específico de Drive. error solo puede ser una de estas dos opciones:
downloadPrevented

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

YoutubeError

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. El error específico de YouTube. error solo puede ser una de estas dos opciones:
videoDeleted

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

AudioTranscriptionError

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. Error específico de la transcripción del archivo de audio. error solo puede ser una de estas dos opciones:
languageDetectionFailed

object (LanguageDetectionFailed)

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

noAudioDetected

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

SourceLimitExceeded

Este tipo no tiene campos.

Indica que el usuario no tiene espacio para esta fuente.

DomainBlocked

Este tipo no tiene campos.

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

Métodos

batchCreate

Crea una lista de Sources.

batchDelete

Elimina varias fuentes

get

Obtiene un Source.