Method: projects.locations.collections.engines.assistants.assist

사용자의 질문을 지원합니다.

HTTP 요청

POST https://discoveryengine.googleapis.com/v1alpha/{name=projects/*/locations/*/collections/*/engines/*/assistants/*}:assist

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

경로 매개변수

매개변수
name

string

필수 항목입니다. Assistant의 리소스 이름입니다. 형식: projects/{project}/locations/{location}/collections/{collection}/engines/{engine}/assistants/{assistant}

요청 본문

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

JSON 표현 
{
  "query": {
    object (Query)
  },
  "session": string,
  "assistSkippingMode": enum (AssistSkippingMode),
  "fileIds": [
    string
  ],
  "userMetadata": {
    object (AssistUserMetadata)
  },
  "languageCode": string,
  "webGroundingEnabled": boolean,
  "dataStoreSpecs": [
    {
      object (DataStoreSpec)
    }
  ],
  "assistGenerationConfig": {
    object (AssistGenerationConfig)
  },
  "googleSearchGroundingEnabled": boolean
}
필드
query

object (Query)

(선택사항) 현재 사용자 쿼리입니다.

빈 쿼리는 fileIds가 제공된 경우에만 지원됩니다. 이 경우 해당 컨텍스트 파일을 기반으로 답변이 생성됩니다.
session

string

(선택사항) 요청에 사용할 세션입니다. 지정된 경우 어시스턴트는 세션 기록에 액세스할 수 있으며 질문과 답변이 여기에 저장됩니다.

-이 세션 ID로 지정되거나 비워 두면 자동으로 생성된 ID로 새 세션이 생성됩니다.

형식: projects/{project}/locations/{location}/collections/{collection}/engines/{engine}/sessions/{session}
assistSkippingMode

enum (AssistSkippingMode)

(선택사항) 어시스턴트가 질문에 답변하지 않는 케이스를 결정합니다. 답변이 건너뛰어진 경우 이유는 AssistResponse.answer 내의 AssistAnswer.assist_skipped_reasons에 나열됩니다.
fileIds[]

string

(선택사항) 요청에 답변하는 데 사용할 파일의 ID입니다. 파일을 업로드하면 ID가 AddContextFileResponse.file_id에 반환됩니다.
userMetadata

object (AssistUserMetadata)

(선택사항) 쿼리를 시작하는 사용자에 대한 정보입니다.
languageCode

string

(선택사항) 언어 감지가 실패한 경우 답변에 사용할 언어입니다. 언어 감지 결과와 관계없이 작업에서 생성된 오류 메시지의 언어로도 사용됩니다.
webGroundingEnabled

boolean

(선택사항) true로 설정하면 웹 검색을 사용한 그라운딩이 사용 설정됩니다. Assistant.web_grounding_type이 [WEB_GROUNDING_TYPE_GOOGLE_SEARCH][] 또는 [WEB_GROUNDING_TYPE_ENTERPRISE_WEB_SEARCH][]인 경우에만 작동합니다.
dataStoreSpecs[]

object (DataStoreSpec)

(선택사항) 검색 호출에서 필터링할 DataStore와 해당 데이터 저장소의 구성을 정의하는 사양입니다. 데이터 스토어가 여러 개인 Engine에만 적용됩니다.

이 필드를 설정하지 않으면 ignoreDataStores가 true로 설정된 경우를 제외하고 엔진의 모든 데이터 스토어가 사용됩니다.
assistGenerationConfig

object (AssistGenerationConfig)

(선택사항) 요청 수준 생성 구성입니다. 엔진 수준에서 기본 생성 구성을 재정의하는 데 사용됩니다.
googleSearchGroundingEnabled
(deprecated)

boolean

(선택사항) 지원 중단되었습니다. 대신 webGroundingEnabled를 사용하세요.

응답 본문

AssistantService.Assist 메서드에 대한 응답입니다.

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

JSON 표현 
{
  "answer": {
    object (AssistAnswer)
  },
  "sessionInfo": {
    object (SessionInfo)
  },
  "assistToken": string
}
필드
answer

object (AssistAnswer)

질문에 대한 응답으로 생성된 AssistAnswer 리소스입니다.
sessionInfo

object (SessionInfo)

세션 정보입니다.
assistToken

string

현재 요청-응답 쌍을 식별하는 전역 고유 ID입니다. 의견 및 지원에 사용됩니다.

승인 범위

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

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

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

IAM 권한

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

  • discoveryengine.assistants.assist

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

AssistSkippingMode

지원 요청에 사용할 수 있는 건너뛰기 동작입니다.

열거형
ASSIST_SKIPPING_MODE_UNSPECIFIED 기본값 질문에서 지원을 요청하지 않는 경우 답변을 건너뛸 수 있습니다.
REQUEST_ASSIST 어시스턴트 답변을 요청합니다. 정책 검사에 실패한 질문은 답변이 건너뛰어질 수 있습니다.

SessionInfo

세션에 관한 정보입니다.

JSON 표현 
{
  "session": string,
  "queryId": string
}
필드
session

string

새로 생성되거나 계속된 세션의 이름입니다.

형식: projects/{project}/locations/{location}/collections/{collection}/engines/{engine}/sessions/{session}
queryId

string

이 지원 API 호출에 해당하는 쿼리 ID입니다. 하나의 세션에 여러 턴이 있을 수 있으며 각 턴에는 고유한 쿼리 ID가 있습니다.

assistants.assist API 호출에서 세션 이름과 이 쿼리 ID를 지정하면 이 검색 호출의 검색 결과 컨텍스트에서 지원 요청이 발생합니다.