Skip to content

README.md

Latest commit

 

History

History
613 lines (415 loc) · 78.3 KB

README.md

File metadata and controls

613 lines (415 loc) · 78.3 KB
Raw

Agents

Overview

Available Operations

create

CreateAgent

Example Usage

import os
from textql_sdk import Textql


with Textql(
    api_key=os.getenv("TEXTQL_API_KEY", ""),
) as textql:

    res = textql.agents.create()

    # Handle response
    print(res)

Parameters

Parameter Type Required Description
connect_timeout_ms Optional[float] ➖ N/A
name Optional[str] ➖ N/A
prompt Optional[str] ➖ N/A
paradigm_options Optional[models.TextqlRPCPublicParadigmParadigmOptions] ➖ N/A
source_suggestion_id Optional[str] ➖ N/A
slack_channel_id OptionalNullable[str] ➖ N/A
slack_dm_user_ids List[str] ➖ N/A
skip_org_default_channel Optional[bool] ➖ N/A
llm_model Optional[models.TextqlRPCPublicChatLlmModel] ➖ N/A
fast_mode OptionalNullable[bool] ➖ N/A
is_stateful OptionalNullable[bool] ➖ N/A
posting_frequency_crons List[str] ➖ N/A
email_recipient_member_ids List[str] ➖ N/A
channel_ids List[str] ➖ N/A
teams_channel_id OptionalNullable[str] ➖ N/A
teams_dm_user_aad_ids List[str] ➖ N/A
slack_trigger Optional[models.TextqlRPCPublicAgentSlackAgentTrigger] ➖ N/A
posting_frequency_cadences List[str] ➖ Index-aligned with posting_frequency_crons. A non-empty cadence
(HOURLY/FOUR-HOUR/EIGHT-HOUR/DAILY/WEEKLY) marks a flexible schedule whose
cron the backend generates; "" (or an empty list) means exact.
callable_as_subagent OptionalNullable[bool] ➖ Unset defaults to true: new agents are delegatable unless the caller opts
out. Mirrors allow_ad_hoc_subagents below.
subagent_invoker_member_ids List[str] ➖ N/A
subagent_invoker_role_ids List[str] ➖ N/A
feed_enabled OptionalNullable[bool] ➖ N/A
subagent_agent_ids List[str] ➖ N/A
allow_ad_hoc_subagents OptionalNullable[bool] ➖ N/A
methodology Optional[models.TextqlRPCPublicChatMethodology] ➖ N/A
retries Optional[utils.RetryConfig] ➖ Configuration to override the default retry behavior of the client.

Response

models.AgentServiceCreateAgentResponse

Errors

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

delete

DeleteAgent

Example Usage

import os
from textql_sdk import Textql


with Textql(
    api_key=os.getenv("TEXTQL_API_KEY", ""),
) as textql:

    res = textql.agents.delete()

    # Handle response
    print(res)

Parameters

Parameter Type Required Description
connect_timeout_ms Optional[float] ➖ N/A
agent_id Optional[str] ➖ N/A
retries Optional[utils.RetryConfig] ➖ Configuration to override the default retry behavior of the client.

Response

models.AgentServiceDeleteAgentResponse

Errors

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

duplicate

DuplicateAgent

Example Usage

import os
from textql_sdk import Textql


with Textql(
    api_key=os.getenv("TEXTQL_API_KEY", ""),
) as textql:

    res = textql.agents.duplicate()

    # Handle response
    print(res)

Parameters

Parameter Type Required Description
connect_timeout_ms Optional[float] ➖ N/A
agent_id Optional[str] ➖ N/A
retries Optional[utils.RetryConfig] ➖ Configuration to override the default retry behavior of the client.

Response

models.AgentServiceDuplicateAgentResponse

Errors

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

get_agent

GetAgent

Example Usage

import os
from textql_sdk import Textql


with Textql(
    api_key=os.getenv("TEXTQL_API_KEY", ""),
) as textql:

    res = textql.agents.get_agent()

    # Handle response
    print(res)

Parameters

