REST Resource: projects.locations.collections.engines.sessions.assistAnswers

리소스: AssistAnswer

AssistAnswer 리소스, AssistResponse의 기본 부분

JSON 표현 
{
  "name": string,
  "state": enum (State),
  "replies": [
    {
      object (Reply)
    }
  ],
  "diagnosticInfo": {
    object
  },
  "assistSkippedReasons": [
    enum (AssistSkippedReason)
  ],
  "requiredAuthorizations": [
    {
      object (RequiredAuthorization)
    }
  ],
  "customerPolicyEnforcementResult": {
    object (CustomerPolicyEnforcementResult)
  }
}
필드
name

string

변경할 수 없습니다. 식별자. AssistAnswer의 리소스 이름입니다. 형식: projects/{project}/locations/{location}/collections/{collection}/engines/{engine}/sessions/{session}/assistAnswers/{assistAnswer}

이 필드는 UTF-8로 인코딩된 문자열이어야 하며 길이 제한은 1,024자(영문 기준)입니다.
state

enum (State)

답변 생성 상태입니다.
replies[]

object (Reply)

어시스턴트의 대답입니다.
diagnosticInfo

object (Struct format)

(선택사항) 요청을 처리하는 중에 수집된 진단 정보입니다. 이는 주로 디버깅에 도움이 되도록 사람 독자만을 위해 제공됩니다. 데이터 구조는 예고 없이 변경될 수 있습니다.
assistSkippedReasons[]

enum (AssistSkippedReason)

지원 통화에 응답하지 않는 이유입니다.
requiredAuthorizations[]

object (RequiredAuthorization)

출력 전용입니다. 필수 승인 목록입니다. 사용자가 특정 Authorization에 대해 승인되지 않았지만 호출된 에이전트가 이를 요구하는 경우에만 채워집니다.
customerPolicyEnforcementResult

object (CustomerPolicyEnforcementResult)

(선택사항) 이 필드에는 금지된 문구 또는 Model Armor 확인과 같은 다양한 정책 확인 결과에 관한 정보가 포함됩니다. 이 필드는 정책 위반으로 인해 지원 통화가 건너뛴 경우에만 채워집니다.

주

답변 생성 상태입니다.

열거형
STATE_UNSPECIFIED 알 수 없는 작업입니다.
IN_PROGRESS 현재 지원 작업이 진행 중입니다.
FAILED 지원 작업에 실패했습니다.
SUCCEEDED 지원 작업이 완료되었습니다.
SKIPPED 지원 작업이 건너뛰었습니다.

답장

어시스트 호출의 멀티파트 응답 중 한 부분입니다.

JSON 표현 
{
  "replyId": string,

  // Union field reply can be only one of the following:
  "groundedContent": {
    object (AssistantGroundedContent)
  }
  // End of list of possible types for union field reply.
}
필드
replyId

string

출력 전용입니다. 설정된 경우 AssistAnswer 리소스 내에서 답글을 고유하게 식별합니다. AssistantService.StreamAssist 호출 중에 동일한 ID를 가진 여러 Reply 메시지가 응답 스트림 내에서 발생할 수 있습니다([AssistantService.StreamAssistResponse][] 메시지 여러 개에 걸쳐). 이는 최종 AssistAnswer 리소스의 단일 Reply 메시지 부분을 나타냅니다.
통합 필드 reply. 어시스턴트 대답의 대안입니다. reply은 다음 중 하나여야 합니다.
groundedContent

object (AssistantGroundedContent)

어시스턴트의 그라운딩된 응답 텍스트 또는 미디어일 수 있습니다.

AssistantGroundedContent

콘텐츠와 그라운딩 정보(있는 경우)입니다.

모든 콘텐츠에 그라운딩이 필요한 것은 아닙니다. '물론 기꺼이 검색해 드릴게요'와 같은 문구에는 그라운딩이 필요하지 않습니다.

JSON 표현 
{
  "content": {
    object (AssistantContent)
  },
  "citationMetadata": {
    object (CitationMetadata)
  },
  "contentMetadata": {
    object (ContentMetadata)
  },

  // Union field metadata can be only one of the following:
  "textGroundingMetadata": {
    object (TextGroundingMetadata)
  }
  // End of list of possible types for union field metadata.
}
필드
content

object (AssistantContent)

콘텐츠입니다.
citationMetadata

object (CitationMetadata)

생성된 콘텐츠의 출처 표시입니다. https://cloud.google.com/vertex-ai/generative-ai/docs/learn/overview#citation_check도 참고하세요.
contentMetadata

