Skip to content

Commit a9468bd

Browse files
chore: Update platform types (#1075)
Automated regeneration of SDK types. Co-authored-by: braintrust-bot[bot] <215900051+braintrust-bot[bot]@users.noreply.github.com>
1 parent e26deb0 commit a9468bd

3 files changed

Lines changed: 66 additions & 26 deletions

File tree

‎generated_types.json‎

Lines changed: 27 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -2525,7 +2525,7 @@
25252525
},
25262526
"xact_id": {
25272527
"type": "string",
2528-
"description": "Transaction id of the brainstore version at the time of the snapshot"
2528+
"description": "Transaction ID of the dataset version at the time of the snapshot"
25292529
},
25302530
"created": {
25312531
"type": [
@@ -2635,7 +2635,7 @@
26352635
"automation_integration"
26362636
],
26372637
"default": "env_var",
2638-
"description": "The category of the secret: env_var for regular environment variables, ai_provider for AI provider API keys"
2638+
"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"
26392639
}
26402640
},
26412641
"required": [
@@ -2847,7 +2847,7 @@
28472847
"minimum": 0,
28482848
"maximum": 1
28492849
},
2850-
"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"
2850+
"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."
28512851
},
28522852
"metadata": {
28532853
"type": [
@@ -3453,7 +3453,7 @@
34533453
"boolean",
34543454
"null"
34553455
],
3456-
"description": "The function exists for internal purposes and should not be displayed in the list of functions."
3456+
"description": "If true, the function was created for use by another Braintrust object and is hidden from function lists in the Braintrust UI."
34573457
}
34583458
},
34593459
"required": [
@@ -4862,7 +4862,8 @@
48624862
"type": "object",
48634863
"properties": {
48644864
"request_source": {
4865-
"type": "string"
4865+
"type": "string",
4866+
"description": "A label identifying the caller, used to attribute usage"
48664867
},
48674868
"input": {
48684869
"description": "Argument to the function, which can be any JSON serializable value"
@@ -4989,7 +4990,7 @@
49894990
"span_id",
49904991
"root_span_id"
49914992
],
4992-
"description": "Identifiers for the row to to log a subspan under"
4993+
"description": "Identifiers for the row to log a subspan under"
49934994
},
49944995
"propagated_event": {
49954996
"type": [
@@ -5632,31 +5633,36 @@
56325633
"type": [
56335634
"string",
56345635
"null"
5635-
]
5636+
],
5637+
"description": "URL of the organization's data plane API. If unset, the Braintrust-hosted API is used."
56365638
},
56375639
"is_universal_api": {
56385640
"type": [
56395641
"boolean",
56405642
"null"
5641-
]
5643+
],
5644+
"description": "Whether the data plane at `api_url` also serves the AI proxy, at `api_url` with `/v1/proxy` appended"
56425645
},
56435646
"is_dataplane_private": {
56445647
"type": [
56455648
"boolean",
56465649
"null"
5647-
]
5650+
],
5651+
"description": "Whether the organization's data plane is only reachable from a private network"
56485652
},
56495653
"proxy_url": {
56505654
"type": [
56515655
"string",
56525656
"null"
5653-
]
5657+
],
5658+
"description": "URL of the organization's AI proxy"
56545659
},
56555660
"realtime_url": {
56565661
"type": [
56575662
"string",
56585663
"null"
5659-
]
5664+
],
5665+
"description": "URL of the organization's realtime service"
56605666
},
56615667
"created": {
56625668
"type": [
@@ -5671,14 +5677,16 @@
56715677
"string",
56725678
"null"
56735679
],
5674-
"format": "date-time"
5680+
"format": "date-time",
5681+
"description": "Date the organization was archived"
56755682
},
56765683
"deleted_at": {
56775684
"type": [
56785685
"string",
56795686
"null"
56805687
],
5681-
"format": "date-time"
5688+
"format": "date-time",
5689+
"description": "Date the organization was deleted"
56825690
},
56835691
"image_rendering_mode": {
56845692
"$ref": "#/components/schemas/ImageRenderingMode"
@@ -5775,7 +5783,7 @@
57755783
"update_acls",
57765784
"delete_acls"
57775785
],
5778-
"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"
5786+
"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"
57795787
},
57805788
"PreprocessorId": {
57815789
"anyOf": [
@@ -6640,7 +6648,7 @@
66406648
"minimum": 0,
66416649
"maximum": 1
66426650
},
6643-
"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."
6651+
"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."
66446652
},
66456653
"metadata": {
66466654
"type": [
@@ -8656,7 +8664,8 @@
86568664
"object",
86578665
"null"
86588666
],
8659-
"additionalProperties": {}
8667+
"additionalProperties": {},
8668+
"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."
86608669
}
86618670
},
86628671
"required": [
@@ -8693,7 +8702,8 @@
86938702
"object",
86948703
"null"
86958704
],
8696-
"additionalProperties": {}
8705+
"additionalProperties": {},
8706+
"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."
86978707
}
86988708
},
86998709
"required": [

‎py/src/braintrust/_generated_types.py‎

Lines changed: 38 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -666,7 +666,7 @@ class DatasetSnapshot(TypedDict):
666666
description: str | None
667667
xact_id: str
668668
"""
669-
Transaction id of the brainstore version at the time of the snapshot
669+
Transaction ID of the dataset version at the time of the snapshot
670670
"""
671671
created: str | None
672672
"""
@@ -723,7 +723,7 @@ class EnvVar(TypedDict):
723723
Literal['env_var', 'ai_provider', 'sandbox_provider', 'automation_integration']
724724
]
725725
"""
726-
The category of the secret: env_var for regular environment variables, ai_provider for AI provider API keys
726+
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
727727
"""
728728

729729

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

856856

@@ -1523,7 +1523,7 @@ class InvokeParentInvokeParent(TypedDict):
15231523
"""
15241524
row_ids: NotRequired[InvokeParentInvokeParentRowIds | None]
15251525
"""
1526-
Identifiers for the row to to log a subspan under
1526+
Identifiers for the row to log a subspan under
15271527
"""
15281528
propagated_event: NotRequired[Mapping[str, Any] | None]
15291529
"""
@@ -1724,16 +1724,37 @@ class Organization(TypedDict):
17241724
Name of the organization
17251725
"""
17261726
api_url: NotRequired[str | None]
1727+
"""
1728+
URL of the organization's data plane API. If unset, the Braintrust-hosted API is used.
1729+
"""
17271730
is_universal_api: NotRequired[bool | None]
1731+
"""
1732+
Whether the data plane at `api_url` also serves the AI proxy, at `api_url` with `/v1/proxy` appended
1733+
"""
17281734
is_dataplane_private: NotRequired[bool | None]
1735+
"""
1736+
Whether the organization's data plane is only reachable from a private network
1737+
"""
17291738
proxy_url: NotRequired[str | None]
1739+
"""
1740+
URL of the organization's AI proxy
1741+
"""
17301742
realtime_url: NotRequired[str | None]
1743+
"""
1744+
URL of the organization's realtime service
1745+
"""
17311746
created: NotRequired[str | None]
17321747
"""
17331748
Date of organization creation
17341749
"""
17351750
archived_at: NotRequired[str | None]
1751+
"""
1752+
Date the organization was archived
1753+
"""
17361754
deleted_at: NotRequired[str | None]
1755+
"""
1756+
Date the organization was deleted
1757+
"""
17371758
image_rendering_mode: NotRequired[ImageRenderingMode | None]
17381759

17391760

@@ -1750,7 +1771,7 @@ class Organization(TypedDict):
17501771
"""
17511772
Each permission permits a certain type of operation on an object in the system
17521773
1753-
Permissions can be assigned to to objects on an individual basis, or grouped into roles
1774+
Permissions can be assigned to objects on an individual basis, or grouped into roles
17541775
"""
17551776

17561777

@@ -2581,6 +2602,9 @@ class RunEvalData(TypedDict):
25812602
The environment tag that resolves to the dataset version to evaluate
25822603
"""
25832604
_internal_btql: NotRequired[Mapping[str, Any] | None]
2605+
"""
2606+
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.
2607+
"""
25842608

25852609

25862610
class RunEvalData1(TypedDict):
@@ -2595,6 +2619,9 @@ class RunEvalData1(TypedDict):
25952619
The environment tag that resolves to the dataset version to evaluate
25962620
"""
25972621
_internal_btql: NotRequired[Mapping[str, Any] | None]
2622+
"""
2623+
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.
2624+
"""
25982625

25992626

26002627
class RunEvalData2(TypedDict):
@@ -2723,7 +2750,7 @@ class ParentParent(TypedDict):
27232750
"""
27242751
row_ids: NotRequired[ParentParentRowIds | None]
27252752
"""
2726-
Identifiers for the row to to log a subspan under
2753+
Identifiers for the row to log a subspan under
27272754
"""
27282755
propagated_event: NotRequired[Mapping[str, Any] | None]
27292756
"""
@@ -3866,6 +3893,9 @@ class FunctionIdFunctionId4(TypedDict):
38663893

38673894
class InvokeFunctionInvokeFunction7(TypedDict):
38683895
request_source: NotRequired[str | None]
3896+
"""
3897+
A label identifying the caller, used to attribute usage
3898+
"""
38693899
input: NotRequired[Any | None]
38703900
"""
38713901
Argument to the function, which can be any JSON serializable value
@@ -4386,7 +4416,7 @@ class ExperimentEvent(TypedDict):
43864416
"""
43874417
scores: NotRequired[Mapping[str, Any] | None]
43884418
"""
4389-
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
4419+
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.
43904420
"""
43914421
metadata: NotRequired[ExperimentEventMetadata | None]
43924422
"""
@@ -4574,7 +4604,7 @@ class ProjectLogsEvent(TypedDict):
45744604
"""
45754605
scores: NotRequired[Mapping[str, Any] | None]
45764606
"""
4577-
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.
4607+
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.
45784608
"""
45794609
metadata: NotRequired[ProjectLogsEventMetadata | None]
45804610
"""

‎py/src/braintrust/generated_types.py‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
"""Auto-generated file (content hash 82ae75924e108923) -- do not modify"""
1+
"""Auto-generated file (content hash 1b6e35c5c24bba44) -- do not modify"""
22

33
from ._generated_types import (
44
Acl,

0 commit comments

Comments
 (0)