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

리소스: 어시스턴트

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

JSON 표현 
{
  "name": string,
  "displayName": string,
  "description": string,
  "generationConfig": {
    object (GenerationConfig)
  },
  "googleSearchGroundingEnabled": boolean,
  "webGroundingType": enum (WebGroundingType),
  "defaultWebGroundingToggleOff": boolean,
  "vertexAiAgentConfigs": [
    {
      object (VertexAiAgentConfig)
    }
  ],
  "enabledActions": {
    string: {
      object (ActionList)
    },
    ...
  },
  "enabledTools": {
    string: {
      object (ToolList)
    },
    ...
  },
  "customerPolicy": {
    object (CustomerPolicy)
  },
  "vertexAiSearchToolConfig": {
    object (VertexAiSearchToolConfig)
  },
  "styleAndFormattingInstructions": string,
  "agentConfigs": [
    {
      object (AgentConfig)
    }
  ],
  "enableEndUserAgentCreation": boolean,
  "disableLocationContext": boolean
}
필드
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)

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

boolean

(선택사항) 이 필드는 webGroundingType이 WEB_GROUNDING_TYPE_GOOGLE_SEARCH 또는 WEB_GROUNDING_TYPE_ENTERPRISE_WEB_SEARCH로 설정된 경우 최종 사용자의 기본 웹 그라운딩 전환 버튼을 제어합니다. 기본적으로 이 필드는 false로 설정되어 있습니다. webGroundingType이 WEB_GROUNDING_TYPE_GOOGLE_SEARCH 또는 WEB_GROUNDING_TYPE_ENTERPRISE_WEB_SEARCH인 경우 최종 사용자의 UI에서 웹 그라운딩이 기본적으로 사용 설정됩니다. true인 경우 그라운딩 전환 버튼이 UI에서 기본적으로 사용 중지됩니다. 웹 그라운딩이 사용 설정된 경우 최종 사용자는 UI에서 웹 그라운딩을 사용 설정할 수 있습니다.
vertexAiAgentConfigs[]
(deprecated)

object (VertexAiAgentConfig)

(선택사항) 지원 중단됨: AgentService의 Dialogflow 에이전트로 대체됩니다. 어시스턴트를 통해 연결할 수 있는 Vertex AI Agent 목록입니다.
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)

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

object (VertexAiSearchToolConfig)

(선택사항) Vertex AI Search 도구의 구성 옵션입니다.
styleAndFormattingInstructions
(deprecated)

string

(선택사항) 지원 중단되었습니다. 대신 [addtional_system_instructions][GenerationConfig.SystemInstruction.additional_system_instructions] 를 사용하세요. 대화 스타일, 어조, 형식을 설정하기 위한 일반적인 시스템 요청 사항 스니펫 자리표시자 [STYLE_AND_FORMATTING_INSTRUCTIONS]를 통해 모든 LLM 프롬프트에 추가됩니다.
agentConfigs[]

object (AgentConfig)

(선택사항) 어시스턴트를 통해 연결할 수 있는 상담사 목록입니다.
enableEndUserAgentCreation

boolean

(선택사항) 최종 사용자가 Agentspace에서 에이전트를 만들 수 있는지 여부를 나타냅니다.
disableLocationContext

boolean

(선택사항) 사용자 위치 컨텍스트를 사용 중지할지 여부를 나타냅니다. 기본적으로 사용자 위치 컨텍스트는 사용 설정되어 있습니다.

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 웹 그라운딩이 사용 중지되었습니다.

VertexAiAgentConfig

지원 중단됨: 대신 AgentService에서 Dialogflow 에이전트를 사용하세요. 어시스턴트를 통해 연결할 수 있는 외부 Vertex AI 에이전트를 나타냅니다.

JSON 표현 
{
  "displayName": string,
  "name": string,
  "toolDescription": string
}
필드
displayName

string

필수 항목입니다. 어시스턴트에서 참조하는 데 사용되는 Vertex AI 에이전트의 표시 이름입니다.
name

string

필수 항목입니다. Vertex AI 에이전트의 리소스 이름입니다. 형식: projects/{project}/locations/{location}/agents/{agent}
toolDescription

string

필수 항목입니다. Vertex AI 에이전트의 도구 설명입니다. 이 설명은 에이전트가 사용자 질문과 관련이 있는지, 질문을 에이전트로 라우팅해야 하는지를 결정하기 위해 LLM에서 사용합니다.

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 처리에 실패하면 요청이 거부됩니다.

VertexAiSearchToolConfig

어시스턴트가 질문을 처리할 때 사용할 수 있는 Vertex AI Search 도구의 구성 옵션입니다.