Parameter Type Required Description
connect_timeout_ms Optional[float] ➖ N/A
agent_id Optional[str] ➖ N/A
retries Optional[utils.RetryConfig] ➖ Configuration to override the default retry behavior of the client.

Response

models.AgentServiceGetAgentResponse

Errors

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

get_db_schema

Read-only table/column list for the agent's private DuckDB memory (agent_db).

Example Usage

import os
from textql_sdk import Textql


with Textql(
    api_key=os.getenv("TEXTQL_API_KEY", ""),
) as textql:

    res = textql.agents.get_db_schema()

    # Handle response
    print(res)

Parameters

Parameter Type Required Description
connect_timeout_ms Optional[float] ➖ N/A
agent_id Optional[str] ➖ N/A
retries Optional[utils.RetryConfig] ➖ Configuration to override the default retry behavior of the client.

Response

models.AgentServiceGetAgentDBSchemaResponse

Errors

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

get_db_table_preview

A bounded row preview of one agent_db table (SELECT ... LIMIT n).

Example Usage

import os
from textql_sdk import Textql


with Textql(
    api_key=os.getenv("TEXTQL_API_KEY", ""),
) as textql:

    res = textql.agents.get_db_table_preview()

    # Handle response
    print(res)

Parameters

Parameter Type Required Description
connect_timeout_ms Optional[float] ➖ N/A
agent_id Optional[str] ➖ N/A
table_name Optional[str] ➖ N/A
limit Optional[int] ➖ clamped server-side; 0 uses the default
retries Optional[utils.RetryConfig] ➖ Configuration to override the default retry behavior of the client.

Response

models.AgentServiceGetAgentDBTablePreviewResponse

Errors

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

get_run

GetAgentRun

Example Usage

import os
from textql_sdk import Textql


with Textql(
    api_key=os.getenv("TEXTQL_API_KEY", ""),
) as textql:

    res = textql.agents.get_run()

    # Handle response
    print(res)

Parameters

Parameter Type Required Description
connect_timeout_ms Optional[float] ➖ N/A
run_id Optional[str] ➖ N/A
retries Optional[utils.RetryConfig] ➖ Configuration to override the default retry behavior of the client.

Response

models.AgentServiceGetAgentRunResponse

Errors

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

list_runs

ListAgentRuns

Example Usage

import os
from textql_sdk import Textql


with Textql(
    api_key=os.getenv("TEXTQL_API_KEY", ""),
) as textql:

    res = textql.agents.list_runs()

    # Handle response
    print(res)

Parameters

Parameter Type Required Description
connect_timeout_ms Optional[float] ➖ N/A
agent_id Optional[str] ➖ N/A
trigger_source OptionalNullable[str] ➖ N/A
status OptionalNullable[str] ➖ N/A
limit Optional[int] ➖ N/A
offset Optional[int] ➖ N/A
retries Optional[utils.RetryConfig] ➖ Configuration to override the default retry behavior of the client.

Response

models.AgentServiceListAgentRunsResponse

Errors

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

list

ListAgents

Example Usage

import os
from textql_sdk import Textql


with Textql(
    api_key=os.getenv("TEXTQL_API_KEY", ""),
) as textql:

    res = textql.agents.list()

    # Handle response
    print(res)

Parameters

Parameter Type Required Description
connect_timeout_ms Optional[float] ➖ N/A
include_inactive Optional[bool] ➖ N/A
include_all_org Optional[bool] ➖ N/A
days Optional[int] ➖ N/A
retries Optional[utils.RetryConfig] ➖ Configuration to override the default retry behavior of the client.

Response

models.AgentServiceListAgentsResponse

Errors

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

reset_agent_avatar

ResetAgentAvatar

Example Usage

import os
from textql_sdk import Textql


with Textql(
    api_key=os.getenv("TEXTQL_API_KEY", ""),
) as textql:

    res = textql.agents.reset_agent_avatar()

    # Handle response
    print(res)

Parameters

Parameter Type Required Description
connect_timeout_ms Optional[float] ➖ N/A
agent_id Optional[str] ➖ N/A
retries Optional[utils.RetryConfig] ➖ Configuration to override the default retry behavior of the client.

