Issue Obtaining Agent Schema

Open
#137 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Assessment

Difficulty
3/5
Estimated time
1-2 days
Newbie friendliness
45/100
Issue type
Bug
Clarity
Mostly clear
Activity status
Quiet
Tech stack
python
Domain
api

Research direction

Start at the glean.client.agents.retrieve(agent_id="") call shown in the issue and compare its returned models with the documented and curl responses. Check how input_schema and output_schema are represented in the Python client. Done means the client response accurately exposes the agent schema returned by the endpoint, with coverage for the reported response shape.

Written by the indexing model from the issue text.

Description

When using this python block to obtain an agent's schema as hosted on the docs:

from glean.api_client import Glean
import os


with Glean(
    api_token=os.getenv("GLEAN_API_TOKEN", ""),
    server_url="https://mycompany-be.glean.com",
) as glean:

    res = glean.client.agents.retrieve(agent_id="<id>")

    # Handle response
    print(res)

This gives me this current output:

agent_id='3fc1d69087e84a.....' input_schema=InputSchema() output_schema=OutputSchema()

Which does not match for the list of an agents schema example response:

{
  "agent_id": "mho4lwzylcozgoc2",
  "name": "HR Policy Agent",
  "input_schema": {},
  "output_schema": {},
  "tools": [
    {
      "tool_id": "string",
      "display_name": "string",
      "type": "string",
      "auth_type": "string",
      "write_action_type": "string",
      "is_setup_finished": true,
      "data_source": "string"
    }
  ]
}

This is the response I receive when curling:

{"agent_id":"c491df2fb3........","name":"[Sales] UMF Advisor","input_schema":{},"output_schema":{"$defs":{"ContentType":{"description":"The type of content block.","enum":["text"],"type":"string"}},"$schema":"https://json-schema.org/draft/2020-12/schema","properties":{"messages":{"items":{"properties":{"content":{"description":"The content of the message.","items":{"properties":{"text":{"type":"string"},"type":{"$ref":"#/$defs/ContentType"}},"required":["text","type"],"title":"MessageTextBlock","type":"object"},"title":"Content","type":"array"},"role":{"description":"The role of the message.","title":"Role","type":"string"}},"title":"Message","type":"object"},"type":"array"}},"required":["messages"],"title":"AgentResponse","type":"object"}}

I understand that these api endpoints are in beta, but is there any communication about updates regarding this endpoint or the other ones regarding agents?

Thank you.

Dominant language
Python
Stars
20
Forks
10
Avg merge
1d 6h
Merged PRs (30d)
17

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

More from gleanwork/api-client-python

All issues in gleanwork/api-client-python

Similar issues

More Python issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.