Data Model
The TensorZero Gateway stores inference and feedback data in ClickHouse. This data can be used for observability, experimentation, and optimization.
ChatInference
The ChatInference
table stores information about inference requests for Chat Functions made to the TensorZero Gateway.
A ChatInference
row can be associated with one or more ModelInference
rows, depending on the variant’s type
.
For chat_completion
, there will be a one-to-one relationship between rows in the two tables.
For other variant types, there might be more associated rows.
Column | Type | Notes |
---|---|---|
id | UUID | Must be a UUIDv7 |
function_name | String | |
variant_name | String | |
episode_id | UUID | Must be a UUIDv7 |
input | String (JSON) | input field in the /inference request body |
output | String (JSON) | Array of content blocks |
tool_params | String (JSON) | Object with any tool parameters (e.g. tool_choice , available_tools ) used for the inference |
inference_params | String (JSON) | Object with any inference parameters per variant type (e.g. {"chat_completion": {"temperature": 0.5}} ) |
processing_time_ms | UInt32 | |
timestamp | DateTime | Materialized from id (using UUIDv7ToDateTime function) |
tags | Map(String, String) | User-assigned tags (e.g. {"user_id": "123"} ) |
JsonInference
The JsonInference
table stores information about inference requests for JSON Functions made to the TensorZero Gateway.
A JsonInference
row can be associated with one or more ModelInference
rows, depending on the variant’s type
.
For chat_completion
, there will be a one-to-one relationship between rows in the two tables.
For other variant types, there might be more associated rows.
Column | Type | Notes |
---|---|---|
id | UUID | Must be a UUIDv7 |
function_name | String | |
variant_name | String | |
episode_id | UUID | Must be a UUIDv7 |
input | String (JSON) | input field in the /inference request body |
output | String (JSON) | Object with parsed and raw fields |
output_schema | String (JSON) | Schema that the output must conform to |
inference_params | String (JSON) | Object with any inference parameters per variant type (e.g. {"chat_completion": {"temperature": 0.5}} ) |
processing_time_ms | UInt32 | |
timestamp | DateTime | Materialized from id (using UUIDv7ToDateTime function) |
tags | Map(String, String) | User-assigned tags (e.g. {"user_id": "123"} ) |
ModelInference
The ModelInference
table stores information about each inference request to a model provider.
This is the inference request you’d make if you had called the model provider directly.
Column | Type | Notes |
---|---|---|
id | UUID | Must be a UUIDv7 |
inference_id | UUID | Must be a UUIDv7 |
raw_request | String | Raw request as sent to the model provider (varies) |
raw_response | String | Raw response from the model provider (varies) |
model_name | String | Name of the model used for the inference |
model_provider_name | String | Name of the model provider used for the inference |
input_tokens | UInt32 | |
output_tokens | UInt32 | |
response_time_ms | UInt32 | |
ttft_ms | Nullable(UInt32) | Only available in streaming inferences |
timestamp | DateTime | Materialized from id (using UUIDv7ToDateTime function) |
system | String | The system input to the model |
input_messages | Array(RequestMessage) | The user and assistant messages input to the model |
output | Array(ContentBlock) | The output of the model |
A RequestMessage
is an object with shape {role: "user" | "assistant", content: List[ContentBlock]}
(content blocks are defined here).
DynamicInContextLearningExample
The DynamicInContextLearningExample
table stores examples for dynamic in-context learning variants.
Column | Type | Notes |
---|---|---|
id | UUID | Must be a UUIDv7 |
function_name | String | |
variant_name | String | |
namespace | String | |
input | String (JSON) | |
output | String | |
embedding | Array(Float32) | |
timestamp | DateTime | Materialized from id (using UUIDv7ToDateTime function) |
BooleanMetricFeedback
The BooleanMetricFeedback
table stores feedback for metrics of type = "boolean"
.
Column | Type | Notes |
---|---|---|
id | UUID | Must be a UUIDv7 |
target_id | UUID | Must be a UUIDv7 that is either inference_id or episode_id depending on level in metric config |
metric_name | String | |
value | Bool | |
timestamp | DateTime | Materialized from id (using UUIDv7ToDateTime function) |
tags | Map(String, String) | User-assigned tags (e.g. {"author": "Alice"} ) |
FloatMetricFeedback
The FloatMetricFeedback
table stores feedback for metrics of type = "float"
.
Column | Type | Notes |
---|---|---|
id | UUID | Must be a UUIDv7 |
target_id | UUID | Must be a UUIDv7 that is either inference_id or episode_id depending on level in metric config |
metric_name | String | |
value | Float32 | |
timestamp | DateTime | Materialized from id (using UUIDv7ToDateTime function) |
tags | Map(String, String) | User-assigned tags (e.g. {"author": "Alice"} ) |
CommentFeedback
The CommentFeedback
table stores feedback provided with metric_name
of "comment"
.
Comments are free-form text feedbacks.
Column | Type | Notes |
---|---|---|
id | UUID | Must be a UUIDv7 |
target_id | UUID | Must be a UUIDv7 that is either inference_id or episode_id depending on level in metric config |
target_type | "inference" or "episode" | |
value | String | |
timestamp | DateTime | Materialized from id (using UUIDv7ToDateTime function) |
tags | Map(String, String) | User-assigned tags (e.g. {"author": "Alice"} ) |
DemonstrationFeedback
The DemonstrationFeedback
table stores feedback in the form of demonstrations.
Demonstrations are examples of good behaviors.
Column | Type | Notes |
---|---|---|
id | UUID | Must be a UUIDv7 |
inference_id | UUID | Must be a UUIDv7 |
value | String | The demonstration or example provided as feedback (must match function output) |
timestamp | DateTime | Materialized from id (using UUIDv7ToDateTime function) |
tags | Map(String, String) | User-assigned tags (e.g. {"author": "Alice"} ) |
BatchRequest
The BatchRequest
table stores information about batch requests made to model providers. We update it every time a particular batch_id
is created or polled.
Column | Type | Notes |
---|---|---|
batch_id | UUID | Must be a UUIDv7 |
id | UUID | Must be a UUIDv7 |
batch_params | String | Parameters used for the batch request |
model_name | String | Name of the model used |
model_provider_name | String | Name of the model provider |
status | String | One of: ‘pending’, ‘completed’, ‘failed’ |
errors | Array(String) | Array of error messages if status is ‘failed’ |
timestamp | DateTime | Materialized from id (using UUIDv7ToDateTime function) |
raw_request | String | Raw request sent to the model provider |
raw_response | String | Raw response received from the model provider |
function_name | String | Name of the function being called |
variant_name | String | Name of the function variant |
BatchModelInference
The BatchModelInference
table stores information about inferences made as part of a batch request.
Once the request succeeds, we use this information to populate the ChatInference
, JsonInference
, and ModelInference
tables.
Column | Type | Notes |
---|---|---|
inference_id | UUID | Must be a UUIDv7 |
batch_id | UUID | Must be a UUIDv7 |
function_name | String | Name of the function being called |
variant_name | String | Name of the function variant |
episode_id | UUID | Must be a UUIDv7 |
input | String (JSON) | input field in the /inference request body |
system | String | The system input to the model |
input_messages | Array(RequestMessage) | The user and assistant messages input to the model |
tool_params | String (JSON) | Object with any tool parameters (e.g. tool_choice , available_tools ) used for the inference |
inference_params | String (JSON) | Object with any inference parameters per variant type (e.g. {"chat_completion": {"temperature": 0.5}} ) |
raw_request | String | Raw request sent to the model provider |
model_name | String | Name of the model used |
model_provider_name | String | Name of the model provider |
output_schema | String | Optional schema for JSON outputs |
tags | Map(String, String) | User-assigned tags (e.g. {"author": "Alice"} ) |
timestamp | DateTime | Materialized from id (using UUIDv7ToDateTime function) |
Materialized View Tables
Materialized views in columnar databases like ClickHouse pre-compute alternative indexings of data, dramatically improving query performance compared to computing results on-the-fly. In TensorZero’s case, we store denormalized data about inferences and feedback in the materialized views below to support efficient queries for common downstream use cases.
FeedbackTag
The FeedbackTag
table stores tags associated with various feedback types. Tags are used to categorize and add metadata to feedback entries, allowing for user-defined filtering later on. Data is inserted into this table by materialized views reading from the BooleanMetricFeedback
, CommentFeedback
, DemonstrationFeedback
, and FloatMetricFeedback
tables.
Column | Type | Notes |
---|---|---|
metric_name | String | Name of the metric the tag is associated with. |
key | String | Key of the tag. |
value | String | Value of the tag. |
feedback_id | UUID | UUID referencing the related feedback entry (e.g., BooleanMetricFeedback.id ). |
InferenceById
The InferenceById
table is a materialized view that combines data from ChatInference
and JSONInference
.
Notably, it indexes the table by id
for fast lookup by the gateway to validate feedback requests.
Column | Type | Notes |
---|---|---|
id | UUID | Must be a UUIDv7 |
function_name | String | |
variant_name | String | |
episode_id | UUID | Must be a UUIDv7 |
function_type | String | Either ‘chat’ or ‘json’ |
InferenceTag
The InferenceTag
table stores tags associated with inferences. Tags are used to categorize and add metadata to inferences, allowing for user-defined filtering later on. Data is inserted into this table by materialized views reading from the ChatInference
and JsonInference
tables.
Column | Type | Notes |
---|---|---|
function_name | String | Name of the function the tag is associated with. |
key | String | Key of the tag. |
value | String | Value of the tag. |
inference_id | UUID | UUID referencing the related inference (e.g., ChatInference.id ). |
BatchIdByInferenceId
The BatchIdByInferenceId
table maps inference IDs to batch IDs, allowing for efficient lookup of which batch an inference belongs to.
Column | Type | Notes |
---|---|---|
inference_id | UUID | Must be a UUIDv7 |
batch_id | UUID | Must be a UUIDv7 |