object (ContentMetadata)

선택사항입니다. 콘텐츠의 메타데이터입니다. 현재는 연구 보조원의 답변에만 사용됩니다.
통합 필드 metadata. 다양한 모달의 그라운딩 메타데이터입니다. 현재는 텍스트만 지원합니다. metadata은 다음 중 하나여야 합니다.
textGroundingMetadata

object (TextGroundingMetadata)

텍스트 소스를 기반으로 한 그라운딩의 메타데이터입니다.

TextGroundingMetadata

텍스트 소스의 그라운딩 세부정보입니다.

JSON 표현 
{
  "segments": [
    {
      object (Segment)
    }
  ],
  "references": [
    {
      object (Reference)
    }
  ],
  "searchEntryPoints": [
    {
      object (SearchEntryPoint)
    }
  ]
}
필드
segments[]

object (Segment)

텍스트 부분의 그라운딩 정보입니다.
references[]

object (Reference)

그라운딩된 텍스트의 참조입니다.
searchEntryPoints[]

object (SearchEntryPoint)

(선택사항) 그라운딩에 사용되는 웹 검색의 Google 검색 진입점입니다.

세그먼트

텍스트 세그먼트의 그라운딩 정보입니다.

JSON 표현 
{
  "startIndex": string,
  "endIndex": string,
  "referenceIndices": [
    integer
  ],
  "groundingScore": number,
  "text": string
}
필드
startIndex

string (int64 format)

세그먼트의 시작을 나타내는 0 기반 색인으로, UTF-8 문자열의 바이트로 측정됩니다 (즉, 여러 바이트로 인코딩된 문자의 길이는 1보다 큼).
endIndex

string (int64 format)

세그먼트의 끝(제외)입니다.
referenceIndices[]

integer

세그먼트의 참조입니다.
groundingScore

number

세그먼트의 점수입니다.
text

string

텍스트 세그먼트 자체입니다.

참조

참조된 콘텐츠 및 관련 문서 메타데이터

JSON 표현 
{
  "content": string,
  "documentMetadata": {
    object (DocumentMetadata)
  }
}
필드
content

string

참조된 텍스트 콘텐츠입니다.
documentMetadata

object (DocumentMetadata)

문서 메타데이터입니다.

DocumentMetadata

문서 메타데이터입니다.

JSON 표현 
{
  "boundingBoxes": [
    {
      object (BoundingBox)
    }
  ],
  "document": string,
  "uri": string,
  "title": string,
  "pageIdentifier": string,
  "domain": string,
  "mimeType": string
}
필드
boundingBoxes[]

object (BoundingBox)

(선택사항) 이 참조의 경계 상자입니다. 여러 페이지를 생성하는 참조를 지원하기 위해 반복됩니다.
document

string

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

string

문서의 URI입니다. 실제 웹사이트로 리디렉션되는 URL이 포함될 수 있습니다.
title

string

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

string

페이지 식별자입니다.
domain

string

문서 URI의 도메인 이름입니다. uri 필드에는 실제 웹사이트로 리디렉션되는 URL이 포함될 수 있으며, 이 경우 타겟 사이트의 도메인 이름이 포함됩니다.
mimeType

string

문서의 MIME 유형입니다. https://www.iana.org/assignments/media-types/media-types.xhtml

BoundingBox

단일 페이지를 생성하는 경계 상자입니다.

JSON 표현 
{
  "pageNumber": string,
  "boundingPoly": {
    object (BoundingPoly)
  }
}
필드
pageNumber

string
boundingPoly

object (BoundingPoly)

문서의 텍스트 콘텐츠에 대한 경계 다각형입니다.

BoundingPoly

문서의 텍스트 콘텐츠에 대한 경계 다각형입니다.

JSON 표현 
{
  "normalizedVertices": [
    {
      object (NormalizedVertex)
    }
  ]
}
필드
normalizedVertices[]

object (NormalizedVertex)

NormalizedVertex

꼭짓점은 이미지의 2D 점을 나타냅니다.

참고: 정규화된 꼭짓점 좌표는 원본 이미지를 기준으로 하며 범위는 0에서 1 사이입니다.

JSON 표현 
{
  "x": number,
  "y": number
}
필드
x

number

X 좌표입니다.
y

number

Y 좌표 (이미지 상단에서 시작)

SearchEntryPoint

Google 검색 진입점

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

string

