api.md

Shared Types

from asktable.types import Policy

Sys

Types:

from asktable.types import SyUpdateConfigResponse

Methods:

• client.sys.update_config(**params) -> SyUpdateConfigResponse

Projects

Types:

from asktable.types.sys import APIKey, ModelGroup, Project, ProjectModelGroupsResponse

Methods:

• client.sys.projects.create(**params) -> Project
• client.sys.projects.retrieve(project_id) -> Project
• client.sys.projects.update(project_id, **params) -> Project
• client.sys.projects.list(**params) -> SyncPage[Project]
• client.sys.projects.delete(project_id) -> object
• client.sys.projects.export(project_id) -> object
• client.sys.projects.import_(**params) -> object
• client.sys.projects.model_groups() -> ProjectModelGroupsResponse

APIKeys

Types:

from asktable.types.sys.projects import APIKeyCreateResponse, APIKeyListResponse

Methods:

• client.sys.projects.api_keys.create(project_id, **params) -> APIKeyCreateResponse
• client.sys.projects.api_keys.list(project_id) -> APIKeyListResponse
• client.sys.projects.api_keys.delete(key_id, *, project_id) -> None
• client.sys.projects.api_keys.create_token(project_id, **params) -> object

Securetunnels

Types:

from asktable.types import SecureTunnel, SecuretunnelListLinksResponse

Methods:

• client.securetunnels.create(**params) -> SecureTunnel
• client.securetunnels.retrieve(securetunnel_id) -> SecureTunnel
• client.securetunnels.update(securetunnel_id, **params) -> SecureTunnel
• client.securetunnels.list(**params) -> SyncPage[SecureTunnel]
• client.securetunnels.delete(securetunnel_id) -> None
• client.securetunnels.list_links(securetunnel_id, **params) -> SyncPage[SecuretunnelListLinksResponse]

Roles

Types:

from asktable.types import Role, RoleGetPolicesResponse

Methods:

• client.roles.create(**params) -> Role
• client.roles.retrieve(role_id) -> Role
• client.roles.update(role_id, **params) -> Role
• client.roles.list(**params) -> SyncPage[Role]
• client.roles.delete(role_id) -> object
• client.roles.get_polices(role_id) -> RoleGetPolicesResponse
• client.roles.get_variables(role_id, **params) -> object

Policies

Methods:

• client.policies.create(**params) -> Policy
• client.policies.retrieve(policy_id) -> Policy
• client.policies.update(policy_id, **params) -> Policy
• client.policies.list(**params) -> SyncPage[Policy]
• client.policies.delete(policy_id) -> None

Chats

Types:

from asktable.types import AIMessage, Chat, ToolMessage, UserMessage, ChatRetrieveResponse

Methods:

• client.chats.create(**params) -> Chat
• client.chats.retrieve(chat_id) -> ChatRetrieveResponse
• client.chats.list(**params) -> SyncPage[Chat]
• client.chats.delete(chat_id) -> None

Messages

Types:

from asktable.types.chats import MessageCreateResponse, MessageRetrieveResponse, MessageListResponse

Methods:

• client.chats.messages.create(chat_id, **params) -> MessageCreateResponse
• client.chats.messages.retrieve(message_id, *, chat_id) -> MessageRetrieveResponse
• client.chats.messages.list(chat_id, **params) -> SyncPage[MessageListResponse]

Datasources

Types:

from asktable.types import (
    Datasource,
    Index,
    Meta,
    DatasourceRetrieveResponse,
    DatasourceRetrieveRuntimeMetaResponse,
)

Methods:

• client.datasources.create(**params) -> Datasource
• client.datasources.retrieve(datasource_id) -> DatasourceRetrieveResponse
• client.datasources.update(datasource_id, **params) -> Datasource
• client.datasources.list(**params) -> SyncPage[Datasource]
• client.datasources.delete(datasource_id) -> object
• client.datasources.add_file(datasource_id, **params) -> object
• client.datasources.delete_file(file_id, *, datasource_id) -> object
• client.datasources.retrieve_runtime_meta(datasource_id) -> DatasourceRetrieveRuntimeMetaResponse
• client.datasources.update_field(datasource_id, **params) -> object

Meta

Methods:

• client.datasources.meta.create(datasource_id, **params) -> object
• client.datasources.meta.retrieve(datasource_id) -> Meta
• client.datasources.meta.update(datasource_id, **params) -> object
• client.datasources.meta.annotate(datasource_id, **params) -> object

UploadParams

Methods:

• client.datasources.upload_params.create(**params) -> object

Indexes

Methods:

• client.datasources.indexes.create(ds_id, **params) -> object
• client.datasources.indexes.list(ds_id, **params) -> SyncPage[Index]
• client.datasources.indexes.delete(index_id, *, ds_id) -> object

Bots

Types:

from asktable.types import Chatbot

Methods:

• client.bots.create(**params) -> Chatbot
• client.bots.retrieve(bot_id) -> Chatbot
• client.bots.update(bot_id, **params) -> Chatbot
• client.bots.list(**params) -> SyncPage[Chatbot]
• client.bots.delete(bot_id) -> object
• client.bots.invite(bot_id, **params) -> object