Response

models.AgentServiceResetAgentAvatarResponse

Errors

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

trigger_agent

TriggerAgent

Example Usage

import os
from textql_sdk import Textql


with Textql(
    api_key=os.getenv("TEXTQL_API_KEY", ""),
) as textql:

    res = textql.agents.trigger_agent()

    # Handle response
    print(res)

Parameters

Parameter Type Required Description
connect_timeout_ms Optional[float] ➖ N/A
agent_id Optional[str] ➖ N/A
retries Optional[utils.RetryConfig] ➖ Configuration to override the default retry behavior of the client.

Response

models.AgentServiceTriggerAgentResponse

Errors

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

update

UpdateAgent

Example Usage

import os
from textql_sdk import Textql


with Textql(
    api_key=os.getenv("TEXTQL_API_KEY", ""),
) as textql:

    res = textql.agents.update()

    # Handle response
    print(res)

Parameters

Parameter Type Required Description
connect_timeout_ms Optional[float] ➖ N/A
agent_id Optional[str] ➖ N/A
name Optional[str] ➖ N/A
prompt Optional[str] ➖ N/A
is_active Optional[bool] ➖ N/A
paradigm_options Optional[models.TextqlRPCPublicParadigmParadigmOptions] ➖ N/A
slack_channel_id OptionalNullable[str] ➖ N/A
slack_dm_user_ids List[str] ➖ N/A
skip_org_default_channel Optional[bool] ➖ N/A
llm_model Optional[models.TextqlRPCPublicChatLlmModel] ➖ N/A
fast_mode OptionalNullable[bool] ➖ N/A
is_stateful OptionalNullable[bool] ➖ N/A
posting_frequency_crons List[str] ➖ N/A
email_recipient_member_ids List[str] ➖ N/A
update_email_recipients OptionalNullable[bool] ➖ N/A
channel_ids List[str] ➖ N/A
update_channel_ids OptionalNullable[bool] ➖ N/A
teams_channel_id OptionalNullable[str] ➖ N/A
teams_dm_user_aad_ids List[str] ➖ N/A
slack_trigger Optional[models.TextqlRPCPublicAgentSlackAgentTrigger] ➖ N/A
posting_frequency_cadences List[str] ➖ Index-aligned with posting_frequency_crons. A non-empty cadence
(HOURLY/FOUR-HOUR/EIGHT-HOUR/DAILY/WEEKLY) marks a flexible schedule whose
cron the backend generates; "" (or an empty list) means exact.
callable_as_subagent OptionalNullable[bool] ➖ Feed participation; nil = don't touch (mirrors fast_mode/is_stateful).
subagent_invoker_member_ids List[str] ➖ N/A
subagent_invoker_role_ids List[str] ➖ N/A
update_subagent_invokers OptionalNullable[bool] ➖ N/A
feed_enabled OptionalNullable[bool] ➖ N/A
subagent_agent_ids List[str] ➖ N/A
update_subagents OptionalNullable[bool] ➖ N/A
allow_ad_hoc_subagents OptionalNullable[bool] ➖ N/A
methodology Optional[models.TextqlRPCPublicChatMethodology] ➖ N/A
retries Optional[utils.RetryConfig] ➖ Configuration to override the default retry behavior of the client.

Response

models.AgentServiceUpdateAgentResponse

Errors

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

upload_agent_avatar

UploadAgentAvatar

Example Usage

import os
from textql_sdk import Textql


with Textql(
    api_key=os.getenv("TEXTQL_API_KEY", ""),
) as textql:

    res = textql.agents.upload_agent_avatar()

    # Handle response
    print(res)

Parameters

Parameter Type Required Description
connect_timeout_ms Optional[float] ➖ N/A
agent_id Optional[str] ➖ N/A
image_data Optional[str] ➖ N/A
file_name Optional[str] ➖ N/A
retries Optional[utils.RetryConfig] ➖ Configuration to override the default retry behavior of the client.

Response

models.AgentServiceUploadAgentAvatarResponse

Errors

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