웹페이지 또는 앱 웹뷰에 삽입할 수 있는 웹 콘텐츠 스니펫입니다.

AssistantContent

멀티모달 콘텐츠

JSON 표현 
{
  "role": string,
  "thought": boolean,

  // Union field data can be only one of the following:
  "text": string,
  "inlineData": {
    object (Blob)
  },
  "file": {
    object (File)
  },
  "executableCode": {
    object (ExecutableCode)
  },
  "codeExecutionResult": {
    object (CodeExecutionResult)
  }
  // End of list of possible types for union field data.
}
필드
role

string

콘텐츠 제작자입니다. 'model' 또는 'user'일 수 있습니다.
thought

boolean

(선택사항) 모델에서 파트를 생성했는지 여부를 나타냅니다.
통합 필드 data. 포함된 데이터입니다. data은 다음 중 하나여야 합니다.
text

string

인라인 텍스트
inlineData

object (Blob)

인라인 바이너리 데이터입니다.
file

object (File)

파일(예: 오디오 요약)
executableCode

object (ExecutableCode)

실행 목적으로 모델에서 생성된 코드입니다.
codeExecutionResult

object (CodeExecutionResult)

ExecutableCode 실행 결과입니다.

blob

인라인 blob입니다.

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

string

필수 항목입니다. 생성된 데이터의 미디어 유형 (MIME 유형)입니다.
data

string (bytes format)

필수 항목입니다. 원시 바이트입니다.

base64 인코딩 문자열입니다.

파일

파일(예: 오디오 요약)

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

string

필수 항목입니다. 파일의 미디어 유형 (MIME 유형)입니다.
fileId

string

필수 항목입니다. 파일 ID입니다.

ExecutableCode

모델에서 실행할 목적으로 모델에서 생성된 코드입니다.

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

string

필수 항목입니다. 코드 콘텐츠입니다. 현재는 Python만 지원됩니다.

CodeExecutionResult

ExecutableCode 실행 결과입니다.

JSON 표현 
{
  "outcome": enum (Outcome),
  "output": string
}
필드
outcome

enum (Outcome)

필수 항목입니다. 코드 실행의 결과입니다.
output

string

(선택사항) 코드 실행이 성공하면 stdout이 포함되고, 그렇지 않으면 stderr 또는 기타 설명이 포함됩니다.

결과

코드 실행의 가능한 결과의 열거형입니다.

열거형
OUTCOME_UNSPECIFIED 지정되지 않은 상태입니다. 이 값은 사용하면 안 됩니다.
OUTCOME_OK 코드 실행이 완료되었습니다.
OUTCOME_FAILED 코드 실행이 완료되었지만 실패했습니다. stderr에는 이유가 포함됩니다.
OUTCOME_DEADLINE_EXCEEDED 코드 실행 시간이 너무 오래돼서 취소되었습니다. 출력이 부분적으로 표시되거나 표시되지 않을 수 있습니다.

CitationMetadata

콘텐츠의 소스 저작자 표시 모음입니다.

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

object (Citation)

출력 전용입니다. 인용 목록입니다.

인용

콘텐츠의 소스 저작자 표시입니다.

JSON 표현 
{
  "startIndex": integer,
  "endIndex": integer,
  "uri": string,
  "title": string,
  "license": string,
  "publicationDate": {
    object (Date)
  }
}
필드
startIndex

integer

출력 전용입니다. 콘텐츠의 시작 색인입니다.
endIndex

integer

출력 전용입니다. 콘텐츠의 끝 색인입니다.
uri

string

출력 전용입니다. 기여 분석의 URL 참조입니다.
title

string

출력 전용입니다. 저작자 표시의 제목입니다.
license

string

출력 전용입니다. 저작자 표시의 라이선스입니다.
publicationDate

object (Date)

출력 전용입니다. 저작자 표시의 게시일입니다.

ContentMetadata

콘텐츠의 메타데이터입니다.

JSON 표현 
{
  "contentKind": enum (ContentKind),
  "contentId": string
}
필드
contentKind

enum (ContentKind)

콘텐츠 유형입니다. 이 콘텐츠가 속한 연구 어시스턴트의 답변 부분을 보여줍니다.
contentId

string

콘텐츠의 ID입니다. 연구 질문과 그에 대한 답변을 연결하는 데 사용됩니다. 예를 들어 연구 질문에 대한 답변의 일부는 질문과 동일한 contentId를 갖습니다.

ContentKind

가능한 콘텐츠 종류입니다. 현재는 연구 도우미의 전체 답변에서 섹션을 구분하는 데만 사용됩니다.

