You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
{{ message }}
Repository navigation
Commit a9468bd
Browse filesBrowse the repository at this point in the historyBrowse files
Copy file name to clipboardExpand all lines: generated_types.json
+27-17Lines changed: 27 additions & 17 deletions
Original file line number
Diff line number
Diff line change
@@ -2525,7 +2525,7 @@
2525
2525
},
2526
2526
"xact_id": {
2527
2527
"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"
2529
2529
},
2530
2530
"created": {
2531
2531
"type": [
@@ -2635,7 +2635,7 @@
2635
2635
"automation_integration"
2636
2636
],
2637
2637
"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"
2639
2639
}
2640
2640
},
2641
2641
"required": [
@@ -2847,7 +2847,7 @@
2847
2847
"minimum": 0,
2848
2848
"maximum": 1
2849
2849
},
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."
2851
2851
},
2852
2852
"metadata": {
2853
2853
"type": [
@@ -3453,7 +3453,7 @@
3453
3453
"boolean",
3454
3454
"null"
3455
3455
],
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."
3457
3457
}
3458
3458
},
3459
3459
"required": [
@@ -4862,7 +4862,8 @@
4862
4862
"type": "object",
4863
4863
"properties": {
4864
4864
"request_source": {
4865
-
"type": "string"
4865
+
"type": "string",
4866
+
"description": "A label identifying the caller, used to attribute usage"
4866
4867
},
4867
4868
"input": {
4868
4869
"description": "Argument to the function, which can be any JSON serializable value"
@@ -4989,7 +4990,7 @@
4989
4990
"span_id",
4990
4991
"root_span_id"
4991
4992
],
4992
-
"description": "Identifiers for the row to to log a subspan under"
4993
+
"description": "Identifiers for the row to log a subspan under"
4993
4994
},
4994
4995
"propagated_event": {
4995
4996
"type": [
@@ -5632,31 +5633,36 @@
5632
5633
"type": [
5633
5634
"string",
5634
5635
"null"
5635
-
]
5636
+
],
5637
+
"description": "URL of the organization's data plane API. If unset, the Braintrust-hosted API is used."
5636
5638
},
5637
5639
"is_universal_api": {
5638
5640
"type": [
5639
5641
"boolean",
5640
5642
"null"
5641
-
]
5643
+
],
5644
+
"description": "Whether the data plane at `api_url` also serves the AI proxy, at `api_url` with `/v1/proxy` appended"
5642
5645
},
5643
5646
"is_dataplane_private": {
5644
5647
"type": [
5645
5648
"boolean",
5646
5649
"null"
5647
-
]
5650
+
],
5651
+
"description": "Whether the organization's data plane is only reachable from a private network"
5648
5652
},
5649
5653
"proxy_url": {
5650
5654
"type": [
5651
5655
"string",
5652
5656
"null"
5653
-
]
5657
+
],
5658
+
"description": "URL of the organization's AI proxy"
5654
5659
},
5655
5660
"realtime_url": {
5656
5661
"type": [
5657
5662
"string",
5658
5663
"null"
5659
-
]
5664
+
],
5665
+
"description": "URL of the organization's realtime service"
5660
5666
},
5661
5667
"created": {
5662
5668
"type": [
@@ -5671,14 +5677,16 @@
5671
5677
"string",
5672
5678
"null"
5673
5679
],
5674
-
"format": "date-time"
5680
+
"format": "date-time",
5681
+
"description": "Date the organization was archived"
5675
5682
},
5676
5683
"deleted_at": {
5677
5684
"type": [
5678
5685
"string",
5679
5686
"null"
5680
5687
],
5681
-
"format": "date-time"
5688
+
"format": "date-time",
5689
+
"description": "Date the organization was deleted"
5682
5690
},
5683
5691
"image_rendering_mode": {
5684
5692
"$ref": "#/components/schemas/ImageRenderingMode"
@@ -5775,7 +5783,7 @@
5775
5783
"update_acls",
5776
5784
"delete_acls"
5777
5785
],
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"
5779
5787
},
5780
5788
"PreprocessorId": {
5781
5789
"anyOf": [
@@ -6640,7 +6648,7 @@
6640
6648
"minimum": 0,
6641
6649
"maximum": 1
6642
6650
},
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."
6644
6652
},
6645
6653
"metadata": {
6646
6654
"type": [
@@ -8656,7 +8664,8 @@
8656
8664
"object",
8657
8665
"null"
8658
8666
],
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."
8660
8669
}
8661
8670
},
8662
8671
"required": [
@@ -8693,7 +8702,8 @@
8693
8702
"object",
8694
8703
"null"
8695
8704
],
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."
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
727
727
"""
728
728
729
729
@@ -850,7 +850,7 @@ class FunctionOrigin(TypedDict):
850
850
"""
851
851
internal: NotRequired[bool|None]
852
852
"""
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.
854
854
"""
855
855
856
856
@@ -1523,7 +1523,7 @@ class InvokeParentInvokeParent(TypedDict):
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
+
"""
2584
2608
2585
2609
2586
2610
classRunEvalData1(TypedDict):
@@ -2595,6 +2619,9 @@ class RunEvalData1(TypedDict):
2595
2619
The environment tag that resolves to the dataset version to evaluate
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
+
"""
2598
2625
2599
2626
2600
2627
classRunEvalData2(TypedDict):
@@ -2723,7 +2750,7 @@ class ParentParent(TypedDict):
@@ -3866,6 +3893,9 @@ class FunctionIdFunctionId4(TypedDict):
3866
3893
3867
3894
classInvokeFunctionInvokeFunction7(TypedDict):
3868
3895
request_source: NotRequired[str|None]
3896
+
"""
3897
+
A label identifying the caller, used to attribute usage
3898
+
"""
3869
3899
input: NotRequired[Any|None]
3870
3900
"""
3871
3901
Argument to the function, which can be any JSON serializable value
@@ -4386,7 +4416,7 @@ class ExperimentEvent(TypedDict):
4386
4416
"""
4387
4417
scores: NotRequired[Mapping[str, Any] |None]
4388
4418
"""
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.
@@ -4574,7 +4604,7 @@ class ProjectLogsEvent(TypedDict):
4574
4604
"""
4575
4605
scores: NotRequired[Mapping[str, Any] |None]
4576
4606
"""
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.
0 commit comments