List

List Agent Versions

agents.versions.list(struuid, VersionListParams**kwargs) -> agent_versionslistlinksAPILinksmetaAPIMetaVersionListResponse

get/v2/gen-ai/agents/{uuid}/versions

To list all agent versions, send a GET request to /v2/gen-ai/agents/{uuid}/versions.

Parameters

uuidstr

pageint

optional

Page number.

per_pageint

optional

Items per page.

Returns

VersionListResponseclass

List of agent versions

Hide ParametersShow Parameters

agent_versionslist

optional

Optional[List[AgentVersion]]

Agents

Hide ParametersShow Parameters

idstr

optional

Unique identifier

formatuint64

agent_uuidstr

optional

Uuid of the agent this version belongs to

attached_child_agentslist

optional

Optional[List[AgentVersionAttachedChildAgent]]

List of child agent relationships

Hide ParametersShow Parameters

agent_namestr

optional

Name of the child agent

child_agent_uuidstr

optional

Child agent unique identifier

if_casestr

optional

If case

is_deletedbool

optional

Child agent is deleted

route_namestr

optional

Route name

attached_functionslist

optional

Optional[List[AgentVersionAttachedFunction]]

List of function versions

Hide ParametersShow Parameters

descriptionstr

optional

Description of the function

faas_namestr

optional

FaaS name of the function

faas_namespacestr

optional

FaaS namespace of the function

is_deletedbool

optional

Whether the function is deleted

namestr

optional

Name of the function

attached_guardrailslist

optional

Optional[List[AgentVersionAttachedGuardrail]]

List of guardrail version

Hide ParametersShow Parameters

is_deletedbool

optional

Whether the guardrail is deleted

namestr

optional

Guardrail Name

priorityint

optional

Guardrail Priority

formatint64

uuidstr

optional

Guardrail UUID

attached_knowledgebaseslist

optional

Optional[List[AgentVersionAttachedKnowledgebase]]

List of knowledge base agent versions

Hide ParametersShow Parameters

is_deletedbool

optional

Deletet at date / time

namestr

optional

Name of the knowledge base

uuidstr

optional

Unique id of the knowledge base

can_rollbackbool

optional

Whether the version is able to be rolled back to

created_atdatetime

optional

Creation date

formatdate-time

created_by_emailstr

optional

User who created this version

currently_appliedbool

optional

Whether this is the currently applied configuration

descriptionstr

optional

Description of the agent

instructionstr

optional

Instruction for the agent

kint

optional

K value for the agent's configuration

formatint64

max_tokensint

optional

Max tokens setting for the agent

formatint64

model_namestr

optional

Name of model associated to the agent version

namestr

optional

Name of the agent

provide_citationsbool

optional

Whether the agent should provide in-response citations

retrieval_methodAPIRetrievalMethod

optional

• RETRIEVAL_METHOD_UNKNOWN: The retrieval method is unknown
• RETRIEVAL_METHOD_REWRITE: The retrieval method is rewrite
• RETRIEVAL_METHOD_STEP_BACK: The retrieval method is step back
• RETRIEVAL_METHOD_SUB_QUERIES: The retrieval method is sub queries
• RETRIEVAL_METHOD_NONE: The retrieval method is none

tagslist

optional

Optional[List[str]]

Tags associated with the agent

temperaturefloat

optional

Temperature setting for the agent

formatfloat

top_pfloat

optional

Top_p setting for the agent

formatfloat

trigger_actionstr

optional

Action triggering the configuration update

version_hashstr

optional

Version hash

linksAPILinks

optional

Links to other pages

metaAPIMeta

optional

Meta information about the data set

HTTPPython

from do_gradientai import GradientAI

client = GradientAI()
versions = client.agents.versions.list(
    uuid="\"123e4567-e89b-12d3-a456-426614174000\"",
)
print(versions.agent_versions)

200 Example

{
  "agent_versions": [
    {
      "id": "\"12345\"",
      "agent_uuid": "\"123e4567-e89b-12d3-a456-426614174000\"",
      "attached_child_agents": [
        {
          "agent_name": "\"example name\"",
          "child_agent_uuid": "\"123e4567-e89b-12d3-a456-426614174000\"",
          "if_case": "\"example string\"",
          "is_deleted": true,
          "route_name": "\"example name\""
        }
      ],
      "attached_functions": [
        {
          "description": "\"example string\"",
          "faas_name": "\"example name\"",
          "faas_namespace": "\"example name\"",
          "is_deleted": true,
          "name": "\"example name\""
        }
      ],
      "attached_guardrails": [
        {
          "is_deleted": true,
          "name": "\"example name\"",
          "priority": 123,
          "uuid": "\"123e4567-e89b-12d3-a456-426614174000\""
        }
      ],
      "attached_knowledgebases": [
        {
          "is_deleted": true,
          "name": "\"example name\"",
          "uuid": "\"123e4567-e89b-12d3-a456-426614174000\""
        }
      ],
      "can_rollback": true,
      "created_at": "2023-01-01T00:00:00Z",
      "created_by_email": "[email protected]",
      "currently_applied": true,
      "description": "\"example string\"",
      "instruction": "\"example string\"",
      "k": 123,
      "max_tokens": 123,
      "model_name": "\"example name\"",
      "name": "\"example name\"",
      "provide_citations": true,
      "retrieval_method": "RETRIEVAL_METHOD_UNKNOWN",
      "tags": [
        "example string"
      ],
      "temperature": 123,
      "top_p": 123,
      "trigger_action": "\"example string\"",
      "version_hash": "\"example string\""
    }
  ],
  "links": {
    "pages": {
      "first": "\"example string\"",
      "last": "\"example string\"",
      "next": "\"example string\"",
      "previous": "\"example string\""
    }
  },
  "meta": {
    "page": 123,
    "pages": 123,
    "total": 123
  }
}