REST Resource: projects.locations.collections.dataStores.sessions.answers

리소스: Answer

답변을 정의합니다.

JSON 표현 
{
  "name": string,
  "state": enum (State),
  "answerText": string,
  "citations": [
    {
      object (Citation)
    }
  ],
  "groundingSupports": [
    {
      object (GroundingSupport)
    }
  ],
  "references": [
    {
      object (Reference)
    }
  ],
  "blobAttachments": [
    {
      object (BlobAttachment)
    }
  ],
  "relatedQuestions": [
    string
  ],
  "steps": [
    {
      object (Step)
    }
  ],
  "queryUnderstandingInfo": {
    object (QueryUnderstandingInfo)
  },
  "answerSkippedReasons": [
    enum (AnswerSkippedReason)
  ],
  "createTime": string,
  "completeTime": string,
  "safetyRatings": [
    {
      object (SafetyRating)
    }
  ],
  "groundingScore": number
}
필드
name

string

변경할 수 없습니다. 정규화된 이름 projects/{project}/locations/global/collections/{collection}/engines/{engine}/sessions/*/answers/*
state

enum (State)

답변 생성 상태입니다.
answerText

string

텍스트 답변입니다.
citations[]

object (Citation)

인용입니다.
groundingSupports[]

object (GroundingSupport)

(선택사항) 그라운딩 지원
references[]

object (Reference)

참고 문헌
blobAttachments[]

object (BlobAttachment)

답변의 blob 첨부파일 목록입니다.
relatedQuestions[]

string

추천 관련 질문
steps[]

object (Step)

대답 생성 단계입니다.
queryUnderstandingInfo

object (QueryUnderstandingInfo)

질문 이해 정보입니다.
answerSkippedReasons[]

enum (AnswerSkippedReason)

추가 답변 건너뜀 이유입니다. 무시된 케이스의 이유를 제공합니다. 건너뛴 항목이 없으면 이 필드가 설정되지 않습니다.
createTime

string (Timestamp format)

출력 전용입니다. 대답 생성 타임스탬프입니다.

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

string (Timestamp format)

출력 전용입니다. 답변 완료 타임스탬프입니다.

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

object (SafetyRating)

(선택사항) 안전 등급
groundingScore

number

참조 청크에 의해 답변이 그라운딩된 정도를 설명하는 [0, 1] 범위의 점수입니다.

주

대답 생성 상태의 열거형입니다.

열거형
STATE_UNSPECIFIED 알 수 없는 작업입니다.
IN_PROGRESS 현재 답변을 생성하는 중입니다.
FAILED 현재 답변 생성이 실패했습니다.
SUCCEEDED 답변 생성이 완료되었습니다.
STREAMING 현재 답변을 생성하는 중입니다.

인용

세그먼트의 인용 정보입니다.

JSON 표현 
{
  "startIndex": string,
  "endIndex": string,
  "sources": [
    {
      object (CitationSource)
    }
  ]
}
필드
startIndex

string (int64 format)

인덱스는 바이트 (UTF-8 유니코드)로 측정된 세그먼트의 시작을 나타냅니다. 비ASCII 문자 등 멀티바이트 문자가 있으면 색인 측정값이 문자열 길이보다 길어집니다.
endIndex

string (int64 format)

기여 분석된 세그먼트의 끝(해당 값 제외)입니다. 바이트 (UTF-8 유니코드) 단위로 측정됩니다. 비ASCII 문자 등 멀티바이트 문자가 있으면 색인 측정값이 문자열 길이보다 길어집니다.
sources[]

object (CitationSource)

기여도가 부여된 세그먼트의 인용 출처입니다.

CitationSource

인용 출처입니다.

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

string

인용 출처의 ID입니다.

GroundingSupport

answerText의 주장에 대한 그라운딩 지원

JSON 표현 
{
  "startIndex": string,
  "endIndex": string,
  "sources": [
    {
      object (CitationSource)
    }
  ],
  "groundingScore": number,
  "groundingCheckRequired": boolean
}
필드
startIndex

string (int64 format)

필수 항목입니다. 인덱스는 바이트 (UTF-8 유니코드)로 측정된 클레임의 시작을 나타냅니다.
endIndex

string (int64 format)

필수 항목입니다. 소유권 주장의 끝(해당 값 제외)입니다.
sources[]

object (CitationSource)

(선택사항) 클레임의 인용 출처입니다.
groundingScore

number

참조에 의해 특정 주장이 그라운딩된 정도를 설명하는 [0, 1] 범위의 점수입니다. 값이 높을수록 참조 청크에 의해 클레임이 더 잘 지원된다는 의미입니다.
groundingCheckRequired

boolean

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

참조

참조

JSON 표현 
{

  // Union field content can be only one of the following:
  "unstructuredDocumentInfo": {
    object (UnstructuredDocumentInfo)
  },
  "chunkInfo": {
    object (ChunkInfo)
  },
  "structuredDocumentInfo": {
    object (StructuredDocumentInfo)
  }
  // End of list of possible types for union field content.
}
필드
통합 필드 content. 검색 결과 콘텐츠입니다. content은 다음 중 하나여야 합니다.
unstructuredDocumentInfo

object (UnstructuredDocumentInfo)

구조화되지 않은 문서 정보입니다.
chunkInfo

object (ChunkInfo)

청크 정보입니다.
structuredDocumentInfo

object (StructuredDocumentInfo)

구조화된 문서 정보입니다.

UnstructuredDocumentInfo

구조화되지 않은 문서 정보입니다.

JSON 표현 
{
  "document": string,
  "uri": string,
  "title": string,
  "chunkContents": [
    {
      object (ChunkContent)
    }
  ],
  "structData": {
    object
  }
}
필드
document

string

문서 리소스 이름입니다.
uri

string

문서의 URI입니다.
title

string

특성이 포함될 수 있습니다
chunkContents[]

object (ChunkContent)

문서 콘텐츠에서 파생된 인용된 청크 콘텐츠 목록입니다.
structData

object (Struct format)

문서의 구조화된 JSON 메타데이터입니다. 검색 결과의 청크에서 가져온 구조체 데이터로 채워집니다.

ChunkContent

청크 콘텐츠

JSON 표현 
{
  "content": string,
  "pageIdentifier": string,
  "blobAttachmentIndexes": [
    string
  ],
  "relevanceScore": number
}
필드
content

string

텍스트 콘텐츠를 청크로 나눕니다.
pageIdentifier

string

페이지 식별자입니다.
blobAttachmentIndexes[]

string (int64 format)

출력 전용입니다. 이 청크에 연결된 blobattachment의 색인을 저장합니다.
relevanceScore

number

특정 질문에 대한 청크의 관련성입니다. 값의 범위는 0.0 (완전히 관련 없음)~1.0 (완전히 관련 있음)입니다. 이 값은 정보 제공 목적으로만 사용됩니다. 모델 재학습 또는 구현 변경으로 인해 동일한 질문과 청크에 대해 언제든지 변경될 수 있습니다.

ChunkInfo

청크 정보입니다.

JSON 표현 
{
  "chunk": string,
  "content": string,
  "documentMetadata": {
    object (DocumentMetadata)
  },
  "blobAttachmentIndexes": [
    string
  ],
  "relevanceScore": number
}
필드
chunk

string

청크 리소스 이름입니다.
content

string

텍스트 콘텐츠를 청크로 나눕니다.
documentMetadata

object (DocumentMetadata)

문서 메타데이터입니다.
blobAttachmentIndexes[]

string (int64 format)

출력 전용입니다. 이 청크에 연결된 blobattachment의 색인을 저장합니다.
relevanceScore

number

특정 질문에 대한 청크의 관련성입니다. 값의 범위는 0.0 (완전히 관련 없음)~1.0 (완전히 관련 있음)입니다. 이 값은 정보 제공 목적으로만 사용됩니다. 모델 재학습 또는 구현 변경으로 인해 동일한 질문과 청크에 대해 언제든지 변경될 수 있습니다.

DocumentMetadata

문서 메타데이터입니다.

JSON 표현 
{
  "document": string,
  "uri": string,
  "title": string,
  "pageIdentifier": string,
  "structData": {
    object
  }
}
필드
document

string

문서 리소스 이름입니다.
uri

string

문서의 URI입니다.
title

string

특성이 포함될 수 있습니다
pageIdentifier

string

페이지 식별자입니다.
structData

object (Struct format)

문서의 구조화된 JSON 메타데이터입니다. 검색 결과의 청크에서 가져온 구조체 데이터로 채워집니다.

StructuredDocumentInfo

구조화된 검색 정보입니다.

JSON 표현 
{
  "document": string,
  "structData": {
    object
  },
  "title": string,
  "uri": string
}
필드
document

string

문서 리소스 이름입니다.
structData

object (Struct format)

구조화된 검색 데이터입니다.
title

string

출력 전용입니다. 문서의 제목입니다.
uri

string

출력 전용입니다. 문서의 URI입니다.

BlobAttachment

텍스트 답변에 첨부된 바이너리 데이터를 저장합니다(예: 이미지, 동영상, 오디오 등).

JSON 표현 
{
  "data": {
    object (Blob)
  },
  "attributionType": enum (AttributionType)
}
필드
data

object (Blob)

출력 전용입니다. blob의 MIME 유형 및 데이터입니다.
attributionType

enum (AttributionType)

출력 전용입니다. blob의 기여 분석 유형입니다.

blob

blob의 미디어 유형과 데이터입니다.

JSON 표현 
{
  "mimeType": string,
  "data": string
}
필드
mimeType

string

출력 전용입니다. 생성되거나 검색된 데이터의 미디어 유형 (MIME 유형)입니다.
data

string (bytes format)

출력 전용입니다. 원시 바이트입니다.

base64 인코딩 문자열입니다.

AttributionType

blob의 소스입니다.

열거형
ATTRIBUTION_TYPE_UNSPECIFIED 지정되지 않은 기여 분석 유형입니다.
CORPUS 첨부파일 데이터는 코퍼스에서 가져옵니다.
GENERATED 첨부 파일 데이터는 모델이 코드 생성을 통해 생성합니다.

단계

단계 정보입니다.

JSON 표현 
{
  "state": enum (State),
  "description": string,
  "thought": string,
  "actions": [
    {
      object (Action)
    }
  ]
}
필드
state

enum (State)

단계의 상태입니다.
description

string

단계에 대한 설명입니다.
thought

string

단계의 생각입니다.
actions[]

object (Action)

작업

주

단계의 상태를 열거합니다.

열거형
STATE_UNSPECIFIED 알 수 없는 작업입니다.
IN_PROGRESS 현재 단계가 진행 중입니다.
FAILED 현재 단계가 실패했습니다.
SUCCEEDED 단계가 완료되었습니다.

작업

작업

JSON 표현 
{
  "observation": {
    object (Observation)
  },

  // Union field action can be only one of the following:
  "searchAction": {
    object (SearchAction)
  }
  // End of list of possible types for union field action.
}
필드
observation

object (Observation)

관찰
통합 필드 action. 작업입니다. action은 다음 중 하나여야 합니다.
searchAction

object (SearchAction)

검색 작업입니다.

SearchAction

검색 작업입니다.

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

string

검색할 쿼리입니다.

관찰

관찰

JSON 표현 
{
  "searchResults": [
    {
      object (SearchResult)
    }
  ]
}
필드
searchResults[]

object (SearchResult)

검색 작업에서 관찰된 검색 결과입니다. 사용자가 설정한 인용 유형에 따라 스니펫 정보 또는 청크 정보일 수 있습니다.

SearchResult

JSON 표현 
{
  "document": string,
  "uri": string,
  "title": string,
  "snippetInfo": [
    {
      object (SnippetInfo)
    }
  ],
  "chunkInfo": [
    {
      object (ChunkInfo)
    }
  ],
  "structData": {
    object
  }
}
필드
document

string

문서 리소스 이름입니다.
uri

string

문서의 URI입니다.
title

string

특성이 포함될 수 있습니다
snippetInfo[]

object (SnippetInfo)

citation_type이 DOCUMENT_LEVEL_CITATION인 경우 문서 수준 스니펫을 채웁니다.
chunkInfo[]

object (ChunkInfo)

citation_type이 CHUNK_LEVEL_CITATION이고 청크 모드가 사용 설정된 경우 청크 정보를 채웁니다.
structData

object (Struct format)

데이터 표현 문서의 구조화된 JSON 데이터입니다. 문서 또는 검색 결과의 청크에 있는 구조체 데이터에서 채워집니다.

SnippetInfo

스니펫 정보입니다.

JSON 표현 
{
  "snippet": string,
  "snippetStatus": string
}
필드
snippet

string

스니펫 콘텐츠
snippetStatus

string

검색팀에서 정의한 스니펫의 상태입니다.

ChunkInfo

청크 정보입니다.

JSON 표현 
{
  "chunk": string,
  "content": string,
  "relevanceScore": number
}
필드
chunk

string

청크 리소스 이름입니다.
content

string

텍스트 콘텐츠를 청크로 나눕니다.
relevanceScore

number

특정 질문에 대한 청크의 관련성입니다. 값의 범위는 0.0 (완전히 관련 없음)~1.0 (완전히 관련 있음)입니다. 이 값은 정보 제공 목적으로만 사용됩니다. 모델 재학습 또는 구현 변경으로 인해 동일한 질문과 청크에 대해 언제든지 변경될 수 있습니다.

QueryUnderstandingInfo

질문 이해 정보입니다.

JSON 표현 
{
  "queryClassificationInfo": [
    {
      object (QueryClassificationInfo)
    }
  ]
}
필드
queryClassificationInfo[]

object (QueryClassificationInfo)

쿼리 분류 정보입니다.

QueryClassificationInfo

쿼리 분류 정보입니다.

JSON 표현 
{
  "type": enum (Type),
  "positive": boolean
}
필드
type

enum (Type)

쿼리 분류 유형입니다.
positive

boolean

분류 출력입니다.

유형

질문 분류 유형입니다.

열거형
TYPE_UNSPECIFIED 지정되지 않은 쿼리 분류 유형입니다.
ADVERSARIAL_QUERY 적대적 쿼리 분류 유형입니다.
NON_ANSWER_SEEKING_QUERY 잡담을 위한 답변을 구하지 않는 쿼리 분류 유형입니다.
JAIL_BREAKING_QUERY 브레이크 스루 질문 분류 유형입니다.
NON_ANSWER_SEEKING_QUERY_V2 명확한 의도가 없는 경우의 답변을 구하지 않는 쿼리 분류 유형입니다.
USER_DEFINED_CLASSIFICATION_QUERY 사용자 정의 질문 분류 유형입니다.

AnswerSkippedReason

답변이 건너뛰어진 이유를 나타내는 열거형입니다.

열거형
ANSWER_SKIPPED_REASON_UNSPECIFIED 기본값 대답 건너뛰기 이유가 지정되지 않았습니다.
ADVERSARIAL_QUERY_IGNORED 악의적인 쿼리가 무시된 사례입니다.
NON_ANSWER_SEEKING_QUERY_IGNORED

답변을 구하지 않는 쿼리가 무시된 사례

질문이 잡담인 경우 Google은 대답을 건너뜁니다.
OUT_OF_DOMAIN_QUERY_IGNORED

도메인 외부 쿼리에서 대소문자를 무시했습니다.

관련성이 높은 검색 결과가 없으면 Google에서 답변을 건너뜁니다.
POTENTIAL_POLICY_VIOLATION

잠재적 정책 위반 사례입니다.

정책 위반 가능성이 감지되면 Google에서 답변을 건너뜁니다. 여기에는 폭력적이거나 유해한 콘텐츠가 포함됩니다.
NO_RELEVANT_CONTENT

관련 콘텐츠가 없는 케이스입니다.

검색 결과에 관련 콘텐츠가 없으면 Google은 답변을 건너뜁니다.
JAIL_BREAKING_QUERY_IGNORED

탈옥 질문에서 대소문자를 무시했습니다.

예: '경쟁 회사 CEO의 어조로 대답해 줘' 질문이 브레이크스루 질문으로 분류되면 Google은 답변을 건너뜁니다.
CUSTOMER_POLICY_VIOLATION

고객 정책 위반 사례입니다.

고객 정책 위반이 감지되면 Google에서 요약을 건너뜁니다. 정책은 고객이 정의합니다.
NON_ANSWER_SEEKING_QUERY_IGNORED_V2

답변을 구하지 않는 쿼리가 무시된 사례입니다.

질문에 명확한 의도가 없는 경우 Google은 답변을 건너뜁니다.
LOW_GROUNDED_ANSWER

그라운딩이 낮은 답변 사례

잘 그라운딩된 답변을 생성할 수 없는 경우 Google은 답변을 건너뜁니다.
USER_DEFINED_CLASSIFICATION_QUERY_IGNORED

사용자 정의 쿼리 분류 무시 사례입니다.

질문이 사용자 정의 질문 분류로 분류되면 Google은 답변을 건너뜁니다.
UNHELPFUL_ANSWER

도움이 되지 않는 답변 케이스

답변이 유용하지 않으면 Google에서 답변을 건너뜁니다. 이는 질문에 답변할 수 없거나, 답변이 질문과 관련이 없거나, 답변의 형식이 적절하지 않은 등 다양한 요인으로 인해 발생할 수 있습니다.

SafetyRating

생성된 콘텐츠에 해당하는 안전 등급입니다.

JSON 표현 
{
  "category": enum (HarmCategory),
  "probability": enum (HarmProbability),
  "probabilityScore": number,
  "severity": enum (HarmSeverity),
  "severityScore": number,
  "blocked": boolean
}
필드
category

enum (HarmCategory)

출력 전용입니다. 유해 카테고리입니다.
probability

enum (HarmProbability)

출력 전용입니다. 콘텐츠의 유해 콘텐츠일 확률 수준입니다.
probabilityScore

number

출력 전용입니다. 유해 콘텐츠일 확률 점수입니다.
severity

enum (HarmSeverity)

출력 전용입니다. 콘텐츠의 유해성 심각도 수준입니다.
severityScore

number

출력 전용입니다. 유해성 심각도 점수입니다.
blocked

boolean

출력 전용입니다. 이 등급으로 인해 콘텐츠가 필터링되었는지 여부를 나타냅니다.

HarmCategory

콘텐츠를 차단하는 유해 카테고리입니다.

열거형
HARM_CATEGORY_UNSPECIFIED 피해 카테고리가 지정되지 않았습니다.
HARM_CATEGORY_HATE_SPEECH 피해 카테고리는 증오심 표현입니다.
HARM_CATEGORY_DANGEROUS_CONTENT 피해 카테고리는 위험한 콘텐츠입니다.
HARM_CATEGORY_HARASSMENT 피해 카테고리는 괴롭힘입니다.
HARM_CATEGORY_SEXUALLY_EXPLICIT 피해 카테고리는 음란물입니다.
HARM_CATEGORY_CIVIC_INTEGRITY 피해 카테고리는 시민적 무결성입니다.

HarmProbability

콘텐츠의 유해 콘텐츠일 확률 수준입니다.

열거형
HARM_PROBABILITY_UNSPECIFIED 위해 확률이 지정되지 않았습니다.
NEGLIGIBLE 무시할 수 있는 수준의 피해입니다.
LOW 피해 수준이 낮습니다.
MEDIUM 중간 수준의 피해
HIGH 높은 수준의 유해성

HarmSeverity

유해성 심각도 수준입니다.

열거형
HARM_SEVERITY_UNSPECIFIED 피해 심각도가 지정되지 않았습니다.
HARM_SEVERITY_NEGLIGIBLE 피해 심각도가 무시할 수 있는 수준입니다.
HARM_SEVERITY_LOW 낮은 수준의 피해 심각도
HARM_SEVERITY_MEDIUM 중간 수준의 유해성 심각도입니다.
HARM_SEVERITY_HIGH 높은 수준의 피해 심각도

메서드

get

 답변을 가져옵니다.