AgentVersion interface

Package:

@azure/ai-projects

Represents a specific version of an agent. Includes metadata, versioning, creation time, and agent definition.

Properties

agent_guid	The unique GUID identifier of the agent.
blueprint	The blueprint for the agent
blueprint_reference	The blueprint for the agent
created_at	The Unix timestamp (seconds) when the agent was created.
definition	The definition of the agent.
description	A human-readable description of the agent.
id	The unique identifier of the agent version.
instance_identity	The instance identity of the agent
metadata	Set of 16 key-value pairs that can be attached to an object. This can be useful for storing additional information about the object in a structured format, and querying for objects via API or the dashboard. Keys are strings with a maximum length of 64 characters. Values are strings with a maximum length of 512 characters.
name	The name of the agent. Name can be used to retrieve/update/delete the agent.
object	The object type, which is always 'agent.version'.
status	The current status of the agent version.
version	The version identifier of the agent. Agents are immutable and every update creates a new version while keeping the name same.

Property Details

agent_guid

The unique GUID identifier of the agent.

agent_guid?: string

Property Value

string

blueprint

The blueprint for the agent

blueprint?: AgentIdentity

Property Value

AgentIdentity

blueprint_reference

The blueprint for the agent

blueprint_reference?: AgentBlueprintReferenceUnion

Property Value

AgentBlueprintReferenceUnion

created_at

The Unix timestamp (seconds) when the agent was created.

created_at: Date

Property Value

Date

definition

The definition of the agent.

definition: AgentDefinitionUnion

Property Value

AgentDefinitionUnion

description

A human-readable description of the agent.

description?: string

Property Value

string

id

The unique identifier of the agent version.

id: string

Property Value

string

instance_identity

The instance identity of the agent

instance_identity?: AgentIdentity

Property Value

AgentIdentity

metadata

Set of 16 key-value pairs that can be attached to an object. This can be useful for storing additional information about the object in a structured format, and querying for objects via API or the dashboard.

Keys are strings with a maximum length of 64 characters. Values are strings with a maximum length of 512 characters.

metadata: Record<string, string>

Property Value

Record<string, string>

name

The name of the agent. Name can be used to retrieve/update/delete the agent.

name: string

Property Value

string

object

The object type, which is always 'agent.version'.

object: "agent.version"

Property Value

"agent.version"

status

The current status of the agent version.

status?: "creating" | "active" | "failed" | "deleting" | "deleted"

Property Value

"creating" | "active" | "failed" | "deleting" | "deleted"

version

The version identifier of the agent. Agents are immutable and every update creates a new version while keeping the name same.

version: string

Property Value

string