LogoLogo
AboutBlogLaunch app ↗
v0.23.x
v0.23.x
  • Get Started
  • Overview
  • Getting Access to Distributional
  • Install the Python SDK
  • Quickstart
  • Learning about Distributional
    • Distributional Concepts
    • Why We Test Data Distributions
    • The Flow of Data
  • Using Distributional
    • Projects
    • Runs
      • Reporting Runs
      • Setting a Baseline Run
    • Metrics
    • Tests
      • Creating Tests
        • Using Filters in Tests
        • Available Statistics and Assertions
      • Running Tests
      • Reviewing Tests
        • What Is a Similarity Index?
    • Notifications
    • Access Controls
      • Organization and Namespaces
      • Users and Permissions
      • Tokens
  • Platform
    • Sandbox
    • Self-hosted
      • Architecture
      • Deployment
        • Helm Chart
        • Terraform Module
      • Networking
      • OIDC Authentication
      • Data Security
  • Reference
    • Query Language
      • Functions
    • Python SDK
      • dbnl
      • dbnl.util
      • dbnl.experimental
      • Classes
      • Eval Module
        • Quick Start
        • dbnl.eval
        • dbnl.eval.metrics
        • Application Metric Sets
        • How-To / FAQ
        • LLM-as-judge and Embedding Metrics
        • RAG / Question Answer Example
      • Classes
  • CLI
  • Versions
    • Release Notes
Powered by GitBook

© 2025 Distributional, Inc. All Rights Reserved.

On this page
  • Project
  • Run
  • RunQuery
  • TestSession
  • ResultData
  • RunSchema

Was this helpful?

Export as PDF
  1. Reference
  2. Python SDK

Classes

Project

dbnl.sdk.models.Project(id: 'str', name: 'str', description: 'Optional[str]' = None)

description : str | None = None

id : str

name : str

Run

dbnl.sdk.models.Run(id: 'str', project_id: 'str', run_schema: 'RunSchema', display_name: 'Optional[str]' = None, metadata: 'Optional[dict[str, str]]' = None, status: "Optional[Literal['pending', 'closing', 'closed', 'canceled', 'errored']]" = None, completed_at: 'Optional[str]' = None)

completed_at : str | None = None

display_name : str | None = None

id : str

metadata : dict[str, str] | None = None

project_id : str

run_schema : RunSchema

status : Literal['pending', 'closing', 'closed', 'canceled', 'errored'] | None = None

RunQuery

dbnl.sdk.models.RunQuery(id: 'str', project_id: 'str', name: 'str', query: 'dict[str, Any]')

id : str

name : str

project_id : str

query : dict[str, Any]

TestSession

dbnl.sdk.models.TestSession(id: 'str', project_id: 'str', inputs: 'list[TestSessionInput]', status: "Literal['PENDING', 'RUNNING', 'PASSED', 'FAILED']", failure: 'Optional[str]' = None, num_tests_passed: 'Optional[int]' = None, num_tests_failed: 'Optional[int]' = None, num_tests_errored: 'Optional[int]' = None, include_tag_ids: 'Optional[list[str]]' = None, exclude_tag_ids: 'Optional[list[str]]' = None, require_tag_ids: 'Optional[list[str]]' = None)

exclude_tag_ids : list[str] | None = None

failure : str | None = None

id : str

include_tag_ids : list[str] | None = None

inputs : list[TestSessionInput]

num_tests_errored : int | None = None

num_tests_failed : int | None = None

num_tests_passed : int | None = None

project_id : str

require_tag_ids : list[str] | None = None

status : Literal['PENDING', 'RUNNING', 'PASSED', 'FAILED']

ResultData

dbnl.sdk.models.ResultData(columns, scalars)

columns : DataFrame

Alias for field number 0

scalars : DataFrame | None

Alias for field number 1

RunSchema

dbnl.sdk.models.RunSchema(columns: 'list[RunSchemaColumnSchema]', scalars: 'Optional[list[RunSchemaScalarSchema]]' = None, index: 'Optional[list[str]]' = None, components_dag: 'Optional[dict[str, list[str]]]' = None)

columns : list[RunSchemaColumnSchema]

components_dag : dict[str, list[str]] | None = None

index : list[str] | None = None

scalars : list[RunSchemaScalarSchema] | None = None

PreviousRAG / Question Answer ExampleNextCLI

Was this helpful?