REST Resource: projects.locations.collections.engines.assistants

리소스: 어시스턴트

검색 엔진 어시스턴트 리소스입니다.

JSON 표현 
{
  "name": string,
  "displayName": string,
  "description": string,
  "generationConfig": {
    object (GenerationConfig)
  },
  "googleSearchGroundingEnabled": boolean,
  "webGroundingType": enum (WebGroundingType),
  "enabledActions": {
    string: {
      object (ActionList)
    },
    ...
  },
  "enabledTools": {
    string: {
      object (ToolList)
    },
    ...
  },
  "customerPolicy": {
    object (CustomerPolicy)
  }
}
필드
name

string

변경할 수 없습니다. 어시스턴트의 리소스 이름입니다. 형식: projects/{project}/locations/{location}/collections/{collection}/engines/{engine}/assistants/{assistant}

길이 제한이 1,024자(영문 기준)인 UTF-8로 인코딩된 문자열이어야 합니다.
displayName

string

필수 항목입니다. 어시스턴트 표시 이름입니다.

길이 제한이 128자(영문 기준)인 UTF-8로 인코딩된 문자열이어야 합니다.
description

string

(선택사항) 추가 정보에 대한 설명입니다. 구성 UI에 표시되며 어시스턴트 사용자에게는 표시되지 않습니다.
generationConfig

object (GenerationConfig)

(선택사항) 어시스턴트 응답 생성 구성입니다.
googleSearchGroundingEnabled
(deprecated)

boolean

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

enum (WebGroundingType)

(선택사항) 사용할 웹 그라운딩 유형입니다.
enabledActions
(deprecated)

map (key: string, value: object (ActionList))

(선택사항) 지원 중단됨: 대신 enabledTools로 대체됩니다. 이 어시스턴트에서 사용 설정된 작업입니다. 키는 커넥터 이름입니다(예: 'projects/{projectId}/locations/{locationId}/collections/{collectionId}/dataconnector'). 값은 커넥터 인스턴스에 대해 관리자가 사용 설정한 작업으로 구성됩니다. 관리자는 프로젝트에서 만든 커넥터 인스턴스에서 여러 작업을 선택적으로 사용 설정할 수 있습니다. 예: {"jira1ConnectorName": [(actionId1, "createTicket"), (actionId2, "transferTicket")], "gmail1ConnectorName": [(actionId3, "sendEmail"),..] }
enabledTools

map (key: string, value: object (ToolList))

(선택사항) 참고: 아직 구현되지 않았습니다. 대신 enabledActions를 사용하세요. 이 어시스턴트에서 사용 설정된 도구입니다. 키는 커넥터 이름입니다(예: 'projects/{projectId}/locations/{locationId}/collections/{collectionId}/dataconnector'). 값은 커넥터 인스턴스에 대해 관리자가 사용 설정한 도구로 구성됩니다. 관리자는 프로젝트에서 만든 커넥터 인스턴스에서 여러 도구를 선택적으로 사용 설정할 수 있습니다. 예: {'jira1ConnectorName': [(toolId1, 'createTicket'), (toolId2, 'transferTicket')], 'gmail1ConnectorName': [(toolId3, 'sendEmail'),..] }
customerPolicy

object (CustomerPolicy)

(선택사항) 어시스턴트의 고객 정책입니다.

GenerationConfig

어시스턴트 응답 생성 구성입니다.

JSON 표현 
{
  "systemInstruction": {
    object (SystemInstruction)
  },
  "defaultLanguage": string
}
필드
systemInstruction

object (SystemInstruction)

시스템 요청 사항으로, LLM 호출의 프롬프트 프리앰블이라고도 합니다. https://cloud.google.com/vertex-ai/generative-ai/docs/learn/prompts/system-instructions도 참고하세요.
defaultLanguage

string

어시스턴트 응답 생성에 사용할 기본 언어입니다. en와 같은 ISO 639-1 언어 코드를 사용합니다. 지정하지 않으면 언어가 자동으로 감지됩니다.

SystemInstruction

시스템 요청 사항으로, LLM 호출의 프롬프트 프리앰블이라고도 합니다.

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

string

(선택사항) 기본 시스템 요청 사항에 추가될 추가 시스템 요청 사항입니다.

WebGroundingType

사용할 웹 그라운딩 유형입니다.

열거형
WEB_GROUNDING_TYPE_UNSPECIFIED 기본값, 지정되지 않은 설정입니다. 사용 중지된 것과 같습니다.
WEB_GROUNDING_TYPE_DISABLED 웹 그라운딩이 사용 중지되었습니다.

ActionList

지원 중단됨: 대신 ToolList로 대체됩니다. 커넥터에서 사용 설정된 작업

JSON 표현 
{
  "actionInfo": [
    {
      object (ActionInfo)
    }
  ]
}
필드
actionInfo[]

object (ActionInfo)

해당 작업 정보가 포함된 작업 목록입니다.

ActionInfo

