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

리소스: Session

외부 세션 프로토 정의입니다.

JSON 표현 
{
  "name": string,
  "displayName": string,
  "state": enum (State),
  "userPseudoId": string,
  "turns": [
    {
      object (Turn)
    }
  ],
  "labels": [
    string
  ],
  "startTime": string,
  "endTime": string,
  "isPinned": boolean
}
필드
name

string

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

string

(선택사항) 세션의 표시 이름입니다.

이 필드는 UI에서 세션을 식별하는 데 사용됩니다. 기본적으로 표시 이름은 세션의 첫 번째 턴 질문 텍스트입니다.
state

enum (State)

세션의 상태입니다.
userPseudoId

string

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

object (Turn)

턴
labels[]

string

(선택사항) 세션의 라벨입니다. ListSessionsRequest에서 필터로 설정할 수 있습니다.
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"입니다.
isPinned

boolean

(선택사항) 세션이 고정되었는지 여부입니다. 고정된 세션은 세션 목록 상단에 표시됩니다.

주

세션 상태의 열거형입니다.

열거형
STATE_UNSPECIFIED 상태가 지정되지 않았습니다.
IN_PROGRESS 현재 세션이 열려 있습니다.

Turn

사용자의 질문과 서비스의 답변을 포함한 대화를 나타냅니다.

JSON 표현 
{
  "query": {
    object (Query)
  },
  "answer": string,
  "assistAnswer": string,
  "detailedAnswer": {
    object (Answer)
  },
  "detailedAssistAnswer": {
    object (AssistAnswer)
  },
  "queryConfig": {
    string: string,
    ...
  }
}
필드
query

object (Query)

(선택사항) 사용자 쿼리입니다. 이 턴이 다른 턴에 대한 대답을 재생성하는 경우 설정되지 않을 수 있습니다.
answer

string

(선택사항) 사용자 질문에 대한 답변의 리소스 이름입니다.

이 턴에서 답변 생성 (/answer API 호출)이 발생한 경우에만 설정합니다.
assistAnswer

string

출력 전용입니다. 사용자 질문에 대한 어시스턴트 대답의 리소스 이름입니다.

이 턴에서 지원 호출 (/assist API 호출)이 발생한 경우에만 설정됩니다.

형식은 projects/{project}/locations/{location}/collections/{collection}/engines/{engine}/sessions/{session}/assistAnswers/{assistAnswer}입니다. 세션의 모든 AssistAnswers를 가져오려면 GetSessionRequest.include_answer_details를 true로 설정하세요. 또는 개별 AssistAnswer 리소스를 가져오려면 AssistAnswerService.GetAssistAnswer API를 사용하세요.
detailedAnswer

object (Answer)

출력 전용입니다. ConversationalSearchService.GetSession API에서 GetSessionRequest.include_answer_details이 true로 설정된 경우 이 필드는 답변 쿼리 세션을 가져올 때 채워집니다.
detailedAssistAnswer

object (AssistAnswer)

출력 전용입니다. ConversationalSearchService.GetSession API에서 GetSessionRequest.include_answer_details이 true로 설정된 경우 이 필드는 어시스턴트 세션을 가져올 때 채워집니다.
queryConfig

map (key: string, value: string)

(선택사항) 사용된 LLM 모델 및 버전, 모델 파라미터 (온도, 그라운딩 파라미터 등)와 같은 쿼리 구성과 관련된 메타데이터를 나타냅니다. 'google.' 프리픽스는 Google에서 개발한 기능을 위해 예약되어 있습니다.

쿼리

사용자가 입력한 쿼리를 정의합니다.

JSON 표현 
{
  "queryId": string,

  // Union field content can be only one of the following:
  "text": string
  // End of list of possible types for union field content.
}
필드
queryId

string

출력 전용입니다. 질문의 고유 ID입니다.
통합 필드 content. 콘텐츠를 쿼리합니다. content은 다음 중 하나여야 합니다.
text

string

일반 텍스트

메서드

create

 세션을 만듭니다.

delete

 세션을 삭제합니다.

get

 세션을 가져옵니다.

list

 상위 DataStore별로 모든 세션을 나열합니다.

patch

 세션을 업데이트합니다.