Auth

Types:

from asktable.types import AuthMeResponse

Methods:

• client.auth.create_token(**params) -> object
• client.auth.me() -> AuthMeResponse

Answers

Types:

from asktable.types import AnswerResponse

Methods:

• client.answers.create(**params) -> AnswerResponse
• client.answers.list(**params) -> SyncPage[AnswerResponse]

Sqls

Types:

from asktable.types import QueryResponse

Methods:

• client.sqls.create(**params) -> QueryResponse
• client.sqls.list(**params) -> SyncPage[QueryResponse]

Caches

Methods:

• client.caches.delete(cache_id) -> None

Integration

Types:

from asktable.types import FileAskResponse

Methods:

• client.integration.create_excel_ds(**params) -> Datasource
• client.integration.excel_csv_ask(**params) -> FileAskResponse

BusinessGlossary

Types:

from asktable.types import Entry, EntryWithDefinition, BusinessGlossaryCreateResponse

Methods:

• client.business_glossary.create(**params) -> BusinessGlossaryCreateResponse
• client.business_glossary.retrieve(entry_id) -> EntryWithDefinition
• client.business_glossary.update(entry_id, **params) -> Entry
• client.business_glossary.list(**params) -> SyncPage[EntryWithDefinition]
• client.business_glossary.delete(entry_id) -> object

Preferences

Types:

from asktable.types import (
    PreferenceCreateResponse,
    PreferenceRetrieveResponse,
    PreferenceUpdateResponse,
)

Methods:

• client.preferences.create(**params) -> PreferenceCreateResponse
• client.preferences.retrieve() -> PreferenceRetrieveResponse
• client.preferences.update(**params) -> PreferenceUpdateResponse
• client.preferences.delete() -> object

Trainings

Types:

from asktable.types import TrainingCreateResponse, TrainingUpdateResponse, TrainingListResponse

Methods:

• client.trainings.create(**params) -> TrainingCreateResponse
• client.trainings.update(id, **params) -> TrainingUpdateResponse
• client.trainings.list(**params) -> SyncPage[TrainingListResponse]
• client.trainings.delete(id, **params) -> object

Project

Types:

from asktable.types import ProjectListModelGroupsResponse

Methods:

• client.project.retrieve() -> Project
• client.project.update(**params) -> Project
• client.project.list_model_groups() -> ProjectListModelGroupsResponse

Scores

Types:

from asktable.types import ScoreCreateResponse

Methods:

• client.scores.create(**params) -> ScoreCreateResponse

Files

Methods:

• client.files.retrieve(file_id) -> object

Dataframes

Types:

from asktable.types import DataframeRetrieveResponse

Methods:

• client.dataframes.retrieve(dataframe_id) -> DataframeRetrieveResponse

Polish

Types:

from asktable.types import PolishCreateResponse

Methods:

• client.polish.create(**params) -> PolishCreateResponse

User

Projects

Types:

from asktable.types.user import ProjectRetrieveModelGroupsResponse

Methods:

• client.user.projects.retrieve_model_groups() -> ProjectRetrieveModelGroupsResponse
• client.user.projects.retrieve_my_project() -> Project
• client.user.projects.update_my_project(**params) -> Project

ATS

Types:

from asktable.types import (
    ATSCreateResponse,
    ATSRetrieveResponse,
    ATSUpdateResponse,
    ATSListResponse,
)

Methods:

• client.ats.create(**params) -> ATSCreateResponse
• client.ats.retrieve(ats_id) -> ATSRetrieveResponse
• client.ats.update(ats_id, **params) -> ATSUpdateResponse
• client.ats.list(**params) -> SyncPage[ATSListResponse]
• client.ats.delete(ats_id, **params) -> object

TestCase

Types:

from asktable.types.ats import (
    TestCaseCreateResponse,
    TestCaseRetrieveResponse,
    TestCaseUpdateResponse,
    TestCaseListResponse,
)

Methods:

• client.ats.test_case.create(ats_id, **params) -> TestCaseCreateResponse
• client.ats.test_case.retrieve(atc_id, *, ats_id) -> TestCaseRetrieveResponse
• client.ats.test_case.update(atc_id, *, ats_id, **params) -> TestCaseUpdateResponse
• client.ats.test_case.list(ats_id, **params) -> SyncPage[TestCaseListResponse]
• client.ats.test_case.delete(atc_id, *, ats_id) -> object

Task

Types:

from asktable.types.ats import (
    TaskRetrieveResponse,
    TaskListResponse,
    TaskGetCaseTasksResponse,
    TaskRunResponse,
)

Methods:

• client.ats.task.retrieve(ats_task_id, *, ats_id) -> TaskRetrieveResponse
• client.ats.task.list(ats_id, **params) -> SyncPage[TaskListResponse]
• client.ats.task.get_case_tasks(ats_task_id, *, ats_id, **params) -> TaskGetCaseTasksResponse
• client.ats.task.run(ats_id, **params) -> TaskRunResponse