Skip to content

README.md

Latest commit

 

History

History
213 lines (135 loc) · 13.8 KB

README.md

File metadata and controls

213 lines (135 loc) · 13.8 KB

Agents

(client.agents)

Overview

Available Operations

retrieve

Returns details of an agent created in the Agent Builder.

Example Usage

from glean.api_client import Glean
import os


with Glean(
    api_token=os.getenv("GLEAN_API_TOKEN", ""),
) as g_client:

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

    # Handle response
    print(res)

Parameters

Parameter Type Required Description
agent_id str ✔️ The ID of the agent.
timezone_offset Optional[int] ➖ The offset of the client's timezone in minutes from UTC. e.g. PDT is -420 because it's 7 hours behind UTC.
retries Optional[utils.RetryConfig] ➖ Configuration to override the default retry behavior of the client.

Response

models.Agent

Errors

Error Type Status Code Content Type
errors.GleanError 4XX, 5XX */*

retrieve_schemas

Return agent's input and output schemas. You can use these schemas to detect changes to an agent's input or output structure.

Example Usage

from glean.api_client import Glean
import os


with Glean(
    api_token=os.getenv("GLEAN_API_TOKEN", ""),
) as g_client:

    res = g_client.client.agents.retrieve_schemas(agent_id="<id>")

    # Handle response
    print(res)

Parameters

Parameter Type Required Description
agent_id str ✔️ The ID of the agent.
timezone_offset Optional[int] ➖ The offset of the client's timezone in minutes from UTC. e.g. PDT is -420 because it's 7 hours behind UTC.
retries Optional[utils.RetryConfig] ➖ Configuration to override the default retry behavior of the client.

Response

models.AgentSchemas

Errors

Error Type Status Code Content Type
errors.GleanError 4XX, 5XX */*

list

Search for agents by agent name.

Example Usage

from glean.api_client import Glean
import os


with Glean(
    api_token=os.getenv("GLEAN_API_TOKEN", ""),
) as g_client:

    res = g_client.client.agents.list(name="HR Policy Agent")

    # Handle response
    print(res)

Parameters

Parameter Type Required Description Example
name Optional[str] ➖ Filters on the name of the agent. The keyword search is case-insensitive. If search string is ommited or empty, acts as no filter. HR Policy Agent
retries Optional[utils.RetryConfig] ➖ Configuration to override the default retry behavior of the client.

Response

models.SearchAgentsResponse

Errors

Error Type Status Code Content Type
errors.GleanError 4XX, 5XX */*

run_stream

Executes an agent run and returns the result as a stream of server-sent events (SSE).

Example Usage

from glean.api_client import Glean
import os


with Glean(
    api_token=os.getenv("GLEAN_API_TOKEN", ""),
) as g_client:

    res = g_client.client.agents.run_stream(agent_id="<id>")

    # Handle response
    print(res)

Parameters

Parameter Type Required Description
agent_id str ✔️ The ID of the agent to run.
input Dict[str, Any] ➖ The input to the agent.
messages List[models.Message] ➖ The messages to pass an input to the agent.
retries Optional[utils.RetryConfig] ➖ Configuration to override the default retry behavior of the client.

Response

str

Errors

Error Type Status Code Content Type
errors.GleanError 4XX, 5XX */*

run

Executes an agent run and returns the final response.

Example Usage

from glean.api_client import Glean
import os


with Glean(
    api_token=os.getenv("GLEAN_API_TOKEN", ""),
) as g_client:

    res = g_client.client.agents.run(agent_id="<id>")

    # Handle response
    print(res)

Parameters

Parameter Type Required Description
agent_id str ✔️ The ID of the agent to run.
input Dict[str, Any] ➖ The input to the agent.
messages List[models.Message] ➖ The messages to pass an input to the agent.
retries Optional[utils.RetryConfig] ➖ Configuration to override the default retry behavior of the client.

Response

models.AgentRunWaitResponse

Errors

Error Type Status Code Content Type
errors.GleanError 4XX, 5XX */*