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

리소스: 에이전트

미리 정의된 특정 작업을 실행합니다.

JSON 표현
{
  "name": string,
  "displayName": string,
  "description": string,
  "icon": {
    object (Image)
  },
  "createTime": string,
  "updateTime": string,
  "authorizations": [
    string
  ],
  "authorizationConfig": {
    object (AuthorizationConfig)
  },
  "dataStoreSpecs": {
    object (DataStoreSpecs)
  },
  "state": enum (State),
  "toolSettings": {
    object (AgentToolSettings)
  },
  "languageCode": string,
  "starterPrompts": [
    {
      object (StarterPrompt)
    }
  ],
  "customPlaceholderText": string,

  // Union field definition can be only one of the following:
  "adkAgentDefinition": {
    object (AdkAgentDefinition)
  },
  "managedAgentDefinition": {
    object (ManagedAgentDefinition)
  },
  "a2aAgentDefinition": {
    object (A2AAgentDefinition)
  },
  "dialogflowAgentDefinition": {
    object (DialogflowAgentDefinition)
  }
  // End of list of possible types for union field definition.

  // Union field agent_state_reason can be only one of the following:
  "suspensionReason": string,
  "rejectionReason": string,
  "deploymentFailureReason": string
  // End of list of possible types for union field agent_state_reason.
}
필드
name

string

식별자. 에이전트의 리소스 이름입니다. 형식: projects/{project}/locations/{location}/collections/{collection}/engines/{engine}/assistants/{assistant}/agents/{agent} 또는 projects/{project}/locations/{location}/collections/{collection}/engines/{engine}/agents/{agent}

displayName

string

필수 항목입니다. 에이전트의 표시 이름입니다. 이는 LLM이 사용자 쿼리에 응답할 에이전트를 자동으로 선택하는 데 사용될 수 있습니다.

description

string

필수 항목입니다. 인간이 읽을 수 있는 에이전트 설명입니다. 이는 LLM이 사용자 쿼리에 응답할 에이전트를 자동으로 선택하는 데 사용될 수 있습니다.

icon

object (Image)

(선택사항) UI에서 에이전트를 나타내는 아이콘입니다.

createTime

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"입니다.

updateTime

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"입니다.

authorizations[]
(deprecated)

string

(선택사항) 지원 중단됨: 대신 Agent.authorization_config을 사용하세요. 이 에이전트에 필요한 승인 목록입니다.

authorizationConfig

object (AuthorizationConfig)

(선택사항) 에이전트에 필요한 승인입니다.

dataStoreSpecs

object (DataStoreSpecs)

(선택사항) 에이전트와 연결된 DataStoreSpecs입니다. 이 필드를 설정하지 않으면 엔진의 모든 데이터 스토어가 사용됩니다.

state

enum (State)

출력 전용입니다. 에이전트의 수명 주기 상태입니다.

toolSettings
(deprecated)

object (AgentToolSettings)

(선택사항) 지원 중단됨: AgentCard 정의로의 마이그레이션이 계획되어 있습니다.

languageCode

string

(선택사항) description, displayName, starterPrompts 필드의 텍스트 언어 코드입니다.

starterPrompts[]

object (StarterPrompt)

(선택사항) 에이전트의 방문 페이지에 사용자에게 표시할 스타터 프롬프트 제안입니다.

customPlaceholderText

string

(선택사항) 사용자가 텍스트를 입력하기 전에 텍스트 상자에 표시되는 맞춤 자리표시자 텍스트입니다.

통합 필드 definition. 에이전트의 정의입니다. LINT.IfChange(definition) definition은 다음 중 하나여야 합니다.
adkAgentDefinition

object (AdkAgentDefinition)

(선택사항) 에이전트의 동작이 ADK 에이전트로 정의됩니다.

managedAgentDefinition

object (ManagedAgentDefinition)

(선택사항) Google 관리 에이전트의 동작입니다.

a2aAgentDefinition

object (A2AAgentDefinition)

(선택사항) 에이전트의 동작은 A2A 에이전트로 정의됩니다.

dialogflowAgentDefinition

object (DialogflowAgentDefinition)

(선택사항) 에이전트의 동작은 Dialogflow 에이전트로 정의됩니다.

통합 필드 agent_state_reason. 상담사가 현재 상태인 이유입니다. agent_state_reason은 다음 중 하나여야 합니다.
suspensionReason

string

출력 전용입니다. 상담사가 정지된 이유입니다. 상태가 SUSPENDED인 경우에만 설정됩니다.

rejectionReason

string

출력 전용입니다. 에이전트가 거부된 이유입니다. 상태가 비공개이고 거부를 통해 도달한 경우에만 설정됩니다.

deploymentFailureReason

string

출력 전용입니다. 에이전트 배포가 실패한 이유입니다. 상태가 DEPLOYMENT_FAILED인 경우에만 설정됩니다.

메서드

create

Agent를 만듭니다.

delete

Agent를 삭제합니다.

deploy

Agent을 배포합니다.

disableAgent

에이전트를 사용 중지합니다.

enableAgent

에이전트를 사용 설정합니다.

get

Agent을 가져옵니다.

getAgentView

주어진 Agent에 대해 AgentView를 반환합니다. 여기에는 에이전트에 관한 추가 정보가 포함됩니다.

getIamPolicy

에이전트 리소스의 액세스 제어 정책을 가져옵니다.

list

호출자가 만든 Assistant의 모든 Agent를 나열합니다.

patch

Agent 업데이트

rejectAgent

대중에게 제공된 에이전트를 거부합니다.

requestAgentReview

검토할 수 있도록 하여 관리자에게 에이전트를 제공합니다.

setIamPolicy

에이전트 리소스의 액세스 제어 정책을 설정합니다.

suspendAgent

에이전트를 정지합니다.

withdrawAgent

대중에게 제공된 에이전트를 철회합니다.