databay-cli 0.1.0__py3-none-any.whl

databay/models/linkedin_source.py

@@ -0,0 +1,11 @@
+"""Models of the ``linkedin_source`` noun.
+
+Generated by python/tools/gen_client.py from contract/core.json; do not edit.
+"""
+
+from __future__ import annotations
+
+from databay.models.shared import AdSourceResponse
+
+
+LinkedinSourceListResponse = list[AdSourceResponse]

databay/models/me.py

@@ -0,0 +1,71 @@
+"""Models of the ``me`` noun.
+
+Generated by python/tools/gen_client.py from contract/core.json; do not edit.
+"""
+
+from __future__ import annotations
+
+from datetime import datetime
+from typing import Any
+
+from databay.model_base import OpenStrEnum, ResponseModel
+
+
+class FeatureFlagsState(OpenStrEnum):
+    OK = 'ok'
+    UNAVAILABLE = 'unavailable'
+    NO_SUBSCRIPTION = 'no_subscription'
+    NO_ORG = 'no_org'
+
+
+class FeatureSource(OpenStrEnum):
+    PLAN = 'plan'
+    OVERRIDE = 'override'
+    CEILING = 'ceiling'
+    PREREQUISITE = 'prerequisite'
+    NOT_READY = 'not_ready'
+
+
+class Principal(OpenStrEnum):
+    USER = 'user'
+    API_KEY = 'api_key'
+    STAFF = 'staff'
+
+
+class FeatureGrant(ResponseModel):
+    blocked_by: str | None = None
+    enabled: bool
+    expires_at: datetime | None = None
+    source: FeatureSource
+
+
+class User(ResponseModel):
+    access_token: str | None = None
+    acr: str | None = None
+    active_org: str | None = None
+    azp: str | None = None
+    dashboard_flags: dict[str, bool] | None = None
+    email: str | None = None
+    entitlements: dict[str, Any] | None = None
+    family_name: str | None = None
+    feature_flags: dict[str, bool] | None = None
+    feature_flags_state: FeatureFlagsState | None = None
+    feature_sources: dict[str, FeatureGrant] | None = None
+    given_name: str | None = None
+    iat: int | None = None
+    max_sources: int | None = None
+    name: str | None = None
+    needs_org_choice: bool | None = None
+    orders_included: int | None = None
+    orders_used: int | None = None
+    organization: list[str] | None = None
+    orgs_unavailable: bool | None = None
+    over_cap: bool = False
+    plan: str | None = None
+    preferred_username: str | None = None
+    principal: Principal = 'user'
+    roles: list[str] | None = None
+    staff_roles: list[str] | None = None
+    sub: str
+    trial_ends_at: datetime | None = None
+    upgrade_cta: bool | None = None

databay/models/meta_ads_source.py

@@ -0,0 +1,11 @@
+"""Models of the ``meta_ads_source`` noun.
+
+Generated by python/tools/gen_client.py from contract/core.json; do not edit.
+"""
+
+from __future__ import annotations
+
+from databay.models.shared import AdSourceResponse
+
+
+MetaAdsSourceListResponse = list[AdSourceResponse]

databay/models/metric_models.py

