REST Resource: projects.locations.notebooks.sources

Risorsa: origine

L'origine rappresenta una singola fonte di contenuti.

Rappresentazione JSON
{
  "name": string,
  "title": string,
  "sourceId": {
    object (SourceId)
  },
  "metadata": {
    object (SourceMetadata)
  },
  "settings": {
    object (SourceSettings)
  }
}
Campi
name

string

Identificatore. Il nome completo della risorsa dell'origine. Formato: projects/{project}/locations/{location}/notebooks/{notebook}/sources/{sourceId}.

Questo campo deve essere una stringa codificata in UTF-8 con un limite di lunghezza di 1024 caratteri.

title

string

Facoltativo. Il titolo della fonte.

sourceId

object (SourceId)

Facoltativo. Solo output. ID origine, che è l'ultimo segmento del nome della risorsa dell'origine.

metadata

object (SourceMetadata)

Solo output. Metadati relativi alla fonte.

settings

object (SourceSettings)

Solo output. Stato dell'origine ed eventuali motivi di errore.

SourceMetadata

Rappresenta i metadati di una fonte e alcune informazioni aggiuntive.

Rappresentazione 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
}
Campi
Campo unione metadata. Metadati della fonte. metadata può essere solo uno dei seguenti:
googleDocsMetadata

object (GoogleDocsSourceMetadata)

metadati per un'origine di Documenti Google.

youtubeMetadata

object (YoutubeMetadata)

metadati per una fonte video di YouTube.

agentspaceMetadata

object (AgentspaceMetadata)

metadati per un'origine Agentspace.

wordCount

integer

Il conteggio delle parole della fonte.

tokenCount

integer

Il numero di token nella sorgente.

sourceAddedTimestamp

string (Timestamp format)

Il timestamp di aggiunta della fonte.

Utilizza RFC 3339, in cui l'output generato è sempre normalizzato in base al fuso orario UTC e utilizza 0, 3, 6 o 9 cifre frazionarie. Sono accettati anche offset diversi da "Z". Esempi: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" o "2014-10-02T15:01:23+05:30".

GoogleDocsSourceMetadata

metadati relativi a un'origine di Documenti Google.

Rappresentazione JSON
{
  "documentId": string,
  "revisionId": string
}
Campi
documentId

string

Solo output. L'ID documento del documento Google.

revisionId

string

Solo output. ID revisione del documento.

YoutubeMetadata

metadati relativi a un'origine video di YouTube.

Rappresentazione JSON
{
  "videoId": string,
  "channelName": string
}
Campi
videoId

string

Solo output. L'ID del video di YouTube.

channelName

string

Solo output. Il nome del canale del video di YouTube.

AgentspaceMetadata

metadati relativi a un'origine agentspace.

Rappresentazione JSON
{
  "documentName": string,
  "documentTitle": string
}
Campi
documentName

string

Solo output. Il nome completo del documento in Agentspace.

documentTitle

string

Solo output. Il titolo del documento.

SourceSettings

Consente l'estensione delle impostazioni dell'origine in sources.batchCreate (in precedenza richiesta AddSource).

Rappresentazione JSON
{
  "status": enum (SourceStatus),
  "failureReason": {
    object (FailureReason)
  }
}
Campi
status

enum (SourceStatus)

lo stato della fonte.

failureReason

object (FailureReason)

Motivo dell'errore contenente dettagli sul motivo per cui l'importazione di un'origine non è riuscita.

SourceStatus

Elenco dei possibili stati di un'origine.

Enum
SOURCE_STATUS_UNSPECIFIED Stato non specificato.
SOURCE_STATUS_PENDING L'origine è in attesa di aggiunta.
SOURCE_STATUS_COMPLETE L'aggiunta dell'origine è stata completata.
SOURCE_STATUS_ERROR L'aggiunta dell'origine non è riuscita definitivamente.
SOURCE_STATUS_PENDING_DELETION L'origine è in attesa di eliminazione.
SOURCE_STATUS_TENTATIVE L'utente sta tentando di aggiungere una fonte, ma non l'abbiamo ancora caricata o controllato i limiti utente. Non viene conteggiato ai fini del limite di fonti dell'utente.

FailureReason

Motivo dell'errore contenente dettagli sul motivo per cui l'importazione di un'origine non è riuscita.

Rappresentazione 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.
}
Campi
Campo unione error. L'errore specifico. error può essere solo uno dei seguenti:
unknown

object (Unknown)

Indica che si è verificato un errore sconosciuto.

sourceTooLong

object (SourceTooLong)

Indica che il conteggio delle parole della sorgente ha superato il limite dell'utente.

ingestionError

object (IngestionError)

Indica che si è verificato un errore durante l'importazione dell'origine.

sourceEmpty

object (SourceEmpty)

Indica che l'origine è vuota.

uploadError

object (UploadError)

Indica che si è verificato un errore durante il caricamento dell'origine.

paywallError

object (PaywallError)

Indica che l'origine è protetta da paywall e non può essere acquisita.

sourceUnreachable

object (SourceUnreachable)

Indica che l'origine non è raggiungibile.

googleDriveError

