Chunks

REST 리소스: corpora.documents.chunks

리소스: Chunk

Chunk는 벡터 표현 및 저장을 위해 독립 단위로 취급되는 Document의 하위 부분입니다. Corpus 하나에 최대 100만 개의 Chunk가 포함될 수 있습니다.

JSON 표현 
{
  "name": string,
  "data": {
    object (ChunkData)
  },
  "customMetadata": [
    {
      object (CustomMetadata)
    }
  ],
  "createTime": string,
  "updateTime": string,
  "state": enum (State)
}
입력란
name string

변경할 수 없습니다. 식별자. Chunk 리소스 이름입니다. ID('corpora/*/documents/*/chunks/' 프리픽스를 제외한 이름)에는 소문자 영숫자 또는 대시(-)로 구성된 최대 40자(영문 기준)를 포함할 수 있습니다. ID는 대시로 시작하거나 끝날 수 없습니다. 생성 시 이름이 비어 있으면 임의의 12자리 고유 ID가 생성됩니다. 예: corpora/{corpus_id}/documents/{document_id}/chunks/123a456b789c

data object (ChunkData)

필수 항목입니다. Chunk의 콘텐츠(예: 텍스트 문자열) 청크당 최대 토큰 수는 2,043개입니다.

customMetadata[] object (CustomMetadata)

선택사항. 키-값 쌍으로 저장된 사용자 제공 커스텀 메타데이터입니다. 단위당 최대 CustomMetadata 수는 20개입니다.

createTime string (Timestamp format)

출력 전용입니다. Chunk가 생성된 시점의 타임스탬프입니다.

RFC3339 UTC 'Zulu' 형식의 타임스탬프입니다(나노초 단위, 소수점 이하 9자리). 예를 들면 "2014-10-02T15:01:23Z" 및 "2014-10-02T15:01:23.045123456Z"입니다.

updateTime string (Timestamp format)

출력 전용입니다. Chunk가 마지막으로 업데이트된 시점의 타임스탬프입니다.

RFC3339 UTC 'Zulu' 형식의 타임스탬프입니다(나노초 단위, 소수점 이하 9자리). 예를 들면 "2014-10-02T15:01:23Z" 및 "2014-10-02T15:01:23.045123456Z"입니다.

state enum (State)

출력 전용입니다. Chunk의 현재 상태입니다.

ChunkData

Chunk 콘텐츠를 나타내는 추출된 데이터

JSON 표현 
{

  // Union field data can be only one of the following:
  "stringValue": string
  // End of list of possible types for union field data.
}
입력란

통합 필드 data.

data는 다음 중 하나여야 합니다.

stringValue string

문자열 형식의 Chunk 콘텐츠 청크당 최대 토큰 수는 2,043개입니다.

주

Chunk의 수명 주기 상태입니다.

열거형
STATE_UNSPECIFIED 기본값입니다. 상태가 생략된 경우 이 값이 사용됩니다.
STATE_PENDING_PROCESSING Chunk을(를) 처리하는 중입니다(임베딩 및 벡터 저장소).
STATE_ACTIVE Chunk가 처리되어 쿼리에 사용할 수 있습니다.
STATE_FAILED Chunk을(를) 처리하지 못했습니다.

메서드: corpora.documents.chunks.create

Chunk를 만듭니다.

엔드포인트

<ph type="x-smartling-placeholder"></ph> 게시물 https://generativelanguage.googleapis.com/v1beta/{parent=corpora/*/documents/*}/chunks

경로 매개변수

parent string

필수 항목입니다. 이 Chunk가 생성될 Document의 이름입니다. 예: corpora/my-corpus-123/documents/the-doc-abc corpora/{corpora}/documents/{document} 형식을 취합니다.

요청 본문

요청 본문에 Chunk의 인스턴스가 포함됩니다.

응답 본문

성공한 경우 응답 본문에 새로 생성된 Chunk의 인스턴스가 포함됩니다.

메서드: corpora.documents.chunks.list

Document의 모든 Chunk를 나열합니다.

엔드포인트

<ph type="x-smartling-placeholder"></ph> 받기 https://generativelanguage.googleapis.com/v1beta/{parent=corpora/*/documents/*}/chunks

경로 매개변수

parent string

필수 항목입니다. Chunk가 포함된 Document의 이름입니다. 예: corpora/my-corpus-123/documents/the-doc-abc corpora/{corpora}/documents/{document} 형식을 취합니다.

쿼리 매개변수

pageSize integer

선택사항. 반환할 최대 Chunk 수입니다 (페이지당). 서비스가 더 적은 Chunk를 반환할 수 있습니다.

