Expand description
JSON request and response types for the Chalk REST API.
These structs mirror the shapes the Chalk HTTP API expects and returns.
We use serde to automatically convert between Rust structs and JSON.
Structs§
- Batch
Report - Status report for an offline query batch job.
- Chalk
Error - A structured error returned by the Chalk server.
- Dataset
Revision - A single revision (run) of an offline query dataset.
- Feature
Encoding Options - Controls how structured feature types are encoded in the response.
- Feature
Meta - Metadata about how a single feature was resolved.
- Feature
Result - A single feature value in the query response.
- GetOffline
Query JobResponse - Response from
GET /v2/offline_query/{revision_id}. - GetOffline
Query Status Response - Response from
GET /v4/offline_query/{job_id}/status. - Offline
Query Input - Inline input data for an offline query — a columnar table.
- Offline
Query Input Sql - Use a SQL query to generate input data.
- Offline
Query Input Uri - Point to an existing Parquet file on S3/GCS.
- Offline
Query Request - The body we POST to
/v4/offline_query. - Offline
Query Response - The response from
/v4/offline_query. - Online
Query Context - Tags and resolver constraints for a query.
- Online
Query Request - The body we POST to
/v1/query/online. - Online
Query Response - The response from
/v1/query/online. - Query
Meta - Metadata about the overall query execution.
- Query
Options - Options that control query behavior (used by both
queryandquery_bulk). - Resolver
Exception - Details about a Python exception that occurred inside a resolver.
- Resource
Requests - Resource requests for an offline query job.
- Token
Exchange Request - The request body for the token exchange endpoint (
/v1/oauth/token). - Token
Response - The response from the token exchange endpoint.
- Upload
Features Result - The response from
POST /v1/upload_features/multi.
Enums§
- Offline
Query Input Type - Input for an offline query — inline data, a Parquet URI, or a SQL query.