REST Resource: projects.locations.notebooks.sources

Recurso: origem

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 de recurso completo da origem. Formato: projects/{project}/locations/{location}/notebooks/{notebook}/sources/{sourceId}.

Este campo tem de ser uma string codificada em UTF-8 com um limite de comprimento de 1024 carateres.
title

string

Opcional. Título da fonte.
sourceId

object (SourceId)

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

object (SourceMetadata)

Apenas saída. Metadados sobre a origem.
settings

object (SourceSettings)

Apenas saída. Estado da origem e todos os motivos de falha.

SourceMetadata

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

Representação 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ão metadata. Metadados da fonte. metadata só pode ser uma das seguintes opções:
googleDocsMetadata

object (GoogleDocsSourceMetadata)

metadados de uma origem do Google Docs.
youtubeMetadata

object (YoutubeMetadata)

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

object (AgentspaceMetadata)

metadados para uma origem do espaço de agentes.
wordCount

integer

A contagem de palavras da fonte.
tokenCount

integer

O número de tokens na origem.
sourceAddedTimestamp

string (Timestamp format)

A indicação de tempo em que a fonte foi adicionada.

Usa RFC 3339, em que o resultado gerado é sempre normalizado em Z e usa 0, 3, 6 ou 9 dígitos fracionários. Também são aceites desvios diferentes de "Z". Exemplos: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" ou "2014-10-02T15:01:23+05:30".

GoogleDocsSourceMetadata

metadados sobre uma origem de documentos do Google Docs.

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

string

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

string

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

YoutubeMetadata

Metadados sobre uma origem 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 agentspace.

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 definições de origem em sources.batchCreate (anteriormente, pedido AddSource).

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

enum (SourceStatus)

estado da origem.
failureReason

object (FailureReason)

Motivo da falha com detalhes sobre o motivo pelo qual não foi possível carregar uma origem.

SourceStatus

Lista de estados possíveis para uma origem.

Enumerações
SOURCE_STATUS_UNSPECIFIED Estado não especificado.
SOURCE_STATUS_PENDING A fonte está pendente de adição.
SOURCE_STATUS_COMPLETE A adição da origem está concluída e foi bem-sucedida.
SOURCE_STATUS_ERROR A adição da origem falhou permanentemente.
SOURCE_STATUS_PENDING_DELETION A origem está pendente de eliminação.
SOURCE_STATUS_TENTATIVE O utilizador está a tentar adicionar uma origem, mas ainda não a carregámos nem verificámos os limites de utilizadores. Não é contabilizado no limite de origens do utilizador.

FailureReason

Motivo da falha com detalhes sobre o motivo pelo qual não foi possível carregar uma origem.

Representação 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ão error. O erro específico. error só pode ser uma das seguintes opções:
unknown

object (Unknown)

Indica que ocorreu um erro desconhecido.
sourceTooLong

object (SourceTooLong)

Indica que a contagem de palavras de origem excedeu o limite do utilizador.
ingestionError

object (IngestionError)

Indica que ocorreu um erro durante a ingestão da origem.
sourceEmpty

object (SourceEmpty)

Indica que a origem está vazia.
uploadError

object (UploadError)

Indica que ocorreu um erro ao carregar a fonte.
paywallError

object (PaywallError)

Indica que a fonte está protegida por um paywall e não pode ser carregada.
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 da transcrição de um ficheiro de áudio.
sourceLimitExceeded

object (SourceLimitExceeded)

Erro se o utilizador tentar atualizar para além dos respetivos limites.
domainBlocked

object (DomainBlocked)

Erro se o utilizador tentar adicionar uma fonte de um domínio bloqueado.

Desconhecido

Este tipo não tem campos.

Indica que ocorreu um erro desconhecido.

SourceTooLong

Indica que a contagem de palavras de origem excedeu o limite do utilizador.

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 utilizador atual no momento do carregamento.

IngestionError

Este tipo não tem campos.

Indica que ocorreu um erro durante a ingestão da origem.

SourceEmpty

Este tipo não tem campos.

Indica que a origem está vazia.

UploadError

Este tipo não tem campos.

Indica que ocorreu um erro ao carregar a fonte.

PaywallError

Este tipo não tem campos.

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

SourceUnreachable

Indica que a origem está inacessível. Esta opção é usada principalmente para fontes adicionadas através de URL.

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

enum (SourceUnreachableErrorReason)

Descreve o motivo pelo qual a origem está inacessível.

SourceUnreachableErrorReason

Detalhes sobre o motivo pelo qual a origem está inacessível. Usado para apresentar a mensagem adequada ao utilizador.

Enumerações
ERROR_REASON_UNSPECIFIED Predefinição
ERROR_REASON_INVALID_URL O URL de origem é inválido.
ERROR_REASON_NOT_ACCESSIBLE Não é possível aceder ao URL de origem.
ERROR_REASON_NOT_REACHABLE Não é possível aceder ao URL de origem.
ERROR_REASON_URL_NOT_FOUND O URL de origem devolveu 404.
ERROR_REASON_TRANSIENT_ERROR O URL de origem não está acessível devido a um erro de rede temporário ou ao limite de tempo excedido do anfitrião, etc.
ERROR_REASON_FETCH_FAILED Não foi possível obter o URL de origem devido a um erro interno.
ERROR_REASON_NOT_SUPPORTED O URL ainda não é suportado. Os exemplos incluem: o conteúdo obtido excede o tamanho máximo de obtenção do rastreador, o conteúdo obtido é de um tipo que ainda não suportamos, etc.

GoogleDriveError

Um erro específico do Google Drive.

Representação 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ão error. O erro específico do Drive. error só pode ser uma das seguintes opções:
downloadPrevented

object (DownloadPrevented)

O utilizador foi impedido de transferir o ficheiro.

DownloadPrevented

Este tipo não tem campos.

O utilizador foi impedido de transferir o ficheiro.

YoutubeError

Um erro específico do YouTube.

Representação 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ão error. O erro específico do YouTube. error só pode ser uma das seguintes opções:
videoDeleted

object (VideoDeleted)

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

VideoDeleted

Este tipo não tem campos.

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

AudioTranscriptionError

Um erro específico da transcrição de um ficheiro de áudio.

Representação 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ão error. Erro específico da transcrição do ficheiro de áudio. error só pode ser uma das seguintes opções:
languageDetectionFailed

object (LanguageDetectionFailed)

Não foi possível detetar o idioma do ficheiro (pode não ser voz).
noAudioDetected

object (NoAudioDetected)

Não foi detetado áudio no ficheiro de entrada (pode ter sido um vídeo).

LanguageDetectionFailed

Este tipo não tem campos.

Não foi possível detetar o idioma do ficheiro (pode não ser voz).

NoAudioDetected

Este tipo não tem campos.

Não foi detetado áudio no ficheiro de entrada.

SourceLimitExceeded

Este tipo não tem campos.

Indica que o utilizador não tem espaço para esta fonte.

DomainBlocked

Este tipo não tem campos.

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

Métodos

batchCreate

 Cria uma lista de Sources.

batchDelete

 Elimina várias fontes

get

 Obtém um Source.