지정하지 않으면 최대 10개의 Chunk가 반환됩니다. 최대 크기 제한은 페이지당 Chunk 100개입니다.

pageToken string

선택사항. 이전 chunks.list 호출에서 받은 페이지 토큰입니다.

응답에서 반환된 nextPageToken를 다음 요청의 인수로 제공하여 다음 페이지를 검색합니다.

페이지를 매길 때 chunks.list에 제공된 다른 모든 매개변수는 페이지 토큰을 제공한 호출과 일치해야 합니다.

요청 본문

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

응답 본문

페이지로 나눈 Chunk 목록을 포함하는 chunks.list의 응답입니다. Chunk는 chunk.create_time 오름차순으로 정렬됩니다.

성공할 경우 응답 본문에 다음 구조의 데이터가 포함됩니다.

입력란
chunks[] object (Chunk)

반환된 Chunk입니다.

nextPageToken string

다음 페이지를 검색하기 위해 pageToken으로 전송할 수 있는 토큰입니다. 이 필드를 생략하면 더 이상 페이지가 표시되지 않습니다.

JSON 표현 
{
  "chunks": [
    {
      object (Chunk)
    }
  ],
  "nextPageToken": string
}

메서드: corpora.documents.chunks.get

특정 Chunk에 관한 정보를 가져옵니다.

엔드포인트

<ph type="x-smartling-placeholder"></ph> 받기 https://generativelanguage.googleapis.com/v1beta/{name=corpora/*/documents/*/chunks/*}

경로 매개변수

name string

필수 항목입니다. 검색할 Chunk의 이름입니다. 예: corpora/my-corpus-123/documents/the-doc-abc/chunks/some-chunk corpora/{corpora}/documents/{document}/chunks/{chunk} 형식을 취합니다.

요청 본문

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

응답 본문

성공한 경우 응답 본문에 Chunk의 인스턴스가 포함됩니다.

메서드: corpora.documents.chunks.patch

Chunk를 업데이트합니다.

엔드포인트

<ph type="x-smartling-placeholder"></ph> 패치 https://generativelanguage.googleapis.com/v1beta/{chunk.name=corpora/*/documents/*/chunks/*}

PATCH https://generativelanguage.googleapis.com/v1beta/{chunk.name=corpora/*/documents/*/chunks/*}

경로 매개변수

chunk.name string

변경할 수 없습니다. 식별자. Chunk 리소스 이름입니다. ID('corpora/*/documents/*/chunks/' 프리픽스를 제외한 이름)에는 소문자 영숫자 또는 대시(-)로 구성된 최대 40자(영문 기준)를 포함할 수 있습니다. ID는 대시로 시작하거나 끝날 수 없습니다. 생성 시 이름이 비어 있으면 임의의 12자리 고유 ID가 생성됩니다. 예: corpora/{corpus_id}/documents/{document_id}/chunks/123a456b789c corpora/{corpora}/documents/{document}/chunks/{chunk} 형식을 취합니다.

쿼리 매개변수

updateMask string (FieldMask format)

필수 항목입니다. 업데이트할 필드의 목록입니다. 현재는 customMetadata 및 data 업데이트만 지원됩니다.

정규화된 필드 이름의 쉼표로 구분된 목록입니다. 예: "user.displayName,photo"

요청 본문

요청 본문에 Chunk의 인스턴스가 포함됩니다.

응답 본문

성공한 경우 응답 본문에 Chunk의 인스턴스가 포함됩니다.

메서드: corpora.documents.chunks.delete

Chunk를 삭제합니다.

엔드포인트

<ph type="x-smartling-placeholder"></ph> 삭제 https://generativelanguage.googleapis.com/v1beta/{name=corpora/*/documents/*/chunks/*}

경로 매개변수

name string

필수 항목입니다. 삭제할 Chunk의 리소스 이름입니다. 예: corpora/my-corpus-123/documents/the-doc-abc/chunks/some-chunk corpora/{corpora}/documents/{document}/chunks/{chunk} 형식을 취합니다.

요청 본문

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

응답 본문

성공한 경우 응답 본문은 비어 있습니다.

메서드: corpora.documents.chunks.batchCreate

Chunk 일괄 생성

엔드포인트

<ph type="x-smartling-placeholder"></ph> 게시물 https://generativelanguage.googleapis.com/v1beta/{parent=corpora/*/documents/*}/chunks:batchCreate

경로 매개변수

parent string