JSON 표현 
{
  "llmSystemInstructions": string
}
필드
llmSystemInstructions
(deprecated)

string

지원 중단되었습니다. 이 필드를 사용하지 마세요. Vertex AI Search의 검색 결과를 기반으로 답변하기 위한 시스템 안내입니다. 검색 도구에서 생성된 답변은 어시스턴트의 최종 답변과 다를 수 있습니다.

일반적으로 시스템 안내는 모델에서 프롬프트를 처리하기 전에 처리하는 자연어 안내 모음입니다. 모델의 동작 방식과 프롬프트에 응답하는 방식을 지정합니다. https://cloud.google.com/vertex-ai/generative-ai/docs/learn/prompts/system-instructions을 참고하세요.

예: '출처의 정보만 사용하여 답변해 줘. 또한 마크다운을 사용하여 답변의 형식을 보기 좋게 지정해 줘'라고 요청할 수 있습니다.

지정하지 않으면 내부 기본값이 사용됩니다.

AgentConfig

어시스턴트가 질문을 처리할 때 호출할 수 있는 에이전트의 구성 옵션입니다.

JSON 표현 
{
  "id": string,
  "displayName": string,
  "toolDescription": string,
  "icon": {
    object (Image)
  },
  "authorizations": [
    string
  ],

  // Union field connection_info can be only one of the following:
  "vertexAiSdkAgentConnectionInfo": {
    object (VertexAiSdkAgentConnectionInfo)
  },
  "httpAgentConnectionInfo": {
    object (HttpAgentConnectionInfo)
  }
  // End of list of possible types for union field connection_info.
}
필드
id

string

필수 항목입니다. 인간이 읽을 수 있는 에이전트의 고유 ID입니다. 다음 정규 표현식과 일치해야 합니다. [a-z][a-zA-Z0-9_-]*
displayName

string

필수 항목입니다. 어시스턴트에서 참조하는 데 사용되는 에이전트의 표시 이름입니다.
toolDescription

string

필수 항목입니다. 에이전트의 도구 설명입니다. 이 설명은 에이전트가 사용자 질문과 관련이 있는지, 질문을 에이전트로 라우팅해야 하는지를 결정하기 위해 LLM에서 사용합니다.
icon

object (Image)

필수 항목입니다. UI에서 에이전트를 나타내는 아이콘입니다.
authorizations[]

string

(선택사항) 필요한 승인의 리소스 이름입니다. 사용자가 승인되지 않은 경우 서비스는 사용자가 브라우저에서 열고 승인해야 하는 여러 승인 URI를 반환합니다. 모든 승인이 부여되면 사용자가 쿼리를 다시 시도할 수 있으며 승인이 에이전트에게 전달됩니다.

형식: projects/{project}/locations/{location}/authorizations/{authorization}
통합 필드 connection_info. 에이전트의 연결 구성입니다. connection_info은 다음 중 하나여야 합니다.
vertexAiSdkAgentConnectionInfo

object (VertexAiSdkAgentConnectionInfo)

필수 항목입니다. Vertex AI SDK 에이전트의 연결 정보
httpAgentConnectionInfo

object (HttpAgentConnectionInfo)

필수 항목입니다. HTTP 에이전트의 연결 정보입니다.

VertexAiSdkAgentConnectionInfo

Vertex AI SDK 에이전트의 연결 정보입니다. 현재 추론 엔진을 통해 노출된 에이전트만 지원됩니다.

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

string

에이전트를 노출하는 추론 엔진의 리소스 이름입니다. 형식: projects/{project}/locations/{location}/reasoningEngines/{reasoningEngine}

HttpAgentConnectionInfo

HTTP를 통해 어시스턴트가 연결할 수 있는 에이전트입니다.

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

string

필수 항목입니다. 에이전트의 HTTP 주소입니다(예: 'https://example.com/agent1').

이미지

이미지를 나타냅니다.

JSON 표현 
{

  // Union field storage_method can be only one of the following:
  "uri": string,
  "content": string
  // End of list of possible types for union field storage_method.
}
필드
통합 필드 storage_method. URI 또는 base64 문자열로 인코딩된 콘텐츠일 수 있습니다. storage_method은 다음 중 하나여야 합니다.
uri

string

필수 항목입니다. 이미지 URI입니다.
content

string

필수 항목입니다. Base64로 인코딩된 이미지 파일 콘텐츠입니다.

메서드

assist

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

create

 Assistant를 만듭니다.

delete

 Assistant를 삭제합니다.

get

 Assistant을 가져옵니다.

list

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

listAvailableAgentViews

 호출자가 사용할 수 있는 Assistant 아래에 상담사를 표시하기 위한 데이터를 나열합니다.

patch

 Assistant 업데이트

streamAssist

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