Skip to content

README.md

Latest commit

 

History

History
326 lines (218 loc) · 30.9 KB

README.md

File metadata and controls

326 lines (218 loc) · 30.9 KB
Raw

SandboxCapabilities

Overview

Available Operations

deliver

Deliver

Example Usage

import os
from textql_sdk import Textql


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

    res = textql.sandbox_capabilities.deliver()

    # Handle response
    print(res)

Parameters

Parameter Type Required Description
connect_timeout_ms Optional[float] ➖ N/A
name Optional[str] ➖ N/A
subject Optional[str] ➖ N/A
body Optional[str] ➖ N/A
routing_json Optional[str] ➖ N/A
parameters List[models.TextqlRPCPublicSandboxQuerySandboxQueryParam] ➖ N/A
attachment_urls List[str] ➖ N/A
recipient_emails List[str] ➖ N/A
retries Optional[utils.RetryConfig] ➖ Configuration to override the default retry behavior of the client.

Response

models.SandboxCapabilityServiceDeliverResponse

Errors

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

execute_write

ExecuteWrite

Example Usage

import os
from textql_sdk import Textql


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

    res = textql.sandbox_capabilities.execute_write()

    # Handle response
    print(res)

Parameters

Parameter Type Required Description
connect_timeout_ms Optional[float] ➖ N/A
name Optional[str] ➖ N/A
connector_id Optional[int] ➖ N/A
statement Optional[str] ➖ N/A
parameters List[models.TextqlRPCPublicSandboxQuerySandboxQueryParam] ➖ N/A
max_rows Optional[models.TextqlRPCPublicSandboxCapabilitySandboxExecuteWriteRequestMaxRows] ➖ N/A
retries Optional[utils.RetryConfig] ➖ Configuration to override the default retry behavior of the client.

Response

models.SandboxCapabilityServiceExecuteWriteResponse

Errors

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

poll_ask

PollAsk

Example Usage

import os
from textql_sdk import Textql


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

    res = textql.sandbox_capabilities.poll_ask()

    # Handle response
    print(res)

Parameters

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

Response

models.SandboxCapabilityServicePollAskResponse

Errors

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

put_asset

PutAsset

Example Usage

import os
from textql_sdk import Textql


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

    res = textql.sandbox_capabilities.put_asset()

    # Handle response
    print(res)

Parameters

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

Response

models.SandboxCapabilityServicePutAssetResponse

Errors

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

send_notify

SendNotify

Example Usage

import os
from textql_sdk import Textql


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

    res = textql.sandbox_capabilities.send_notify()

    # Handle response
    print(res)

Parameters

Parameter Type Required Description
connect_timeout_ms Optional[float] ➖ N/A
name Optional[str] ➖ N/A
subject Optional[str] ➖ N/A
body Optional[str] ➖ N/A
parameters List[models.TextqlRPCPublicSandboxQuerySandboxQueryParam] ➖ N/A
retries Optional[utils.RetryConfig] ➖ Configuration to override the default retry behavior of the client.

Response

models.SandboxCapabilityServiceSendNotifyResponse

Errors

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

start_ask

StartAsk

Example Usage

import os
from textql_sdk import Textql


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

    res = textql.sandbox_capabilities.start_ask()

    # Handle response
    print(res)

Parameters

Parameter Type Required Description
connect_timeout_ms Optional[float] ➖ N/A
name Optional[str] ➖ N/A
agent_id Optional[str] ➖ N/A
prompt Optional[str] ➖ N/A
app_db Optional[str] ➖ N/A
continue_ask_id Optional[str] ➖ ask id of an earlier base-agent ask to follow up in; empty starts a new thread
retries Optional[utils.RetryConfig] ➖ Configuration to override the default retry behavior of the client.

Response

models.SandboxCapabilityServiceStartAskResponse

Errors

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

state_op

StateOp

Example Usage

import os
from textql_sdk import Textql


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

    res = textql.sandbox_capabilities.state_op()

    # Handle response
    print(res)

Parameters

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

Response

models.SandboxCapabilityServiceStateOpResponse

Errors

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