object (GoogleDriveError)

Un errore specifico di Google Drive.

youtubeError

object (YoutubeError)

Un errore specifico di YouTube.

audioTranscriptionError

object (AudioTranscriptionError)

Un errore specifico di trascrizione del file audio.

sourceLimitExceeded

object (SourceLimitExceeded)

Errore se l'utente tenta di eseguire un aggiornamento oltre i limiti.

domainBlocked

object (DomainBlocked)

Errore se l'utente tenta di aggiungere una fonte da un dominio bloccato.

Sconosciuto

Questo tipo non contiene campi.

Indica che si è verificato un errore sconosciuto.

SourceTooLong

Indica che il conteggio delle parole della sorgente ha superato il limite dell'utente.

Rappresentazione JSON
{
  "wordCount": integer,
  "wordLimit": integer
}
Campi
wordCount

integer

Il numero di parole nella fonte.

wordLimit

integer

Il limite di conteggio delle parole per l'utente corrente al momento del caricamento.

IngestionError

Questo tipo non contiene campi.

Indica che si è verificato un errore durante l'importazione dell'origine.

SourceEmpty

Questo tipo non contiene campi.

Indica che l'origine è vuota.

UploadError

Questo tipo non contiene campi.

Indica che si è verificato un errore durante il caricamento dell'origine.

PaywallError

Questo tipo non contiene campi.

Indica che l'origine è protetta da paywall e non può essere acquisita.

SourceUnreachable

Indica che l'origine non è raggiungibile. Viene utilizzato principalmente per le origini aggiunte tramite URL.

Rappresentazione JSON
{
  "errorDetails": enum (SourceUnreachableErrorReason)
}
Campi
errorDetails

enum (SourceUnreachableErrorReason)

Descrive perché l'origine non è raggiungibile.

SourceUnreachableErrorReason

Dettagli sul motivo per cui l'origine non è raggiungibile. Utilizzato per mostrare il messaggio appropriato all'utente.

Enum
ERROR_REASON_UNSPECIFIED Predefinito
ERROR_REASON_INVALID_URL L'URL di origine non è valido.
ERROR_REASON_NOT_ACCESSIBLE L'URL di origine non è accessibile.
ERROR_REASON_NOT_REACHABLE L'URL di origine non è raggiungibile.
ERROR_REASON_URL_NOT_FOUND L'URL di origine ha restituito l'errore 404.
ERROR_REASON_TRANSIENT_ERROR L'URL di origine non è raggiungibile a causa di un errore di rete temporaneo o di timeout dell'host e così via.
ERROR_REASON_FETCH_FAILED Non è stato possibile recuperare l'URL di origine a causa di un errore interno.
ERROR_REASON_NOT_SUPPORTED L'URL non è ancora supportato. Ad esempio, i contenuti recuperati superano le dimensioni massime di recupero del crawler, i contenuti recuperati sono di un tipo non ancora supportato e così via.

GoogleDriveError

Un errore specifico di Google Drive.

Rappresentazione JSON
{

  // Union field error can be only one of the following:
  "downloadPrevented": {
    object (DownloadPrevented)
  }
  // End of list of possible types for union field error.
}
Campi
Campo unione error. L'errore specifico di Drive. error può essere solo uno dei seguenti:
downloadPrevented

object (DownloadPrevented)

All'utente è stato impedito di scaricare il file.

DownloadPrevented

Questo tipo non contiene campi.

All'utente è stato impedito di scaricare il file.

YoutubeError

Un errore specifico di YouTube.

Rappresentazione JSON
{

  // Union field error can be only one of the following:
  "videoDeleted": {
    object (VideoDeleted)
  }
  // End of list of possible types for union field error.
}
Campi
Campo unione error. L'errore specifico di YouTube. error può essere solo uno dei seguenti:
videoDeleted

object (VideoDeleted)

Errore che indica che la fonte è stata rimossa perché il video è stato eliminato.

VideoDeleted

Questo tipo non contiene campi.

Errore che indica che la fonte è stata rimossa perché il video è stato eliminato.

AudioTranscriptionError

Un errore specifico di trascrizione del file audio.

Rappresentazione 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.
}
Campi
Campo unione error. L'errore specifico della trascrizione del file audio. error può essere solo uno dei seguenti:
languageDetectionFailed

object (LanguageDetectionFailed)

Impossibile rilevare la lingua del file (potrebbe non essere un discorso).

noAudioDetected

object (NoAudioDetected)

Nessun audio è stato rilevato nel file di input (potrebbe trattarsi di un video).

LanguageDetectionFailed

Questo tipo non contiene campi.

Impossibile rilevare la lingua del file (potrebbe non essere un discorso).

NoAudioDetected

Questo tipo non contiene campi.

Nessun audio rilevato nel file di input.

SourceLimitExceeded

Questo tipo non contiene campi.

Indica che l'utente non ha spazio per questa origine.

DomainBlocked

Questo tipo non contiene campi.

Errore che indica che l'origine è stata rimossa perché il dominio è stato bloccato.

Metodi

batchCreate

Crea un elenco di Source.

batchDelete

Elimina più fonti

get

Riceve un Source.