REST Resource: projects.locations.notebooks.sources

리소스: 소스

소스는 단일 콘텐츠 소스를 나타냅니다.

JSON 표현 
{
  "name": string,
  "title": string,
  "sourceId": {
    object (SourceId)
  },
  "metadata": {
    object (SourceMetadata)
  },
  "settings": {
    object (SourceSettings)
  }
}
필드
name

string

식별자. 소스의 전체 리소스 이름입니다. 형식은 projects/{project}/locations/{location}/notebooks/{notebook}/sources/{sourceId}입니다.

이 필드는 UTF-8로 인코딩된 문자열이어야 하며 길이 제한은 1,024자(영문 기준)입니다.
title

string

(선택사항) 소스의 제목입니다.
sourceId

object (SourceId)

(선택사항) 출력 전용입니다. 소스 ID입니다. 소스 리소스 이름의 마지막 세그먼트입니다.
metadata

object (SourceMetadata)

출력 전용입니다. 소스에 관한 메타데이터입니다.
settings

object (SourceSettings)

출력 전용입니다. 소스의 상태와 실패 이유입니다.

SourceMetadata

소스의 메타데이터와 일부 추가 정보를 나타냅니다.

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
}
필드
통합 필드 metadata. 소스의 메타데이터입니다. metadata은 다음 중 하나여야 합니다.
googleDocsMetadata

object (GoogleDocsSourceMetadata)

Google 문서 소스의 메타데이터입니다.
youtubeMetadata

object (YoutubeMetadata)

YouTube 동영상 소스의 메타데이터입니다.
agentspaceMetadata

object (AgentspaceMetadata)

agentspace 소스의 메타데이터입니다.
wordCount

integer

소스의 단어 수입니다.
tokenCount

integer

소스의 토큰 수입니다.
sourceAddedTimestamp

string (Timestamp format)

소스가 추가된 타임스탬프입니다.

생성된 출력은 항상 Z-정규화되고 소수점 이하 0, 3, 6 또는 9자리인 RFC 3339를 사용합니다. 'Z' 이외의 오프셋도 허용됩니다. 예를 들면 "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" 또는 "2014-10-02T15:01:23+05:30"입니다.

GoogleDocsSourceMetadata

Google 문서 소스에 관한 메타데이터입니다.

JSON 표현 
{
  "documentId": string,
  "revisionId": string
}
필드
documentId

string

출력 전용입니다. Google 문서의 문서 ID입니다.
revisionId

string

출력 전용입니다. 문서의 버전 ID입니다.

YoutubeMetadata

YouTube 동영상 소스에 관한 메타데이터입니다.

JSON 표현 
{
  "videoId": string,
  "channelName": string
}
필드
videoId

string

출력 전용입니다. YouTube 동영상의 ID입니다.
channelName

string

출력 전용입니다. YouTube 동영상의 채널 이름입니다.

AgentspaceMetadata

에이전트 스페이스 소스에 관한 메타데이터입니다.

JSON 표현 
{
  "documentName": string,
  "documentTitle": string
}
필드
documentName

string

출력 전용입니다. Agentspace의 전체 문서 이름입니다.
documentTitle

string

출력 전용입니다. 문서의 제목입니다.

SourceSettings

sources.batchCreate (이전의 AddSource 요청)에서 소스 설정을 확장할 수 있습니다.

JSON 표현 
{
  "status": enum (SourceStatus),
  "failureReason": {
    object (FailureReason)
  }
}
필드
status

enum (SourceStatus)

소스의 상태입니다.
failureReason

object (FailureReason)

소스가 수집되지 않은 이유에 관한 세부정보가 포함된 실패 이유입니다.

SourceStatus

소스의 가능한 상태 목록입니다.

열거형
SOURCE_STATUS_UNSPECIFIED 지정되지 않은 상태입니다.
SOURCE_STATUS_PENDING 소스가 추가 대기 중입니다.
SOURCE_STATUS_COMPLETE 소스 추가가 완료되었으며 성공했습니다.
SOURCE_STATUS_ERROR 소스 추가가 영구적으로 실패했습니다.
SOURCE_STATUS_PENDING_DELETION 소스가 삭제 대기 중입니다.
SOURCE_STATUS_TENTATIVE 사용자가 소스를 추가하려고 하지만 아직 소스가 업로드되지 않았거나 사용자 한도가 확인되지 않았습니다. 사용자의 소스 한도에 포함되지 않습니다.

FailureReason

소스가 수집되지 않은 이유에 관한 세부정보가 포함된 실패 이유입니다.

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.
}
필드
통합 필드 error. 구체적인 오류입니다. error은 다음 중 하나여야 합니다.
unknown

object (Unknown)

알 수 없는 오류가 발생했음을 나타냅니다.
sourceTooLong

object (SourceTooLong)

소스 단어 수가 사용자 한도를 초과했음을 나타냅니다.
ingestionError

object (IngestionError)

소스를 인제스트하는 중에 오류가 발생했음을 나타냅니다.
sourceEmpty

object (SourceEmpty)

소스가 비어 있음을 나타냅니다.
uploadError

object (UploadError)

소스를 업로드하는 중에 오류가 발생했음을 나타냅니다.
paywallError

object (PaywallError)

소스가 페이월로 설정되어 있어 인제스트할 수 없음을 나타냅니다.
sourceUnreachable

object (SourceUnreachable)

소스에 연결할 수 없음을 나타냅니다.
googleDriveError

object (GoogleDriveError)

Google Drive 관련 오류입니다.
youtubeError