@@ -0,0 +1,274 @@
+"""Models of the ``metric_models`` noun.
+
+Generated by python/tools/gen_client.py from contract/core.json; do not edit.
+"""
+
+from __future__ import annotations
+
+from datetime import datetime
+
+from pydantic import Field
+
+from databay.model_base import OpenStrEnum, RequestModel, ResponseModel
+
+
+class CustomerModelSource(OpenStrEnum):
+    UPLOAD = 'upload'
+    GIT = 'git'
+    DBT_IMPORT = 'dbt_import'
+    FORM = 'form'
+
+
+class CustomerModelState(OpenStrEnum):
+    DRAFT = 'draft'
+    PUBLISHED = 'published'
+    SUPERSEDED = 'superseded'
+
+
+class DimensionType(OpenStrEnum):
+    TIME = 'time'
+    STRING = 'string'
+    NUMBER = 'number'
+
+
+class MeasureFilterOp(OpenStrEnum):
+    EQ = '='
+    NE = '!='
+    GT = '>'
+    GE = '>='
+    LT = '<'
+    LE = '<='
+    IN = 'in'
+    IS_NULL = 'is_null'
+    IS_NOT_NULL = 'is_not_null'
+
+
+class MeasureType(OpenStrEnum):
+    SUM = 'sum'
+    COUNT = 'count'
+    COUNT_DISTINCT = 'count_distinct'
+    AVG = 'avg'
+    MIN = 'min'
+    MAX = 'max'
+    NUMBER = 'number'
+
+
+class MetricFormat(OpenStrEnum):
+    NUMBER = 'number'
+    CURRENCY = 'currency'
+    PERCENT = 'percent'
+
+
+class ModelChange(OpenStrEnum):
+    UNCHANGED = 'unchanged'
+    ADDED = 'added'
+    CHANGED = 'changed'
+    REMOVED = 'removed'
+
+
+class NotFormEditable(OpenStrEnum):
+    SEVERAL_TABLES = 'several_tables'
+    MAPPED_COLUMNS = 'mapped_columns'
+    SHARED_TABLE = 'shared_table'
+    CUSTOM_CUBE_NAME = 'custom_cube_name'
+    RENAMED_BREAKDOWN = 'renamed_breakdown'
+    OVER_METRICS = 'over_metrics'
+    COLUMN_EXPRESSION = 'column_expression'
+
+
+class Breakdown(ResponseModel):
+    column: str
+    type: str
+
+
+class BreakdownsWrite(RequestModel):
+    breakdowns: list[Breakdown]
+    revision: int
+
+
+class DbtImportNote(ResponseModel):
+    note: str
+    relation: str
+
+
+class ModelVersionSummary(ResponseModel):
+    author_user_id: str
+    created_at: datetime
+    digest: str
+    git_commit: str | None
+    published_at: datetime | None
+    source: CustomerModelSource
+    state: CustomerModelState
+    version: int
+
+
+class DbtImportOut(ResponseModel):
+    comments_dropped: bool
+    cubes: list[str]
+    digest: str
+    draft: ModelVersionSummary | None
+    metrics: list[str]
+    notes: list[DbtImportNote]
+    revision: int | None
+    yaml: str
+
+
+class DbtImportRequest(RequestModel):
+    dry_run: bool = False
+    relations: list[str] | None = None
+    replace_draft: bool = False
+    revision: int | None = None
+
+
+class DimensionSpec(ResponseModel):
+    column: str
+    name: str
+    type: DimensionType
+
+
+class FormCondition(ResponseModel):
+    column: str
+    op: str
+    value: int | float | str | None = None
+    values: list[int | float | str] | None = None
+
+
+class MetricFields(ResponseModel):
+    aggregation: str
+    column: str | None = None
+    conditions: list[FormCondition] | None = None
+    description: str
+    format: str | None = None
+    name: str
+    table: str
+    title: str | None = None
+
+
+class FormMetric(ResponseModel):
+    cube: str
+    editable: bool
+    fields_: MetricFields | None = Field(alias='fields')
+    name: str
+    reason: NotFormEditable | None
+
+
+class FormTable(ResponseModel):
+    breakdowns: list[Breakdown]
+    cube: str
+    editable: bool
+    reason: NotFormEditable | None
+    table: str
+
+
+class GitFileProblem(ResponseModel):
+    file: str
+    path: str
+    reason: str
+
+
+class GitModelError(ResponseModel):
+    code: str
+    commit: str
+    errors: list[GitFileProblem]
+
+
+class MeasureFilter(ResponseModel):
+    column: str
+    op: MeasureFilterOp
+    value: int | float | str | None = None
+    values: list[int | float | str] | None = None
+
+
+class MetricEditOut(ResponseModel):
+    affected_metrics: list[str]
+    comments_dropped: bool
+    draft: ModelVersionSummary
+    revision: int
+
+
+class MetricFormOut(ResponseModel):
+    based_on: CustomerModelState | None
+    git_managed: bool
+    metrics: list[FormMetric]
+    revision: int
+    tables: list[FormTable]
+
+
+class MetricSpec(ResponseModel):
+    description: str
+    filters: list[MeasureFilter] = []
+    format: MetricFormat | None = None
+    name: str
+    sql: str | None = None
+    title: str | None = None
+    type: MeasureType
+
+
+class MetricWrite(RequestModel):
+    breakdowns: list[Breakdown] | None = None
+    metric: MetricFields
+    revision: int
+
+
+class ModelMetricChange(ResponseModel):
+    change: ModelChange
+    cube: str
+    draft: MetricSpec | None
+    name: str
+    published: MetricSpec | None
+    table: str
+
+
+class ModelTableChange(ResponseModel):
+    change: ModelChange
+    cube: str
+    draft: list[DimensionSpec] | None
+    published: list[DimensionSpec] | None
+    table: str
+
+
+class ModelChangesOut(ResponseModel):
+    draft: ModelVersionSummary | None
+    git_managed: bool
+    metrics: list[ModelMetricChange]
+    published_version: int | None
+    revision: int
+    tables: list[ModelTableChange]
+
+
+class ModelPush(RequestModel):
+    revision: int | None = None
+    yaml: str
+
+
+class ModelUpload(RequestModel):
+    yaml: str
+
+
+class ModelValidationOut(ResponseModel):
+    cubes: list[str]
+    digest: str
+    metrics: list[str]
+
+
+class ModelVersionListOut(ResponseModel):
+    last_git_commit: str | None
+    last_git_error: GitModelError | None
+    versions: list[ModelVersionSummary]
+
+
+class ModelVersionOut(ResponseModel):
+    author_user_id: str
+    created_at: datetime
+    digest: str
+    git_commit: str | None
+    published_at: datetime | None
+    revision: int
+    source: CustomerModelSource
+    state: CustomerModelState
+    version: int
+    yaml: str
+
+
+class PublishRequest(RequestModel):
+    revision: int | None = None

