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
Copy file name to clipboardExpand all lines: reference.md
+9-94Lines changed: 9 additions & 94 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -178,6 +178,7 @@ Controls how the model uses tools. The following options are supported:
178
178
The Prompt configuration to use. Two formats are supported:
179
179
- An object representing the details of the Prompt configuration
180
180
- A string representing the raw contents of a .prompt file
181
+
181
182
A new Prompt version will be created if the provided details do not match any existing version.
182
183
183
184
</dd>
@@ -282,14 +283,6 @@ A new Prompt version will be created if the provided details do not match any ex
282
283
<dl>
283
284
<dd>
284
285
285
-
**log_status:**`typing.Optional[LogStatus]` — Status of a Log. Set to `incomplete` if you intend to update and eventually complete the Log and want the File's monitoring Evaluators to wait until you mark it as `complete`. If log_status is not provided, observability will pick up the Log as soon as possible. Updating this from specified to unspecified is undefined behavior.
286
-
287
-
</dd>
288
-
</dl>
289
-
290
-
<dl>
291
-
<dd>
292
-
293
286
**source_datapoint_id:**`typing.Optional[str]` — Unique identifier for the Datapoint that this Log is derived from. This can be used by Humanloop to associate Logs to Evaluations. If provided, Humanloop will automatically associate this Log to Evaluations that require a Log for this Datapoint-Version pair.
294
287
295
288
</dd>
@@ -587,14 +580,6 @@ Controls how the model uses tools. The following options are supported:
587
580
<dl>
588
581
<dd>
589
582
590
-
**log_status:**`typing.Optional[LogStatus]` — Status of a Log. Set to `incomplete` if you intend to update and eventually complete the Log and want the File's monitoring Evaluators to wait until you mark it as `complete`. If log_status is not provided, observability will pick up the Log as soon as possible. Updating this from specified to unspecified is undefined behavior.
@@ -724,6 +709,7 @@ Controls how the model uses tools. The following options are supported:
724
709
The Prompt configuration to use. Two formats are supported:
725
710
- An object representing the details of the Prompt configuration
726
711
- A string representing the raw contents of a .prompt file
712
+
727
713
A new Prompt version will be created if the provided details do not match any existing version.
728
714
729
715
</dd>
@@ -772,14 +758,6 @@ A new Prompt version will be created if the provided details do not match any ex
772
758
<dl>
773
759
<dd>
774
760
775
-
**log_status:**`typing.Optional[LogStatus]` — Status of a Log. Set to `incomplete` if you intend to update and eventually complete the Log and want the File's monitoring Evaluators to wait until you mark it as `complete`. If log_status is not provided, observability will pick up the Log as soon as possible. Updating this from specified to unspecified is undefined behavior.
776
-
777
-
</dd>
778
-
</dl>
779
-
780
-
<dl>
781
-
<dd>
782
-
783
761
**source_datapoint_id:**`typing.Optional[str]` — Unique identifier for the Datapoint that this Log is derived from. This can be used by Humanloop to associate Logs to Evaluations. If provided, Humanloop will automatically associate this Log to Evaluations that require a Log for this Datapoint-Version pair.
784
762
785
763
</dd>
@@ -996,6 +974,7 @@ Controls how the model uses tools. The following options are supported:
996
974
The Prompt configuration to use. Two formats are supported:
997
975
- An object representing the details of the Prompt configuration
998
976
- A string representing the raw contents of a .prompt file
977
+
999
978
A new Prompt version will be created if the provided details do not match any existing version.
1000
979
1001
980
</dd>
@@ -1044,14 +1023,6 @@ A new Prompt version will be created if the provided details do not match any ex
1044
1023
<dl>
1045
1024
<dd>
1046
1025
1047
-
**log_status:**`typing.Optional[LogStatus]` — Status of a Log. Set to `incomplete` if you intend to update and eventually complete the Log and want the File's monitoring Evaluators to wait until you mark it as `complete`. If log_status is not provided, observability will pick up the Log as soon as possible. Updating this from specified to unspecified is undefined behavior.
1048
-
1049
-
</dd>
1050
-
</dl>
1051
-
1052
-
<dl>
1053
-
<dd>
1054
-
1055
1026
**source_datapoint_id:**`typing.Optional[str]` — Unique identifier for the Datapoint that this Log is derived from. This can be used by Humanloop to associate Logs to Evaluations. If provided, Humanloop will automatically associate this Log to Evaluations that require a Log for this Datapoint-Version pair.
1056
1027
1057
1028
</dd>
@@ -2690,14 +2661,6 @@ client.tools.call()
2690
2661
<dl>
2691
2662
<dd>
2692
2663
2693
-
**log_status:**`typing.Optional[LogStatus]` — Status of a Log. Set to `incomplete` if you intend to update and eventually complete the Log and want the File's monitoring Evaluators to wait until you mark it as `complete`. If log_status is not provided, observability will pick up the Log as soon as possible. Updating this from specified to unspecified is undefined behavior.
2694
-
2695
-
</dd>
2696
-
</dl>
2697
-
2698
-
<dl>
2699
-
<dd>
2700
-
2701
2664
**source_datapoint_id:**`typing.Optional[str]` — Unique identifier for the Datapoint that this Log is derived from. This can be used by Humanloop to associate Logs to Evaluations. If provided, Humanloop will automatically associate this Log to Evaluations that require a Log for this Datapoint-Version pair.
**log_status:**`typing.Optional[LogStatus]` — Status of a Log. Set to `incomplete` if you intend to update and eventually complete the Log and want the File's monitoring Evaluators to wait until you mark it as `complete`. If log_status is not provided, observability will pick up the Log as soon as possible. Updating this from specified to unspecified is undefined behavior.
2956
-
2957
-
</dd>
2958
-
</dl>
2959
-
2960
-
<dl>
2961
-
<dd>
2962
-
2963
2918
**source_datapoint_id:**`typing.Optional[str]` — Unique identifier for the Datapoint that this Log is derived from. This can be used by Humanloop to associate Logs to Evaluations. If provided, Humanloop will automatically associate this Log to Evaluations that require a Log for this Datapoint-Version pair.
**log_status:**`typing.Optional[LogStatus]` — Status of a Log. Set to `incomplete` if you intend to update and eventually complete the Log and want the File's monitoring Evaluators to wait until you mark it as `complete`. If log_status is not provided, observability will pick up the Log as soon as possible. Updating this from specified to unspecified is undefined behavior.
**log_status:**`typing.Optional[LogStatus]` — Status of a Log. Set to `incomplete` if you intend to update and eventually complete the Log and want the File's monitoring Evaluators to wait until you mark it as `complete`. If log_status is not provided, observability will pick up the Log as soon as possible. Updating this from specified to unspecified is undefined behavior.
5783
-
5784
-
</dd>
5785
-
</dl>
5786
-
5787
-
<dl>
5788
-
<dd>
5789
-
5790
5729
**source_datapoint_id:**`typing.Optional[str]` — Unique identifier for the Datapoint that this Log is derived from. This can be used by Humanloop to associate Logs to Evaluations. If provided, Humanloop will automatically associate this Log to Evaluations that require a Log for this Datapoint-Version pair.
5791
5730
5792
5731
</dd>
@@ -6883,9 +6822,6 @@ Log to a Flow.
6883
6822
6884
6823
You can use query parameters `version_id`, or `environment`, to target
6885
6824
an existing version of the Flow. Otherwise, the default deployed version will be chosen.
6886
-
6887
-
If you create the Flow Log with a `log_status` of `incomplete`, you should later update it to `complete`
**log_status:**`typing.Optional[LogStatus]` — Status of the Flow Log. When a Log is updated from `incomplete` to `complete`, it becomes available to Monitoring Evaluators. Flow Logs cannot have an unspecified status: they must start as `incomplete` to allow children to be added. Provide `complete` if you don't intend to add children to the trace.
7013
+
**log_status:**`typing.Optional[LogStatus]` — Status of the Flow Log. When a Log is updated from `incomplete` to `complete`, no more Logs can be addedto it.
**log_status:**`typing.Optional[LogStatus]` — Status of the Flow Log. When a Flow Log is updated to `complete`, no more Logs can be added to it. Monitoring Evaluators will only run on `complete`Flow Logs.
7188
+
**log_status:**`typing.Optional[LogStatus]` — Status of the Flow Log. When a Flow Log is updated to `complete`, no more Logs can be added to it. You cannot update a Flow Log's status from `complete`to `incomplete`.
7253
7189
7254
7190
</dd>
7255
7191
</dl>
@@ -8447,6 +8383,7 @@ Controls how the model uses tools. The following options are supported:
8447
8383
The Agent configuration to use. Two formats are supported:
8448
8384
- An object representing the details of the Agent configuration
8449
8385
- A string representing the raw contents of a .agent file
8386
+
8450
8387
A new Agent version will be created if the provided details do not match any existing version.
8451
8388
8452
8389
</dd>
@@ -8551,14 +8488,6 @@ A new Agent version will be created if the provided details do not match any exi
8551
8488
<dl>
8552
8489
<dd>
8553
8490
8554
-
**log_status:**`typing.Optional[LogStatus]` — Status of a Log. Set to `incomplete` if you intend to update and eventually complete the Log and want the File's monitoring Evaluators to wait until you mark it as `complete`. If log_status is not provided, observability will pick up the Log as soon as possible. Updating this from specified to unspecified is undefined behavior.
8555
-
8556
-
</dd>
8557
-
</dl>
8558
-
8559
-
<dl>
8560
-
<dd>
8561
-
8562
8491
**source_datapoint_id:**`typing.Optional[str]` — Unique identifier for the Datapoint that this Log is derived from. This can be used by Humanloop to associate Logs to Evaluations. If provided, Humanloop will automatically associate this Log to Evaluations that require a Log for this Datapoint-Version pair.
**log_status:**`typing.Optional[LogStatus]` — Status of the Flow Log. When a Flow Log is updated to `complete`, no more Logs can be added to it. Monitoring Evaluators will only run on `complete`Flow Logs.
8654
+
**log_status:**`typing.Optional[LogStatus]` — Status of the Flow Log. When a Flow Log is updated to `complete`, no more Logs can be added to it. You cannot update a Flow Log's status from `complete`to `incomplete`.
8726
8655
8727
8656
</dd>
8728
8657
</dl>
@@ -8862,6 +8791,7 @@ Controls how the model uses tools. The following options are supported:
8862
8791
The Agent configuration to use. Two formats are supported:
8863
8792
- An object representing the details of the Agent configuration
8864
8793
- A string representing the raw contents of a .agent file
8794
+
8865
8795
A new Agent version will be created if the provided details do not match any existing version.
8866
8796
8867
8797
</dd>
@@ -8910,14 +8840,6 @@ A new Agent version will be created if the provided details do not match any exi
8910
8840
<dl>
8911
8841
<dd>
8912
8842
8913
-
**log_status:**`typing.Optional[LogStatus]` — Status of a Log. Set to `incomplete` if you intend to update and eventually complete the Log and want the File's monitoring Evaluators to wait until you mark it as `complete`. If log_status is not provided, observability will pick up the Log as soon as possible. Updating this from specified to unspecified is undefined behavior.
8914
-
8915
-
</dd>
8916
-
</dl>
8917
-
8918
-
<dl>
8919
-
<dd>
8920
-
8921
8843
**source_datapoint_id:**`typing.Optional[str]` — Unique identifier for the Datapoint that this Log is derived from. This can be used by Humanloop to associate Logs to Evaluations. If provided, Humanloop will automatically associate this Log to Evaluations that require a Log for this Datapoint-Version pair.
8922
8844
8923
8845
</dd>
@@ -9120,6 +9042,7 @@ Controls how the model uses tools. The following options are supported:
9120
9042
The Agent configuration to use. Two formats are supported:
9121
9043
- An object representing the details of the Agent configuration
9122
9044
- A string representing the raw contents of a .agent file
9045
+
9123
9046
A new Agent version will be created if the provided details do not match any existing version.
9124
9047
9125
9048
</dd>
@@ -9168,14 +9091,6 @@ A new Agent version will be created if the provided details do not match any exi
9168
9091
<dl>
9169
9092
<dd>
9170
9093
9171
-
**log_status:**`typing.Optional[LogStatus]` — Status of a Log. Set to `incomplete` if you intend to update and eventually complete the Log and want the File's monitoring Evaluators to wait until you mark it as `complete`. If log_status is not provided, observability will pick up the Log as soon as possible. Updating this from specified to unspecified is undefined behavior.
9172
-
9173
-
</dd>
9174
-
</dl>
9175
-
9176
-
<dl>
9177
-
<dd>
9178
-
9179
9094
**source_datapoint_id:**`typing.Optional[str]` — Unique identifier for the Datapoint that this Log is derived from. This can be used by Humanloop to associate Logs to Evaluations. If provided, Humanloop will automatically associate this Log to Evaluations that require a Log for this Datapoint-Version pair.
0 commit comments