REST Resource: projects.locations.notebooks.sources

Recurso: Source

A origem representa uma única fonte de conteúdo.

Representação JSON 
{
  "name": string,
  "title": string,
  "sourceId": {
    object (SourceId)
  },
  "metadata": {
    object (SourceMetadata)
  },
  "settings": {
    object (SourceSettings)
  }
}
Campos
name

string

Identificador. O nome completo do recurso da origem. Formato: projects/{project}/locations/{location}/notebooks/{notebook}/sources/{sourceId}.

Esse campo precisa ser uma string codificada em UTF-8 com um limite de 1.024 caracteres.
title

string

Opcional. Título da fonte.
sourceId

object (SourceId)

Opcional. Apenas saída. ID da origem, que é o último segmento do nome do recurso da origem.
metadata

object (SourceMetadata)

Somente saída. Metadados sobre a origem.
settings

object (SourceSettings)

Apenas saída. Status da origem e motivos de falha.

SourceMetadata

Representa os metadados de uma fonte e algumas informações adicionais.

Representação JSON 
{

  // The following is a list of mutually exclusive fields. At most one of the
  // fields will be set in a response:
  "googleDocsMetadata": {
    object (GoogleDocsSourceMetadata)
  },
  "youtubeMetadata": {
    object (YoutubeMetadata)
  },
  "agentspaceMetadata": {
    object (AgentspaceMetadata)
  }
  // End of mutually exclusive fields.
  "wordCount": integer,
  "tokenCount": integer,
  "sourceAddedTimestamp": string
}
Campos
Metadados da origem. Confira a seguir uma lista de campos mutuamente exclusivos. No máximo um dos campos será definido em uma resposta:
googleDocsMetadata

object (GoogleDocsSourceMetadata)

metadados de uma fonte de documento do Google.
youtubeMetadata

object (YoutubeMetadata)

metadados de uma fonte de vídeo do YouTube.
agentspaceMetadata

object (AgentspaceMetadata)

Metadados de uma fonte do Agentspace.
Fim dos campos mutuamente exclusivos.
wordCount

integer

A contagem de palavras da fonte.
tokenCount

integer

O número de tokens na origem.
sourceAddedTimestamp

string (Timestamp format)

O carimbo de data/hora em que a fonte foi adicionada.

Usa o padrão RFC 3339, em que a saída gerada é sempre convertida em Z e tem 0, 3, 6 ou 9 dígitos fracionários. Além de Z, outros ajustes também são aceitos. Exemplos: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" ou "2014-10-02T15:01:23+05:30".

GoogleDocsSourceMetadata

Metadados sobre uma fonte de documento do Google.

Representação JSON 
{
  "documentId": string,
  "revisionId": string
}
Campos
documentId

string

Apenas saída. O ID do documento do Google.
revisionId

string

Apenas saída. ID da revisão do documento.

YoutubeMetadata

Metadados sobre uma fonte de vídeo do YouTube.

Representação JSON 
{
  "videoId": string,
  "channelName": string
}
Campos
videoId

string

Apenas saída. O ID do vídeo do YouTube.
channelName

string

Apenas saída. O nome do canal do vídeo do YouTube.

AgentspaceMetadata

Metadados sobre uma origem do espaço do agente.

Representação JSON 
{
  "documentName": string,
  "documentTitle": string
}
Campos
documentName

string

Apenas saída. O nome completo do documento no Agentspace.
documentTitle

string

Apenas saída. O título do documento.

SourceSettings

Permite a extensão das configurações de origem em sources.batchCreate (antiga solicitação AddSource).

Representação JSON 
{
  "status": enum (SourceStatus),
  "failureReason": {
    object (FailureReason)
  }
}
Campos
status

enum (SourceStatus)

status da origem.
failureReason

object (FailureReason)

Motivo da falha com detalhes sobre por que uma fonte não foi ingerida.

SourceStatus

Lista de possíveis status para uma fonte.