databay/models/metrics.py

@@ -0,0 +1,158 @@
+"""Models of the ``metrics`` noun.
+
+Generated by python/tools/gen_client.py from contract/core.json; do not edit.
+"""
+
+from __future__ import annotations
+
+from datetime import date
+from typing import Literal
+
+from pydantic import Field
+
+from databay.model_base import OpenStrEnum, RequestModel, ResponseModel
+
+
+class FilterOp(OpenStrEnum):
+    EQUALS = 'equals'
+    NOTEQUALS = 'notEquals'
+    CONTAINS = 'contains'
+    NOTCONTAINS = 'notContains'
+    STARTSWITH = 'startsWith'
+    ENDSWITH = 'endsWith'
+    GT = 'gt'
+    GTE = 'gte'
+    LT = 'lt'
+    LTE = 'lte'
+    SET = 'set'
+    NOTSET = 'notSet'
+
+
+class Grain(OpenStrEnum):
+    DAY = 'day'
+    WEEK = 'week'
+    MONTH = 'month'
+    QUARTER = 'quarter'
+    YEAR = 'year'
+
+
+class MetricSource(OpenStrEnum):
+    BUILTIN = 'builtin'
+    CUSTOMER = 'customer'
+
+
+class MetricState(OpenStrEnum):
+    READY = 'ready'
+    COMPILING = 'compiling'
+    UNAVAILABLE = 'unavailable'
+
+
+class MetricOrderDirection(OpenStrEnum):
+    ASC = 'asc'
+    DESC = 'desc'
+
+
+class Column(ResponseModel):
+    name: str
+    type: str
+
+
+class CompiledSql(ResponseModel):
+    params: list[str | int | float | bool | None]
+    text: str
+
+
+class LineageRelation(ResponseModel):
+    database: str
+    name: str
+
+
+class Lineage(ResponseModel):
+    tables: list[LineageRelation]
+    views: list[LineageRelation]
+    warehouse: str
+
+
+class MetricDefinition(ResponseModel):
+    cube: str
+    description: str
+    expression: str | None
+    members: list[str]
+    name: str
+    type: str
+
+
+class Explain(ResponseModel):
+    definition: MetricDefinition
+    lineage: Lineage
+    sql: CompiledSql
+
+
+class MetricFilter(RequestModel):
+    member: str
+    op: FilterOp
+    values: list[str] | None = None
+
+
+class MetricOut(ResponseModel):
+    cube: str
+    customer_model_version: int | None
+    description: str
+    dimensions: list[str]
+    filter_ops: list[FilterOp]
+    grains: list[Grain]
+    name: str
+    reason: str | None
+    source: MetricSource
+    state: MetricState
+    time_dimension: str | None
+    title: str | None
+    type: str
+    warehouses: list[str]
+
+
+class MetricListOut(ResponseModel):
+    metrics: list[MetricOut]
+    model_version_: int | None = Field(alias='model_version')
+    policy_revision: str
+    reason: str | None
+    state: MetricState
+
+
+class MetricOrder(RequestModel):
+    direction: MetricOrderDirection = 'asc'
+    member: str
+
+
+class TimeRange(RequestModel):
+    from_: date | None = Field(default=None, alias='from')
+    grain: Grain | None = None
+    last: str | None = None
+    to: date | None = None
+
+
+class MetricQuery(RequestModel):
+    dimensions: list[str] | None = None
+    dry_run: bool = False
+    explain: bool = False
+    filters: list[MetricFilter] | None = None
+    limit: int = 10000
+    metric: str | None = None
+    metrics: list[str] | None = None
+    model_version_: int | None = Field(default=None, alias='model_version')
+    order: list[MetricOrder] | None = None
+    time: TimeRange | None = None
+    warehouse: str | None = None
+
+
+class MetricQueryOut(ResponseModel):
+    answer_path: Literal['metric'] = 'metric'
+    columns: list[Column]
+    dry_run: bool
+    explain: Explain | None
+    model_version_: int = Field(alias='model_version')
+    policy_revision: str
+    row_count: int
+    rows: list[list[str | float | None]]
+    truncated: bool
+    warehouse: str