지원 중단됨: 대신 ToolInfo로 대체됩니다. 작업을 식별하는 정보입니다.

JSON 표현 
{
  "actionName": string,
  "actionDisplayName": string
}
필드
actionName

string

DataConnectorService.QueryAvailableActions에 의해 정의된 작업의 이름입니다.
actionDisplayName

string

작업의 표시 이름입니다.

ToolList

커넥터에서 사용 설정된 도구

JSON 표현 
{
  "toolInfo": [
    {
      object (ToolInfo)
    }
  ]
}
필드
toolInfo[]

object (ToolInfo)

해당 도구 정보가 포함된 도구 목록입니다.

ToolInfo

도구를 식별하는 정보입니다.

JSON 표현 
{
  "toolName": string,
  "toolDisplayName": string
}
필드
toolName

string

DataConnectorService.QueryAvailableActions에 의해 정의된 도구의 이름입니다. 참고: DataConnectorService API에서 action를 사용하지만 여기서는 tool와 동일합니다.
toolDisplayName

string

도구의 표시 이름입니다.

CustomerPolicy

어시스턴트에 대한 고객 정의 정책입니다.

JSON 표현 
{
  "bannedPhrases": [
    {
      object (BannedPhrase)
    }
  ],
  "modelArmorConfig": {
    object (ModelArmorConfig)
  }
}
필드
bannedPhrases[]

object (BannedPhrase)

(선택사항) 차단된 문구 목록입니다.
modelArmorConfig

object (ModelArmorConfig)

(선택사항) 사용자 프롬프트와 어시스턴트 응답을 정리하는 데 사용되는 Model Armor 구성입니다.

BannedPhrase

고객 정의 금지 문구의 정의입니다. 차단된 문구는 사용자 질문이나 LLM 대답에 포함될 수 없으며, 그렇지 않으면 대답이 거부됩니다.

JSON 표현 
{
  "phrase": string,
  "matchType": enum (BannedPhraseMatchType),
  "ignoreDiacritics": boolean
}
필드
phrase

string

필수 항목입니다. 금지할 원시 문자열 콘텐츠입니다.
matchType

enum (BannedPhraseMatchType)

(선택사항) 금지된 문구의 검색 유형입니다.
ignoreDiacritics

boolean

(선택사항) true인 경우 금지된 문구를 일치시킬 때 발음 구별 기호 (예: 악센트, 움라우트)가 무시됩니다. 예를 들어 '카페'는 'café'와 일치합니다.

BannedPhraseMatchType

차단된 문구의 일치 방법입니다.

열거형
BANNED_PHRASE_MATCH_TYPE_UNSPECIFIED 기본값은 SIMPLE_STRING_MATCH입니다.
SIMPLE_STRING_MATCH 금지된 문구가 텍스트의 어느 곳에서든 정확한 하위 문자열로 발견되면 일치하는 것으로 간주됩니다.
WORD_BOUNDARY_STRING_MATCH 금지된 문구는 텍스트에서 발견된 패턴이 단어 구분 기호로 둘러싸여 있는 경우에만 일치합니다. 구문 자체에는 단어 구분자가 포함될 수 있습니다.

ModelArmorConfig

사용자 프롬프트와 어시스턴트 응답을 정리하는 데 사용되는 고객 정의 Model Armor 템플릿의 구성입니다.

JSON 표현 
{
  "userPromptTemplate": string,
  "responseTemplate": string,
  "failureMode": enum (FailureMode)
}
필드
userPromptTemplate

string

(선택사항) 사용자 프롬프트를 정리하기 위한 Model Armor 템플릿의 리소스 이름입니다. 형식: projects/{project}/locations/{location}/templates/{templateId}

지정하지 않으면 사용자 프롬프트에 삭제가 적용되지 않습니다.
responseTemplate

string

(선택사항) 어시스턴트 응답을 정리하기 위한 Model Armor 템플릿의 리소스 이름입니다. 형식: projects/{project}/locations/{location}/templates/{templateId}

지정하지 않으면 어시스턴트 대답에 정리 작업이 적용되지 않습니다.
failureMode

enum (FailureMode)

(선택사항) Model Armor 삭제의 실패 모드를 정의합니다.

FailureMode

Model Armor가 요청을 처리하지 못할 때의 동작을 결정합니다.

열거형
FAILURE_MODE_UNSPECIFIED 지정되지 않은 실패 모드, 기본 동작은 FAIL_CLOSED입니다.
FAIL_OPEN Model Armor 처리에 실패해도 변경 없이 요청을 계속 진행할 수 있습니다.
FAIL_CLOSED Model Armor 처리에 실패하면 요청이 거부됩니다.

메서드

assist

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

create

 Assistant를 만듭니다.

delete

 Assistant를 삭제합니다.

get

 Assistant을 가져옵니다.

list

 Engine 아래의 모든 Assistant를 나열합니다.

patch

 Assistant 업데이트

streamAssist

 스트리밍 방식으로 사용자의 질문을 지원합니다.