object (YoutubeError)

YouTube 관련 오류입니다.
audioTranscriptionError

object (AudioTranscriptionError)

오디오 파일 스크립트 작성 관련 오류입니다.
sourceLimitExceeded

object (SourceLimitExceeded)

사용자가 한도를 초과하여 업데이트하려고 하면 오류가 발생합니다.
domainBlocked

object (DomainBlocked)

사용자가 차단된 도메인에서 소스를 추가하려고 하면 오류가 발생합니다.

알 수 없음

이 유형에는 필드가 없습니다.

알 수 없는 오류가 발생했음을 나타냅니다.

SourceTooLong

소스 단어 수가 사용자 한도를 초과했음을 나타냅니다.

JSON 표현 
{
  "wordCount": integer,
  "wordLimit": integer
}
필드
wordCount

integer

소스의 단어 수입니다.
wordLimit

integer

업로드 시점의 현재 사용자의 단어 수 한도입니다.

IngestionError

이 유형에는 필드가 없습니다.

소스를 인제스트하는 중에 오류가 발생했음을 나타냅니다.

SourceEmpty

이 유형에는 필드가 없습니다.

소스가 비어 있음을 나타냅니다.

UploadError

이 유형에는 필드가 없습니다.

소스를 업로드하는 중에 오류가 발생했음을 나타냅니다.

PaywallError

이 유형에는 필드가 없습니다.

소스가 페이월로 설정되어 있어 인제스트할 수 없음을 나타냅니다.

SourceUnreachable

소스에 연결할 수 없음을 나타냅니다. 주로 URL을 통해 추가된 소스에 사용됩니다.

JSON 표현 
{
  "errorDetails": enum (SourceUnreachableErrorReason)
}
필드
errorDetails

enum (SourceUnreachableErrorReason)

소스에 연결할 수 없는 이유를 설명합니다.

SourceUnreachableErrorReason

소스에 연결할 수 없는 이유에 관한 세부정보입니다. 사용자에게 적절한 메시지를 표시하는 데 사용됩니다.

열거형
ERROR_REASON_UNSPECIFIED 기본값
ERROR_REASON_INVALID_URL 소스 URL이 잘못되었습니다.
ERROR_REASON_NOT_ACCESSIBLE 소스 URL에 액세스할 수 없습니다.
ERROR_REASON_NOT_REACHABLE 소스 URL에 연결할 수 없습니다.
ERROR_REASON_URL_NOT_FOUND 소스 URL에서 404를 반환했습니다.
ERROR_REASON_TRANSIENT_ERROR 일시적인 네트워크 오류나 호스트 제한 시간 등으로 인해 소스 URL에 연결할 수 없습니다.
ERROR_REASON_FETCH_FAILED 내부 오류로 인해 소스 URL을 가져올 수 없습니다.
ERROR_REASON_NOT_SUPPORTED 아직 지원되지 않는 URL입니다. 예로는 가져온 콘텐츠가 트롤러 가져오기 최대 크기를 초과하거나 가져온 콘텐츠가 아직 지원되지 않는 유형인 경우 등이 있습니다.

GoogleDriveError

Google Drive 관련 오류입니다.

JSON 표현 
{

  // Union field error can be only one of the following:
  "downloadPrevented": {
    object (DownloadPrevented)
  }
  // End of list of possible types for union field error.
}
필드
통합 필드 error. Drive 관련 오류입니다. error은 다음 중 하나여야 합니다.
downloadPrevented

object (DownloadPrevented)

사용자가 파일을 다운로드할 수 없습니다.

DownloadPrevented

이 유형에는 필드가 없습니다.

사용자가 파일을 다운로드할 수 없습니다.

YoutubeError

YouTube 관련 오류입니다.

JSON 표현 
{

  // Union field error can be only one of the following:
  "videoDeleted": {
    object (VideoDeleted)
  }
  // End of list of possible types for union field error.
}
필드
통합 필드 error. YouTube 관련 오류입니다. error은 다음 중 하나여야 합니다.
videoDeleted

object (VideoDeleted)

동영상이 삭제되어 소스가 삭제되었음을 나타내는 오류입니다.

VideoDeleted

이 유형에는 필드가 없습니다.

동영상이 삭제되어 소스가 삭제되었음을 나타내는 오류입니다.

AudioTranscriptionError

오디오 파일 스크립트 작성 관련 오류입니다.

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.
}
필드
통합 필드 error. 오디오 파일 스크립트 작성 관련 오류입니다. error은 다음 중 하나여야 합니다.
languageDetectionFailed

object (LanguageDetectionFailed)

파일의 언어를 감지할 수 없습니다 (음성이 아닐 수 있음).
noAudioDetected

object (NoAudioDetected)

입력 파일에서 오디오가 감지되지 않았습니다 (동영상일 수 있음).

LanguageDetectionFailed

이 유형에는 필드가 없습니다.

파일의 언어를 감지할 수 없습니다 (음성이 아닐 수 있음).

NoAudioDetected

이 유형에는 필드가 없습니다.

입력 파일에서 오디오가 감지되지 않았습니다.

SourceLimitExceeded

이 유형에는 필드가 없습니다.

사용자에게 이 소스를 위한 공간이 없음을 나타냅니다.

DomainBlocked

이 유형에는 필드가 없습니다.

도메인이 차단되어 소스가 삭제되었음을 나타내는 오류입니다.

메서드

batchCreate

 Source 목록을 만듭니다.

batchDelete

 여러 소스를 삭제합니다.

get

 Source을 가져옵니다.