Docuents

REST 리소스: corpora.documents

리소스: Document

Document는 Chunk의 모음입니다. Corpus에는 최대 10,000개의 Document가 포함될 수 있습니다.

JSON 표현 
{
  "name": string,
  "displayName": string,
  "customMetadata": [
    {
      object (CustomMetadata)
    }
  ],
  "updateTime": string,
  "createTime": string
}
입력란
name string

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

displayName string

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

customMetadata[] object (CustomMetadata)

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

updateTime string (Timestamp format)

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

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

createTime string (Timestamp format)

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

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

메서드: corpora.documents.create

빈 Document를 만듭니다.

엔드포인트

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

경로 매개변수

parent string

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

요청 본문

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

응답 본문

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

메서드: corpora.documents.list

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

엔드포인트

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

경로 매개변수

parent string

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

쿼리 매개변수

pageSize integer

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

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

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
}

메서드: corpora.documents.query

Document를 통해 시맨틱 검색을 실행합니다.

엔드포인트

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

경로 매개변수

name string

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

요청 본문

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

<ph type="x-smartling-placeholder">
</ph> 입력란
query string

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

resultsCount integer

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

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

metadataFilters[] object (MetadataFilter)

선택사항. Chunk 메타데이터로 필터링합니다. 각 MetadataFilter 객체는 고유 키에 해당해야 합니다. 여러 MetadataFilter 객체는 논리적 'AND'로 조인됩니다.

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

검색어 예: (2020년 OR < 2010년) AND (장르 = 드라마 OR 장르 = 액션)

MetadataFilter 객체 목록: metadataFilters = [ {key = "chunk.custom_metadata.year" 조건 = [{int_value = 2020, 작업 = GREATER_EQUAL}, {int_value = 2010, operations = LESS}}, {key = "chunk.custom_metadata.genre" 조건 = [{stringValue = "drama", 작업 = EQUAL}, {stringValue = "action", 작업 = EQUAL}}]

숫자 범위에 대한 쿼리 예: (연도 > 2015 AND 연도 <= 2020)

MetadataFilter 객체 목록: metadataFilters = [ {key = "chunk.custom_metadata.year" conditions = [{int_value = 2015, operation = GREATER}]}, {key = &quot;chunk.custom_metadata.year&quot; 조건 = [{int_value = 2020, 작업 = LESS_EQUAL}]}]

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

응답 본문

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

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

입력란
relevantChunks[] object (RelevantChunk)

반환된 관련 청크입니다.

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

메서드: corpora.documents.get

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

엔드포인트

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

경로 매개변수

name string

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

요청 본문

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

응답 본문

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

메서드: corpora.documents.patch

Document를 업데이트합니다.

엔드포인트

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

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

경로 매개변수

document.name string

변경할 수 없습니다. 식별자. Document 리소스 이름입니다. ID('corpora/*/documents/' 접두사를 제외한 이름)에는 소문자 영숫자 또는 대시(-)로 구성된 최대 40자(영문 기준)를 포함할 수 있습니다. ID는 대시로 시작하거나 끝날 수 없습니다. 생성 시 이름이 비어 있으면 고유한 이름이 12자리 임의 접미사와 함께 displayName에서 파생됩니다. 예: corpora/{corpus_id}/documents/my-awesome-doc-123a456b789c corpora/{corpora}/documents/{document} 형식을 취합니다.

쿼리 매개변수

updateMask string (FieldMask format)

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

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

요청 본문

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

응답 본문

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

메서드: corpora.documents.delete

Document를 삭제합니다.

엔드포인트

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

경로 매개변수

name string

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

쿼리 매개변수

force boolean

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

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

요청 본문

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

응답 본문

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

CustomMetadata

키-값 쌍으로 저장된 사용자 제공 메타데이터입니다.

JSON 표현 
{
  "key": string,

  // Union field value can be only one of the following:
  "stringValue": string,
  "stringListValue": {
    object (StringList)
  },
  "numericValue": number
  // End of list of possible types for union field value.
}
입력란
key string

필수 항목입니다. 저장할 메타데이터의 키입니다.

통합 필드 value.

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

stringValue string

저장할 메타데이터의 문자열 값입니다.

stringListValue object (StringList)

저장할 메타데이터의 StringList 값입니다.

numericValue number

저장할 메타데이터의 숫자 값입니다.

StringList

단일 메타데이터 키에 할당된 사용자 제공 문자열 값입니다.

JSON 표현 
{
  "values": [
    string
  ]
}
입력란
values[] string

저장할 메타데이터의 문자열 값입니다.