IAgent

Home > @gooddata/sdk-model > IAgent

IAgent interface

This API is provided as an alpha preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.

Represents an AI agent entity.

Signature:

export interface IAgent

Properties

Property

Modifiers

Type

Description

aiKnowledge?

boolean

(ALPHA) (Optional) Whether AI knowledge base is enabled.

availableToAll?

boolean

(ALPHA) (Optional) Whether the agent is available to all users.

createdAt?

string

(ALPHA) (Optional) Creation timestamp.

createdBy?

IUser

(ALPHA) (Optional) User who created the agent.

customSkills?

AgentCustomSkill[] | null

(ALPHA) (Optional) List of custom skills when skillsMode is "custom".

description?

string

(ALPHA) (Optional) Agent description.

enabled?

boolean

(ALPHA) (Optional) Whether the agent is enabled.

modifiedAt?

string

(ALPHA) (Optional) Last modification timestamp.

modifiedBy?

IUser

(ALPHA) (Optional) User who last modified the agent.

name?

string

(ALPHA) (Optional) Agent name.

personality?

string

(ALPHA) (Optional) Agent personality prompt.

ref

ObjRef

(ALPHA) Agent reference.

skillsMode?

AgentSkillsMode

(ALPHA) (Optional) Skills mode - "all" uses all skills, "custom" uses only selected skills.

userGroups?

IUserGroup[]

(ALPHA) (Optional) User groups the agent is associated with.

← IActiveCalendarsIAgentPatch →