Skip to content

chore: Update platform types #1075

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
Abhijeet Prasad (AbhiPrasad) merged 1 commit into from
Nov 6, 2026
Merged

chore: Update platform types #1075

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
44 changes: 27 additions & 17 deletions generated_types.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2525,7 +2525,7 @@
},
"xact_id": {
"type": "string",
"description": "Transaction id of the brainstore version at the time of the snapshot"
"description": "Transaction ID of the dataset version at the time of the snapshot"
},
"created": {
"type": [
Expand Down Expand Up @@ -2635,7 +2635,7 @@
"automation_integration"
],
"default": "env_var",
"description": "The category of the secret: env_var for regular environment variables, ai_provider for AI provider API keys"
"description": "The category of the secret: env_var for regular environment variables, ai_provider for AI provider API keys, sandbox_provider for sandbox provider credentials, automation_integration for automation delivery credentials"
}
},
"required": [
Expand Down Expand Up @@ -2847,7 +2847,7 @@
"minimum": 0,
"maximum": 1
},
"description": "A dictionary of numeric values (between 0 and 1) to log. The scores should give you a variety of signals that help you determine how accurate the outputs are compared to what you expect and diagnose failures. For example, a summarization app might have one score that tells you how accurate the summary is, and another that measures the word similarity between the generated and grouth truth summary. The word similarity score could help you determine whether the summarization was covering similar concepts or not. You can use these scores to help you sort, filter, and compare experiments"
"description": "A dictionary of numeric values (between 0 and 1) to log. The scores should give you a variety of signals that help you determine how accurate the outputs are compared to what you expect and diagnose failures. For example, a summarization app might have one score that tells you how accurate the summary is, and another that measures the word similarity between the generated and ground truth summary. The word similarity score could help you determine whether the summarization was covering similar concepts or not. You can use these scores to help you sort, filter, and compare experiments."
},
"metadata": {
"type": [
Expand Down Expand Up @@ -3453,7 +3453,7 @@
"boolean",
"null"
],
"description": "The function exists for internal purposes and should not be displayed in the list of functions."
"description": "If true, the function was created for use by another Braintrust object and is hidden from function lists in the Braintrust UI."
}
},
"required": [
Expand Down Expand Up @@ -4862,7 +4862,8 @@
"type": "object",
"properties": {
"request_source": {
"type": "string"
"type": "string",
"description": "A label identifying the caller, used to attribute usage"
},
"input": {
"description": "Argument to the function, which can be any JSON serializable value"
Expand Down Expand Up @@ -4989,7 +4990,7 @@
"span_id",
"root_span_id"
],
"description": "Identifiers for the row to to log a subspan under"
"description": "Identifiers for the row to log a subspan under"
},
"propagated_event": {
"type": [
Expand Down Expand Up @@ -5632,31 +5633,36 @@
"type": [
"string",
"null"
]
],
"description": "URL of the organization's data plane API. If unset, the Braintrust-hosted API is used."
},
"is_universal_api": {
"type": [
"boolean",
"null"
]
],
"description": "Whether the data plane at `api_url` also serves the AI proxy, at `api_url` with `/v1/proxy` appended"
},
"is_dataplane_private": {
"type": [
"boolean",
"null"
]
],
"description": "Whether the organization's data plane is only reachable from a private network"
},
"proxy_url": {
"type": [
"string",
"null"
]
],
"description": "URL of the organization's AI proxy"
},
"realtime_url": {
"type": [
"string",
"null"
]
],
"description": "URL of the organization's realtime service"
},
"created": {
"type": [
Expand All @@ -5671,14 +5677,16 @@
"string",
"null"
],
"format": "date-time"
"format": "date-time",
"description": "Date the organization was archived"
},
"deleted_at": {
"type": [
"string",
"null"
],
"format": "date-time"
"format": "date-time",
"description": "Date the organization was deleted"
},
"image_rendering_mode": {
"$ref": "#/components/schemas/ImageRenderingMode"
Expand Down Expand Up @@ -5775,7 +5783,7 @@
"update_acls",
"delete_acls"
],
"description": "Each permission permits a certain type of operation on an object in the system\n\nPermissions can be assigned to to objects on an individual basis, or grouped into roles"
"description": "Each permission permits a certain type of operation on an object in the system\n\nPermissions can be assigned to objects on an individual basis, or grouped into roles"
},
"PreprocessorId": {
"anyOf": [
Expand Down Expand Up @@ -6640,7 +6648,7 @@
"minimum": 0,
"maximum": 1
},
"description": "A dictionary of numeric values (between 0 and 1) to log. The scores should give you a variety of signals that help you determine how accurate the outputs are compared to what you expect and diagnose failures. For example, a summarization app might have one score that tells you how accurate the summary is, and another that measures the word similarity between the generated and grouth truth summary. The word similarity score could help you determine whether the summarization was covering similar concepts or not. You can use these scores to help you sort, filter, and compare logs."
"description": "A dictionary of numeric values (between 0 and 1) to log. The scores should give you a variety of signals that help you determine how accurate the outputs are compared to what you expect and diagnose failures. For example, a summarization app might have one score that tells you how accurate the summary is, and another that measures the word similarity between the generated and ground truth summary. The word similarity score could help you determine whether the summarization was covering similar concepts or not. You can use these scores to help you sort, filter, and compare logs."
},
"metadata": {
"type": [
Expand Down Expand Up @@ -8656,7 +8664,8 @@
"object",
"null"
],
"additionalProperties": {}
"additionalProperties": {},
"description": "Internal BTQL query overrides in parsed JSON form that select which dataset rows to evaluate. `filter` is a BTQL expression object, `sort` is an array of BTQL sort expressions, and `limit` is an integer."
}
},
"required": [
Expand Down Expand Up @@ -8693,7 +8702,8 @@
"object",
"null"
],
"additionalProperties": {}
"additionalProperties": {},
"description": "Internal BTQL query overrides in parsed JSON form that select which dataset rows to evaluate. `filter` is a BTQL expression object, `sort` is an array of BTQL sort expressions, and `limit` is an integer."
}
},
"required": [
Expand Down
46 changes: 38 additions & 8 deletions py/src/braintrust/_generated_types.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -666,7 +666,7 @@ class DatasetSnapshot(TypedDict):
description: str | None
xact_id: str
"""
Transaction id of the brainstore version at the time of the snapshot
Transaction ID of the dataset version at the time of the snapshot
"""
created: str | None
"""
Expand Down Expand Up @@ -723,7 +723,7 @@ class EnvVar(TypedDict):
Literal['env_var', 'ai_provider', 'sandbox_provider', 'automation_integration']
]
"""
The category of the secret: env_var for regular environment variables, ai_provider for AI provider API keys
The category of the secret: env_var for regular environment variables, ai_provider for AI provider API keys, sandbox_provider for sandbox provider credentials, automation_integration for automation delivery credentials
"""


Expand Down Expand Up @@ -850,7 +850,7 @@ class FunctionOrigin(TypedDict):
"""
internal: NotRequired[bool | None]
"""
The function exists for internal purposes and should not be displayed in the list of functions.
If true, the function was created for use by another Braintrust object and is hidden from function lists in the Braintrust UI.
"""


Expand Down Expand Up @@ -1523,7 +1523,7 @@ class InvokeParentInvokeParent(TypedDict):
"""
row_ids: NotRequired[InvokeParentInvokeParentRowIds | None]
"""
Identifiers for the row to to log a subspan under
Identifiers for the row to log a subspan under
"""
propagated_event: NotRequired[Mapping[str, Any] | None]
"""
Expand Down Expand Up @@ -1724,16 +1724,37 @@ class Organization(TypedDict):
Name of the organization
"""
api_url: NotRequired[str | None]
"""
URL of the organization's data plane API. If unset, the Braintrust-hosted API is used.
"""
is_universal_api: NotRequired[bool | None]
"""
Whether the data plane at `api_url` also serves the AI proxy, at `api_url` with `/v1/proxy` appended
"""
is_dataplane_private: NotRequired[bool | None]
"""
Whether the organization's data plane is only reachable from a private network
"""
proxy_url: NotRequired[str | None]
"""
URL of the organization's AI proxy
"""
realtime_url: NotRequired[str | None]
"""
URL of the organization's realtime service
"""
created: NotRequired[str | None]
"""
Date of organization creation
"""
archived_at: NotRequired[str | None]
"""
Date the organization was archived
"""
deleted_at: NotRequired[str | None]
"""
Date the organization was deleted
"""
image_rendering_mode: NotRequired[ImageRenderingMode | None]


Expand All @@ -1750,7 +1771,7 @@ class Organization(TypedDict):
"""
Each permission permits a certain type of operation on an object in the system

Permissions can be assigned to to objects on an individual basis, or grouped into roles
Permissions can be assigned to objects on an individual basis, or grouped into roles
"""


Expand Down Expand Up @@ -2581,6 +2602,9 @@ class RunEvalData(TypedDict):
The environment tag that resolves to the dataset version to evaluate
"""
_internal_btql: NotRequired[Mapping[str, Any] | None]
"""
Internal BTQL query overrides in parsed JSON form that select which dataset rows to evaluate. `filter` is a BTQL expression object, `sort` is an array of BTQL sort expressions, and `limit` is an integer.
"""


class RunEvalData1(TypedDict):
Expand All @@ -2595,6 +2619,9 @@ class RunEvalData1(TypedDict):
The environment tag that resolves to the dataset version to evaluate
"""
_internal_btql: NotRequired[Mapping[str, Any] | None]
"""
Internal BTQL query overrides in parsed JSON form that select which dataset rows to evaluate. `filter` is a BTQL expression object, `sort` is an array of BTQL sort expressions, and `limit` is an integer.
"""


class RunEvalData2(TypedDict):
Expand Down Expand Up @@ -2723,7 +2750,7 @@ class ParentParent(TypedDict):
"""
row_ids: NotRequired[ParentParentRowIds | None]
"""
Identifiers for the row to to log a subspan under
Identifiers for the row to log a subspan under
"""
propagated_event: NotRequired[Mapping[str, Any] | None]
"""
Expand Down Expand Up @@ -3866,6 +3893,9 @@ class FunctionIdFunctionId4(TypedDict):

class InvokeFunctionInvokeFunction7(TypedDict):
request_source: NotRequired[str | None]
"""
A label identifying the caller, used to attribute usage
"""
input: NotRequired[Any | None]
"""
Argument to the function, which can be any JSON serializable value
Expand Down Expand Up @@ -4386,7 +4416,7 @@ class ExperimentEvent(TypedDict):
"""
scores: NotRequired[Mapping[str, Any] | None]
"""
A dictionary of numeric values (between 0 and 1) to log. The scores should give you a variety of signals that help you determine how accurate the outputs are compared to what you expect and diagnose failures. For example, a summarization app might have one score that tells you how accurate the summary is, and another that measures the word similarity between the generated and grouth truth summary. The word similarity score could help you determine whether the summarization was covering similar concepts or not. You can use these scores to help you sort, filter, and compare experiments
A dictionary of numeric values (between 0 and 1) to log. The scores should give you a variety of signals that help you determine how accurate the outputs are compared to what you expect and diagnose failures. For example, a summarization app might have one score that tells you how accurate the summary is, and another that measures the word similarity between the generated and ground truth summary. The word similarity score could help you determine whether the summarization was covering similar concepts or not. You can use these scores to help you sort, filter, and compare experiments.
"""
metadata: NotRequired[ExperimentEventMetadata | None]
"""
Expand Down Expand Up @@ -4574,7 +4604,7 @@ class ProjectLogsEvent(TypedDict):
"""
scores: NotRequired[Mapping[str, Any] | None]
"""
A dictionary of numeric values (between 0 and 1) to log. The scores should give you a variety of signals that help you determine how accurate the outputs are compared to what you expect and diagnose failures. For example, a summarization app might have one score that tells you how accurate the summary is, and another that measures the word similarity between the generated and grouth truth summary. The word similarity score could help you determine whether the summarization was covering similar concepts or not. You can use these scores to help you sort, filter, and compare logs.
A dictionary of numeric values (between 0 and 1) to log. The scores should give you a variety of signals that help you determine how accurate the outputs are compared to what you expect and diagnose failures. For example, a summarization app might have one score that tells you how accurate the summary is, and another that measures the word similarity between the generated and ground truth summary. The word similarity score could help you determine whether the summarization was covering similar concepts or not. You can use these scores to help you sort, filter, and compare logs.
"""
metadata: NotRequired[ProjectLogsEventMetadata | None]
"""
Expand Down
2 changes: 1 addition & 1 deletion py/src/braintrust/generated_types.py
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
"""Auto-generated file (content hash 82ae75924e108923) -- do not modify"""
"""Auto-generated file (content hash 1b6e35c5c24bba44) -- do not modify"""

from ._generated_types import (
Acl,
Expand Down
Loading