diff --git a/.devcontainer/README.md b/.devcontainer/README.md index 396929a..e8ee441 100644 --- a/.devcontainer/README.md +++ b/.devcontainer/README.md @@ -1,4 +1,9 @@ +
+ +
+
+ > **Remember to shutdown a GitHub Codespace when it is not in use!** # Dev Containers Quick Start diff --git a/.speakeasy/gen.lock b/.speakeasy/gen.lock index 7113995..db539c8 100644 --- a/.speakeasy/gen.lock +++ b/.speakeasy/gen.lock @@ -5,10 +5,13 @@ management: speakeasyVersion: 1.790.2 generationVersion: 2.918.3 releaseVersion: 1.0.0 + repoURL: https://github.com/TextQLLabs/textql-python-v3.git + installationURL: https://github.com/TextQLLabs/textql-python-v3.git + published: true persistentEdits: - generation_id: 68140121-7345-49b7-a5b4-f3d843e2971e - pristine_commit_hash: 38695b4c89cb18b9b3fb21934319a55d751ec3c9 - pristine_tree_hash: e89c06b643d694b1a0ed71616f292d8ecd6e424a + generation_id: 04243628-82e1-44e6-a697-527e7084bce7 + pristine_commit_hash: 125e7bcb7ff1b29e233f2867a8e8f49279bb466a + pristine_tree_hash: c9d3b8bbc0dbe9a5f2662c46c4cbec0b5b558671 features: python: additionalDependencies: 1.1.0 @@ -38,8 +41,8 @@ features: trackedFiles: .devcontainer/README.md: id: b170c0f184ac - last_write_checksum: sha1:3c63dfd4dcea8df0d4add09e975a6887e6da4aab - pristine_git_object: 396929ab2e57cf09dd25ec83bd4496f733b95701 + last_write_checksum: sha1:fea883b284bfec7f10a2e244128e1f762d588fbd + pristine_git_object: e8ee4419f56de2e4cfdce3f52eb9bd7327165a55 .devcontainer/devcontainer.json: id: b34062a34eb1 last_write_checksum: sha1:94309e8c8eab5ab063986bf625f513a59825e947 @@ -9618,24 +9621,28 @@ trackedFiles: pristine_git_object: 14a5ab5a0178bf5f37c25306ec11372c1dfc1f4e pyproject.toml: id: 5d07e7d72637 - last_write_checksum: sha1:c6deba0fe8bf6aae73f27c7f65f9330592fe2b9b - pristine_git_object: b017f41b5751a707c3378314fbb8575c6672167f + last_write_checksum: sha1:64c63d5ac0ba3b71cdde7ff5d7057e706ebd1f74 + pristine_git_object: bca3ae065a5bb796ac333be16c9cbbde1ec2bd2e + scripts/prepare_readme.py: + id: e0c5957a6035 + last_write_checksum: sha1:d5a0f1ce09f7b890340fdb6f26345fce7dc9a70d + pristine_git_object: 3ef9df5c8f66bbe36cd1e79e878615664b64ca5e scripts/publish.sh: id: fe273b08f514 - last_write_checksum: sha1:adc9b741c12ad1591ab4870eabe20f0d0a86cd1a - pristine_git_object: ef28dc10c60d7d6a4bac0c6a1e9caba36b471861 + last_write_checksum: sha1:b290b25b36dca3d5eb1a2e66a2e1bcf2e7326cf3 + pristine_git_object: c35748f360329c2bc370e9b189f49b1a360b2c48 src/textql_sdk/__init__.py: id: e7d88b3ed3d6 last_write_checksum: sha1:da077c0bdfcef64a4a5aea91a17292f72fa2b088 pristine_git_object: 833c68cd526fe34aab2b7e7c45f974f7f4b9e120 src/textql_sdk/_hooks/__init__.py: id: 5f9e9b155923 - last_write_checksum: sha1:45a380490e968d8d95994dd97554ac60eeb6ae60 - pristine_git_object: e763be4b171bbcf9c16caeaf381f8c92ce8d8e6e + last_write_checksum: sha1:e3111289afd28ad557c21d9e2f918caabfb7037d + pristine_git_object: 2ee66cdd592fe41731c24ddd407c8ca31c50aec1 src/textql_sdk/_hooks/sdkhooks.py: id: 0e33c82ca39e - last_write_checksum: sha1:81fdcb0c96182eef2ba363b333e11f4d2668e499 - pristine_git_object: 22ab328978a3007dd6f94189590311e5e23fb835 + last_write_checksum: sha1:dce8bef6c2a9d41ebe80b6a2b88e64871c60c9fc + pristine_git_object: 9e960a809b619f585b1ac6ccfbbf889cab9fd56b src/textql_sdk/_hooks/types.py: id: 0953e8f4f114 last_write_checksum: sha1:cf9f9961307e084ca735534d2bf91ad1e7f84569 diff --git a/.speakeasy/out.openapi.yaml b/.speakeasy/out.openapi.yaml index 4a880fe..50f7aa9 100644 --- a/.speakeasy/out.openapi.yaml +++ b/.speakeasy/out.openapi.yaml @@ -304,7 +304,6 @@ paths: $ref: '#/components/schemas/textql.rpc.public.agent.ResetAgentAvatarResponse' x-speakeasy-group: agents x-speakeasy-name-override: resetAgentAvatar - /textql.rpc.public.agent.AgentService/StreamAgentStatus: {} /textql.rpc.public.agent.AgentService/TriggerAgent: post: tags: @@ -2698,7 +2697,6 @@ paths: $ref: '#/components/schemas/textql.rpc.public.chat.SendResponse' x-speakeasy-group: chats x-speakeasy-name-override: send - /textql.rpc.public.chat.ChatService/StreamChat: {} /textql.rpc.public.chat.ChatService/SubmitContextPromptChange: post: tags: @@ -2851,7 +2849,6 @@ paths: $ref: '#/components/schemas/textql.rpc.public.chat.UpdateChatResponse' x-speakeasy-group: chats x-speakeasy-name-override: update - /textql.rpc.public.chat.ChatService/WatchChat: {} /textql.rpc.public.connector.ConnectorService/CreateConnector: post: tags: @@ -4382,7 +4379,6 @@ paths: $ref: '#/components/schemas/textql.rpc.public.dashboard.UpdateDashboardScheduleResponse' x-speakeasy-group: dashboards x-speakeasy-name-override: updateDashboardSchedule - /textql.rpc.public.dashboard.DashboardService/WatchDashboardHealth: {} /textql.rpc.public.dataset.DatasetService/CreateFolder: post: tags: @@ -10373,7 +10369,6 @@ paths: $ref: '#/components/schemas/textql.rpc.public.playbook.SetTeamsChannelContextPlaybookResponse' x-speakeasy-group: playbooks x-speakeasy-name-override: setTeamsChannelContext - /textql.rpc.public.playbook.PlaybookService/StreamTemplateDataStatus: {} /textql.rpc.public.playbook.PlaybookService/SubscribeToPlaybook: post: tags: @@ -38106,6 +38101,13 @@ components: nullable: true title: TeamsUser additionalProperties: false + textql.rpc.public.chat.StreamChatEvent: + type: object + title: StreamChatEvent + description: A single streamed cell event from StreamChat. + properties: + cell: + $ref: '#/components/schemas/textql.rpc.public.chat.Cell' securitySchemes: apiKey: type: apiKey diff --git a/.speakeasy/workflow.lock b/.speakeasy/workflow.lock index 4f14b40..27a28c8 100644 --- a/.speakeasy/workflow.lock +++ b/.speakeasy/workflow.lock @@ -2,8 +2,8 @@ speakeasyVersion: 1.790.2 sources: TextQL API: sourceNamespace: textql-api - sourceRevisionDigest: sha256:65faee1459f901cff814ae083c87f819507ad9870948fdb7929c124dd060ddc0 - sourceBlobDigest: sha256:c76cec743b844222895588d7c1b2216ed72f9e207dd15cf8f6fd6d018a56eb97 + sourceRevisionDigest: sha256:4396f79faecd1cccbf0adca15bbe79791c3370bfaaedeecfa45324c629916bf8 + sourceBlobDigest: sha256:fa54e1335583276c5ae5acfd5542a7d45e340f36b9abb35645bbab18542f6e40 tags: - latest - 1.0.0 @@ -11,10 +11,10 @@ targets: textql: source: TextQL API sourceNamespace: textql-api - sourceRevisionDigest: sha256:65faee1459f901cff814ae083c87f819507ad9870948fdb7929c124dd060ddc0 - sourceBlobDigest: sha256:c76cec743b844222895588d7c1b2216ed72f9e207dd15cf8f6fd6d018a56eb97 + sourceRevisionDigest: sha256:4396f79faecd1cccbf0adca15bbe79791c3370bfaaedeecfa45324c629916bf8 + sourceBlobDigest: sha256:fa54e1335583276c5ae5acfd5542a7d45e340f36b9abb35645bbab18542f6e40 codeSamplesNamespace: textql-api-python-code-samples - codeSamplesRevisionDigest: sha256:50917bf43662c0917905cf10bd9545e3a7f41e9c3758166336646bab92154e11 + codeSamplesRevisionDigest: sha256:10cbd43bca15d1e828d1de0b1f98650da5da6297bd504e0d6b7eb109e96abf6b workflow: workflowVersion: 1.0.0 speakeasyVersion: latest @@ -31,6 +31,9 @@ workflow: textql: target: python source: TextQL API + publish: + pypi: + token: $pypi_token codeSamples: registry: location: registry.speakeasyapi.dev/textql/home/textql-api-python-code-samples diff --git a/README-PYPI.md b/README-PYPI.md new file mode 100644 index 0000000..4585d46 --- /dev/null +++ b/README-PYPI.md @@ -0,0 +1,930 @@ +# textql + +Developer-friendly & type-safe Python SDK specifically catered to leverage *textql* API. +[![License: MIT](https://img.shields.io/badge/LICENSE_//_MIT-3b5bdb?style=for-the-badge&labelColor=eff6ff)](https://opensource.org/licenses/MIT) + + +## Summary + +TextQL API: TextQL public API. Generated from protobuf service definitions; internal +endpoints are excluded via google.api.visibility / file_visibility. + + + +## Table of Contents + +* [textql](https://github.com/TextQLLabs/textql-python-v3/blob/master/#textql) + * [SDK Installation](https://github.com/TextQLLabs/textql-python-v3/blob/master/#sdk-installation) + * [IDE Support](https://github.com/TextQLLabs/textql-python-v3/blob/master/#ide-support) + * [SDK Example Usage](https://github.com/TextQLLabs/textql-python-v3/blob/master/#sdk-example-usage) + * [Authentication](https://github.com/TextQLLabs/textql-python-v3/blob/master/#authentication) + * [Available Resources and Operations](https://github.com/TextQLLabs/textql-python-v3/blob/master/#available-resources-and-operations) + * [Retries](https://github.com/TextQLLabs/textql-python-v3/blob/master/#retries) + * [Error Handling](https://github.com/TextQLLabs/textql-python-v3/blob/master/#error-handling) + * [Server Selection](https://github.com/TextQLLabs/textql-python-v3/blob/master/#server-selection) + * [Custom HTTP Client](https://github.com/TextQLLabs/textql-python-v3/blob/master/#custom-http-client) + * [Resource Management](https://github.com/TextQLLabs/textql-python-v3/blob/master/#resource-management) + * [Debugging](https://github.com/TextQLLabs/textql-python-v3/blob/master/#debugging) +* [Development](https://github.com/TextQLLabs/textql-python-v3/blob/master/#development) + * [Maturity](https://github.com/TextQLLabs/textql-python-v3/blob/master/#maturity) + * [Contributions](https://github.com/TextQLLabs/textql-python-v3/blob/master/#contributions) + + + + +## SDK Installation + +> [!NOTE] +> **Python version upgrade policy** +> +> Once a Python version reaches its [official end of life date](https://devguide.python.org/versions/), a 3-month grace period is provided for users to upgrade. Following this grace period, the minimum python version supported in the SDK will be updated. + +The SDK can be installed with *uv*, *pip*, or *poetry* package managers. + +### uv + +*uv* is a fast Python package installer and resolver, designed as a drop-in replacement for pip and pip-tools. It's recommended for its speed and modern Python tooling capabilities. + +```bash +uv add textql-sdk +``` + +### PIP + +*PIP* is the default package installer for Python, enabling easy installation and management of packages from PyPI via the command line. + +```bash +pip install textql-sdk +``` + +### Poetry + +*Poetry* is a modern tool that simplifies dependency management and package publishing by using a single `pyproject.toml` file to handle project metadata and dependencies. + +```bash +poetry add textql-sdk +``` + +### Shell and script usage with `uv` + +You can use this SDK in a Python shell with [uv](https://docs.astral.sh/uv/) and the `uvx` command that comes with it like so: + +```shell +uvx --from textql-sdk python +``` + +It's also possible to write a standalone Python script without needing to set up a whole project like so: + +```python +#!/usr/bin/env -S uv run --script +# /// script +# requires-python = ">=3.10" +# dependencies = [ +# "textql-sdk", +# ] +# /// + +from textql_sdk import Textql + +sdk = Textql( + # SDK arguments +) + +# Rest of script here... +``` + +Once that is saved to a file, you can run it with `uv run script.py` where +`script.py` can be replaced with the actual file name. + + + +## IDE Support + +### PyCharm + +Generally, the SDK will work well with most IDEs out of the box. However, when using PyCharm, you can enjoy much better integration with Pydantic by installing an additional plugin. + +- [PyCharm Pydantic Plugin](https://docs.pydantic.dev/latest/integrations/pycharm/) + + + +## SDK Example Usage + +### Example + +```python +# Synchronous Example +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) +``` + +
+ +The same SDK client can also be used to make asynchronous requests by importing asyncio. + +```python +# Asynchronous Example +import asyncio +import os +from textql_sdk import Textql + +async def main(): + + async with Textql( + api_key=os.getenv("TEXTQL_API_KEY", ""), + ) as textql: + + res = await textql.agents.create_async() + + # Handle response + print(res) + +asyncio.run(main()) +``` + + + +## Authentication + +### Per-Client Security Schemes + +This SDK supports the following security scheme globally: + +| Name | Type | Scheme | Environment Variable | +| --------- | ------ | ------- | -------------------- | +| `api_key` | apiKey | API key | `TEXTQL_API_KEY` | + +To authenticate with the API the `api_key` parameter must be set when initializing the SDK client instance. For example: +```python +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) + +``` + + + +## Available Resources and Operations + +
+Available methods + +### [Agents](https://github.com/TextQLLabs/textql-python-v3/blob/master/docs/sdks/agents/README.md) + +* [create](https://github.com/TextQLLabs/textql-python-v3/blob/master/docs/sdks/agents/README.md#create) - CreateAgent +* [delete](https://github.com/TextQLLabs/textql-python-v3/blob/master/docs/sdks/agents/README.md#delete) - DeleteAgent +* [duplicate](https://github.com/TextQLLabs/textql-python-v3/blob/master/docs/sdks/agents/README.md#duplicate) - DuplicateAgent +* [get_agent](https://github.com/TextQLLabs/textql-python-v3/blob/master/docs/sdks/agents/README.md#get_agent) - GetAgent +* [get_run](https://github.com/TextQLLabs/textql-python-v3/blob/master/docs/sdks/agents/README.md#get_run) - GetAgentRun +* [list_runs](https://github.com/TextQLLabs/textql-python-v3/blob/master/docs/sdks/agents/README.md#list_runs) - ListAgentRuns +* [list](https://github.com/TextQLLabs/textql-python-v3/blob/master/docs/sdks/agents/README.md#list) - ListAgents +* [reset_agent_avatar](https://github.com/TextQLLabs/textql-python-v3/blob/master/docs/sdks/agents/README.md#reset_agent_avatar) - ResetAgentAvatar +* [trigger_agent](https://github.com/TextQLLabs/textql-python-v3/blob/master/docs/sdks/agents/README.md#trigger_agent) - TriggerAgent +* [update](https://github.com/TextQLLabs/textql-python-v3/blob/master/docs/sdks/agents/README.md#update) - UpdateAgent +* [upload_agent_avatar](https://github.com/TextQLLabs/textql-python-v3/blob/master/docs/sdks/agents/README.md#upload_agent_avatar) - UploadAgentAvatar + +### [Apps](https://github.com/TextQLLabs/textql-python-v3/blob/master/docs/sdks/apps/README.md) + +* [heartbeat](https://github.com/TextQLLabs/textql-python-v3/blob/master/docs/sdks/apps/README.md#heartbeat) - Viewer heartbeat: keeps a warm compute worker alive while the app is open so its billed lifetime tracks the view session (mirrors a dashboard's viewer TTL). No-op when the app has no warm worker; never spawns one. +* [create_app](https://github.com/TextQLLabs/textql-python-v3/blob/master/docs/sdks/apps/README.md#create_app) - CreateApp +* [delete_app](https://github.com/TextQLLabs/textql-python-v3/blob/master/docs/sdks/apps/README.md#delete_app) - DeleteApp +* [duplicate](https://github.com/TextQLLabs/textql-python-v3/blob/master/docs/sdks/apps/README.md#duplicate) - Duplicates an app the caller can view into a new draft app they own, named "Copy of ". Copies code/files/data sources/compute functions/ schedule; never carries over the source's published state or data snapshot. +* [get](https://github.com/TextQLLabs/textql-python-v3/blob/master/docs/sdks/apps/README.md#get) - GetApp +* [get_app_version](https://github.com/TextQLLabs/textql-python-v3/blob/master/docs/sdks/apps/README.md#get_app_version) - GetAppVersion +* [get_app_view_stats](https://github.com/TextQLLabs/textql-python-v3/blob/master/docs/sdks/apps/README.md#get_app_view_stats) - View analytics: reads the engagement views recorded on app page load. +* [get_members_with_apps](https://github.com/TextQLLabs/textql-python-v3/blob/master/docs/sdks/apps/README.md#get_members_with_apps) - GetMembersWithApps +* [invoke_compute_function](https://github.com/TextQLLabs/textql-python-v3/blob/master/docs/sdks/apps/README.md#invoke_compute_function) - Executes a declared compute function on a pooled sandbox worker; gated, org-scoped, rate-limited. +* [list_versions](https://github.com/TextQLLabs/textql-python-v3/blob/master/docs/sdks/apps/README.md#list_versions) - Version history: a snapshot is recorded on each publish; authors can list and restore. +* [list](https://github.com/TextQLLabs/textql-python-v3/blob/master/docs/sdks/apps/README.md#list) - ListApps +* [move_app_to_folder](https://github.com/TextQLLabs/textql-python-v3/blob/master/docs/sdks/apps/README.md#move_app_to_folder) - Moves an app into a library folder (or to root when folder_id is empty). +* [refresh](https://github.com/TextQLLabs/textql-python-v3/blob/master/docs/sdks/apps/README.md#refresh) - Re-fetches data sources, rebuilds the document with a fresh snapshot, re-uploads. +* [restore_app_version](https://github.com/TextQLLabs/textql-python-v3/blob/master/docs/sdks/apps/README.md#restore_app_version) - RestoreAppVersion +* [set_favorite](https://github.com/TextQLLabs/textql-python-v3/blob/master/docs/sdks/apps/README.md#set_favorite) - Favorite/unfavorite a library item (app or dashboard) for the calling member. Per-member, per-org; favorited=false hard-deletes the row. Covers both primitives since the merged library page pins apps and dashboards through one client. +* [update](https://github.com/TextQLLabs/textql-python-v3/blob/master/docs/sdks/apps/README.md#update) - UpdateApp + +### [AuditLogs](https://github.com/TextQLLabs/textql-python-v3/blob/master/docs/sdks/auditlogs/README.md) + +* [configure_otlp_export](https://github.com/TextQLLabs/textql-python-v3/blob/master/docs/sdks/auditlogs/README.md#configure_otlp_export) - ConfigureOtlpExport +* [configure_s3_export](https://github.com/TextQLLabs/textql-python-v3/blob/master/docs/sdks/auditlogs/README.md#configure_s3_export) - ConfigureS3Export +* [delete_otlp_export_config](https://github.com/TextQLLabs/textql-python-v3/blob/master/docs/sdks/auditlogs/README.md#delete_otlp_export_config) - DeleteOtlpExportConfig +* [delete_s3_export_config](https://github.com/TextQLLabs/textql-python-v3/blob/master/docs/sdks/auditlogs/README.md#delete_s3_export_config) - DeleteS3ExportConfig +* [get_otlp_export_config](https://github.com/TextQLLabs/textql-python-v3/blob/master/docs/sdks/auditlogs/README.md#get_otlp_export_config) - GetOtlpExportConfig +* [get_s3_export_config](https://github.com/TextQLLabs/textql-python-v3/blob/master/docs/sdks/auditlogs/README.md#get_s3_export_config) - GetS3ExportConfig +* [list](https://github.com/TextQLLabs/textql-python-v3/blob/master/docs/sdks/auditlogs/README.md#list) - ListAuditLogs +* [test_otlp_export_connection](https://github.com/TextQLLabs/textql-python-v3/blob/master/docs/sdks/auditlogs/README.md#test_otlp_export_connection) - TestOtlpExportConnection +* [test_s3_export_connection](https://github.com/TextQLLabs/textql-python-v3/blob/master/docs/sdks/auditlogs/README.md#test_s3_export_connection) - TestS3ExportConnection +* [trigger_otlp_export](https://github.com/TextQLLabs/textql-python-v3/blob/master/docs/sdks/auditlogs/README.md#trigger_otlp_export) - TriggerOtlpExport +* [trigger_s3_export](https://github.com/TextQLLabs/textql-python-v3/blob/master/docs/sdks/auditlogs/README.md#trigger_s3_export) - TriggerS3Export + +### [Chats](https://github.com/TextQLLabs/textql-python-v3/blob/master/docs/sdks/chats/README.md) + +* [approve_context_prompt_change](https://github.com/TextQLLabs/textql-python-v3/blob/master/docs/sdks/chats/README.md#approve_context_prompt_change) - ApproveContextPromptChange +* [approve_ontology_change](https://github.com/TextQLLabs/textql-python-v3/blob/master/docs/sdks/chats/README.md#approve_ontology_change) - Resolve a halted ask_approval form cell. Submit runs the form's submission and continues the agent with the outcome; Reject discards it (passive, no run); Dismiss treats it as a change request (no run, next message says what to change). All three set the cell's outcome, like the other approve/deny cells. +* [attach_agent](https://github.com/TextQLLabs/textql-python-v3/blob/master/docs/sdks/chats/README.md#attach_agent) - External API users +* [attach_app](https://github.com/TextQLLabs/textql-python-v3/blob/master/docs/sdks/chats/README.md#attach_app) - AttachApp +* [attach_dashboard](https://github.com/TextQLLabs/textql-python-v3/blob/master/docs/sdks/chats/README.md#attach_dashboard) - AttachDashboard +* [attach_dataset](https://github.com/TextQLLabs/textql-python-v3/blob/master/docs/sdks/chats/README.md#attach_dataset) - AttachDataset +* [bookmark](https://github.com/TextQLLabs/textql-python-v3/blob/master/docs/sdks/chats/README.md#bookmark) - BookmarkChat +* [cancel_stream](https://github.com/TextQLLabs/textql-python-v3/blob/master/docs/sdks/chats/README.md#cancel_stream) - CancelStream +* [check_permissions](https://github.com/TextQLLabs/textql-python-v3/blob/master/docs/sdks/chats/README.md#check_permissions) - CheckChatPermissions +* [check_health](https://github.com/TextQLLabs/textql-python-v3/blob/master/docs/sdks/chats/README.md#check_health) - CheckHealth +* [check_streamlit_health](https://github.com/TextQLLabs/textql-python-v3/blob/master/docs/sdks/chats/README.md#check_streamlit_health) - CheckStreamlitHealth +* [create_chat](https://github.com/TextQLLabs/textql-python-v3/blob/master/docs/sdks/chats/README.md#create_chat) - CreateChat +* [delete](https://github.com/TextQLLabs/textql-python-v3/blob/master/docs/sdks/chats/README.md#delete) - DeleteChat +* [dismiss_questions](https://github.com/TextQLLabs/textql-python-v3/blob/master/docs/sdks/chats/README.md#dismiss_questions) - DismissQuestions +* [duplicate_chat](https://github.com/TextQLLabs/textql-python-v3/blob/master/docs/sdks/chats/README.md#duplicate_chat) - DuplicateChat +* [get_api_answer](https://github.com/TextQLLabs/textql-python-v3/blob/master/docs/sdks/chats/README.md#get_api_answer) - GetAPIChatAnswer +* [get_artifact](https://github.com/TextQLLabs/textql-python-v3/blob/master/docs/sdks/chats/README.md#get_artifact) - GetArtifact +* [get](https://github.com/TextQLLabs/textql-python-v3/blob/master/docs/sdks/chats/README.md#get) - GetChat +* [get_artifacts_summary](https://github.com/TextQLLabs/textql-python-v3/blob/master/docs/sdks/chats/README.md#get_artifacts_summary) - GetChatArtifactsSummary +* [get_chat_execution_timing](https://github.com/TextQLLabs/textql-python-v3/blob/master/docs/sdks/chats/README.md#get_chat_execution_timing) - GetChatExecutionTiming +* [get_history](https://github.com/TextQLLabs/textql-python-v3/blob/master/docs/sdks/chats/README.md#get_history) - GetChatHistory +* [get_all](https://github.com/TextQLLabs/textql-python-v3/blob/master/docs/sdks/chats/README.md#get_all) - GetChats +* [get_completion_parameters](https://github.com/TextQLLabs/textql-python-v3/blob/master/docs/sdks/chats/README.md#get_completion_parameters) - GetCompletionParameters +* [get_completion_parameters_batch](https://github.com/TextQLLabs/textql-python-v3/blob/master/docs/sdks/chats/README.md#get_completion_parameters_batch) - GetCompletionParametersBatch +* [get_llm_usage](https://github.com/TextQLLabs/textql-python-v3/blob/master/docs/sdks/chats/README.md#get_llm_usage) - GetLlmUsage +* [get_members_with_chats](https://github.com/TextQLLabs/textql-python-v3/blob/master/docs/sdks/chats/README.md#get_members_with_chats) - List distinct chat creators the user can access +* [get_playbook_chats](https://github.com/TextQLLabs/textql-python-v3/blob/master/docs/sdks/chats/README.md#get_playbook_chats) - GetPlaybookChats +* [poll_events](https://github.com/TextQLLabs/textql-python-v3/blob/master/docs/sdks/chats/README.md#poll_events) - PollChatEvents +* [query_one_shot](https://github.com/TextQLLabs/textql-python-v3/blob/master/docs/sdks/chats/README.md#query_one_shot) - QueryOneShot +* [rate_cell](https://github.com/TextQLLabs/textql-python-v3/blob/master/docs/sdks/chats/README.md#rate_cell) - RateChatCell appends a row to cell_rating for every click; thumbs-down also upserts a user_thumbs_down thread_warning. +* [reject_context_prompt_change](https://github.com/TextQLLabs/textql-python-v3/blob/master/docs/sdks/chats/README.md#reject_context_prompt_change) - RejectContextPromptChange +* [reject_ontology_change](https://github.com/TextQLLabs/textql-python-v3/blob/master/docs/sdks/chats/README.md#reject_ontology_change) - RejectOntologyChange +* [run](https://github.com/TextQLLabs/textql-python-v3/blob/master/docs/sdks/chats/README.md#run) - RunChat +* [send](https://github.com/TextQLLabs/textql-python-v3/blob/master/docs/sdks/chats/README.md#send) - SendMessage +* [submit_context_prompt_change](https://github.com/TextQLLabs/textql-python-v3/blob/master/docs/sdks/chats/README.md#submit_context_prompt_change) - SubmitContextPromptChange +* [submit_questions](https://github.com/TextQLLabs/textql-python-v3/blob/master/docs/sdks/chats/README.md#submit_questions) - Resolve a halted questions cell. Submit hands the answers to the agent and resumes it; Dismiss hands over only the answered count and does NOT resume (the user's next message becomes the dismissal reason). +* [unbookmark](https://github.com/TextQLLabs/textql-python-v3/blob/master/docs/sdks/chats/README.md#unbookmark) - UnbookmarkChat +* [update](https://github.com/TextQLLabs/textql-python-v3/blob/master/docs/sdks/chats/README.md#update) - UpdateChat + +### [Connectors](https://github.com/TextQLLabs/textql-python-v3/blob/master/docs/sdks/connectors/README.md) + +* [create](https://github.com/TextQLLabs/textql-python-v3/blob/master/docs/sdks/connectors/README.md#create) - CreateConnector +* [delete](https://github.com/TextQLLabs/textql-python-v3/blob/master/docs/sdks/connectors/README.md#delete) - DeleteConnector +* [duplicate_connector](https://github.com/TextQLLabs/textql-python-v3/blob/master/docs/sdks/connectors/README.md#duplicate_connector) - DuplicateConnector +* [execute_query](https://github.com/TextQLLabs/textql-python-v3/blob/master/docs/sdks/connectors/README.md#execute_query) - ExecuteQuery +* [get](https://github.com/TextQLLabs/textql-python-v3/blob/master/docs/sdks/connectors/README.md#get) - GetConnector +* [get_connector_cell_durations](https://github.com/TextQLLabs/textql-python-v3/blob/master/docs/sdks/connectors/README.md#get_connector_cell_durations) - GetConnectorCellDurations +* [get_chats](https://github.com/TextQLLabs/textql-python-v3/blob/master/docs/sdks/connectors/README.md#get_chats) - GetConnectorChats +* [get_dashboards](https://github.com/TextQLLabs/textql-python-v3/blob/master/docs/sdks/connectors/README.md#get_dashboards) - GetConnectorDashboards +* [get_connector_stats](https://github.com/TextQLLabs/textql-python-v3/blob/master/docs/sdks/connectors/README.md#get_connector_stats) - GetConnectorStats +* [get_usage](https://github.com/TextQLLabs/textql-python-v3/blob/master/docs/sdks/connectors/README.md#get_usage) - GetConnectorUsage +* [get_connectors](https://github.com/TextQLLabs/textql-python-v3/blob/master/docs/sdks/connectors/README.md#get_connectors) - GetConnectors +* [get_example_queries](https://github.com/TextQLLabs/textql-python-v3/blob/master/docs/sdks/connectors/README.md#get_example_queries) - GetExampleQueries +* [get_table_preview](https://github.com/TextQLLabs/textql-python-v3/blob/master/docs/sdks/connectors/README.md#get_table_preview) - GetTablePreview +* [list_tables](https://github.com/TextQLLabs/textql-python-v3/blob/master/docs/sdks/connectors/README.md#list_tables) - ListConnectorTables +* [list_query_templates](https://github.com/TextQLLabs/textql-python-v3/blob/master/docs/sdks/connectors/README.md#list_query_templates) - ListQueryTemplates +* [test](https://github.com/TextQLLabs/textql-python-v3/blob/master/docs/sdks/connectors/README.md#test) - TestConnector +* [update](https://github.com/TextQLLabs/textql-python-v3/blob/master/docs/sdks/connectors/README.md#update) - UpdateConnector + +### [Dashboards](https://github.com/TextQLLabs/textql-python-v3/blob/master/docs/sdks/dashboards/README.md) + +* [check_health](https://github.com/TextQLLabs/textql-python-v3/blob/master/docs/sdks/dashboards/README.md#check_health) - CheckDashboardHealth +* [create_dashboard](https://github.com/TextQLLabs/textql-python-v3/blob/master/docs/sdks/dashboards/README.md#create_dashboard) - CRUD operations +* [create_folder](https://github.com/TextQLLabs/textql-python-v3/blob/master/docs/sdks/dashboards/README.md#create_folder) - Folder management +* [delete](https://github.com/TextQLLabs/textql-python-v3/blob/master/docs/sdks/dashboards/README.md#delete) - DeleteDashboard +* [delete_folder](https://github.com/TextQLLabs/textql-python-v3/blob/master/docs/sdks/dashboards/README.md#delete_folder) - DeleteDashboardFolder +* [discard_changes](https://github.com/TextQLLabs/textql-python-v3/blob/master/docs/sdks/dashboards/README.md#discard_changes) - DiscardDashboardChanges +* [duplicate](https://github.com/TextQLLabs/textql-python-v3/blob/master/docs/sdks/dashboards/README.md#duplicate) - DuplicateDashboard +* [get](https://github.com/TextQLLabs/textql-python-v3/blob/master/docs/sdks/dashboards/README.md#get) - GetDashboard +* [get_version](https://github.com/TextQLLabs/textql-python-v3/blob/master/docs/sdks/dashboards/README.md#get_version) - GetDashboardVersion +* [get_dashboard_view_stats](https://github.com/TextQLLabs/textql-python-v3/blob/master/docs/sdks/dashboards/README.md#get_dashboard_view_stats) - View analytics +* [get_members_with_dashboards](https://github.com/TextQLLabs/textql-python-v3/blob/master/docs/sdks/dashboards/README.md#get_members_with_dashboards) - Member management +* [list_folders](https://github.com/TextQLLabs/textql-python-v3/blob/master/docs/sdks/dashboards/README.md#list_folders) - ListDashboardFolders +* [list_versions](https://github.com/TextQLLabs/textql-python-v3/blob/master/docs/sdks/dashboards/README.md#list_versions) - Version history +* [list](https://github.com/TextQLLabs/textql-python-v3/blob/master/docs/sdks/dashboards/README.md#list) - ListDashboards +* [move_to_folder](https://github.com/TextQLLabs/textql-python-v3/blob/master/docs/sdks/dashboards/README.md#move_to_folder) - MoveDashboardToFolder +* [preview_config](https://github.com/TextQLLabs/textql-python-v3/blob/master/docs/sdks/dashboards/README.md#preview_config) - Config-managed dashboards: render a `.dashboard` straight from a patch ref before it merges (ADR-0022). Runs as the file's run_as, gated on the previewer being authorized for it; persists nothing. +* [publish](https://github.com/TextQLLabs/textql-python-v3/blob/master/docs/sdks/dashboards/README.md#publish) - Publishing workflow +* [regenerate_screenshot](https://github.com/TextQLLabs/textql-python-v3/blob/master/docs/sdks/dashboards/README.md#regenerate_screenshot) - Screenshot management +* [restore_dashboard_version](https://github.com/TextQLLabs/textql-python-v3/blob/master/docs/sdks/dashboards/README.md#restore_dashboard_version) - RestoreDashboardVersion +* [run_scheduled_dashboard](https://github.com/TextQLLabs/textql-python-v3/blob/master/docs/sdks/dashboards/README.md#run_scheduled_dashboard) - RunScheduledDashboard +* [spawn](https://github.com/TextQLLabs/textql-python-v3/blob/master/docs/sdks/dashboards/README.md#spawn) - Dashboard execution +* [update_dashboard](https://github.com/TextQLLabs/textql-python-v3/blob/master/docs/sdks/dashboards/README.md#update_dashboard) - UpdateDashboard +* [update_dashboard_folder](https://github.com/TextQLLabs/textql-python-v3/blob/master/docs/sdks/dashboards/README.md#update_dashboard_folder) - UpdateDashboardFolder +* [update_dashboard_schedule](https://github.com/TextQLLabs/textql-python-v3/blob/master/docs/sdks/dashboards/README.md#update_dashboard_schedule) - Scheduling + +### [Datasets](https://github.com/TextQLLabs/textql-python-v3/blob/master/docs/sdks/datasets/README.md) + +* [create_folder](https://github.com/TextQLLabs/textql-python-v3/blob/master/docs/sdks/datasets/README.md#create_folder) - CreateFolder +* [create_power_bi_dataset](https://github.com/TextQLLabs/textql-python-v3/blob/master/docs/sdks/datasets/README.md#create_power_bi_dataset) - CreatePowerBIDataset +* [create_tableau_dataset](https://github.com/TextQLLabs/textql-python-v3/blob/master/docs/sdks/datasets/README.md#create_tableau_dataset) - Create Tableau dataset from views/datasources +* [create_upload_presign_url](https://github.com/TextQLLabs/textql-python-v3/blob/master/docs/sdks/datasets/README.md#create_upload_presign_url) - uploads +* [delete](https://github.com/TextQLLabs/textql-python-v3/blob/master/docs/sdks/datasets/README.md#delete) - Delete a dataset (soft delete) +* [export](https://github.com/TextQLLabs/textql-python-v3/blob/master/docs/sdks/datasets/README.md#export) - export dataset in "raw" format – original if dataset is uploaded, converted format otherwise (defaults to CSV) +* [fetch](https://github.com/TextQLLabs/textql-python-v3/blob/master/docs/sdks/datasets/README.md#fetch) - GetDataset, GetDatasets only return metadata +* [get_stats](https://github.com/TextQLLabs/textql-python-v3/blob/master/docs/sdks/datasets/README.md#get_stats) - GetDatasetStats +* [get_dataset_values](https://github.com/TextQLLabs/textql-python-v3/blob/master/docs/sdks/datasets/README.md#get_dataset_values) - GetDatasetValues +* [get](https://github.com/TextQLLabs/textql-python-v3/blob/master/docs/sdks/datasets/README.md#get) - GetDatasets +* [get_by_ids](https://github.com/TextQLLabs/textql-python-v3/blob/master/docs/sdks/datasets/README.md#get_by_ids) - GetDatasetsByIds +* [get_folders](https://github.com/TextQLLabs/textql-python-v3/blob/master/docs/sdks/datasets/README.md#get_folders) - for AR: CreateFolderACL, UpdateFolderACL, DeleteFolderACL +* [process_upload_presign_url](https://github.com/TextQLLabs/textql-python-v3/blob/master/docs/sdks/datasets/README.md#process_upload_presign_url) - ProcessUploadPresignUrl +* [update_dataset](https://github.com/TextQLLabs/textql-python-v3/blob/master/docs/sdks/datasets/README.md#update_dataset) - Update dataset metadata + +### [Libraries](https://github.com/TextQLLabs/textql-python-v3/blob/master/docs/sdks/libraries/README.md) + +* [add_submodule](https://github.com/TextQLLabs/textql-python-v3/blob/master/docs/sdks/libraries/README.md#add_submodule) - AddLibrarySubmodule +* [approve_patch](https://github.com/TextQLLabs/textql-python-v3/blob/master/docs/sdks/libraries/README.md#approve_patch) - ApprovePatch +* [configure_library_remote](https://github.com/TextQLLabs/textql-python-v3/blob/master/docs/sdks/libraries/README.md#configure_library_remote) - ConfigureLibraryRemote +* [create_approval_rule](https://github.com/TextQLLabs/textql-python-v3/blob/master/docs/sdks/libraries/README.md#create_approval_rule) - CreateApprovalRule +* [create_context_patch_auto_approve_rule](https://github.com/TextQLLabs/textql-python-v3/blob/master/docs/sdks/libraries/README.md#create_context_patch_auto_approve_rule) - CreateContextPatchAutoApproveRule +* [create_library_directory](https://github.com/TextQLLabs/textql-python-v3/blob/master/docs/sdks/libraries/README.md#create_library_directory) - CreateLibraryDirectory +* [create_file_upload_url](https://github.com/TextQLLabs/textql-python-v3/blob/master/docs/sdks/libraries/README.md#create_file_upload_url) - CreateLibraryFileUploadUrl +* [delete_approval_rule](https://github.com/TextQLLabs/textql-python-v3/blob/master/docs/sdks/libraries/README.md#delete_approval_rule) - DeleteApprovalRule +* [delete_context_patch_auto_approve_rule](https://github.com/TextQLLabs/textql-python-v3/blob/master/docs/sdks/libraries/README.md#delete_context_patch_auto_approve_rule) - DeleteContextPatchAutoApproveRule +* [delete_library_directory](https://github.com/TextQLLabs/textql-python-v3/blob/master/docs/sdks/libraries/README.md#delete_library_directory) - DeleteLibraryDirectory +* [delete_library_file](https://github.com/TextQLLabs/textql-python-v3/blob/master/docs/sdks/libraries/README.md#delete_library_file) - DeleteLibraryFile +* [delete_owners](https://github.com/TextQLLabs/textql-python-v3/blob/master/docs/sdks/libraries/README.md#delete_owners) - DeleteLibraryOwners +* [deny_patch](https://github.com/TextQLLabs/textql-python-v3/blob/master/docs/sdks/libraries/README.md#deny_patch) - DenyPatch +* [exchange_github_code](https://github.com/TextQLLabs/textql-python-v3/blob/master/docs/sdks/libraries/README.md#exchange_github_code) - ExchangeLibraryGithubCode +* [finalize_file_upload](https://github.com/TextQLLabs/textql-python-v3/blob/master/docs/sdks/libraries/README.md#finalize_file_upload) - FinalizeLibraryFileUpload +* [get_codeowner_coverage](https://github.com/TextQLLabs/textql-python-v3/blob/master/docs/sdks/libraries/README.md#get_codeowner_coverage) - GetCodeownerCoverage +* [get_config_export_capabilities](https://github.com/TextQLLabs/textql-python-v3/blob/master/docs/sdks/libraries/README.md#get_config_export_capabilities) - GetConfigExportCapabilities +* [get_effective_owners](https://github.com/TextQLLabs/textql-python-v3/blob/master/docs/sdks/libraries/README.md#get_effective_owners) - GetEffectiveLibraryOwners +* [get_file_usage](https://github.com/TextQLLabs/textql-python-v3/blob/master/docs/sdks/libraries/README.md#get_file_usage) - GetFileUsage +* [get_file_usage_timeline](https://github.com/TextQLLabs/textql-python-v3/blob/master/docs/sdks/libraries/README.md#get_file_usage_timeline) - GetFileUsageTimeline +* [get_ana_config](https://github.com/TextQLLabs/textql-python-v3/blob/master/docs/sdks/libraries/README.md#get_ana_config) - GetLibraryAnaConfig +* [get_file](https://github.com/TextQLLabs/textql-python-v3/blob/master/docs/sdks/libraries/README.md#get_file) - GetLibraryFile +* [get_library_github_o_auth_url](https://github.com/TextQLLabs/textql-python-v3/blob/master/docs/sdks/libraries/README.md#get_library_github_o_auth_url) - GetLibraryGithubOAuthURL +* [get_history_file_diff](https://github.com/TextQLLabs/textql-python-v3/blob/master/docs/sdks/libraries/README.md#get_history_file_diff) - GetLibraryHistoryFileDiff +* [get_migration_status](https://github.com/TextQLLabs/textql-python-v3/blob/master/docs/sdks/libraries/README.md#get_migration_status) - GetLibraryMigrationStatus +* [get_library_owners](https://github.com/TextQLLabs/textql-python-v3/blob/master/docs/sdks/libraries/README.md#get_library_owners) - GetLibraryOwners +* [get_remote](https://github.com/TextQLLabs/textql-python-v3/blob/master/docs/sdks/libraries/README.md#get_remote) - GetLibraryRemote +* [get_size_timeline](https://github.com/TextQLLabs/textql-python-v3/blob/master/docs/sdks/libraries/README.md#get_size_timeline) - GetLibrarySizeTimeline +* [get_library_sync_conflicts](https://github.com/TextQLLabs/textql-python-v3/blob/master/docs/sdks/libraries/README.md#get_library_sync_conflicts) - GetLibrarySyncConflicts +* [get_ontology_usage_summary](https://github.com/TextQLLabs/textql-python-v3/blob/master/docs/sdks/libraries/README.md#get_ontology_usage_summary) - GetOntologyUsageSummary +* [get_patch](https://github.com/TextQLLabs/textql-python-v3/blob/master/docs/sdks/libraries/README.md#get_patch) - GetPatch +* [get_patch_by_number](https://github.com/TextQLLabs/textql-python-v3/blob/master/docs/sdks/libraries/README.md#get_patch_by_number) - GetPatchByNumber +* [get_patch_capabilities](https://github.com/TextQLLabs/textql-python-v3/blob/master/docs/sdks/libraries/README.md#get_patch_capabilities) - GetPatchCapabilities +* [get_raw_patch](https://github.com/TextQLLabs/textql-python-v3/blob/master/docs/sdks/libraries/README.md#get_raw_patch) - GetRawPatch +* [get_usage_details_for_file](https://github.com/TextQLLabs/textql-python-v3/blob/master/docs/sdks/libraries/README.md#get_usage_details_for_file) - GetUsageDetailsForFile +* [list_approval_rules](https://github.com/TextQLLabs/textql-python-v3/blob/master/docs/sdks/libraries/README.md#list_approval_rules) - ListApprovalRules +* [list_chats_for_file](https://github.com/TextQLLabs/textql-python-v3/blob/master/docs/sdks/libraries/README.md#list_chats_for_file) - ListChatsForFile +* [list_context_patch_auto_approve_rules](https://github.com/TextQLLabs/textql-python-v3/blob/master/docs/sdks/libraries/README.md#list_context_patch_auto_approve_rules) - ListContextPatchAutoApproveRules +* [list_library_entries](https://github.com/TextQLLabs/textql-python-v3/blob/master/docs/sdks/libraries/README.md#list_library_entries) - ListLibraryEntries +* [list_library_history](https://github.com/TextQLLabs/textql-python-v3/blob/master/docs/sdks/libraries/README.md#list_library_history) - ListLibraryHistory +* [list_imports](https://github.com/TextQLLabs/textql-python-v3/blob/master/docs/sdks/libraries/README.md#list_imports) - ListLibraryImports +* [list_library_submodules](https://github.com/TextQLLabs/textql-python-v3/blob/master/docs/sdks/libraries/README.md#list_library_submodules) - ListLibrarySubmodules +* [list_library_sync_runs](https://github.com/TextQLLabs/textql-python-v3/blob/master/docs/sdks/libraries/README.md#list_library_sync_runs) - ListLibrarySyncRuns +* [list_patch_reviewers](https://github.com/TextQLLabs/textql-python-v3/blob/master/docs/sdks/libraries/README.md#list_patch_reviewers) - ListPatchReviewers +* [list_patches](https://github.com/TextQLLabs/textql-python-v3/blob/master/docs/sdks/libraries/README.md#list_patches) - ListPatches +* [list_skills](https://github.com/TextQLLabs/textql-python-v3/blob/master/docs/sdks/libraries/README.md#list_skills) - Lists the skills under the library's flat skills/ root that the caller can read (OWNERS-filtered). Returns display metadata only — never instruction bodies — feeding the chat composer's `/` autocomplete. +* [migrate_legacy_context](https://github.com/TextQLLabs/textql-python-v3/blob/master/docs/sdks/libraries/README.md#migrate_legacy_context) - MigrateLegacyContextToLibrary +* [migrate_ontology](https://github.com/TextQLLabs/textql-python-v3/blob/master/docs/sdks/libraries/README.md#migrate_ontology) - MigrateOntologyToLibrary +* [plan_merge](https://github.com/TextQLLabs/textql-python-v3/blob/master/docs/sdks/libraries/README.md#plan_merge) - PlanLibraryMerge +* [preview_library_pull_from_remote](https://github.com/TextQLLabs/textql-python-v3/blob/master/docs/sdks/libraries/README.md#preview_library_pull_from_remote) - PreviewLibraryPullFromRemote +* [pull_from_remote](https://github.com/TextQLLabs/textql-python-v3/blob/master/docs/sdks/libraries/README.md#pull_from_remote) - PullLibraryFromRemote +* [push_library_to_remote](https://github.com/TextQLLabs/textql-python-v3/blob/master/docs/sdks/libraries/README.md#push_library_to_remote) - PushLibraryToRemote +* [recover](https://github.com/TextQLLabs/textql-python-v3/blob/master/docs/sdks/libraries/README.md#recover) - RecoverLibrary +* [remove_remote](https://github.com/TextQLLabs/textql-python-v3/blob/master/docs/sdks/libraries/README.md#remove_remote) - RemoveLibraryRemote +* [remove_library_submodule](https://github.com/TextQLLabs/textql-python-v3/blob/master/docs/sdks/libraries/README.md#remove_library_submodule) - RemoveLibrarySubmodule +* [rename_file](https://github.com/TextQLLabs/textql-python-v3/blob/master/docs/sdks/libraries/README.md#rename_file) - RenameLibraryFile +* [request_patch_review](https://github.com/TextQLLabs/textql-python-v3/blob/master/docs/sdks/libraries/README.md#request_patch_review) - RequestPatchReview +* [resolve_sync_conflict](https://github.com/TextQLLabs/textql-python-v3/blob/master/docs/sdks/libraries/README.md#resolve_sync_conflict) - ResolveLibrarySyncConflict +* [restore_patch](https://github.com/TextQLLabs/textql-python-v3/blob/master/docs/sdks/libraries/README.md#restore_patch) - RestorePatch +* [revert_patch](https://github.com/TextQLLabs/textql-python-v3/blob/master/docs/sdks/libraries/README.md#revert_patch) - RevertPatch +* [save_all_objects_as_config](https://github.com/TextQLLabs/textql-python-v3/blob/master/docs/sdks/libraries/README.md#save_all_objects_as_config) - SaveAllObjectsAsConfig +* [save_as_config](https://github.com/TextQLLabs/textql-python-v3/blob/master/docs/sdks/libraries/README.md#save_as_config) - SaveObjectAsConfig +* [trigger_config_drift_reconcile](https://github.com/TextQLLabs/textql-python-v3/blob/master/docs/sdks/libraries/README.md#trigger_config_drift_reconcile) - TriggerConfigDriftReconcile forces an immediate config-sync catch-up for the caller's org: if the Library repo's live HEAD differs from the last reconciled commit, it enqueues a reconcile (otherwise no-op). The on-demand equivalent of waiting for the periodic drift scan. +* [update_approval_rule](https://github.com/TextQLLabs/textql-python-v3/blob/master/docs/sdks/libraries/README.md#update_approval_rule) - UpdateApprovalRule +* [update_context_patch_auto_approve_rule](https://github.com/TextQLLabs/textql-python-v3/blob/master/docs/sdks/libraries/README.md#update_context_patch_auto_approve_rule) - UpdateContextPatchAutoApproveRule +* [update_library_sync_config](https://github.com/TextQLLabs/textql-python-v3/blob/master/docs/sdks/libraries/README.md#update_library_sync_config) - UpdateLibrarySyncConfig +* [upsert_ana_config](https://github.com/TextQLLabs/textql-python-v3/blob/master/docs/sdks/libraries/README.md#upsert_ana_config) - UpsertLibraryAnaConfig +* [upsert_library_file](https://github.com/TextQLLabs/textql-python-v3/blob/master/docs/sdks/libraries/README.md#upsert_library_file) - UpsertLibraryFile +* [upsert_owners](https://github.com/TextQLLabs/textql-python-v3/blob/master/docs/sdks/libraries/README.md#upsert_owners) - UpsertLibraryOwners +* [validate_config](https://github.com/TextQLLabs/textql-python-v3/blob/master/docs/sdks/libraries/README.md#validate_config) - Read-only functional validation of a proposed config: parse + dependency resolution/reachability, no authorization and no persistence. "ok" means functionally valid, not "guaranteed to merge" — the merge gate re-checks authorization at approve time. + +### [LibraryService](https://github.com/TextQLLabs/textql-python-v3/blob/master/docs/sdks/libraryservice/README.md) + +* [library_service_list_golden_files](https://github.com/TextQLLabs/textql-python-v3/blob/master/docs/sdks/libraryservice/README.md#library_service_list_golden_files) - ListGoldenFiles +* [library_service_set_library_file_golden](https://github.com/TextQLLabs/textql-python-v3/blob/master/docs/sdks/libraryservice/README.md#library_service_set_library_file_golden) - SetLibraryFileGolden + +### [Mcp](https://github.com/TextQLLabs/textql-python-v3/blob/master/docs/sdks/mcp/README.md) + +* [clear_o_auth_token](https://github.com/TextQLLabs/textql-python-v3/blob/master/docs/sdks/mcp/README.md#clear_o_auth_token) - ClearOAuthToken +* [delete](https://github.com/TextQLLabs/textql-python-v3/blob/master/docs/sdks/mcp/README.md#delete) - DeleteMCPServer +* [get_servers](https://github.com/TextQLLabs/textql-python-v3/blob/master/docs/sdks/mcp/README.md#get_servers) - GetMCPServers +* [handle_o_auth_callback](https://github.com/TextQLLabs/textql-python-v3/blob/master/docs/sdks/mcp/README.md#handle_o_auth_callback) - HandleOAuthCallback +* [initiate_o_auth_flow](https://github.com/TextQLLabs/textql-python-v3/blob/master/docs/sdks/mcp/README.md#initiate_o_auth_flow) - InitiateOAuthFlow +* [toggle_server](https://github.com/TextQLLabs/textql-python-v3/blob/master/docs/sdks/mcp/README.md#toggle_server) - ToggleMCPServer +* [upsert_mcp_servers](https://github.com/TextQLLabs/textql-python-v3/blob/master/docs/sdks/mcp/README.md#upsert_mcp_servers) - UpsertMCPServers + +### [MetricsExports](https://github.com/TextQLLabs/textql-python-v3/blob/master/docs/sdks/metricsexports/README.md) + +* [configure](https://github.com/TextQLLabs/textql-python-v3/blob/master/docs/sdks/metricsexports/README.md#configure) - ConfigureMetricsExport +* [delete_config](https://github.com/TextQLLabs/textql-python-v3/blob/master/docs/sdks/metricsexports/README.md#delete_config) - DeleteMetricsExportConfig +* [get_metrics_export_config](https://github.com/TextQLLabs/textql-python-v3/blob/master/docs/sdks/metricsexports/README.md#get_metrics_export_config) - GetMetricsExportConfig +* [test_connection](https://github.com/TextQLLabs/textql-python-v3/blob/master/docs/sdks/metricsexports/README.md#test_connection) - TestMetricsExportConnection +* [trigger_push](https://github.com/TextQLLabs/textql-python-v3/blob/master/docs/sdks/metricsexports/README.md#trigger_push) - TriggerMetricsPush + +### [Observability](https://github.com/TextQLLabs/textql-python-v3/blob/master/docs/sdks/observability/README.md) + +* [activate_custom_topic](https://github.com/TextQLLabs/textql-python-v3/blob/master/docs/sdks/observability/README.md#activate_custom_topic) - ActivateCustomTopic +* [backfill_custom_topic](https://github.com/TextQLLabs/textql-python-v3/blob/master/docs/sdks/observability/README.md#backfill_custom_topic) - BackfillCustomTopic +* [backfill_thread_warnings](https://github.com/TextQLLabs/textql-python-v3/blob/master/docs/sdks/observability/README.md#backfill_thread_warnings) - BackfillThreadWarnings +* [create_custom_topic](https://github.com/TextQLLabs/textql-python-v3/blob/master/docs/sdks/observability/README.md#create_custom_topic) - CreateCustomTopic +* [deactivate_custom_topic](https://github.com/TextQLLabs/textql-python-v3/blob/master/docs/sdks/observability/README.md#deactivate_custom_topic) - DeactivateCustomTopic +* [delete_custom_topic](https://github.com/TextQLLabs/textql-python-v3/blob/master/docs/sdks/observability/README.md#delete_custom_topic) - DeleteCustomTopic +* [export_csv](https://github.com/TextQLLabs/textql-python-v3/blob/master/docs/sdks/observability/README.md#export_csv) - ExportObservabilityCsv +* [fix_check_record](https://github.com/TextQLLabs/textql-python-v3/blob/master/docs/sdks/observability/README.md#fix_check_record) - FixCheckRecord +* [fix_warning](https://github.com/TextQLLabs/textql-python-v3/blob/master/docs/sdks/observability/README.md#fix_warning) - FixWarning +* [get_access_method_stats](https://github.com/TextQLLabs/textql-python-v3/blob/master/docs/sdks/observability/README.md#get_access_method_stats) - GetAccessMethodStats +* [get_active_people_stats](https://github.com/TextQLLabs/textql-python-v3/blob/master/docs/sdks/observability/README.md#get_active_people_stats) - GetActivePeopleStats +* [get_active_people_trend](https://github.com/TextQLLabs/textql-python-v3/blob/master/docs/sdks/observability/README.md#get_active_people_trend) - GetActivePeopleTrend +* [get_backfill_preview](https://github.com/TextQLLabs/textql-python-v3/blob/master/docs/sdks/observability/README.md#get_backfill_preview) - GetBackfillPreview +* [get_backfill_status](https://github.com/TextQLLabs/textql-python-v3/blob/master/docs/sdks/observability/README.md#get_backfill_status) - GetBackfillStatus +* [get_billing_stats](https://github.com/TextQLLabs/textql-python-v3/blob/master/docs/sdks/observability/README.md#get_billing_stats) - GetBillingStats +* [get_chat_source_stats](https://github.com/TextQLLabs/textql-python-v3/blob/master/docs/sdks/observability/README.md#get_chat_source_stats) - GetChatSourceStats +* [get_chat_topics](https://github.com/TextQLLabs/textql-python-v3/blob/master/docs/sdks/observability/README.md#get_chat_topics) - GetChatTopics +* [get_check_record_fix](https://github.com/TextQLLabs/textql-python-v3/blob/master/docs/sdks/observability/README.md#get_check_record_fix) - GetCheckRecordFix +* [get_custom_topic](https://github.com/TextQLLabs/textql-python-v3/blob/master/docs/sdks/observability/README.md#get_custom_topic) - GetCustomTopic +* [get_custom_topic_people](https://github.com/TextQLLabs/textql-python-v3/blob/master/docs/sdks/observability/README.md#get_custom_topic_people) - GetCustomTopicPeople +* [get_custom_topic_threads](https://github.com/TextQLLabs/textql-python-v3/blob/master/docs/sdks/observability/README.md#get_custom_topic_threads) - GetCustomTopicThreads +* [get_engagement_spectrum](https://github.com/TextQLLabs/textql-python-v3/blob/master/docs/sdks/observability/README.md#get_engagement_spectrum) - GetEngagementSpectrum +* [get_member_activity](https://github.com/TextQLLabs/textql-python-v3/blob/master/docs/sdks/observability/README.md#get_member_activity) - GetMemberActivity +* [get_observability_stats](https://github.com/TextQLLabs/textql-python-v3/blob/master/docs/sdks/observability/README.md#get_observability_stats) - GetObservabilityStats +* [get_thread_warnings](https://github.com/TextQLLabs/textql-python-v3/blob/master/docs/sdks/observability/README.md#get_thread_warnings) - GetThreadWarnings +* [list_custom_topics](https://github.com/TextQLLabs/textql-python-v3/blob/master/docs/sdks/observability/README.md#list_custom_topics) - ListCustomTopics +* [refine_draft](https://github.com/TextQLLabs/textql-python-v3/blob/master/docs/sdks/observability/README.md#refine_draft) - Custom topics +* [set_topic_tag_feedback](https://github.com/TextQLLabs/textql-python-v3/blob/master/docs/sdks/observability/README.md#set_topic_tag_feedback) - SetTopicTagFeedback +* [update_custom_topic](https://github.com/TextQLLabs/textql-python-v3/blob/master/docs/sdks/observability/README.md#update_custom_topic) - UpdateCustomTopic + +### [Playbooks](https://github.com/TextQLLabs/textql-python-v3/blob/master/docs/sdks/playbooks/README.md) + +* [attach_dashboard](https://github.com/TextQLLabs/textql-python-v3/blob/master/docs/sdks/playbooks/README.md#attach_dashboard) - AttachDashboard +* [attach_dataset](https://github.com/TextQLLabs/textql-python-v3/blob/master/docs/sdks/playbooks/README.md#attach_dataset) - AttachDataset +* [cancel_template_execution](https://github.com/TextQLLabs/textql-python-v3/blob/master/docs/sdks/playbooks/README.md#cancel_template_execution) - Cancel template execution for a specific template header +* [create_playbook](https://github.com/TextQLLabs/textql-python-v3/blob/master/docs/sdks/playbooks/README.md#create_playbook) - CreatePlaybook +* [deactivate](https://github.com/TextQLLabs/textql-python-v3/blob/master/docs/sdks/playbooks/README.md#deactivate) - DeactivatePlaybook +* [delete](https://github.com/TextQLLabs/textql-python-v3/blob/master/docs/sdks/playbooks/README.md#delete) - DeletePlaybook +* [demo_playbook](https://github.com/TextQLLabs/textql-python-v3/blob/master/docs/sdks/playbooks/README.md#demo_playbook) - DemoPlaybook +* [deploy](https://github.com/TextQLLabs/textql-python-v3/blob/master/docs/sdks/playbooks/README.md#deploy) - DeployPlaybook +* [duplicate](https://github.com/TextQLLabs/textql-python-v3/blob/master/docs/sdks/playbooks/README.md#duplicate) - DuplicatePlaybook +* [favorite_report](https://github.com/TextQLLabs/textql-python-v3/blob/master/docs/sdks/playbooks/README.md#favorite_report) - Favorite report management +* [get_active_subscribed_count](https://github.com/TextQLLabs/textql-python-v3/blob/master/docs/sdks/playbooks/README.md#get_active_subscribed_count) - GetActiveSubscribedPlaybooksCount +* [get_chat_reports_summary](https://github.com/TextQLLabs/textql-python-v3/blob/master/docs/sdks/playbooks/README.md#get_chat_reports_summary) - Lightweight endpoint for chat report drawer - returns summaries without full blocks +* [get_members_with](https://github.com/TextQLLabs/textql-python-v3/blob/master/docs/sdks/playbooks/README.md#get_members_with) - GetMembersWithPlaybooks +* [fetch](https://github.com/TextQLLabs/textql-python-v3/blob/master/docs/sdks/playbooks/README.md#fetch) - GetPlaybook +* [get_batch_run](https://github.com/TextQLLabs/textql-python-v3/blob/master/docs/sdks/playbooks/README.md#get_batch_run) - Get a specific batch run +* [get_playbook_lineage](https://github.com/TextQLLabs/textql-python-v3/blob/master/docs/sdks/playbooks/README.md#get_playbook_lineage) - GetPlaybookLineage +* [get_reports](https://github.com/TextQLLabs/textql-python-v3/blob/master/docs/sdks/playbooks/README.md#get_reports) - GetPlaybookReports +* [get_playbook_reports_batch](https://github.com/TextQLLabs/textql-python-v3/blob/master/docs/sdks/playbooks/README.md#get_playbook_reports_batch) - Get reports for multiple template data IDs in a single batch request +* [get](https://github.com/TextQLLabs/textql-python-v3/blob/master/docs/sdks/playbooks/README.md#get) - GetPlaybooks +* [get_playbooks_previews](https://github.com/TextQLLabs/textql-python-v3/blob/master/docs/sdks/playbooks/README.md#get_playbooks_previews) - GetPlaybooksPreviews +* [get_report_by_id](https://github.com/TextQLLabs/textql-python-v3/blob/master/docs/sdks/playbooks/README.md#get_report_by_id) - Get a single report by ID +* [get_reports_with_filters](https://github.com/TextQLLabs/textql-python-v3/blob/master/docs/sdks/playbooks/README.md#get_reports_with_filters) - GetReportsWithFilters +* [list_slack_channel_context_playbooks](https://github.com/TextQLLabs/textql-python-v3/blob/master/docs/sdks/playbooks/README.md#list_slack_channel_context_playbooks) - List all Slack channels context playbook mappings for the organization +* [list_all_teams_channel_context_playbooks](https://github.com/TextQLLabs/textql-python-v3/blob/master/docs/sdks/playbooks/README.md#list_all_teams_channel_context_playbooks) - ListAllTeamsChannelContextPlaybooks +* [list_batch_runs](https://github.com/TextQLLabs/textql-python-v3/blob/master/docs/sdks/playbooks/README.md#list_batch_runs) - List batch runs for a playbook +* [list_slack_channels_for_context](https://github.com/TextQLLabs/textql-python-v3/blob/master/docs/sdks/playbooks/README.md#list_slack_channels_for_context) - List Slack channel IDs where the given playbook is set as the context +* [list_teams_channels_for_context_playbook](https://github.com/TextQLLabs/textql-python-v3/blob/master/docs/sdks/playbooks/README.md#list_teams_channels_for_context_playbook) - ListTeamsChannelsForContextPlaybook +* [mark_report_as_read](https://github.com/TextQLLabs/textql-python-v3/blob/master/docs/sdks/playbooks/README.md#mark_report_as_read) - Report read tracking +* [preview_slack_report](https://github.com/TextQLLabs/textql-python-v3/blob/master/docs/sdks/playbooks/README.md#preview_slack_report) - PreviewSlackReport +* [remove_dashboard](https://github.com/TextQLLabs/textql-python-v3/blob/master/docs/sdks/playbooks/README.md#remove_dashboard) - RemoveDashboard +* [remove_dataset](https://github.com/TextQLLabs/textql-python-v3/blob/master/docs/sdks/playbooks/README.md#remove_dataset) - RemoveDataset +* [run](https://github.com/TextQLLabs/textql-python-v3/blob/master/docs/sdks/playbooks/README.md#run) - RunPlaybook +* [set_slack_channel_context_playbook](https://github.com/TextQLLabs/textql-python-v3/blob/master/docs/sdks/playbooks/README.md#set_slack_channel_context_playbook) - Set the context playbook for a Slack channel. This associates the given playbook to a Slack channel so that Slack messages in that channel use the playbook's context by default. +* [set_teams_channel_context](https://github.com/TextQLLabs/textql-python-v3/blob/master/docs/sdks/playbooks/README.md#set_teams_channel_context) - SetTeamsChannelContextPlaybook +* [subscribe](https://github.com/TextQLLabs/textql-python-v3/blob/master/docs/sdks/playbooks/README.md#subscribe) - SubscribeToPlaybook +* [unset_slack_channel_context_playbook](https://github.com/TextQLLabs/textql-python-v3/blob/master/docs/sdks/playbooks/README.md#unset_slack_channel_context_playbook) - Unset the context playbook for a Slack channel. This clears any association so that messages in this channel no longer use a specific playbook context. +* [unset_teams_channel_context](https://github.com/TextQLLabs/textql-python-v3/blob/master/docs/sdks/playbooks/README.md#unset_teams_channel_context) - UnsetTeamsChannelContextPlaybook +* [unsubscribe](https://github.com/TextQLLabs/textql-python-v3/blob/master/docs/sdks/playbooks/README.md#unsubscribe) - UnsubscribeFromPlaybook +* [update](https://github.com/TextQLLabs/textql-python-v3/blob/master/docs/sdks/playbooks/README.md#update) - UpdatePlaybook + +### [Powerbi](https://github.com/TextQLLabs/textql-python-v3/blob/master/docs/sdks/powerbisdk/README.md) + +* [export_report_image](https://github.com/TextQLLabs/textql-python-v3/blob/master/docs/sdks/powerbisdk/README.md#export_report_image) - ExportPowerBIReportImage +* [generate_embed_token](https://github.com/TextQLLabs/textql-python-v3/blob/master/docs/sdks/powerbisdk/README.md#generate_embed_token) - GeneratePowerBIEmbedToken +* [get_dataset_preview](https://github.com/TextQLLabs/textql-python-v3/blob/master/docs/sdks/powerbisdk/README.md#get_dataset_preview) - GetPowerBIDatasetPreview +* [get_synced_items](https://github.com/TextQLLabs/textql-python-v3/blob/master/docs/sdks/powerbisdk/README.md#get_synced_items) - GetSyncedPowerBIItems +* [list](https://github.com/TextQLLabs/textql-python-v3/blob/master/docs/sdks/powerbisdk/README.md#list) - ListPowerBIDatasets +* [list_reports](https://github.com/TextQLLabs/textql-python-v3/blob/master/docs/sdks/powerbisdk/README.md#list_reports) - ListPowerBIReports +* [list_workspaces](https://github.com/TextQLLabs/textql-python-v3/blob/master/docs/sdks/powerbisdk/README.md#list_workspaces) - ListPowerBIWorkspaces +* [sync_power_bi_items](https://github.com/TextQLLabs/textql-python-v3/blob/master/docs/sdks/powerbisdk/README.md#sync_power_bi_items) - SyncPowerBIItems +* [test_connection](https://github.com/TextQLLabs/textql-python-v3/blob/master/docs/sdks/powerbisdk/README.md#test_connection) - TestPowerBIConnection +* [unsync_items](https://github.com/TextQLLabs/textql-python-v3/blob/master/docs/sdks/powerbisdk/README.md#unsync_items) - UnsyncPowerBIItems + +### [Rbac](https://github.com/TextQLLabs/textql-python-v3/blob/master/docs/sdks/rbac/README.md) + +* [add_group_member](https://github.com/TextQLLabs/textql-python-v3/blob/master/docs/sdks/rbac/README.md#add_group_member) - AddGroupMember +* [approve_access_request](https://github.com/TextQLLabs/textql-python-v3/blob/master/docs/sdks/rbac/README.md#approve_access_request) - ApproveAccessRequest +* [assign_permission_to_role](https://github.com/TextQLLabs/textql-python-v3/blob/master/docs/sdks/rbac/README.md#assign_permission_to_role) - AssignPermissionToRole +* [assign_role_to_member](https://github.com/TextQLLabs/textql-python-v3/blob/master/docs/sdks/rbac/README.md#assign_role_to_member) - Member role assignment +* [convert_role_to_group](https://github.com/TextQLLabs/textql-python-v3/blob/master/docs/sdks/rbac/README.md#convert_role_to_group) - ConvertRoleToGroup +* [create_api_key](https://github.com/TextQLLabs/textql-python-v3/blob/master/docs/sdks/rbac/README.md#create_api_key) - API Key management +* [create_group](https://github.com/TextQLLabs/textql-python-v3/blob/master/docs/sdks/rbac/README.md#create_group) - CreateGroup +* [create_role](https://github.com/TextQLLabs/textql-python-v3/blob/master/docs/sdks/rbac/README.md#create_role) - Role management +* [create_service_account](https://github.com/TextQLLabs/textql-python-v3/blob/master/docs/sdks/rbac/README.md#create_service_account) - Service account management +* [delete_group](https://github.com/TextQLLabs/textql-python-v3/blob/master/docs/sdks/rbac/README.md#delete_group) - DeleteGroup +* [delete_role](https://github.com/TextQLLabs/textql-python-v3/blob/master/docs/sdks/rbac/README.md#delete_role) - DeleteRole +* [delete_service_account](https://github.com/TextQLLabs/textql-python-v3/blob/master/docs/sdks/rbac/README.md#delete_service_account) - DeleteServiceAccount +* [generate_share_link](https://github.com/TextQLLabs/textql-python-v3/blob/master/docs/sdks/rbac/README.md#generate_share_link) - GenerateShareLink +* [get_current_member_roles_and_permissions](https://github.com/TextQLLabs/textql-python-v3/blob/master/docs/sdks/rbac/README.md#get_current_member_roles_and_permissions) - Get current member roles and permissions +* [get_embed_user_api_key](https://github.com/TextQLLabs/textql-python-v3/blob/master/docs/sdks/rbac/README.md#get_embed_user_api_key) - GetEmbedUserApiKey +* [get_group](https://github.com/TextQLLabs/textql-python-v3/blob/master/docs/sdks/rbac/README.md#get_group) - GetGroup +* [get_member_groups](https://github.com/TextQLLabs/textql-python-v3/blob/master/docs/sdks/rbac/README.md#get_member_groups) - GetMemberGroups +* [get_member_roles](https://github.com/TextQLLabs/textql-python-v3/blob/master/docs/sdks/rbac/README.md#get_member_roles) - GetMemberRoles +* [get_object_access](https://github.com/TextQLLabs/textql-python-v3/blob/master/docs/sdks/rbac/README.md#get_object_access) - GetObjectAccess +* [get_role](https://github.com/TextQLLabs/textql-python-v3/blob/master/docs/sdks/rbac/README.md#get_role) - GetRole +* [get_role_permissions](https://github.com/TextQLLabs/textql-python-v3/blob/master/docs/sdks/rbac/README.md#get_role_permissions) - GetRolePermissions +* [has_object_access](https://github.com/TextQLLabs/textql-python-v3/blob/master/docs/sdks/rbac/README.md#has_object_access) - HasObjectAccess +* [list_access_requests](https://github.com/TextQLLabs/textql-python-v3/blob/master/docs/sdks/rbac/README.md#list_access_requests) - ListAccessRequests +* [list_api_keys](https://github.com/TextQLLabs/textql-python-v3/blob/master/docs/sdks/rbac/README.md#list_api_keys) - ListApiKeys +* [list_group_connectors](https://github.com/TextQLLabs/textql-python-v3/blob/master/docs/sdks/rbac/README.md#list_group_connectors) - ListGroupConnectors +* [list_groups](https://github.com/TextQLLabs/textql-python-v3/blob/master/docs/sdks/rbac/README.md#list_groups) - ListGroups +* [list_permissions](https://github.com/TextQLLabs/textql-python-v3/blob/master/docs/sdks/rbac/README.md#list_permissions) - Permission management +* [list_roles](https://github.com/TextQLLabs/textql-python-v3/blob/master/docs/sdks/rbac/README.md#list_roles) - ListRoles +* [list_scim_group_mappings](https://github.com/TextQLLabs/textql-python-v3/blob/master/docs/sdks/rbac/README.md#list_scim_group_mappings) - ListScimGroupMappings +* [list_service_accounts](https://github.com/TextQLLabs/textql-python-v3/blob/master/docs/sdks/rbac/README.md#list_service_accounts) - ListServiceAccounts +* [migrate_all_scim_group_mappings](https://github.com/TextQLLabs/textql-python-v3/blob/master/docs/sdks/rbac/README.md#migrate_all_scim_group_mappings) - MigrateAllScimGroupMappings +* [migrate_scim_group_mapping_to_group](https://github.com/TextQLLabs/textql-python-v3/blob/master/docs/sdks/rbac/README.md#migrate_scim_group_mapping_to_group) - MigrateScimGroupMappingToGroup +* [reject_access_request](https://github.com/TextQLLabs/textql-python-v3/blob/master/docs/sdks/rbac/README.md#reject_access_request) - RejectAccessRequest +* [remove_group_member](https://github.com/TextQLLabs/textql-python-v3/blob/master/docs/sdks/rbac/README.md#remove_group_member) - RemoveGroupMember +* [remove_permission_from_role](https://github.com/TextQLLabs/textql-python-v3/blob/master/docs/sdks/rbac/README.md#remove_permission_from_role) - RemovePermissionFromRole +* [remove_role_from_member](https://github.com/TextQLLabs/textql-python-v3/blob/master/docs/sdks/rbac/README.md#remove_role_from_member) - RemoveRoleFromMember +* [request_access](https://github.com/TextQLLabs/textql-python-v3/blob/master/docs/sdks/rbac/README.md#request_access) - Access request management +* [revert_scim_group_mapping_to_role](https://github.com/TextQLLabs/textql-python-v3/blob/master/docs/sdks/rbac/README.md#revert_scim_group_mapping_to_role) - RevertScimGroupMappingToRole +* [revoke_api_key](https://github.com/TextQLLabs/textql-python-v3/blob/master/docs/sdks/rbac/README.md#revoke_api_key) - RevokeApiKey +* [revoke_object_access](https://github.com/TextQLLabs/textql-python-v3/blob/master/docs/sdks/rbac/README.md#revoke_object_access) - RevokeObjectAccess +* [rotate_api_key](https://github.com/TextQLLabs/textql-python-v3/blob/master/docs/sdks/rbac/README.md#rotate_api_key) - RotateApiKey +* [share_object](https://github.com/TextQLLabs/textql-python-v3/blob/master/docs/sdks/rbac/README.md#share_object) - Object sharing and access control +* [share_with_group](https://github.com/TextQLLabs/textql-python-v3/blob/master/docs/sdks/rbac/README.md#share_with_group) - ShareObjectWithGroup +* [share_object_with_role](https://github.com/TextQLLabs/textql-python-v3/blob/master/docs/sdks/rbac/README.md#share_object_with_role) - ShareObjectWithRole +* [update_group](https://github.com/TextQLLabs/textql-python-v3/blob/master/docs/sdks/rbac/README.md#update_group) - UpdateGroup +* [update_object_access](https://github.com/TextQLLabs/textql-python-v3/blob/master/docs/sdks/rbac/README.md#update_object_access) - UpdateObjectAccess +* [update_object_visibility](https://github.com/TextQLLabs/textql-python-v3/blob/master/docs/sdks/rbac/README.md#update_object_visibility) - UpdateObjectVisibility +* [update_role](https://github.com/TextQLLabs/textql-python-v3/blob/master/docs/sdks/rbac/README.md#update_role) - UpdateRole + +### [Sandbox](https://github.com/TextQLLabs/textql-python-v3/blob/master/docs/sdks/sandbox/README.md) + +* [execute_query](https://github.com/TextQLLabs/textql-python-v3/blob/master/docs/sdks/sandbox/README.md#execute_query) - ExecuteQuery + +### [SandboxAdmin](https://github.com/TextQLLabs/textql-python-v3/blob/master/docs/sdks/sandboxadmin/README.md) + +* [get_sandbox](https://github.com/TextQLLabs/textql-python-v3/blob/master/docs/sdks/sandboxadmin/README.md#get_sandbox) - GetSandbox +* [list_sandbox_egress](https://github.com/TextQLLabs/textql-python-v3/blob/master/docs/sdks/sandboxadmin/README.md#list_sandbox_egress) - Outbound HTTP(S) calls a sandbox made (the egress ledger). Durable — reads the recorded table, so it works for stopped sandboxes too. +* [list_executions](https://github.com/TextQLLabs/textql-python-v3/blob/master/docs/sdks/sandboxadmin/README.md#list_executions) - ListSandboxExecutions +* [list_sandbox_files](https://github.com/TextQLLabs/textql-python-v3/blob/master/docs/sdks/sandboxadmin/README.md#list_sandbox_files) - Live filesystem of a running sandbox. Both are NO-OP (read-only) and only return data while the worker is alive; available=false otherwise. +* [list_sandbox_spend](https://github.com/TextQLLabs/textql-python-v3/blob/master/docs/sdks/sandboxadmin/README.md#list_sandbox_spend) - Per-lease compute usage for a sandbox, computed from lease durations × the compute rate. Durable (reads the lease table), so it works for stopped sandboxes. This is usage (ACUs), not the invoiced dollar amount. +* [list](https://github.com/TextQLLabs/textql-python-v3/blob/master/docs/sdks/sandboxadmin/README.md#list) - ListSandboxes +* [read_file](https://github.com/TextQLLabs/textql-python-v3/blob/master/docs/sdks/sandboxadmin/README.md#read_file) - ReadSandboxFile +* [restart_sandbox](https://github.com/TextQLLabs/textql-python-v3/blob/master/docs/sdks/sandboxadmin/README.md#restart_sandbox) - Restart a stopped/reaped sandbox by re-acquiring a worker for the same sandbox_id, preserving the original owner. Same scoping as StopSandbox (owner, or sandbox:write_private for org-wide). +* [stop](https://github.com/TextQLLabs/textql-python-v3/blob/master/docs/sdks/sandboxadmin/README.md#stop) - StopSandbox + +### [Scim](https://github.com/TextQLLabs/textql-python-v3/blob/master/docs/sdks/scim/README.md) + +* [create_o_auth_client](https://github.com/TextQLLabs/textql-python-v3/blob/master/docs/sdks/scim/README.md#create_o_auth_client) - CreateScimOAuthClient +* [create_scim_token](https://github.com/TextQLLabs/textql-python-v3/blob/master/docs/sdks/scim/README.md#create_scim_token) - CreateScimToken +* [list_scim_o_auth_clients](https://github.com/TextQLLabs/textql-python-v3/blob/master/docs/sdks/scim/README.md#list_scim_o_auth_clients) - ListScimOAuthClients +* [list](https://github.com/TextQLLabs/textql-python-v3/blob/master/docs/sdks/scim/README.md#list) - ListScimTokens +* [revoke_o_auth_client](https://github.com/TextQLLabs/textql-python-v3/blob/master/docs/sdks/scim/README.md#revoke_o_auth_client) - RevokeScimOAuthClient +* [revoke_scim_token](https://github.com/TextQLLabs/textql-python-v3/blob/master/docs/sdks/scim/README.md#revoke_scim_token) - RevokeScimToken + +### [Secrets](https://github.com/TextQLLabs/textql-python-v3/blob/master/docs/sdks/secrets/README.md) + +* [create_api_revision](https://github.com/TextQLLabs/textql-python-v3/blob/master/docs/sdks/secrets/README.md#create_api_revision) - CreateApiRevision +* [delete_api_access_key](https://github.com/TextQLLabs/textql-python-v3/blob/master/docs/sdks/secrets/README.md#delete_api_access_key) - DeleteApiAccessKey +* [delete_api_revision](https://github.com/TextQLLabs/textql-python-v3/blob/master/docs/sdks/secrets/README.md#delete_api_revision) - DeleteApiRevision +* [delete_secret](https://github.com/TextQLLabs/textql-python-v3/blob/master/docs/sdks/secrets/README.md#delete_secret) - DeleteSecret +* [get_api_access_key](https://github.com/TextQLLabs/textql-python-v3/blob/master/docs/sdks/secrets/README.md#get_api_access_key) - GetApiAccessKey +* [get_members_with_secrets](https://github.com/TextQLLabs/textql-python-v3/blob/master/docs/sdks/secrets/README.md#get_members_with_secrets) - GetMembersWithSecrets +* [list_api_access_keys](https://github.com/TextQLLabs/textql-python-v3/blob/master/docs/sdks/secrets/README.md#list_api_access_keys) - ListApiAccessKeys +* [list_api_providers](https://github.com/TextQLLabs/textql-python-v3/blob/master/docs/sdks/secrets/README.md#list_api_providers) - ListApiProviders +* [list_secrets](https://github.com/TextQLLabs/textql-python-v3/blob/master/docs/sdks/secrets/README.md#list_secrets) - ListSecrets +* [migrate_secret_to_api_connector](https://github.com/TextQLLabs/textql-python-v3/blob/master/docs/sdks/secrets/README.md#migrate_secret_to_api_connector) - MigrateSecretToApiConnector +* [put_secret](https://github.com/TextQLLabs/textql-python-v3/blob/master/docs/sdks/secrets/README.md#put_secret) - PutSecret +* [test_api_access_key](https://github.com/TextQLLabs/textql-python-v3/blob/master/docs/sdks/secrets/README.md#test_api_access_key) - TestApiAccessKey +* [update](https://github.com/TextQLLabs/textql-python-v3/blob/master/docs/sdks/secrets/README.md#update) - UpdateSecret +* [upsert_api_access_key](https://github.com/TextQLLabs/textql-python-v3/blob/master/docs/sdks/secrets/README.md#upsert_api_access_key) - UpsertApiAccessKey + +### [Slack](https://github.com/TextQLLabs/textql-python-v3/blob/master/docs/sdks/slack/README.md) + +* [create_uuid](https://github.com/TextQLLabs/textql-python-v3/blob/master/docs/sdks/slack/README.md#create_uuid) - CreateSlackUuid +* [delete_installation](https://github.com/TextQLLabs/textql-python-v3/blob/master/docs/sdks/slack/README.md#delete_installation) - DeleteInstallation +* [get_current_user](https://github.com/TextQLLabs/textql-python-v3/blob/master/docs/sdks/slack/README.md#get_current_user) - GetCurrentUser +* [handle_o_auth_callback](https://github.com/TextQLLabs/textql-python-v3/blob/master/docs/sdks/slack/README.md#handle_o_auth_callback) - HandleSlackOAuthCallback +* [list_channels](https://github.com/TextQLLabs/textql-python-v3/blob/master/docs/sdks/slack/README.md#list_channels) - ListChannels +* [list_installations](https://github.com/TextQLLabs/textql-python-v3/blob/master/docs/sdks/slack/README.md#list_installations) - ListInstallations +* [list_users](https://github.com/TextQLLabs/textql-python-v3/blob/master/docs/sdks/slack/README.md#list_users) - ListUsers +* [sync_workspace](https://github.com/TextQLLabs/textql-python-v3/blob/master/docs/sdks/slack/README.md#sync_workspace) - SyncWorkspace + +### [Tableau](https://github.com/TextQLLabs/textql-python-v3/blob/master/docs/sdks/tableausdk/README.md) + +* [generate_embed_token](https://github.com/TextQLLabs/textql-python-v3/blob/master/docs/sdks/tableausdk/README.md#generate_embed_token) - Generate JWT token for embedding views +* [get_collection_thumbnail](https://github.com/TextQLLabs/textql-python-v3/blob/master/docs/sdks/tableausdk/README.md#get_collection_thumbnail) - Get collection thumbnail (first view image) +* [get_connected_app_status](https://github.com/TextQLLabs/textql-python-v3/blob/master/docs/sdks/tableausdk/README.md#get_connected_app_status) - GetConnectedAppStatus +* [get_starred_items](https://github.com/TextQLLabs/textql-python-v3/blob/master/docs/sdks/tableausdk/README.md#get_starred_items) - GetStarredTableauItems +* [list_tableau_datasources](https://github.com/TextQLLabs/textql-python-v3/blob/master/docs/sdks/tableausdk/README.md#list_tableau_datasources) - List Tableau datasources +* [list_projects](https://github.com/TextQLLabs/textql-python-v3/blob/master/docs/sdks/tableausdk/README.md#list_projects) - List Tableau projects +* [list_views](https://github.com/TextQLLabs/textql-python-v3/blob/master/docs/sdks/tableausdk/README.md#list_views) - List Tableau views +* [list_workbooks](https://github.com/TextQLLabs/textql-python-v3/blob/master/docs/sdks/tableausdk/README.md#list_workbooks) - List Tableau workbooks +* [refresh_collection](https://github.com/TextQLLabs/textql-python-v3/blob/master/docs/sdks/tableausdk/README.md#refresh_collection) - RefreshTableauCollection +* [reset_connected_app](https://github.com/TextQLLabs/textql-python-v3/blob/master/docs/sdks/tableausdk/README.md#reset_connected_app) - ResetConnectedApp +* [star_item](https://github.com/TextQLLabs/textql-python-v3/blob/master/docs/sdks/tableausdk/README.md#star_item) - Star/unstar items +* [test_tableau_connection](https://github.com/TextQLLabs/textql-python-v3/blob/master/docs/sdks/tableausdk/README.md#test_tableau_connection) - Test a Tableau connection +* [unstar_tableau_item](https://github.com/TextQLLabs/textql-python-v3/blob/master/docs/sdks/tableausdk/README.md#unstar_tableau_item) - UnstarTableauItem + +### [Teams](https://github.com/TextQLLabs/textql-python-v3/blob/master/docs/sdks/teams/README.md) + +* [create_uuid](https://github.com/TextQLLabs/textql-python-v3/blob/master/docs/sdks/teams/README.md#create_uuid) - CreateTeamsUuid +* [delete_installation](https://github.com/TextQLLabs/textql-python-v3/blob/master/docs/sdks/teams/README.md#delete_installation) - DeleteInstallation +* [get_current_user](https://github.com/TextQLLabs/textql-python-v3/blob/master/docs/sdks/teams/README.md#get_current_user) - GetCurrentUser +* [handle_o_auth_callback](https://github.com/TextQLLabs/textql-python-v3/blob/master/docs/sdks/teams/README.md#handle_o_auth_callback) - HandleTeamsOAuthCallback +* [list](https://github.com/TextQLLabs/textql-python-v3/blob/master/docs/sdks/teams/README.md#list) - ListChannels +* [list_installations](https://github.com/TextQLLabs/textql-python-v3/blob/master/docs/sdks/teams/README.md#list_installations) - ListInstallations +* [list_users](https://github.com/TextQLLabs/textql-python-v3/blob/master/docs/sdks/teams/README.md#list_users) - ListUsers +* [sync_workspace](https://github.com/TextQLLabs/textql-python-v3/blob/master/docs/sdks/teams/README.md#sync_workspace) - SyncWorkspace + +
+ + + +## Retries + +Some of the endpoints in this SDK support retries. If you use the SDK without any configuration, it will fall back to the default retry strategy provided by the API. However, the default retry strategy can be overridden on a per-operation basis, or across the entire SDK. + +To change the default retry strategy for a single API call, simply provide a `RetryConfig` object to the call: +```python +import os +from textql_sdk import Textql +from textql_sdk.utils import BackoffStrategy, RetryConfig + + +with Textql( + api_key=os.getenv("TEXTQL_API_KEY", ""), +) as textql: + + res = textql.agents.create(, + RetryConfig("backoff", BackoffStrategy(1, 50, 1.1, 100), False)) + + # Handle response + print(res) + +``` + +If you'd like to override the default retry strategy for all operations that support retries, you can use the `retry_config` optional parameter when initializing the SDK: +```python +import os +from textql_sdk import Textql +from textql_sdk.utils import BackoffStrategy, RetryConfig + + +with Textql( + retry_config=RetryConfig("backoff", BackoffStrategy(1, 50, 1.1, 100), False), + api_key=os.getenv("TEXTQL_API_KEY", ""), +) as textql: + + res = textql.agents.create() + + # Handle response + print(res) + +``` + + + +## Error Handling + +[`TextqlError`](https://github.com/TextQLLabs/textql-python-v3/blob/master/./src/textql_sdk/errors/textqlerror.py) is the base class for all HTTP error responses. It has the following properties: + +| Property | Type | Description | +| ------------------ | ---------------- | ------------------------------------------------------ | +| `err.message` | `str` | Error message | +| `err.status_code` | `int` | HTTP response status code eg `404` | +| `err.headers` | `httpx.Headers` | HTTP response headers | +| `err.body` | `str` | HTTP body. Can be empty string if no body is returned. | +| `err.raw_response` | `httpx.Response` | Raw HTTP response | + +### Example +```python +import os +from textql_sdk import Textql, errors + + +with Textql( + api_key=os.getenv("TEXTQL_API_KEY", ""), +) as textql: + res = None + try: + + res = textql.agents.create() + + # Handle response + print(res) + + + except errors.TextqlError as e: + # The base class for HTTP error responses + print(e.message) + print(e.status_code) + print(e.body) + print(e.headers) + print(e.raw_response) + +``` + +### Error Classes +**Primary error:** +* [`TextqlError`](https://github.com/TextQLLabs/textql-python-v3/blob/master/./src/textql_sdk/errors/textqlerror.py): The base class for HTTP error responses. + +
Less common errors (5) + +
+ +**Network errors:** +* [`httpx.RequestError`](https://www.python-httpx.org/exceptions/#httpx.RequestError): Base class for request errors. + * [`httpx.ConnectError`](https://www.python-httpx.org/exceptions/#httpx.ConnectError): HTTP client was unable to make a request to a server. + * [`httpx.TimeoutException`](https://www.python-httpx.org/exceptions/#httpx.TimeoutException): HTTP request timed out. + + +**Inherit from [`TextqlError`](https://github.com/TextQLLabs/textql-python-v3/blob/master/./src/textql_sdk/errors/textqlerror.py)**: +* [`ResponseValidationError`](https://github.com/TextQLLabs/textql-python-v3/blob/master/./src/textql_sdk/errors/responsevalidationerror.py): Type mismatch between the response data and the expected Pydantic model. Provides access to the Pydantic validation error via the `cause` attribute. + +
+ + + +## Server Selection + +### Override Server URL Per-Client + +The default server can be overridden globally by passing a URL to the `server_url: str` optional parameter when initializing the SDK client instance. For example: +```python +import os +from textql_sdk import Textql + + +with Textql( + server_url="https://app.textql.com", + api_key=os.getenv("TEXTQL_API_KEY", ""), +) as textql: + + res = textql.agents.create() + + # Handle response + print(res) + +``` + + + +## Custom HTTP Client + +The Python SDK makes API calls using the [httpx](https://www.python-httpx.org/) HTTP library. In order to provide a convenient way to configure timeouts, cookies, proxies, custom headers, and other low-level configuration, you can initialize the SDK client with your own HTTP client instance. +Depending on whether you are using the sync or async version of the SDK, you can pass an instance of `HttpClient` or `AsyncHttpClient` respectively, which are Protocol's ensuring that the client has the necessary methods to make API calls. +This allows you to wrap the client with your own custom logic, such as adding custom headers, logging, or error handling, or you can just pass an instance of `httpx.Client` or `httpx.AsyncClient` directly. + +For example, you could specify a header for every request that this sdk makes as follows: +```python +from textql_sdk import Textql +import httpx + +http_client = httpx.Client(headers={"x-custom-header": "someValue"}) +s = Textql(client=http_client) +``` + +or you could wrap the client with your own custom logic: +```python +from textql_sdk import Textql +from textql_sdk.httpclient import AsyncHttpClient +import httpx + +class CustomClient(AsyncHttpClient): + client: AsyncHttpClient + + def __init__(self, client: AsyncHttpClient): + self.client = client + + async def send( + self, + request: httpx.Request, + *, + stream: bool = False, + auth: Union[ + httpx._types.AuthTypes, httpx._client.UseClientDefault, None + ] = httpx.USE_CLIENT_DEFAULT, + follow_redirects: Union[ + bool, httpx._client.UseClientDefault + ] = httpx.USE_CLIENT_DEFAULT, + ) -> httpx.Response: + request.headers["Client-Level-Header"] = "added by client" + + return await self.client.send( + request, stream=stream, auth=auth, follow_redirects=follow_redirects + ) + + def build_request( + self, + method: str, + url: httpx._types.URLTypes, + *, + content: Optional[httpx._types.RequestContent] = None, + data: Optional[httpx._types.RequestData] = None, + files: Optional[httpx._types.RequestFiles] = None, + json: Optional[Any] = None, + params: Optional[httpx._types.QueryParamTypes] = None, + headers: Optional[httpx._types.HeaderTypes] = None, + cookies: Optional[httpx._types.CookieTypes] = None, + timeout: Union[ + httpx._types.TimeoutTypes, httpx._client.UseClientDefault + ] = httpx.USE_CLIENT_DEFAULT, + extensions: Optional[httpx._types.RequestExtensions] = None, + ) -> httpx.Request: + return self.client.build_request( + method, + url, + content=content, + data=data, + files=files, + json=json, + params=params, + headers=headers, + cookies=cookies, + timeout=timeout, + extensions=extensions, + ) + +s = Textql(async_client=CustomClient(httpx.AsyncClient())) +``` + + + +## Resource Management + +The `Textql` class implements the context manager protocol and registers a finalizer function to close the underlying sync and async HTTPX clients it uses under the hood. This will close HTTP connections, release memory and free up other resources held by the SDK. In short-lived Python programs and notebooks that make a few SDK method calls, resource management may not be a concern. However, in longer-lived programs, it is beneficial to create a single SDK instance via a [context manager][context-manager] and reuse it across the application. + +[context-manager]: https://docs.python.org/3/reference/datamodel.html#context-managers + +```python +import os +from textql_sdk import Textql +def main(): + + with Textql( + api_key=os.getenv("TEXTQL_API_KEY", ""), + ) as textql: + # Rest of application here... + + +# Or when using async: +async def amain(): + + async with Textql( + api_key=os.getenv("TEXTQL_API_KEY", ""), + ) as textql: + # Rest of application here... +``` + + + +## Debugging + +You can setup your SDK to emit debug logs for SDK requests and responses. + +You can pass your own logger class directly into your SDK. +```python +from textql_sdk import Textql +import logging + +logging.basicConfig(level=logging.DEBUG) +s = Textql(debug_logger=logging.getLogger("textql_sdk")) +``` + +You can also enable a default debug logger by setting an environment variable `TEXTQL_DEBUG` to true. + + + + +# Development + +## Maturity + +This SDK is in beta, and there may be breaking changes between versions without a major version update. Therefore, we recommend pinning usage +to a specific package version. This way, you can install the same version each time without breaking changes unless you are intentionally +looking for the latest version. + +## Contributions + +While we value open-source contributions to this SDK, this library is generated programmatically. Any manual changes added to internal files will be overwritten on the next generation. +We look forward to hearing your feedback. Feel free to open a PR or an issue with a proof of concept and we'll do our best to include it in a future release. + +### SDK Created by [Speakeasy](https://www.speakeasy.com/?utm_source=textql&utm_campaign=python) diff --git a/RELEASES.md b/RELEASES.md new file mode 100644 index 0000000..ec4c9d4 --- /dev/null +++ b/RELEASES.md @@ -0,0 +1,11 @@ + + +## 2026-07-17 21:45:13 +### Changes +Based on: +- OpenAPI Doc +- Speakeasy CLI 1.790.2 (2.918.3) https://github.com/speakeasy-api/speakeasy +### Generated +- [python v1.0.0] . +### Releases +- [PyPI v1.0.0] https://pypi.org/project/textql-sdk/1.0.0 - . \ No newline at end of file diff --git a/pyproject.toml b/pyproject.toml index 18bc663..bca3ae0 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -3,13 +3,14 @@ name = "textql-sdk" version = "1.0.0" description = "Python Client SDK Generated by Speakeasy." authors = [{ name = "Speakeasy" },] -readme = "README.md" +readme = "README-PYPI.md" requires-python = ">=3.10" dependencies = [ "httpcore >=1.0.9", "httpx >=0.28.1", "pydantic >=2.11.2,<2.13", ] +urls.repository = "https://github.com/TextQLLabs/textql-python-v3.git" license = { text = "Apache-2.0" } [dependency-groups] @@ -17,10 +18,6 @@ dev = [ "mypy ==1.15.0", "pylint ==3.2.3", "pyright ==1.1.398", - "pytest >=8.0.0", - "pytest-asyncio >=0.24.0", - "pytest-xdist >=3.6.0", - "python-dotenv >=1.0.0", ] [tool.setuptools.packages.find] @@ -35,13 +32,7 @@ build-backend = "setuptools.build_meta" [tool.pytest.ini_options] asyncio_default_fixture_loop_scope = "function" -asyncio_mode = "auto" -pythonpath = ["src", "."] -testpaths = ["tests"] -markers = [ - "integration: tests that hit a real (or locally running) TextQL API server", - "unit: fast, fully-mocked tests that never touch the network", -] +pythonpath = ["src"] [tool.mypy] disable_error_code = "misc" diff --git a/scripts/prepare_readme.py b/scripts/prepare_readme.py new file mode 100644 index 0000000..3ef9df5 --- /dev/null +++ b/scripts/prepare_readme.py @@ -0,0 +1,35 @@ +"""Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.""" + +import re +import shutil + +try: + with open("README.md", "r", encoding="utf-8") as rh: + readme_contents = rh.read() + GITHUB_URL = "https://github.com/TextQLLabs/textql-python-v3.git" + GITHUB_URL = ( + GITHUB_URL[: -len(".git")] if GITHUB_URL.endswith(".git") else GITHUB_URL + ) + REPO_SUBDIR = "" + # links on PyPI should have absolute URLs + readme_contents = re.sub( + r"(\[[^\]]+\]\()((?!https?:)[^\)]+)(\))", + lambda m: m.group(1) + + GITHUB_URL + + "/blob/master/" + + REPO_SUBDIR + + m.group(2) + + m.group(3), + readme_contents, + ) + + with open("README-PYPI.md", "w", encoding="utf-8") as wh: + wh.write(readme_contents) +except Exception as e: + try: + print("Failed to rewrite README.md to README-PYPI.md, copying original instead") + print(e) + shutil.copyfile("README.md", "README-PYPI.md") + except Exception as ie: + print("Failed to copy README.md to README-PYPI.md") + print(ie) diff --git a/scripts/publish.sh b/scripts/publish.sh index ef28dc1..c35748f 100755 --- a/scripts/publish.sh +++ b/scripts/publish.sh @@ -1,4 +1,6 @@ #!/usr/bin/env bash +uv run python scripts/prepare_readme.py + uv build uv publish --token $PYPI_TOKEN diff --git a/src/textql_sdk/_hooks/__init__.py b/src/textql_sdk/_hooks/__init__.py index e763be4..2ee66cd 100644 --- a/src/textql_sdk/_hooks/__init__.py +++ b/src/textql_sdk/_hooks/__init__.py @@ -2,3 +2,4 @@ from .sdkhooks import * from .types import * +from .registration import * diff --git a/src/textql_sdk/_hooks/registration.py b/src/textql_sdk/_hooks/registration.py new file mode 100644 index 0000000..cab4778 --- /dev/null +++ b/src/textql_sdk/_hooks/registration.py @@ -0,0 +1,13 @@ +from .types import Hooks + + +# This file is only ever generated once on the first generation and then is free to be modified. +# Any hooks you wish to add should be registered in the init_hooks function. Feel free to define them +# in this file or in separate files in the hooks folder. + + +def init_hooks(hooks: Hooks): + # pylint: disable=unused-argument + """Add hooks by calling hooks.register{sdk_init/before_request/after_success/after_error}Hook + with an instance of a hook that implements that specific Hook interface + Hooks are registered per SDK instance, and are valid for the lifetime of the SDK instance""" diff --git a/src/textql_sdk/_hooks/sdkhooks.py b/src/textql_sdk/_hooks/sdkhooks.py index 22ab328..9e960a8 100644 --- a/src/textql_sdk/_hooks/sdkhooks.py +++ b/src/textql_sdk/_hooks/sdkhooks.py @@ -11,6 +11,7 @@ AfterErrorHook, Hooks, ) +from .registration import init_hooks from typing import List, Optional, Tuple from textql_sdk.sdkconfiguration import SDKConfiguration @@ -21,6 +22,7 @@ def __init__(self) -> None: self.before_request_hooks: List[BeforeRequestHook] = [] self.after_success_hooks: List[AfterSuccessHook] = [] self.after_error_hooks: List[AfterErrorHook] = [] + init_hooks(self) def register_sdk_init_hook(self, hook: SDKInitHook) -> None: self.sdk_init_hooks.append(hook) diff --git a/src/textql_sdk/models/security.py b/src/textql_sdk/models/security.py index 182a101..aaecd98 100644 --- a/src/textql_sdk/models/security.py +++ b/src/textql_sdk/models/security.py @@ -27,7 +27,7 @@ class Security(BaseModel): @model_serializer(mode="wrap") def serialize_model(self, handler): - optional_fields = set(["api_key"]) + optional_fields = set(["apiKey"]) serialized = handler(self) m = {} diff --git a/src/textql_sdk/sdkconfiguration.py b/src/textql_sdk/sdkconfiguration.py index 6d26aea..378441e 100644 --- a/src/textql_sdk/sdkconfiguration.py +++ b/src/textql_sdk/sdkconfiguration.py @@ -20,8 +20,6 @@ ] """Contains the list of servers available to the SDK""" -_RPC_BASE_PATH = "/rpc/public" - @dataclass class SDKConfiguration: @@ -43,12 +41,8 @@ class SDKConfiguration: def get_server_details(self) -> Tuple[str, Dict[str, str]]: if self.server_url is not None and self.server_url: - base = remove_suffix(self.server_url, "/") - else: - if self.server_idx is None: - self.server_idx = 0 - base = SERVERS[self.server_idx] + return remove_suffix(self.server_url, "/"), {} + if self.server_idx is None: + self.server_idx = 0 - if not base.endswith(_RPC_BASE_PATH): - base = base + _RPC_BASE_PATH - return base, {} + return SERVERS[self.server_idx], {} diff --git a/src/textql_sdk/utils/retries.py b/src/textql_sdk/utils/retries.py index b9709b2..ca7b59e 100644 --- a/src/textql_sdk/utils/retries.py +++ b/src/textql_sdk/utils/retries.py @@ -174,7 +174,7 @@ def _get_sleep_interval( if ( isinstance(exception, TemporaryError) and exception.retry_after is not None - and exception.retry_after >= 0 + and exception.retry_after > 0 ): return exception.retry_after / 1000 @@ -208,8 +208,6 @@ def do_request() -> httpx.Response: if res.status_code == parsed_code: raise TemporaryError(res) except (httpx.NetworkError, httpx.TimeoutException) as exception: - # Re-raise raw so the generic backoff loop retries it; - # wrap in PermanentError to stop retrying immediately. if retries.config.retry_connection_errors: raise @@ -255,8 +253,6 @@ async def do_request() -> httpx.Response: if res.status_code == parsed_code: raise TemporaryError(res) except (httpx.NetworkError, httpx.TimeoutException) as exception: - # Re-raise raw so the generic backoff loop retries it; - # wrap in PermanentError to stop retrying immediately. if retries.config.retry_connection_errors: raise diff --git a/uv.lock b/uv.lock index 118469c..1ace2ae 100644 --- a/uv.lock +++ b/uv.lock @@ -42,15 +42,6 @@ wheels = [ { url = "https://files.pythonhosted.org/packages/80/96/b32bbbb46170a1c8b8b1f28c794202e25cfe743565e9d3469b8eb1e0cc05/astroid-3.2.4-py3-none-any.whl", hash = "sha256:413658a61eeca6202a59231abb473f932038fbcbf1666587f66d482083413a25", size = 276348, upload-time = "2024-07-20T12:57:40.886Z" }, ] -[[package]] -name = "backports-asyncio-runner" -version = "1.2.0" -source = { registry = "https://pypi.org/simple" } -sdist = { url = "https://files.pythonhosted.org/packages/8e/ff/70dca7d7cb1cbc0edb2c6cc0c38b65cba36cccc491eca64cabd5fe7f8670/backports_asyncio_runner-1.2.0.tar.gz", hash = "sha256:a5aa7b2b7d8f8bfcaa2b57313f70792df84e32a2a746f585213373f900b42162", size = 69893, upload-time = "2025-07-02T02:27:15.685Z" } -wheels = [ - { url = "https://files.pythonhosted.org/packages/a0/59/76ab57e3fe74484f48a53f8e337171b4a2349e506eabe136d7e01d059086/backports_asyncio_runner-1.2.0-py3-none-any.whl", hash = "sha256:0da0a936a8aeb554eccb426dc55af3ba63bcdc69fa1a600b5bb305413a4477b5", size = 12313, upload-time = "2025-07-02T02:27:14.263Z" }, -] - [[package]] name = "certifi" version = "2026.6.17" @@ -83,22 +74,13 @@ name = "exceptiongroup" version = "1.3.1" source = { registry = "https://pypi.org/simple" } dependencies = [ - { name = "typing-extensions", marker = "python_full_version < '3.11'" }, + { name = "typing-extensions" }, ] sdist = { url = "https://files.pythonhosted.org/packages/50/79/66800aadf48771f6b62f7eb014e352e5d06856655206165d775e675a02c9/exceptiongroup-1.3.1.tar.gz", hash = "sha256:8b412432c6055b0b7d14c310000ae93352ed6754f70fa8f7c34141f91c4e3219", size = 30371, upload-time = "2025-11-21T23:01:54.787Z" } wheels = [ { url = "https://files.pythonhosted.org/packages/8a/0e/97c33bf5009bdbac74fd2beace167cab3f978feb69cc36f1ef79360d6c4e/exceptiongroup-1.3.1-py3-none-any.whl", hash = "sha256:a7a39a3bd276781e98394987d3a5701d0c4edffb633bb7a5144577f82c773598", size = 16740, upload-time = "2025-11-21T23:01:53.443Z" }, ] -[[package]] -name = "execnet" -version = "2.1.2" -source = { registry = "https://pypi.org/simple" } -sdist = { url = "https://files.pythonhosted.org/packages/bf/89/780e11f9588d9e7128a3f87788354c7946a9cbb1401ad38a48c4db9a4f07/execnet-2.1.2.tar.gz", hash = "sha256:63d83bfdd9a23e35b9c6a3261412324f964c2ec8dcd8d3c6916ee9373e0befcd", size = 166622, upload-time = "2025-11-12T09:56:37.75Z" } -wheels = [ - { url = "https://files.pythonhosted.org/packages/ab/84/02fc1827e8cdded4aa65baef11296a9bbe595c474f0d6d758af082d849fd/execnet-2.1.2-py3-none-any.whl", hash = "sha256:67fba928dd5a544b783f6056f449e5e3931a5c378b128bc18501f7ea79e296ec", size = 40708, upload-time = "2025-11-12T09:56:36.333Z" }, -] - [[package]] name = "h11" version = "0.16.0" @@ -145,15 +127,6 @@ wheels = [ { url = "https://files.pythonhosted.org/packages/1e/5e/d4e9f1a599fb8e573b7b87160658329fbf28d19eac2718f51fc3def3aa5a/idna-3.18-py3-none-any.whl", hash = "sha256:7f952cbe720b688055e3f87de14f5c3e5fdaa8bc3928985c4077ca689de849a2", size = 65455, upload-time = "2026-06-02T14:34:06.319Z" }, ] -[[package]] -name = "iniconfig" -version = "2.3.0" -source = { registry = "https://pypi.org/simple" } -sdist = { url = "https://files.pythonhosted.org/packages/72/34/14ca021ce8e5dfedc35312d08ba8bf51fdd999c576889fc2c24cb97f4f10/iniconfig-2.3.0.tar.gz", hash = "sha256:c76315c77db068650d49c5b56314774a7804df16fee4402c1f19d6d15d8c4730", size = 20503, upload-time = "2025-10-18T21:55:43.219Z" } -wheels = [ - { url = "https://files.pythonhosted.org/packages/cb/b1/3846dd7f199d53cb17f49cba7e651e9ce294d8497c8c150530ed11865bb8/iniconfig-2.3.0-py3-none-any.whl", hash = "sha256:f631c04d2c48c52b84d0d0549c99ff3859c98df65b3101406327ecc7d53fbf12", size = 7484, upload-time = "2025-10-18T21:55:41.639Z" }, -] - [[package]] name = "isort" version = "5.13.2" @@ -228,15 +201,6 @@ wheels = [ { url = "https://files.pythonhosted.org/packages/88/b2/d0896bdcdc8d28a7fc5717c305f1a861c26e18c05047949fb371034d98bd/nodeenv-1.10.0-py2.py3-none-any.whl", hash = "sha256:5bb13e3eed2923615535339b3c620e76779af4cb4c6a90deccc9e36b274d3827", size = 23438, upload-time = "2025-12-20T14:08:52.782Z" }, ] -[[package]] -name = "packaging" -version = "26.2" -source = { registry = "https://pypi.org/simple" } -sdist = { url = "https://files.pythonhosted.org/packages/d7/f1/e7a6dd94a8d4a5626c03e4e99c87f241ba9e350cd9e6d75123f992427270/packaging-26.2.tar.gz", hash = "sha256:ff452ff5a3e828ce110190feff1178bb1f2ea2281fa2075aadb987c2fb221661", size = 228134, upload-time = "2026-04-24T20:15:23.917Z" } -wheels = [ - { url = "https://files.pythonhosted.org/packages/df/b2/87e62e8c3e2f4b32e5fe99e0b86d576da1312593b39f47d8ceef365e95ed/packaging-26.2-py3-none-any.whl", hash = "sha256:5fc45236b9446107ff2415ce77c807cee2862cb6fac22b8a73826d0693b0980e", size = 100195, upload-time = "2026-04-24T20:15:22.081Z" }, -] - [[package]] name = "platformdirs" version = "4.10.0" @@ -246,15 +210,6 @@ wheels = [ { url = "https://files.pythonhosted.org/packages/81/e6/cd9575ac904136b3cbf7aa7ee819ef86eedb7274e46f230e94ea4342e729/platformdirs-4.10.0-py3-none-any.whl", hash = "sha256:fb516cdb12eb0d857d0cd85a7c57cea4d060bee4578d6cf5a14dfdf8cbf8784a", size = 22743, upload-time = "2026-05-28T03:32:52.175Z" }, ] -[[package]] -name = "pluggy" -version = "1.6.0" -source = { registry = "https://pypi.org/simple" } -sdist = { url = "https://files.pythonhosted.org/packages/f9/e2/3e91f31a7d2b083fe6ef3fa267035b518369d9511ffab804f839851d2779/pluggy-1.6.0.tar.gz", hash = "sha256:7dcc130b76258d33b90f61b658791dede3486c3e6bfb003ee5c9bfb396dd22f3", size = 69412, upload-time = "2025-05-15T12:30:07.975Z" } -wheels = [ - { url = "https://files.pythonhosted.org/packages/54/20/4d324d65cc6d9205fabedc306948156824eb9f0ee1633355a8f7ec5c66bf/pluggy-1.6.0-py3-none-any.whl", hash = "sha256:e920276dd6813095e9377c0bc5566d94c932c33b27a3e3945d8389c374dd4746", size = 20538, upload-time = "2025-05-15T12:30:06.134Z" }, -] - [[package]] name = "pydantic" version = "2.12.5" @@ -388,15 +343,6 @@ wheels = [ { url = "https://files.pythonhosted.org/packages/36/c7/cfc8e811f061c841d7990b0201912c3556bfeb99cdcb7ed24adc8d6f8704/pydantic_core-2.41.5-pp311-pypy311_pp73-win_amd64.whl", hash = "sha256:56121965f7a4dc965bff783d70b907ddf3d57f6eba29b6d2e5dabfaf07799c51", size = 2145302, upload-time = "2025-11-04T13:43:46.64Z" }, ] -[[package]] -name = "pygments" -version = "2.20.0" -source = { registry = "https://pypi.org/simple" } -sdist = { url = "https://files.pythonhosted.org/packages/c3/b2/bc9c9196916376152d655522fdcebac55e66de6603a76a02bca1b6414f6c/pygments-2.20.0.tar.gz", hash = "sha256:6757cd03768053ff99f3039c1a36d6c0aa0b263438fcab17520b30a303a82b5f", size = 4955991, upload-time = "2026-03-29T13:29:33.898Z" } -wheels = [ - { url = "https://files.pythonhosted.org/packages/f4/7e/a72dd26f3b0f4f2bf1dd8923c85f7ceb43172af56d63c7383eb62b332364/pygments-2.20.0-py3-none-any.whl", hash = "sha256:81a9e26dd42fd28a23a2d169d86d7ac03b46e2f8b59ed4698fb4785f946d0176", size = 1231151, upload-time = "2026-03-29T13:29:30.038Z" }, -] - [[package]] name = "pylint" version = "3.2.3" @@ -429,60 +375,6 @@ wheels = [ { url = "https://files.pythonhosted.org/packages/58/e0/5283593f61b3c525d6d7e94cfb6b3ded20b3df66e953acaf7bb4f23b3f6e/pyright-1.1.398-py3-none-any.whl", hash = "sha256:0a70bfd007d9ea7de1cf9740e1ad1a40a122592cfe22a3f6791b06162ad08753", size = 5780235, upload-time = "2025-03-26T10:06:03.994Z" }, ] -[[package]] -name = "pytest" -version = "9.1.1" -source = { registry = "https://pypi.org/simple" } -dependencies = [ - { name = "colorama", marker = "sys_platform == 'win32'" }, - { name = "exceptiongroup", marker = "python_full_version < '3.11'" }, - { name = "iniconfig" }, - { name = "packaging" }, - { name = "pluggy" }, - { name = "pygments" }, - { name = "tomli", marker = "python_full_version < '3.11'" }, -] -sdist = { url = "https://files.pythonhosted.org/packages/e4/47/b9efed96c114afcfa3c9d3fe98a76a1d14c74a9e266d397cf6eb64be5e01/pytest-9.1.1.tar.gz", hash = "sha256:1088fbde8f2b49d95a549a195707afa7a76a3ce9bcadc26b6d71f0ffda5fe313", size = 1636369, upload-time = "2026-06-19T10:58:32.857Z" } -wheels = [ - { url = "https://files.pythonhosted.org/packages/24/25/1de2678b631f5a49215c6c96fff41ba892b0a34df68d6d80292b1b48aa7f/pytest-9.1.1-py3-none-any.whl", hash = "sha256:37a86b45efb9a47a61a36449063e8e18d0cab3161329fc099eb21783169c4f0c", size = 386536, upload-time = "2026-06-19T10:58:31.347Z" }, -] - -[[package]] -name = "pytest-asyncio" -version = "1.4.0" -source = { registry = "https://pypi.org/simple" } -dependencies = [ - { name = "backports-asyncio-runner", marker = "python_full_version < '3.11'" }, - { name = "pytest" }, - { name = "typing-extensions", marker = "python_full_version < '3.13'" }, -] -sdist = { url = "https://files.pythonhosted.org/packages/43/7c/d36d04db312ecf4298932ef77e6e4a9e8ad017906e24e34f0b0c361a2473/pytest_asyncio-1.4.0.tar.gz", hash = "sha256:c6c0d2259945122819f171a32ecea2c349ead889ee28176caaf492143424be42", size = 58514, upload-time = "2026-05-26T09:56:04.083Z" } -wheels = [ - { url = "https://files.pythonhosted.org/packages/03/e2/08a497ef684b88559c9cc5f4ad53a37e7b99e727094a86d6ea32536d5d3c/pytest_asyncio-1.4.0-py3-none-any.whl", hash = "sha256:933ca923a23075a87fb7070c0ec272a6848489824d887c85c812670932835aa1", size = 16930, upload-time = "2026-05-26T09:56:02.576Z" }, -] - -[[package]] -name = "pytest-xdist" -version = "3.8.0" -source = { registry = "https://pypi.org/simple" } -dependencies = [ - { name = "execnet" }, - { name = "pytest" }, -] -sdist = { url = "https://files.pythonhosted.org/packages/78/b4/439b179d1ff526791eb921115fca8e44e596a13efeda518b9d845a619450/pytest_xdist-3.8.0.tar.gz", hash = "sha256:7e578125ec9bc6050861aa93f2d59f1d8d085595d6551c2c90b6f4fad8d3a9f1", size = 88069, upload-time = "2025-07-01T13:30:59.346Z" } -wheels = [ - { url = "https://files.pythonhosted.org/packages/ca/31/d4e37e9e550c2b92a9cbc2e4d0b7420a27224968580b5a447f420847c975/pytest_xdist-3.8.0-py3-none-any.whl", hash = "sha256:202ca578cfeb7370784a8c33d6d05bc6e13b4f25b5053c30a152269fd10f0b88", size = 46396, upload-time = "2025-07-01T13:30:56.632Z" }, -] - -[[package]] -name = "python-dotenv" -version = "1.2.2" -source = { registry = "https://pypi.org/simple" } -sdist = { url = "https://files.pythonhosted.org/packages/82/ed/0301aeeac3e5353ef3d94b6ec08bbcabd04a72018415dcb29e588514bba8/python_dotenv-1.2.2.tar.gz", hash = "sha256:2c371a91fbd7ba082c2c1dc1f8bf89ca22564a087c2c287cd9b662adde799cf3", size = 50135, upload-time = "2026-03-01T16:00:26.196Z" } -wheels = [ - { url = "https://files.pythonhosted.org/packages/0b/d7/1959b9648791274998a9c3526f6d0ec8fd2233e4d4acce81bbae76b44b2a/python_dotenv-1.2.2-py3-none-any.whl", hash = "sha256:1d8214789a24de455a8b8bd8ae6fe3c6b69a5e3d64aa8a8e5d68e694bbcb285a", size = 22101, upload-time = "2026-03-01T16:00:25.09Z" }, -] - [[package]] name = "textql-sdk" version = "1.0.0" @@ -498,10 +390,6 @@ dev = [ { name = "mypy" }, { name = "pylint" }, { name = "pyright" }, - { name = "pytest" }, - { name = "pytest-asyncio" }, - { name = "pytest-xdist" }, - { name = "python-dotenv" }, ] [package.metadata] @@ -516,10 +404,6 @@ dev = [ { name = "mypy", specifier = "==1.15.0" }, { name = "pylint", specifier = "==3.2.3" }, { name = "pyright", specifier = "==1.1.398" }, - { name = "pytest", specifier = ">=8.0.0" }, - { name = "pytest-asyncio", specifier = ">=0.24.0" }, - { name = "pytest-xdist", specifier = ">=3.6.0" }, - { name = "python-dotenv", specifier = ">=1.0.0" }, ] [[package]]