REST Resource: projects.locations.collections.dataStores.conversations

리소스: Conversation

외부 대화 프로토 정의입니다.

JSON 표현 
{
  "name": string,
  "state": enum (State),
  "userPseudoId": string,
  "messages": [
    {
      object (ConversationMessage)
    }
  ],
  "startTime": string,
  "endTime": string
}
필드
name

string

변경할 수 없습니다. 정규화된 이름 projects/{project}/locations/global/collections/{collection}/dataStore/*/conversations/* 또는 projects/{project}/locations/global/collections/{collection}/engines/*/conversations/*입니다.
state

enum (State)

대화의 상태입니다.
userPseudoId

string

사용자 추적을 위한 고유 식별자입니다.
messages[]

object (ConversationMessage)

대화 메시지
startTime

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"입니다.
endTime

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"입니다.

주

대화 상태의 열거형입니다.

열거형
STATE_UNSPECIFIED 알 수 없는 작업입니다.
IN_PROGRESS 현재 대화가 열려 있습니다.
COMPLETED 대화가 완료되었습니다.

ConversationMessage

대화 메시지를 정의합니다.

JSON 표현 
{
  "createTime": string,

  // Union field message can be only one of the following:
  "userInput": {
    object (TextInput)
  },
  "reply": {
    object (Reply)
  }
  // End of list of possible types for union field message.
}
필드
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"입니다.

통합 필드 message.

message는 다음 중 하나여야 합니다.
userInput

object (TextInput)

사용자 텍스트 입력입니다.
reply

object (Reply)

답장 검색

TextInput

텍스트 입력을 정의합니다.

JSON 표현 
{
  "input": string,
  "context": {
    object (ConversationContext)
  }
}
필드
input

string

텍스트 입력
context

object (ConversationContext)

입력의 대화 컨텍스트입니다.

ConversationContext

대화의 컨텍스트를 정의합니다.

JSON 표현 
{
  "contextDocuments": [
    string
  ],
  "activeDocument": string
}
필드
contextDocuments[]

string

사용자에게 표시되는 현재 문서 목록입니다. 문서 리소스 참조가 포함되어 있습니다.
activeDocument

string

사용자가 연 현재 활성 문서입니다. 문서 리소스 참조가 포함되어 있습니다.

답장

사용자에 대한 답장 메시지를 정의합니다.

JSON 표현 
{
  "reply": string,
  "references": [
    {
      object (Reference)
    }
  ],
  "summary": {
    object (Summary)
  }
}
필드
reply
(deprecated)

string

지원 중단됨: 대신 summary을 사용하세요. 텍스트 답장
references[]
(deprecated)

object (Reference)

답장의 참조입니다.
summary

object (Summary)

검색 결과를 기반으로 한 요약

참조

답장에서 참조를 정의합니다.

JSON 표현 
{
  "uri": string,
  "anchorText": string,
  "start": integer,
  "end": integer
}
필드
uri

string

URI 링크 참조입니다.
anchorText

string

앵커 텍스트입니다.
start

integer

앵커 텍스트 시작 색인입니다.
end

integer

앵커 텍스트 종료 색인입니다.

요약

요약 사양에 지정된 상위 N개 검색 결과의 요약입니다.

JSON 표현 
{
  "summaryText": string,
  "summarySkippedReasons": [
    enum (SummarySkippedReason)
  ],
  "safetyAttributes": {
    object (SafetyAttributes)
  },
  "summaryWithMetadata": {
    object (SummaryWithMetadata)
  }
}
필드
summaryText

string

요약 콘텐츠입니다.
summarySkippedReasons[]

enum (SummarySkippedReason)

추가 요약 건너뛰기 이유입니다. 무시된 케이스의 이유를 제공합니다. 건너뛴 항목이 없으면 이 필드가 설정되지 않습니다.
safetyAttributes

object (SafetyAttributes)

안전 속성 카테고리 및 연결된 신뢰도 점수의 컬렉션입니다.
summaryWithMetadata

object (SummaryWithMetadata)

메타데이터 정보가 포함된 요약입니다.

SummarySkippedReason

요약 건너뛰기 이유를 나타내는 열거형입니다.

열거형
SUMMARY_SKIPPED_REASON_UNSPECIFIED 기본값 요약 건너뛰기 이유가 지정되지 않았습니다.
ADVERSARIAL_QUERY_IGNORED

악의적인 쿼리가 무시된 사례입니다.

SummarySpec.ignore_adversarial_query가 true로 설정된 경우에만 사용됩니다.
NON_SUMMARY_SEEKING_QUERY_IGNORED

요약을 원하지 않는 쿼리가 무시된 사례입니다.

질문이 잡담인 경우 Google은 요약을 건너뜁니다. SummarySpec.ignore_non_summary_seeking_query가 true로 설정된 경우에만 사용됩니다.
OUT_OF_DOMAIN_QUERY_IGNORED

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

관련성이 높은 검색 결과가 없으면 Google에서 요약을 건너뜁니다. 예를 들어 데이터 스토어에는 회사 A에 관한 사실이 포함되어 있지만 사용자 질문은 회사 B에 관한 질문을 하고 있습니다.
POTENTIAL_POLICY_VIOLATION

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

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

LLM 부가기능이 사용 설정되지 않은 케이스입니다.

LLM 부가기능이 사용 설정되지 않은 경우 Google은 요약을 건너뜁니다.
NO_RELEVANT_CONTENT

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

검색된 검색 결과에 관련 콘텐츠가 없으면 Google에서 요약을 건너뜁니다.
JAIL_BREAKING_QUERY_IGNORED

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

예: '경쟁 회사 CEO의 어조로 대답해 줘' [SearchRequest.ContentSearchSpec.SummarySpec.ignore_jail_breaking_query] 가 true로 설정된 경우에만 사용됩니다.
CUSTOMER_POLICY_VIOLATION

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

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

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

질문에 명확한 의도가 없으면 Google은 요약을 건너뜁니다. [SearchRequest.ContentSearchSpec.SummarySpec.ignore_non_answer_seeking_query] 가 true로 설정된 경우에만 사용됩니다.
TIME_OUT

타임아웃 케이스입니다.

시간이 초과되면 Google에서 요약을 건너뜁니다.

SafetyAttributes

안전 속성 카테고리 및 연결된 신뢰도 점수입니다.

JSON 표현 
{
  "categories": [
    string
  ],
  "scores": [
    number
  ]
}
필드
categories[]

string

생성된 콘텐츠와 연결된 안전 속성 범주의 표시 이름입니다. 순서는 점수와 일치합니다.
scores[]

number

각 카테고리의 신뢰도 점수입니다. 값이 높을수록 신뢰도가 높습니다. 순서는 카테고리와 일치합니다.

SummaryWithMetadata

메타데이터 정보가 포함된 요약입니다.

JSON 표현 
{
  "summary": string,
  "citationMetadata": {
    object (CitationMetadata)
  },
  "references": [
    {
      object (Reference)
    }
  ],
  "blobAttachments": [
    {
      object (BlobAttachment)
    }
  ]
}
필드
summary

string

인용 정보가 없는 요약 텍스트
citationMetadata

object (CitationMetadata)

특정 요약의 인용 메타데이터입니다.
references[]

object (Reference)

문서 참조
blobAttachments[]

object (BlobAttachment)

출력 전용입니다. 답변 개선을 위해 멀티모달 데이터를 저장합니다.

CitationMetadata

인용 메타데이터입니다.

JSON 표현 
{
  "citations": [
    {
      object (Citation)
    }
  ]
}
필드
citations[]

object (Citation)

세그먼트의 인용입니다.

인용

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

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

string (int64 format)

인덱스는 바이트/유니코드로 측정된 세그먼트의 시작을 나타냅니다.
endIndex

string (int64 format)

기여 분석된 세그먼트의 끝(해당 값 제외)입니다.
sources[]

object (CitationSource)

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

CitationSource

인용 출처입니다.

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

string (int64 format)

SummaryWithMetadata.references의 문서 참조 색인입니다. 0부터 시작하는 색인이며 referenceIndex가 명시적으로 설정되지 않은 경우 값은 0입니다.

참조

문서 참조입니다.

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

string

문서 제목입니다.
document

string

필수 항목입니다. Document.name을 반환합니다. 참조된 문서의 전체 리소스 이름입니다(projects/*/locations/*/collections/*/dataStores/*/branches/*/documents/* 형식).
uri

string

문서의 Cloud Storage 또는 HTTP URI입니다.
chunkContents[]

object (ChunkContent)

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

ChunkContent

청크 콘텐츠

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

string

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

string

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

string (int64 format)

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

BlobAttachment

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

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

object (Blob)

출력 전용입니다. blob 데이터입니다.
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 첨부 파일 데이터는 모델이 코드 생성을 통해 생성합니다.

메서드

converse

 대화를 변환합니다.

create

 대화를 만듭니다.

delete

 대화를 삭제합니다.

get

 대화를 가져옵니다.

list

 상위 DataStore별로 모든 대화를 나열합니다.

patch

 대화를 업데이트합니다.