Method: projects.locations.groundingConfigs.check

그라운딩 확인을 실행합니다.

HTTP 요청

POST https://discoveryengine.googleapis.com/v1beta/{groundingConfig=projects/*/locations/*/groundingConfigs/*}:check

URL은 gRPC 트랜스코딩 문법을 사용합니다.

경로 매개변수

매개변수
groundingConfig

string

필수 항목입니다. 그라운딩 구성의 리소스 이름입니다(예: projects/*/locations/global/groundingConfigs/default_grounding_config).

요청 본문

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

JSON 표현 
{
  "answerCandidate": string,
  "facts": [
    {
      object (GroundingFact)
    }
  ],
  "groundingSpec": {
    object (CheckGroundingSpec)
  },
  "userLabels": {
    string: string,
    ...
  }
}
필드
answerCandidate

string

확인할 답변 후보입니다. 최대 길이는 4096개 토큰입니다.
facts[]

object (GroundingFact)

그라운딩 확인을 위한 사실 목록입니다. 최대 200개의 사실을 지원합니다.
groundingSpec

object (CheckGroundingSpec)

그라운딩 확인 구성입니다.
userLabels

map (key: string, value: string)

리소스에 적용된 사용자 라벨은 다음 요구사항을 충족해야 합니다.

  • 각 리소스는 여러 개의 라벨(최대 64개)을 가질 수 있습니다.
  • 각 라벨은 키-값 쌍이어야 합니다.
  • 키는 비워 둘 수 없으며 최소 길이는 1자이고 최대 길이는 63자입니다. 값은 비워 둘 수 있으며 최대 길이는 63자(영문 기준)입니다.
  • 키와 값에는 소문자, 숫자, 밑줄, 대시만 사용할 수 있습니다. 모든 문자는 UTF-8 인코딩을 사용해야 하며 국제 문자가 허용됩니다.
  • 라벨의 키 부분은 고유해야 합니다. 그러나 여러 리소스에 동일한 키를 사용할 수 있습니다.
  • 키는 소문자나 국제 문자로 시작해야 합니다.

자세한 내용은 Google Cloud 문서를 참고하세요.

응답 본문

GroundedGenerationService.CheckGrounding 메서드에 대한 응답 메시지입니다.

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

JSON 표현 
{
  "citedChunks": [
    {
      object (FactChunk)
    }
  ],
  "citedFacts": [
    {
      object (CheckGroundingFactChunk)
    }
  ],
  "claims": [
    {
      object (Claim)
    }
  ],
  "supportScore": number
}
필드
citedChunks[]

object (FactChunk)

답변 후보의 모든 주장에서 인용된 사실 목록입니다. 이는 요청에 제공된 사실에서 파생됩니다.
citedFacts[]

object (CheckGroundingFactChunk)

답변 후보의 모든 주장에서 인용된 사실 목록입니다. 이는 요청에 제공된 사실에서 파생됩니다.
claims[]

object (Claim)

대답 후보의 모든 주장에 걸친 주장 텍스트 및 인용 정보
supportScore

number

입력 답변 후보의 지원 점수입니다. 점수가 높을수록 제공된 사실에 의해 뒷받침되는 클레임의 비율이 높습니다. 이 값은 응답이 반환될 때 항상 설정됩니다.

승인 범위

다음 OAuth 범위 중 하나가 필요합니다.

  • https://www.googleapis.com/auth/cloud-platform
  • https://www.googleapis.com/auth/discoveryengine.readwrite

자세한 내용은 Authentication Overview를 참조하세요.

IAM 권한

groundingConfig 리소스에 대해서는 다음 IAM 권한이 필요합니다.

  • discoveryengine.groundingConfigs.check

자세한 내용은 IAM 문서를 참조하세요.

GroundingFact

그라운딩 사실

JSON 표현 
{
  "factText": string,
  "attributes": {
    string: string,
    ...
  }
}
필드
factText

string

사실의 텍스트 콘텐츠입니다. 최대 10,000자(영문 기준)까지 가능합니다.
attributes

map (key: string, value: string)

사실과 연결된 속성입니다. 일반적인 속성에는 source (사실의 출처를 나타냄), author (사실의 작성자를 나타냄) 등이 있습니다.

CheckGroundingSpec

그라운딩 확인 사양입니다.

JSON 표현 
{
  "citationThreshold": number,
  "enableClaimLevelScore": boolean
}
필드
citationThreshold

number

답변 후보에서 클레임에 대해 팩트를 인용해야 하는지 여부를 결정하는 데 사용되는 임곗값([0,1])입니다. 기준점을 높게 선택하면 인용 횟수는 적지만 매우 강력한 인용이 발생하고, 기준점을 낮게 선택하면 인용 횟수는 많지만 다소 약한 인용이 발생할 수 있습니다. 설정하지 않으면 기준점이 기본적으로 0.6으로 설정됩니다.
enableClaimLevelScore

boolean

대답에서 클레임 수준 그라운딩 점수를 사용 설정하는 제어 플래그입니다.

FactChunk

사실 청크입니다.

JSON 표현 
{
  "chunkText": string,
  "source": string,
  "index": integer,
  "sourceMetadata": {
    string: string,
    ...
  },
  "uri": string,
  "title": string,
  "domain": string
}
필드
chunkText

string

사실 청크의 텍스트 콘텐츠입니다. 최대 10,000자(영문 기준)까지 가능합니다.
source

string

이 사실 청크가 검색된 소스입니다. 요청에 제공된 GroundingFacts에서 가져온 경우 이 필드에는 이 청크가 가져온 특정 사실의 색인이 포함됩니다.
index

integer

이 청크의 색인입니다. 현재 스트리밍 모드에만 사용됩니다.
sourceMetadata

map (key: string, value: string)

소스 참조에 대한 더 세부적인 정보입니다.
uri

string

소스의 URI입니다.
title

string

소스의 제목입니다.
domain

string

소스의 도메인입니다.

CheckGroundingFactChunk

그라운딩 확인을 위한 사실 청크입니다.

JSON 표현 
{
  "chunkText": string
}
필드
chunkText

string

사실 청크의 텍스트 콘텐츠입니다. 최대 10,000자(영문 기준)까지 가능합니다.

클레임

답변 후보의 주장에 대한 텍스트 및 인용 정보입니다.

JSON 표현 
{
  "claimText": string,
  "citationIndices": [
    integer
  ],
  "startPos": integer,
  "endPos": integer,
  "groundingCheckRequired": boolean,
  "score": number
}
필드
claimText

string

답변 후보의 주장에 대한 텍스트입니다. 인용 또는 반대 인용이 발견되었는지 여부와 관계없이 항상 제공됩니다.
citationIndices[]

integer

주장과 관련된 인용을 지정하는 색인 목록입니다('citedChunks'). 예를 들어 [1,3,4] 는 인용된 청크[1], 인용된 청크[3], 인용된 청크[4] 가 클레임을 뒷받침하는 인용된 사실임을 의미합니다. 사실에 대한 인용은 주장이 사실에 의해 뒷받침됨을 나타냅니다.
startPos

integer

답변 후보에서 클레임이 시작되는 위치입니다(바이트 단위). 이는 문자 수로 측정되지 않으므로 일부 문자는 1바이트 이상을 차지할 수 있다는 점을 염두에 두고 사용자 인터페이스에 렌더링해야 합니다. 예를 들어 클레임 텍스트에 비ASCII 문자가 포함된 경우 문자 (프로그래밍 언어에 따라 다름)로 측정할 때와 바이트 (프로그래밍 언어에 관계없음)로 측정할 때 시작 및 종료 위치가 달라집니다.
endPos

integer

답변 후보에서 클레임의 끝을 나타내는 위치입니다(바이트 단위, 제외). 이는 문자로 측정되지 않으므로 문자로 렌더링해야 합니다. 예를 들어 클레임 텍스트에 비ASCII 문자가 포함된 경우 문자 (프로그래밍 언어에 따라 다름)로 측정할 때와 바이트 (프로그래밍 언어에 관계없음)로 측정할 때 시작 및 종료 위치가 달라집니다.
groundingCheckRequired

boolean

이 클레임에 그라운딩 검사가 필요했음을 나타냅니다. 시스템에서 이 주장에 출처 표시/그라운딩 확인이 필요하지 않다고 판단한 경우 이 필드는 false로 설정됩니다. 이 경우 클레임에 대한 그라운딩 검사가 실행되지 않았으므로 citationIndices이 반환되지 않아야 합니다.
score

number

답변 후보의 주장에 대한 신뢰도 점수입니다. 범위는 [0, 1]입니다. CheckGroundingRequest.grounding_spec.enable_claim_level_score이 true인 경우에만 설정됩니다.