열거형
CONTENT_KIND_UNSPECIFIED 알 수 없는 작업입니다.
RESEARCH_PLAN 조사 계획서
RESEARCH_QUESTION 연구 질문
RESEARCH_ANSWER 연구 답변
RESEARCH_REPORT 연구 보고서.
RESEARCH_AUDIO_SUMMARY 조사 오디오 요약

AssistSkippedReason

지원 통화에 응답하지 않는 이유입니다.

열거형
ASSIST_SKIPPED_REASON_UNSPECIFIED 기본값 건너뛰기 이유가 지정되지 않았습니다.
NON_ASSIST_SEEKING_QUERY_IGNORED 질문이 답변을 구하는 것처럼 보이지 않아 어시스턴트가 질문을 무시했습니다.
CUSTOMER_POLICY_VIOLATION 고객 정책 위반으로 인해 어시스턴트가 질문을 무시하거나 답변을 거부했습니다 (예: 질문 또는 답변에 차단된 문구가 포함됨).

RequiredAuthorization

에이전트가 작동하는 데 필요한 승인을 나타냅니다.

JSON 표현 
{
  "authorization": string,
  "displayName": string,
  "authorizationUri": string
}
필드
authorization

string

출력 전용입니다. Authorization의 이름입니다.
displayName

string

출력 전용입니다. 승인의 표시 이름입니다.
authorizationUri

string

출력 전용입니다. 사용자가 승인을 위해 열어야 하는 URI입니다.

CustomerPolicyEnforcementResult

고객 정책 시행 결과입니다. 금지된 문구 또는 Model Armor 확인과 같은 다양한 정책 확인 결과를 포함합니다.

JSON 표현 
{
  "verdict": enum (Verdict),
  "policyResults": [
    {
      object (PolicyEnforcementResult)
    }
  ]
}
필드
verdict

enum (Verdict)

고객 정책 시정 조치의 최종 평결입니다. 하나의 정책만 처리를 차단한 경우 평결은 차단입니다.
policyResults[]

object (PolicyEnforcementResult)

고객 정책 시행 결과입니다. 정책 위반으로 인해 지원 통화가 건너뛴 경우에만 채워집니다. 여기에는 쿼리 처리를 차단한 필터의 결과가 포함됩니다.

결과

고객 정책 시행에 대한 평결입니다.

열거형
UNSPECIFIED 알 수 없는 값입니다.
ALLOW 정책 위반이 없습니다.
BLOCK 고객 정책에 의해 처리가 차단되었습니다.

PolicyEnforcementResult

단일 정책 유형에 대한 고객 정책 시행 결과입니다.

JSON 표현 
{

  // Union field enforcement_result can be only one of the following:
  "bannedPhraseEnforcementResult": {
    object (BannedPhraseEnforcementResult)
  },
  "modelArmorEnforcementResult": {
    object (ModelArmorEnforcementResult)
  }
  // End of list of possible types for union field enforcement_result.
}
필드
통합 필드 enforcement_result. 정책 유형별 결과입니다. 오류일 수도 있고 정책 시정 조치 결과에 관한 세부정보일 수도 있습니다. enforcement_result은 다음 중 하나여야 합니다.
bannedPhraseEnforcementResult

object (BannedPhraseEnforcementResult)

금지된 문구 정책의 정책 시행 결과입니다.
modelArmorEnforcementResult

object (ModelArmorEnforcementResult)

Model Armor 정책의 정책 시행 결과입니다.

BannedPhraseEnforcementResult

금지된 문구 정책에 대한 고객 정책 시행 결과입니다.

JSON 표현 
{
  "bannedPhrases": [
    string
  ]
}
필드
bannedPhrases[]

string

질문 또는 답변에서 발견된 차단된 문구입니다.

ModelArmorEnforcementResult

Model Armor 정책에 대한 고객 정책 시행 결과입니다.

JSON 표현 
{

  // Union field result can be only one of the following:
  "modelArmorViolation": string,
  "error": {
    object (Status)
  }
  // End of list of possible types for union field result.
}
필드
통합 필드 result. Model Armor 정책 결과입니다. result은 다음 중 하나여야 합니다.
modelArmorViolation

string

발견된 Model Armor 위반입니다.
error

object (Status)

어떤 이유로든 정책 시행이 실패한 경우 Model Armor에서 반환하는 오류입니다.

메서드

get

 AssistAnswer을 가져옵니다.