Corpora

REST 리소스: corpora

리소스: Corpus

Corpus는 Document의 모음입니다. 한 프로젝트에서 최대 5개의 코퍼스를 만들 수 있습니다.

JSON 표현 
{
  "name": string,
  "displayName": string,
  "createTime": string,
  "updateTime": string
}
입력란
name string

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

displayName string

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

createTime string (Timestamp format)

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

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

updateTime string (Timestamp format)

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

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

메서드: corpora.create

빈 Corpus를 만듭니다.

엔드포인트

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

요청 본문

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

응답 본문

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

메서드: corpora.list

사용자가 소유한 모든 Corpora를 나열합니다.

엔드포인트

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

쿼리 매개변수

pageSize integer

선택사항. 페이지당 반환할 최대 Corpora 수입니다. 서비스는 더 적은 수의 Corpora를 반환할 수 있습니다.

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

pageToken string

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

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

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

요청 본문

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

응답 본문

페이지로 나눈 Corpora 목록을 포함하는 corpora.list의 응답입니다. 결과는 corpus.create_time 오름차순으로 정렬됩니다.

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

입력란
corpora[] object (Corpus)

반환된 코퍼스입니다.

nextPageToken string

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

JSON 표현 
{
  "corpora": [
    {
      object (Corpus)
    }
  ],
  "nextPageToken": string
}

메서드: corpora.query

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

엔드포인트

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

경로 매개변수

name string

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

요청 본문

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

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

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

metadataFilters[] object (MetadataFilter)

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

문서 수준에서 쿼리 예: (연도 >= 2020 OR 연도 < 2010) AND (장르 = 드라마 OR 장르 = 액션)