선택사항. 이 Chunk 배치가 생성될 Document의 이름입니다. 모든 CreateChunkRequest의 상위 필드는 이 값과 일치해야 합니다. 예: corpora/my-corpus-123/documents/the-doc-abc corpora/{corpora}/documents/{document} 형식을 취합니다.

요청 본문

요청 본문에는 다음과 같은 구조의 데이터가 포함됩니다.

<ph type="x-smartling-placeholder">
</ph> 입력란
requests[] object (CreateChunkRequest)

필수 항목입니다. 생성할 Chunk를 지정하는 요청 메시지입니다. 배치당 최대 100개의 Chunk를 만들 수 있습니다.

응답 본문

생성된 Chunk 목록이 포함된 chunks.batchCreate의 응답입니다.

성공할 경우 응답 본문에 다음 구조의 데이터가 포함됩니다.

입력란
chunks[] object (Chunk)

Chunk이(가) 생성되었습니다.

JSON 표현 
{
  "chunks": [
    {
      object (Chunk)
    }
  ]
}

CreateChunkRequest

Chunk 생성 요청입니다.

JSON 표현 
{
  "parent": string,
  "chunk": {
    object (Chunk)
  }
}
입력란
parent string

필수 항목입니다. 이 Chunk가 생성될 Document의 이름입니다. 예: corpora/my-corpus-123/documents/the-doc-abc

chunk object (Chunk)

필수 항목입니다. 만들 Chunk입니다.

메서드: corpora.documents.chunks.batchUpdate

Chunk 일괄 업데이트

엔드포인트

<ph type="x-smartling-placeholder"></ph> 게시물 https://generativelanguage.googleapis.com/v1beta/{parent=corpora/*/documents/*}/chunks:batchUpdate

경로 매개변수

parent string

선택사항. 업데이트할 Chunk가 포함된 Document의 이름입니다. 모든 UpdateChunkRequest의 상위 필드는 이 값과 일치해야 합니다. 예: corpora/my-corpus-123/documents/the-doc-abc corpora/{corpora}/documents/{document} 형식을 취합니다.

요청 본문

요청 본문에는 다음과 같은 구조의 데이터가 포함됩니다.

<ph type="x-smartling-placeholder">
</ph> 입력란
requests[] object (UpdateChunkRequest)

필수 항목입니다. 업데이트할 Chunk를 지정하는 요청 메시지입니다. 한 번에 최대 100개의 Chunk를 업데이트할 수 있습니다.

응답 본문

업데이트된 Chunk 목록이 포함된 chunks.batchUpdate의 응답

성공할 경우 응답 본문에 다음 구조의 데이터가 포함됩니다.

입력란
chunks[] object (Chunk)

Chunk이(가) 업데이트되었습니다.

JSON 표현 
{
  "chunks": [
    {
      object (Chunk)
    }
  ]
}

UpdateChunkRequest

Chunk 업데이트 요청입니다.

JSON 표현 
{
  "chunk": {
    object (Chunk)
  },
  "updateMask": string
}
입력란
chunk object (Chunk)

필수 항목입니다. 업데이트할 Chunk입니다.

updateMask string (FieldMask format)

필수 항목입니다. 업데이트할 필드의 목록입니다. 현재는 customMetadata 및 data 업데이트만 지원됩니다.

정규화된 필드 이름의 쉼표로 구분된 목록입니다. 예: "user.displayName,photo"

메서드: corpora.documents.chunks.batchDelete

Chunk 일괄 삭제

엔드포인트

<ph type="x-smartling-placeholder"></ph> 게시물 https://generativelanguage.googleapis.com/v1beta/{parent=corpora/*/documents/*}/chunks:batchDelete

경로 매개변수

parent string

선택사항. 삭제할 Chunk가 포함된 Document의 이름입니다. 모든 DeleteChunkRequest의 상위 필드는 이 값과 일치해야 합니다. 예: corpora/my-corpus-123/documents/the-doc-abc corpora/{corpora}/documents/{document} 형식을 취합니다.

요청 본문

요청 본문에는 다음과 같은 구조의 데이터가 포함됩니다.

<ph type="x-smartling-placeholder">
</ph> 입력란
requests[] object (DeleteChunkRequest)

필수 항목입니다. 삭제할 Chunk를 지정하는 요청 메시지입니다.

응답 본문

성공한 경우 응답 본문은 비어 있습니다.

DeleteChunkRequest

Chunk 삭제 요청입니다.

JSON 표현 
{
  "name": string
}
입력란
name string

필수 항목입니다. 삭제할 Chunk의 리소스 이름입니다. 예: corpora/my-corpus-123/documents/the-doc-abc/chunks/some-chunk