api.md

Shared Types

from dataherald.types import (
    GoldenSqlResponse,
    InstructionResponse,
    NlGenerationResponse,
    SqlGenerationResponse,
)

DatabaseConnections

Types:

from dataherald.types import DBConnectionResponse, DatabaseConnectionListResponse

Methods:

• client.database_connections.create(**params) -> DBConnectionResponse
• client.database_connections.retrieve(id) -> DBConnectionResponse
• client.database_connections.update(id, **params) -> DBConnectionResponse
• client.database_connections.list() -> DatabaseConnectionListResponse

Drivers

Types:

from dataherald.types.database_connections import DriverResponse, DriverListResponse

Methods:

• client.database_connections.drivers.list() -> DriverListResponse

Finetunings

Types:

from dataherald.types import FinetuningResponse, FinetuningListResponse

Methods:

• client.finetunings.create(**params) -> FinetuningResponse
• client.finetunings.retrieve(id) -> FinetuningResponse
• client.finetunings.list(**params) -> FinetuningListResponse
• client.finetunings.cancel(id) -> FinetuningResponse

GoldenSqls

Types:

from dataherald.types import (
    AdminConsoleGoldenSqlResponse,
    GoldenSqlListResponse,
    GoldenSqlDeleteResponse,
    GoldenSqlUploadResponse,
)

Methods:

• client.golden_sqls.retrieve(id) -> GoldenSqlResponse
• client.golden_sqls.list(**params) -> GoldenSqlListResponse
• client.golden_sqls.delete(id) -> object
• client.golden_sqls.upload(**params) -> GoldenSqlUploadResponse

Instructions

Types:

from dataherald.types import InstructionListResponse, InstructionDeleteResponse

Methods:

• client.instructions.create(**params) -> InstructionResponse
• client.instructions.retrieve(id) -> InstructionResponse
• client.instructions.update(id, **params) -> InstructionResponse
• client.instructions.list(**params) -> InstructionListResponse
• client.instructions.delete(id) -> object

First

Methods:

• client.instructions.first.retrieve() -> InstructionResponse

Generations

Types:

from dataherald.types import GenerationListItem, GenerationResponse, GenerationListResponse

Methods:

• client.generations.create(id) -> GenerationResponse
• client.generations.retrieve(id) -> GenerationResponse
• client.generations.update(id, **params) -> GenerationResponse
• client.generations.list(**params) -> GenerationListResponse
• client.generations.nl_generation(id) -> NlGenerationResponse
• client.generations.sql_generation(id, **params) -> GenerationResponse

Prompts

Types:

from dataherald.types import PromptResponse, PromptListResponse

Methods:

• client.prompts.create(**params) -> PromptResponse
• client.prompts.retrieve(id) -> PromptResponse
• client.prompts.list(**params) -> PromptListResponse

SqlGenerations

Types:

from dataherald.types.prompts import SqlGenerationRetrieveResponse

Methods:

• client.prompts.sql_generations.create(id, **params) -> SqlGenerationResponse
• client.prompts.sql_generations.retrieve(id, **params) -> object
• client.prompts.sql_generations.nl_generations(id, **params) -> NlGenerationResponse

SqlGenerations

Types:

from dataherald.types import SqlGenerationListResponse, SqlGenerationExecuteResponse

Methods:

• client.sql_generations.create(**params) -> SqlGenerationResponse
• client.sql_generations.retrieve(id) -> SqlGenerationResponse
• client.sql_generations.list(**params) -> SqlGenerationListResponse
• client.sql_generations.execute(id, **params) -> SqlGenerationExecuteResponse

NlGenerations

Types:

from dataherald.types.sql_generations import NlGenerationRetrieveResponse

Methods:

• client.sql_generations.nl_generations.create(id, **params) -> NlGenerationResponse
• client.sql_generations.nl_generations.retrieve(id, **params) -> object

NlGenerations

Types:

from dataherald.types import NlGenerationListResponse

Methods:

• client.nl_generations.create(**params) -> NlGenerationResponse
• client.nl_generations.retrieve(id) -> NlGenerationResponse
• client.nl_generations.list(**params) -> NlGenerationListResponse

TableDescriptions

Types:

from dataherald.types import (
    TableDescriptionResponse,
    TableDescriptionListResponse,
    TableDescriptionSyncSchemasResponse,
)

Methods:

• client.table_descriptions.retrieve(id) -> TableDescriptionResponse
• client.table_descriptions.update(id, **params) -> TableDescriptionResponse
• client.table_descriptions.list(**params) -> TableDescriptionListResponse
• client.table_descriptions.sync_schemas(**params) -> TableDescriptionSyncSchemasResponse

Heartbeat

Types:

from dataherald.types import HeartbeatRetrieveResponse

Methods:

• client.heartbeat.retrieve() -> object

Engine

Types:

from dataherald.types import EngineHeartbeatResponse

Methods:

• client.engine.heartbeat() -> object