MetadataFilter 객체 목록: metadataFilters = [ {key = "document.custom_metadata.year" 조건 = [{int_value = 2020, 작업 = GREATER_EQUAL}, {int_value = 2010, operations = LESS}]}, {key = "document.custom_metadata.year" 조건 = [{int_value = 2020, 작업 = GREATER_EQUAL}, {int_value = 2010, operations = LESS}]}, {key = "document.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'만 지원합니다.

resultsCount integer

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

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

응답 본문

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

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

입력란
relevantChunks[] object (RelevantChunk)

관련 청크

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

메서드: corpora.get

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

엔드포인트

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

경로 매개변수

name string

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

요청 본문

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

응답 본문

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

메서드: corpora.patch

Corpus를 업데이트합니다.

엔드포인트

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

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

경로 매개변수

corpus.name string

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

쿼리 매개변수

updateMask string (FieldMask format)

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

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

요청 본문

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

응답 본문

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

메서드: corpora.delete

Corpus를 삭제합니다.

엔드포인트

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

경로 매개변수

name string

필수 항목입니다. Corpus의 리소스 이름입니다. 예: corpora/my-corpus-123 corpora/{corpora} 형식을 취합니다.

쿼리 매개변수

force boolean

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

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

요청 본문

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

응답 본문

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

REST 리소스: corpora.permissions

리소스: Permission

권한 리소스는 사용자, 그룹 또는 기타 전 세계 사용자에게 PaLM API 리소스 (예: 조정된 모델, 코퍼스)에 대한 액세스 권한을 부여합니다.

역할은 사용자가 PaLM API 리소스에서 특정 작업을 수행할 수 있도록 허용하는 작업의 모음입니다. 사용자, 그룹 또는 서비스 계정에서 사용할 수 있도록 하려면 역할을 할당합니다. 역할을 할당하면 역할에 포함된 권한을 부여하게 됩니다.

세 가지 동심 역할이 있습니다. 각 역할은 이전 역할에서 허용하는 작업의 상위 집합입니다.

  • 리더가 추론에 리소스 (예: 조정된 모델, 코퍼스)를 사용할 수 있음
  • 작성자에게는 읽기 권한이 있으며 추가로 수정하고 공유할 수 있습니다.
  • 소유자는 작성자 권한을 가지며 추가 권한이 있는 경우 삭제할 수 있습니다.
JSON 표현 
{
  "name": string,
  "granteeType": enum (GranteeType),
  "emailAddress": string,
  "role": enum (Role)
}
입력란
name string

출력 전용입니다. 식별자. 권한 이름입니다. 생성 시 고유한 이름이 생성됩니다. 예: managedModels/{tunedModel}/permissions/{permission} corpora/{corpus}/permissions/{permission} 출력 전용입니다.

granteeType enum (GranteeType)

선택사항. 변경할 수 없습니다. 피부여자 유형입니다.

emailAddress string

선택사항. 변경할 수 없습니다. 이 권한이 참조하는 그룹 사용자의 이메일 주소입니다. 권한 부여자 유형이 EVERYONE인 경우 필드가 설정되지 않습니다.

role enum (Role)

필수 항목입니다. 이 권한이 부여하는 역할입니다.

GranteeType

이 권한의 피부여자 유형을 정의합니다.

열거형
GRANTEE_TYPE_UNSPECIFIED 기본값입니다. 이 값은 사용되지 않습니다.
USER 사용자를 나타냅니다. 설정하면 사용자의 emailAddress를 제공해야 합니다.
GROUP 그룹을 나타냅니다. 설정하면 그룹의 emailAddress를 제공해야 합니다.
EVERYONE 모든 사용자에 대한 액세스 권한을 나타냅니다. 추가 정보는 필요하지 않습니다.

역할

이 권한이 부여하는 역할을 정의합니다.

열거형
ROLE_UNSPECIFIED 기본값입니다. 이 값은 사용되지 않습니다.
OWNER 소유자는 리소스를 사용, 업데이트, 공유, 삭제할 수 있습니다.
WRITER 작성자가 리소스를 사용, 업데이트, 공유할 수 있습니다.
READER 리더가 리소스를 사용할 수 있습니다.

MetadataFilter

Chunk 또는 Document 수준의 메타데이터 값에 따라 검색을 제한하는 사용자 제공 필터입니다. 예 (장르 = 드라마 OR 장르 = 액션): 키 = 'document.custom_metadata.genre' 조건 = [{stringValue = "drama", 작업 = EQUAL}, {stringValue = "action", 작업 = EQUAL}]

JSON 표현 
{
  "key": string,
  "conditions": [
    {
      object (Condition)
    }
  ]
}
입력란
key string

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

conditions[] object (Condition)

필수 항목입니다. 이 필터를 트리거할 특정 키의 Condition입니다. 여러 개의 Condition가 논리 OR로 결합됩니다.

조건

단일 키에 적용할 수 있는 필터 조건입니다.

JSON 표현 
{
  "operation": enum (Operator),

  // Union field value can be only one of the following:
  "stringValue": string,
  "numericValue": number
  // End of list of possible types for union field value.
}
입력란
operation enum (Operator)

필수 항목입니다. 조건을 트리거하기 위해 지정된 키-값 쌍에 적용되는 연산자입니다.

통합 필드 value. 값 유형은 해당 키의 필드에 정의된 값 유형과 일치해야 합니다. 값 유형이 일관되지 않으면 결과는 빈 집합이 됩니다. CustomMetadata에 StringList 값 유형이 있으면 필터링 조건은 INCLUDES/EXCLUDES 연산과 쌍을 이루는 string_value를 사용해야 합니다. 그러지 않으면 결과도 빈 집합이 됩니다. value은 다음 중 하나여야 합니다.
stringValue string

메타데이터를 필터링할 문자열 값입니다.

numericValue number

메타데이터를 필터링할 숫자 값입니다.

연산자

키-값 쌍에 적용할 수 있는 유효한 연산자를 정의합니다.

열거형
OPERATOR_UNSPECIFIED 기본값입니다. 이 값은 사용되지 않습니다.
LESS 숫자로 지원됩니다.
LESS_EQUAL 숫자로 지원됩니다.
EQUAL 숫자 및 문자열.
GREATER_EQUAL 숫자로 지원됩니다.
GREATER 숫자로 지원됩니다.
NOT_EQUAL 숫자 & 문자열.
INCLUDES 지정된 키의 CustomMetadata 값 유형에 stringListValue이 있는 경우에만 문자열로 지원됩니다.
EXCLUDES 지정된 키의 CustomMetadata 값 유형에 stringListValue이 있는 경우에만 문자열로 지원됩니다.

RelevantChunk

검색어와 관련된 청크의 정보입니다.

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

검색어와의 Chunk 관련성

chunk object (Chunk)

쿼리와 연결된 Chunk입니다.