Tipos enumerados
SOURCE_STATUS_UNSPECIFIED Status não especificado.
SOURCE_STATUS_PENDING A fonte está pendente de adição.
SOURCE_STATUS_COMPLETE A adição da origem foi concluída.
SOURCE_STATUS_ERROR A adição da fonte falhou permanentemente.
SOURCE_STATUS_PENDING_DELETION A exclusão da origem está pendente.
SOURCE_STATUS_TENTATIVE O usuário está tentando adicionar uma fonte, mas ainda não fizemos o upload nem verificamos os limites do usuário. Não conta para o limite de fontes do usuário.

FailureReason

Motivo da falha com detalhes sobre por que uma fonte não foi ingerida.

Representação JSON 
{

  // The following is a list of mutually exclusive fields. At most one of the
  // fields will be set in a response:
  "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)
  },
  "mimeTypeBlocked": {
    object (MimeTypeBlocked)
  },
  "policyCheckFailed": {
    object (PolicyCheckFailed)
  }
  // End of mutually exclusive fields.
}
Campos
O erro específico. Confira a seguir uma lista de campos mutuamente exclusivos. No máximo um dos campos será definido em uma resposta:
unknown

object (Unknown)

Indica que ocorreu um erro desconhecido.
sourceTooLong

object (SourceTooLong)

Indica que a contagem de palavras da fonte excedeu o limite do usuário.
ingestionError

object (IngestionError)

Indica que ocorreu um erro ao ingerir a origem.
sourceEmpty

object (SourceEmpty)

Indica que a origem está vazia.
uploadError

object (UploadError)

Indica que ocorreu um erro ao fazer o upload da fonte.
paywallError

object (PaywallError)

Indica que a fonte está protegida por paywall e não pode ser ingerida.
sourceUnreachable

object (SourceUnreachable)

Indica que a origem está inacessível.
googleDriveError

object (GoogleDriveError)

Um erro específico do Google Drive.
youtubeError

object (YoutubeError)

Um erro específico do YouTube.
audioTranscriptionError

object (AudioTranscriptionError)

Um erro específico de transcrição de arquivo de áudio.
sourceLimitExceeded

object (SourceLimitExceeded)

Erro se o usuário tentar atualizar além dos limites.
domainBlocked

object (DomainBlocked)

Erro se o usuário tentar adicionar uma fonte de um domínio bloqueado.
mimeTypeBlocked

object (MimeTypeBlocked)

Indica que o tipo MIME de origem está bloqueado.
policyCheckFailed

object (PolicyCheckFailed)

Indica que a verificação da política falhou.
Fim dos campos mutuamente exclusivos.

Desconhecido

Esse tipo não tem campos.

Indica que ocorreu um erro desconhecido.

SourceTooLong

Indica que a contagem de palavras da fonte excedeu o limite do usuário.

Representação JSON 
{
  "wordCount": integer,
  "wordLimit": integer
}
Campos
wordCount

integer

O número de palavras na fonte.
wordLimit

integer

O limite de contagem de palavras para o usuário atual no momento do envio.

IngestionError

Esse tipo não tem campos.

Indica que ocorreu um erro ao ingerir a origem.

SourceEmpty

Esse tipo não tem campos.

Indica que a origem está vazia.

UploadError

Esse tipo não tem campos.

Indica que ocorreu um erro ao fazer o upload da fonte.

PaywallError

Esse tipo não tem campos.

Indica que a fonte está protegida por paywall e não pode ser ingerida.

SourceUnreachable

Indica que a origem está inacessível. Isso é usado principalmente para fontes adicionadas por URL.

Representação JSON 
{
  "errorDetails": enum (SourceUnreachableErrorReason)
}
Campos
errorDetails

enum (SourceUnreachableErrorReason)

Descreve por que a origem está inacessível.

SourceUnreachableErrorReason

Detalhes sobre por que a origem está inacessível. Usado para mostrar a mensagem adequada ao usuário.

