Documents

파일 검색 API는 원시 소스 파일 또는 문서를 임시 파일 객체로 참조합니다.

메서드: fileSearchStores.documents.delete

Document를 삭제합니다.

엔드포인트

delete https://generativelanguage.googleapis.com/v1beta/{name=fileSearchStores/*/documents/*}

경로 매개변수

name string

필수 항목입니다. 삭제할 Document의 리소스 이름입니다. 예: fileSearchStores/my-file-search-store-123/documents/the-doc-abc fileSearchStores/{filesearchstore}/documents/{document} 형식이 사용됩니다.

쿼리 매개변수

force boolean

선택사항입니다. true로 설정하면 이 Document와 관련된 모든 Chunk 및 객체도 삭제됩니다.

false (기본값)인 경우 Document에 Chunk가 포함되어 있으면 FAILED_PRECONDITION 오류가 반환됩니다.

요청 본문

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

응답 본문

성공하면 응답 본문은 빈 JSON 객체입니다.

메서드: fileSearchStores.documents.get

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

엔드포인트

get https://generativelanguage.googleapis.com/v1beta/{name=fileSearchStores/*/documents/*}

경로 매개변수

name string

필수 항목입니다. 가져올 Document의 이름입니다. 예: fileSearchStores/my-file-search-store-123/documents/the-doc-abc fileSearchStores/{filesearchstore}/documents/{document} 형식이 사용됩니다.

요청 본문

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

응답 본문

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

메서드: fileSearchStores.documents.list

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

엔드포인트

get https://generativelanguage.googleapis.com/v1beta/{parent=fileSearchStores/*}/documents

경로 매개변수

parent string

필수 항목입니다. Document이 포함된 FileSearchStore의 이름입니다. 예: fileSearchStores/my-file-search-store-123 fileSearchStores/{filesearchstore} 형식이 사용됩니다.

쿼리 매개변수

pageSize integer

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

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

pageToken string

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

다음 페이지를 가져오기 위한 다음 요청의 인수로 응답에서 반환된 nextPageToken을 제공합니다.

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

요청 본문

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

응답 본문

Document의 페이지로 나누어진 목록이 포함된 documents.list의 응답입니다. Document은 오름차순 document.create_time로 정렬됩니다.

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

필드
documents[] object (Document)

반환된 Document입니다.

nextPageToken string

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

JSON 표현 
{
  "documents": [
    {
      object (Document)
    }
  ],
  "nextPageToken": string
}

메서드: fileSearchStores.documents.query

Document에 대해 시맨틱 검색을 실행합니다.

엔드포인트

post https://generativelanguage.googleapis.com/v1beta/{name=fileSearchStores/*/documents/*}:query

경로 매개변수

name string

필수 항목입니다. 쿼리할 Document의 이름입니다. 예: fileSearchStores/my-file-search-store-123/documents/the-doc-abc fileSearchStores/{filesearchstore}/documents/{document} 형식이 사용됩니다.

요청 본문

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

필드
query string

필수 항목입니다. 시맨틱 검색을 실행할 쿼리 문자열입니다.

resultsCount integer

선택사항입니다. 반환할 최대 Chunk 수입니다. 서비스에서 Chunk를 더 적게 반환할 수 있습니다.

지정하지 않으면 최대 10개의 Chunk가 반환됩니다. 지정된 최대 결과 수는 100입니다.

metadataFilters[] object (MetadataFilter)

선택사항입니다. Chunk 메타데이터 필터 각 MetadataFilter 객체는 고유한 키에 상응해야 합니다. 여러 MetadataFilter 객체는 논리적 'AND'로 결합됩니다.

참고: Document 이름이 이미 지정되어 있으므로 이 요청에는 Document 수준 필터링이 지원되지 않습니다.

예시 쿼리: (year >= 2020 OR year < 2010) AND (genre = drama OR genre = action)

MetadataFilter object list: metadataFilters = [ {key = "chunk.custom_metadata.year" conditions = [{int_value = 2020, operation = GREATER_EQUAL}, {int_value = 2010, operation = LESS}}, {key = "chunk.custom_metadata.genre" conditions = [{stringValue = "drama", operation = EQUAL}, {stringValue = "action", operation = EQUAL}}]

숫자 값 범위의 예시 쿼리: (year > 2015 AND year <= 2020)

MetadataFilter object list: metadataFilters = [ {key = "chunk.custom_metadata.year" conditions = [{int_value = 2015, operation = GREATER}]}, {key = "chunk.custom_metadata.year" conditions = [{int_value = 2020, operation = LESS_EQUAL}]}]

참고: 동일한 키의 'AND'는 숫자 값에만 지원됩니다. 문자열 값은 동일한 키에 대한 'OR'만 지원합니다.

응답 본문

관련 청크 목록이 포함된 documents.query의 응답입니다.

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

필드
relevantChunks[] object (RelevantChunk)

반환된 관련 청크입니다.

JSON 표현 
{
  "relevantChunks": [
    {
      object (RelevantChunk)
    }
  ]
}

REST 리소스: fileSearchStores.documents

리소스: Document

Document은 Chunk의 모음입니다.

필드
name string

변경할 수 없습니다. 식별자. Document 리소스 이름입니다. ID (이름에서 'fileSearchStores/*/documents/' 접두사 제외)에는 소문자 영숫자 또는 대시 (-)로 구성된 최대 40자가 포함될 수 있습니다. ID는 대시로 시작하거나 끝날 수 없습니다. 생성 시 이름이 비어 있으면 12자리 무작위 서픽스와 함께 displayName에서 고유한 이름이 파생됩니다. 예: fileSearchStores/{file_search_store_id}/documents/my-awesome-doc-123a456b789c

displayName string

선택사항입니다. Document의 사람이 읽을 수 있는 표시 이름입니다. 표시 이름은 공백을 포함하여 512자(영문 기준) 이하여야 합니다. 예: 'Semantic Retriever Documentation'

customMetadata[] object (CustomMetadata)

선택사항입니다. 쿼리에 사용되는 키-값 쌍으로 저장된 사용자 제공 맞춤 메타데이터입니다. Document에는 최대 20개의 CustomMetadata이 있을 수 있습니다.

updateTime string (Timestamp format)

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

생성된 출력은 항상 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"입니다.

createTime string (Timestamp format)

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

생성된 출력은 항상 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"입니다.

state enum (State)

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

sizeBytes string (int64 format)

출력 전용입니다. 문서에 삽입된 원시 바이트의 크기입니다.

mimeType string

출력 전용입니다. 문서의 MIME 유형입니다.

JSON 표현 
{
  "name": string,
  "displayName": string,
  "customMetadata": [
    {
      object (CustomMetadata)
    }
  ],
  "updateTime": string,
  "createTime": string,
  "state": enum (State),
  "sizeBytes": string,
  "mimeType": string
}

주

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

열거형
STATE_UNSPECIFIED 기본값입니다. 이 값은 상태가 생략된 경우에 사용됩니다.
STATE_PENDING Document의 일부 Chunks가 처리되고 있습니다 (임베딩 및 벡터 저장).
STATE_ACTIVE Document의 모든 Chunks가 처리되어 쿼리할 수 있습니다.
STATE_FAILED Document 중 일부 Chunks를 처리하지 못했습니다.