Corpora

메서드: corpora.create

빈 Corpus를 만듭니다.

엔드포인트

게시 https://generativelanguage.googleapis.com/v1beta/corpora

요청 본문

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

필드
name string

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

displayName string

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

응답 본문

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

메서드: corpora.query

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

엔드포인트

게시 https://generativelanguage.googleapis.com/v1beta/{name=corpora/*}:query

경로 매개변수

name string

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

요청 본문

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

필드
query string

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

metadataFilters[] object (MetadataFilter)

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

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

MetadataFilter 객체 목록: metadataFilters = [ {key = "document.custom_metadata.year" conditions = [{int_value = 2020, operation = GREATER_EQUAL}, {int_value = 2010, operation = LESS}]}, {key = "document.custom_metadata.year" conditions = [{int_value = 2020, operation = GREATER_EQUAL}, {int_value = 2010, operation = LESS}]}, {key = "document.custom_metadata.genre" conditions = [{stringValue = "drama", operation = EQUAL}, {stringValue = "action", operation = EQUAL}]}]

숫자 범위 값에 관한 청크 수준 쿼리 예: (연도 > 2015 AND 연도 <= 2020)

MetadataFilter 객체 목록: 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'만 지원합니다.

resultsCount integer

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

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

응답 본문

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

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

필드
relevantChunks[] object (RelevantChunk)

관련 청크

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

메서드: corpora.list

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

엔드포인트

get https://generativelanguage.googleapis.com/v1beta/corpora

쿼리 매개변수

pageSize integer

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

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

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.get

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

엔드포인트

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

경로 매개변수

name string

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

요청 본문

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

응답 본문

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

메서드: corpora.patch

Corpus를 업데이트합니다.

엔드포인트

패치 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는 대시로 시작하거나 끝나면 안 됩니다. 만들 때 이름이 비어 있으면 displayName에서 12자 길이의 임의의 접미사와 함께 고유한 이름이 파생됩니다. 예: corpora/my-awesome-corpora-123a456b789c corpora/{corpora} 형식입니다.

쿼리 매개변수

updateMask string (FieldMask format)

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

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

요청 본문

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

필드
displayName string

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

응답 본문

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

메서드: corpora.delete

Corpus를 삭제합니다.

엔드포인트

삭제 https://generativelanguage.googleapis.com/v1beta/{name=corpora/*}

경로 매개변수

name string

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

쿼리 매개변수

force boolean

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

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

요청 본문

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

응답 본문

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

REST 리소스: corpora.permissions

리소스: 권한

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

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

세 가지 역할이 동심원으로 표시됩니다. 각 역할은 이전 역할의 허용된 작업의 상위 집합입니다.

  • 리더가 추론에 리소스 (예: 조정된 모델, 자료)를 사용할 수 있음
  • 작성자가 읽기 권한을 보유하고 있으며 추가로 수정 및 공유할 수 있습니다.
  • 소유자가 작성자 권한을 보유하고 있으며 추가로 삭제할 수 있음
필드
name string

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

granteeType enum (GranteeType)

선택사항입니다. 변경할 수 없습니다. 수여 대상자의 유형입니다.

emailAddress string

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

role enum (Role)

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

JSON 표현 
{
  "name": string,
  "granteeType": enum (GranteeType),
  "emailAddress": string,
  "role": enum (Role)
}

GranteeType

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

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

역할

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

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

MetadataFilter

사용자가 제공한 필터로 Chunk 또는 Document 수준 메타데이터 값을 기반으로 검색을 제한합니다. 예 (genre = drama OR genre = action): key = "document.custom_metadata.genre" conditions = [{stringValue = "drama", operation = EQUAL}, {stringValue = "action", operation = EQUAL}]

필드
key string

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

conditions[] object (Condition)

필수 항목입니다. 이 필터를 트리거하는 지정된 키의 Condition입니다. 여러 개의 Condition는 논리적 OR로 결합됩니다.

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

조건

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

필드
operation enum (Operator)

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

value Union type
값 유형은 해당 키의 필드에 정의된 값 유형과 일치해야 합니다. 값 유형이 일치하지 않으면 결과는 빈 집합입니다. CustomMetadata에 StringList 값 유형이 있는 경우 필터링 조건은 INCLUDES/EXCLUDES 연산자와 함께 string_value를 사용해야 합니다. 그러지 않으면 결과도 빈 집합이 됩니다. value은 다음 중 하나여야 합니다.
stringValue string

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

numericValue number

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

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

  // value
  "stringValue": string,
  "numericValue": number
  // Union type
}

연산자

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

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

RelevantChunk

쿼리와 관련된 청크의 정보입니다.

필드
chunkRelevanceScore number

Chunk 검색어와의 관련성

chunk object (Chunk)

쿼리와 연결된 Chunk입니다.

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

REST 리소스: corpora

리소스: 텍스트 corpus

Corpus는 Document의 모음입니다. 한 프로젝트에서 최대 5개의 자료 집합을 만들 수 있습니다.

필드
name string

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

displayName string

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

createTime string (Timestamp format)

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

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

updateTime string (Timestamp format)

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

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

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