Tipos enumerados
ERROR_REASON_UNSPECIFIED Padrão
ERROR_REASON_INVALID_URL O URL de origem é inválido.
ERROR_REASON_NOT_ACCESSIBLE Não é possível acessar o URL de origem.
ERROR_REASON_NOT_REACHABLE Não é possível acessar o URL da fonte.
ERROR_REASON_URL_NOT_FOUND O URL de origem retornou 404.
ERROR_REASON_TRANSIENT_ERROR O URL de origem não está acessível devido a um erro de rede temporário ou tempo limite do host etc.
ERROR_REASON_FETCH_FAILED Não foi possível buscar o URL de origem devido a um erro interno.
ERROR_REASON_NOT_SUPPORTED O URL ainda não é compatível. Por exemplo, o conteúdo buscado excede o tamanho máximo de busca do rastreador, o conteúdo buscado é de um tipo que ainda não oferecemos suporte etc.

GoogleDriveError

Um erro específico do Google Drive.

Representação JSON 
{

  // The following is a list of mutually exclusive fields. At most one of the
  // fields will be set in a response:
  "downloadPrevented": {
    object (DownloadPrevented)
  }
  // End of mutually exclusive fields.
}
Campos
O erro específico do Drive. Confira a seguir uma lista de campos mutuamente exclusivos. No máximo um dos campos será definido em uma resposta:
downloadPrevented

object (DownloadPrevented)

O usuário não conseguiu baixar o arquivo.
Fim dos campos mutuamente exclusivos.

DownloadPrevented

Esse tipo não tem campos.

O usuário não conseguiu baixar o arquivo.

YoutubeError

Um erro específico do YouTube.

Representação JSON 
{

  // The following is a list of mutually exclusive fields. At most one of the
  // fields will be set in a response:
  "videoDeleted": {
    object (VideoDeleted)
  }
  // End of mutually exclusive fields.
}
Campos
O erro específico do YouTube. Confira a seguir uma lista de campos mutuamente exclusivos. No máximo um dos campos será definido em uma resposta:
videoDeleted

object (VideoDeleted)

Erro para indicar que a origem foi removida porque o vídeo foi excluído.
Fim dos campos mutuamente exclusivos.

VideoDeleted

Esse tipo não tem campos.

Erro para indicar que a origem foi removida porque o vídeo foi excluído.

AudioTranscriptionError

Um erro específico de transcrição de arquivo de áudio.

Representação JSON 
{

  // The following is a list of mutually exclusive fields. At most one of the
  // fields will be set in a response:
  "languageDetectionFailed": {
    object (LanguageDetectionFailed)
  },
  "noAudioDetected": {
    object (NoAudioDetected)
  }
  // End of mutually exclusive fields.
}
Campos
O erro específico da transcrição do arquivo de áudio. Confira a seguir uma lista de campos mutuamente exclusivos. No máximo um dos campos será definido em uma resposta:
languageDetectionFailed

object (LanguageDetectionFailed)

Não foi possível detectar o idioma do arquivo (talvez ele não seja de fala).
noAudioDetected

object (NoAudioDetected)

Nenhum áudio foi detectado no arquivo de entrada (talvez fosse um vídeo).
Fim dos campos mutuamente exclusivos.

LanguageDetectionFailed

Esse tipo não tem campos.

Não foi possível detectar o idioma do arquivo (talvez ele não seja de fala).

NoAudioDetected

Esse tipo não tem campos.

Nenhum áudio foi detectado no arquivo de entrada.

SourceLimitExceeded

Esse tipo não tem campos.

Indica que o usuário não tem espaço para essa origem.

DomainBlocked

Esse tipo não tem campos.

Erro para indicar que a origem foi removida porque o domínio foi bloqueado.

MimeTypeBlocked

Esse tipo não tem campos.

Indica que o tipo MIME de origem está bloqueado.

PolicyCheckFailed

Esse tipo não tem campos.

Indica que a verificação da política falhou.

Métodos

batchCreate

 Cria uma lista de Sources.

batchDelete

 Exclui várias fontes

get

 Recebe um Source.