Method: projects.locations.collections.engines.sessions.listSessionFileMetadata

현재 세션의 모든 파일에 대한 메타데이터를 나열합니다.

HTTP 요청

GET https://discoveryengine.googleapis.com/v1alpha/{name=projects/*/locations/*/collections/*/engines/*/sessions/*}:listSessionFileMetadata

URL은 gRPC 트랜스코딩 문법을 사용합니다.

경로 매개변수

매개변수
name

string

필수 항목입니다. 세션의 리소스 이름입니다. 형식: projects/{project}/locations/{location}/collections/{collection}/engines/{engine}/sessions/{session}

요청 본문

요청 본문은 비어 있어야 합니다.

응답 본문

AssistantService.ListSessionFileMetadata 메서드의 응답 메시지입니다.

성공한 경우 응답 본문은 다음과 같은 구조의 데이터를 포함합니다.

JSON 표현
{
  "fileMetadata": [
    {
      object (FileMetadata)
    }
  ],
  "totalQuotaPercentage": number
}
필드
fileMetadata[]

object (FileMetadata)

FileMetadata입니다.

totalQuotaPercentage
(deprecated)

number

지원 중단됨: 이 필드는 설정되지 않을 수 있으며, 값에 모든 파일 형식이 고려되지 않을 수 있습니다. 삭제 예정

모든 파일에서 사용한 총 할당량 비율입니다.

승인 범위

다음 OAuth 범위 중 하나가 필요합니다.

  • https://www.googleapis.com/auth/cloud-platform
  • https://www.googleapis.com/auth/discoveryengine.readwrite
  • https://www.googleapis.com/auth/discoveryengine.assist.readwrite

자세한 내용은 Authentication Overview를 참조하세요.

IAM 권한

name 리소스에 대해서는 다음 IAM 권한이 필요합니다.

  • discoveryengine.sessions.listSessionFileMetadata

자세한 내용은 IAM 문서를 참조하세요.

FileMetadata 클래스의 메소드

파일의 메타데이터입니다.

JSON 표현
{
  "fileId": string,
  "name": string,
  "mimeType": string,
  "byteSize": string,
  "tokenCount": string,
  "quotaPercentage": number,
  "selected": boolean,
  "usedInConversation": boolean,
  "originalUri": string,
  "originalSourceType": enum (FileSource),
  "uploadTime": string,
  "metadata": {
    string: string,
    ...
  },
  "session": string
}
필드
fileId

string

파일의 ID입니다.

name

string

업로드된 파일의 이름입니다.

mimeType

string

파일의 콘텐츠 유형입니다(https://www.iana.org/assignments/media-types/media-types.xhtml 참고).

byteSize

string (int64 format)

컨텍스트 파일의 크기(바이트)입니다.

tokenCount
(deprecated)

string (int64 format)

지원 중단됨: 이 필드는 일부 파일 형식에 설정되지 않으며 최종적으로 삭제됩니다.

토큰으로 측정된 파일의 길이입니다.

quotaPercentage
(deprecated)

number

지원 중단됨: 이 필드는 일부 파일 형식에 설정되지 않으며 최종적으로 삭제됩니다.

파일에서 사용한 할당량의 비율입니다.

selected

boolean

파일이 사용되도록 선택된 경우

usedInConversation

boolean

파일이 이전에 세션에서 사용되었는지 (즉, 쿼리에서 사용됨) 여부와 대화 기록의 일부인지 아니면 업로드되었지만 아직 사용되지 않았는지 여부입니다.

originalUri

string

(선택사항) 파일의 원래 위치입니다. 로컬 파일 경로 또는 외부 시스템에서 파일에 액세스할 수 있는 기타 URI일 수 있습니다. 이 URL이 비어 있을 수 있는 두 가지 시나리오가 있습니다. 1. 파일이 인라인 데이터로 전송된 경우 (예: 클립보드에서 붙여넣음). 2. 원래 위치를 사용할 수 없는 경우

URI가 유효하거나 실제로 존재하는 파일을 가리킨다고 보장할 수는 없습니다. 예를 들어 파일이 세션에 업로드된 후 원본 소스에서 삭제되었을 수 있습니다.

originalSourceType

enum (FileSource)

(선택사항) 파일의 원래 소스 유형입니다.

uploadTime

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"입니다.

metadata

map (key: string, value: string)

(선택사항) 특정 사용 사례에 적합한 파일 관련 메타데이터를 나타냅니다. 'google.' 프리픽스는 Google에서 사용하는 키에 예약되어 있지만 다른 프리픽스는 자유롭게 사용할 수 있습니다.

session

string

출력 전용입니다. 세션의 리소스 이름입니다. 형식은 projects/{project}/locations/{location}/collections/{collection}/engines/{engine}/sessions/{session}입니다.