databay/models/models.py

@@ -0,0 +1,73 @@
+"""Models of the ``models`` noun.
+
+Generated by python/tools/gen_client.py from contract/core.json; do not edit.
+"""
+
+from __future__ import annotations
+
+from datetime import datetime
+from typing import Any
+
+from databay.model_base import OpenStrEnum, RequestModel, ResponseModel
+
+
+class GitAuthKind(OpenStrEnum):
+    DEPLOY_KEY = 'deploy_key'
+    TOKEN = 'token'
+    GITHUB_APP = 'github_app'
+
+
+class BranchCheckRequest(RequestModel):
+    ref: str
+
+
+class CheckedGitModel(ResponseModel):
+    estimated_rows: int | None
+    name: str
+    path: str
+    refresh: str
+    storage: str
+
+
+class CommitProblem(ResponseModel):
+    code: str
+    detail: str
+    extra: dict[str, Any]
+    file: str | None
+    line: int | None
+
+
+class CommitCheck(ResponseModel):
+    commit: str
+    disabled_models: list[str]
+    models: list[CheckedGitModel]
+    passed: bool
+    problems: list[CommitProblem]
+
+
+class GitSyncError(ResponseModel):
+    code: str
+    commit: str | None
+    detail: str
+    extra: dict[str, Any]
+
+
+class GitConnectionOut(ResponseModel):
+    applied_at: datetime | None
+    applied_commit: str | None
+    auth_kind: GitAuthKind
+    branch: str
+    connection_id: str
+    disabled_models: list[str]
+    error: GitSyncError | None
+    folder: str
+    github_installation_id: int | None
+    github_repo: str | None
+    last_sync_at: datetime | None
+    next_sync_at: datetime
+    project_id: str
+    public_key: str | None
+    repo_url: str
+    token_username: str | None
+    warehouse_db_uuid: str
+    webhook_path: str | None

databay/models/nlq.py

@@ -0,0 +1,92 @@
+"""Models of the ``nlq`` noun.
+
+Generated by python/tools/gen_client.py from contract/core.json; do not edit.
+"""
+
+from __future__ import annotations
+
+from typing import Any
+
+from databay.model_base import OpenStrEnum, RequestModel, ResponseModel
+
+
+class AnswerOutcome(OpenStrEnum):
+    ANSWERED = 'answered'
+    WRITTEN_OUT = 'written_out'
+    QUERY_FAILED = 'query_failed'
+
+
+class NoAnswerReason(OpenStrEnum):
+    NO_RELEVANT_TABLES = 'no_relevant_tables'
+    INSUFFICIENT_DATA = 'insufficient_data'
+    AMBIGUOUS_QUESTION = 'ambiguous_question'
+    PROVIDER_NOT_CONFIGURED = 'provider_not_configured'
+    QUERY_REFUSED = 'query_refused'
+    UNKNOWN_WAREHOUSE = 'unknown_warehouse'
+    PROVIDER_BUSY = 'provider_busy'
+
+
+class AiUsageResponse(ResponseModel):
+    limit: int
+    remaining: int
+    resets_at: str
+    used: int
+
+
+class ChatTurn(RequestModel):
+    query: str | None = None
+    question: str
+
+
+class AskRequest(RequestModel):
+    conversation_id: str | None = None
+    database_name: str | None = None
+    database_uuid: str
+    history: list[ChatTurn] | None = None
+    question: str
+
+
+class QueryMetadata(ResponseModel):
+    embedding_model: str | None = None
+    model: str
+    processing_time_ms: int
+
+
+class TableMetadata(ResponseModel):
+    database: str
+    relevance_score: float
+    table: str
+
+
+class NLQFailureResponse(ResponseModel):
+    confidence: float
+    conversation_id: str | None = None
+    message: str
+    metadata: QueryMetadata
+    query: None = None
+    reason: NoAnswerReason
+    success: bool = False
+    suggestions: list[str] | None = None
+    tables_used: list[TableMetadata] | None = None
+
+
+class QueryResult(ResponseModel):
+    columns: list[str]
+    rows: list[list[Any]]
+    truncated: bool
+
+
+class NLQSuccessResponse(ResponseModel):
+    answer: str | None = None
+    answer_outcome: AnswerOutcome | None = None
+    confidence: float
+    conversation_id: str | None = None
+    metadata: QueryMetadata
+    query: str
+    reasoning: str
+    result: QueryResult | None = None
+    success: bool = True
+    tables_used: list[TableMetadata]
+
+
+NlqAskResponse = NLQSuccessResponse | NLQFailureResponse