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
+70-63Lines changed: 70 additions & 63 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -306,15 +306,7 @@ Controls how the model uses tools. The following options are supported:
306
306
<dl>
307
307
<dd>
308
308
309
-
**trace_id:**`typing.Optional[str]` — Identifier of the Flow Log to which the Log will be associated. Multiple Logs can be associated by passing the same trace_id in subsequent log requests. Use the Flow File log endpoint to create the Trace first.
310
-
311
-
</dd>
312
-
</dl>
313
-
314
-
<dl>
315
-
<dd>
316
-
317
-
**trace_parent_log_id:**`typing.Optional[str]` — Log under which this Log should be nested. Leave field blank if the Log should be nested directly under root Trace Log. Parent Log should already be added to the Trace.
309
+
**trace_parent_id:**`typing.Optional[str]` — The ID of the parent Log to nest this Log under in a Trace.
@@ -867,15 +858,7 @@ Controls how the model uses tools. The following options are supported:
867
858
<dl>
868
859
<dd>
869
860
870
-
**trace_id:**`typing.Optional[str]` — Identifier of the Flow Log to which the Log will be associated. Multiple Logs can be associated by passing the same trace_id in subsequent log requests. Use the Flow File log endpoint to create the Trace first.
871
-
872
-
</dd>
873
-
</dl>
874
-
875
-
<dl>
876
-
<dd>
877
-
878
-
**trace_parent_log_id:**`typing.Optional[str]` — Log under which this Log should be nested. Leave field blank if the Log should be nested directly under root Trace Log. Parent Log should already be added to the Trace.
861
+
**trace_parent_id:**`typing.Optional[str]` — The ID of the parent Log to nest this Log under in a Trace.
879
862
880
863
</dd>
881
864
</dl>
@@ -1141,15 +1124,7 @@ Controls how the model uses tools. The following options are supported:
1141
1124
<dl>
1142
1125
<dd>
1143
1126
1144
-
**trace_id:**`typing.Optional[str]` — Identifier of the Flow Log to which the Log will be associated. Multiple Logs can be associated by passing the same trace_id in subsequent log requests. Use the Flow File log endpoint to create the Trace first.
1145
-
1146
-
</dd>
1147
-
</dl>
1148
-
1149
-
<dl>
1150
-
<dd>
1151
-
1152
-
**trace_parent_log_id:**`typing.Optional[str]` — Log under which this Log should be nested. Leave field blank if the Log should be nested directly under root Trace Log. Parent Log should already be added to the Trace.
1127
+
**trace_parent_id:**`typing.Optional[str]` — The ID of the parent Log to nest this Log under in a Trace.
1153
1128
1154
1129
</dd>
1155
1130
</dl>
@@ -2565,15 +2540,7 @@ client.tools.log(
2565
2540
<dl>
2566
2541
<dd>
2567
2542
2568
-
**trace_id:**`typing.Optional[str]` — Identifier of the Flow Log to which the Log will be associated. Multiple Logs can be associated by passing the same trace_id in subsequent log requests. Use the Flow File log endpoint to create the Trace first.
2569
-
2570
-
</dd>
2571
-
</dl>
2572
-
2573
-
<dl>
2574
-
<dd>
2575
-
2576
-
**trace_parent_log_id:**`typing.Optional[str]` — Log under which this Log should be nested. Leave field blank if the Log should be nested directly under root Trace Log. Parent Log should already be added to the Trace.
2543
+
**trace_parent_id:**`typing.Optional[str]` — The ID of the parent Log to nest this Log under in a Trace.
2577
2544
2578
2545
</dd>
2579
2546
</dl>
@@ -4304,7 +4271,7 @@ client.datasets.delete(
4304
4271
<dl>
4305
4272
<dd>
4306
4273
4307
-
Update the Dataset with the given ID.
4274
+
Move the Dataset to a different path or change the name.
4308
4275
</dd>
4309
4276
</dl>
4310
4277
</dd>
@@ -6092,15 +6059,7 @@ client.evaluators.log(
6092
6059
<dl>
6093
6060
<dd>
6094
6061
6095
-
**trace_id:**`typing.Optional[str]` — Identifier of the Flow Log to which the Log will be associated. Multiple Logs can be associated by passing the same trace_id in subsequent log requests. Use the Flow File log endpoint to create the Trace first.
6096
-
6097
-
</dd>
6098
-
</dl>
6099
-
6100
-
<dl>
6101
-
<dd>
6102
-
6103
-
**trace_parent_log_id:**`typing.Optional[str]` — Log under which this Log should be nested. Leave field blank if the Log should be nested directly under root Trace Log. Parent Log should already be added to the Trace.
6062
+
**trace_parent_id:**`typing.Optional[str]` — The ID of the parent Log to nest this Log under in a Trace.
6104
6063
6105
6064
</dd>
6106
6065
</dl>
@@ -6434,7 +6393,7 @@ client.flows.move(
6434
6393
<dl>
6435
6394
<dd>
6436
6395
6437
-
Get a list of all Flows.
6396
+
Get a list of Flows.
6438
6397
</dd>
6439
6398
</dl>
6440
6399
</dd>
@@ -6534,6 +6493,26 @@ client.flows.list()
6534
6493
<dl>
6535
6494
<dd>
6536
6495
6496
+
#### 📝 Description
6497
+
6498
+
<dl>
6499
+
<dd>
6500
+
6501
+
<dl>
6502
+
<dd>
6503
+
6504
+
Create or update a Flow.
6505
+
6506
+
Flows can also be identified by the `ID` or their `path`.
6507
+
6508
+
If you provide a commit message, then the new version will be committed;
6509
+
otherwise it will be uncommitted. If you try to commit an already committed version,
6510
+
an exception will be raised.
6511
+
</dd>
6512
+
</dl>
6513
+
</dd>
6514
+
</dl>
6515
+
6537
6516
#### 🔌 Usage
6538
6517
6539
6518
<dl>
@@ -6622,7 +6601,10 @@ client.flows.upsert(
6622
6601
<dl>
6623
6602
<dd>
6624
6603
6625
-
Log a Flow Trace.
6604
+
Log to a Flow.
6605
+
6606
+
You can use query parameters `version_id`, or `environment`, to target
6607
+
an existing version of the Flow. Otherwise, the default deployed version will be chosen.
6626
6608
</dd>
6627
6609
</dl>
6628
6610
</dd>
@@ -6802,47 +6784,47 @@ client.flows.log()
6802
6784
<dl>
6803
6785
<dd>
6804
6786
6805
-
**trace_id:**`typing.Optional[str]` — ID of the Trace. If not provided, one will be assigned.
6787
+
**trace_parent_id:**`typing.Optional[str]` — The ID of the parent Log to nest this Log under in a Trace.
6806
6788
6807
6789
</dd>
6808
6790
</dl>
6809
6791
6810
6792
<dl>
6811
6793
<dd>
6812
6794
6813
-
**trace_parent_log_id:**`typing.Optional[str]` — Log under which this Log should be nested. Leave field blank if the Log should be nested directly under root Trace Log. Parent Log should already be added to the Trace.
6795
+
**batches:**`typing.Optional[typing.Sequence[str]]` — Array of Batch Ids that this log is part of. Batches are used to group Logs together for offline Evaluations
6814
6796
6815
6797
</dd>
6816
6798
</dl>
6817
6799
6818
6800
<dl>
6819
6801
<dd>
6820
6802
6821
-
**batches:**`typing.Optional[typing.Sequence[str]]` — Array of Batch Ids that this log is part of. Batches are used to group Logs together for offline Evaluations
6803
+
**user:**`typing.Optional[str]` — End-user ID related to the Log.
6822
6804
6823
6805
</dd>
6824
6806
</dl>
6825
6807
6826
6808
<dl>
6827
6809
<dd>
6828
6810
6829
-
**user:**`typing.Optional[str]` — End-user ID related to the Log.
6811
+
**flow_log_request_environment:**`typing.Optional[str]` — The name of the Environment the Log is associated to.
6830
6812
6831
6813
</dd>
6832
6814
</dl>
6833
6815
6834
6816
<dl>
6835
6817
<dd>
6836
6818
6837
-
**flow_log_request_environment:**`typing.Optional[str]` — The name of the Environment the Log is associated to.
6819
+
**save:**`typing.Optional[bool]` — Whether the request/response payloads will be stored on Humanloop.
6838
6820
6839
6821
</dd>
6840
6822
</dl>
6841
6823
6842
6824
<dl>
6843
6825
<dd>
6844
6826
6845
-
**save:**`typing.Optional[bool]` — Whether the request/response payloads will be stored on Humanloop.
6827
+
**trace_id:**`typing.Optional[str]` — ID of the Trace. If not provided, one will be assigned.
**log_id:**`str` — Unique identifier of the Flow Log.
6919
6918
6920
6919
</dd>
6921
6920
</dl>
6922
6921
6923
6922
<dl>
6924
6923
<dd>
6925
6924
6926
-
**status:**`TraceStatus` — Status of the Trace. When a Trace is marked as `complete`, no more Logs can be added to it. Monitoring Evaluators will only run on `complete` Traces.
6925
+
**trace_status:**`TraceStatus` — Status of the Trace. When a Trace is marked as `complete`, no more Logs can be added to it. Monitoring Evaluators will only run on completed Traces.
6927
6926
6928
6927
</dd>
6929
6928
</dl>
@@ -6939,7 +6938,15 @@ client.flows.update_trace(
6939
6938
<dl>
6940
6939
<dd>
6941
6940
6942
-
**output:**`typing.Optional[str]` — The output of the Flow Log.
6941
+
**output:**`typing.Optional[str]` — The output of the Flow Log. Provide None to unset existing `output` value. Provide either this or `error`.
6942
+
6943
+
</dd>
6944
+
</dl>
6945
+
6946
+
<dl>
6947
+
<dd>
6948
+
6949
+
**error:**`typing.Optional[str]` — The error message of the Flow Log. Provide None to unset existing `error` value. Provide either this or `output`.
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.
874
873
875
-
trace_id : typing.Optional[str]
876
-
Identifier of the Flow Log to which the Log will be associated. Multiple Logs can be associated by passing the same trace_id in subsequent log requests. Use the Flow File log endpoint to create the Trace first.
877
-
878
-
trace_parent_log_id : typing.Optional[str]
879
-
Log under which this Log should be nested. Leave field blank if the Log should be nested directly under root Trace Log. Parent Log should already be added to the Trace.
874
+
trace_parent_id : typing.Optional[str]
875
+
The ID of the parent Log to nest this Log under in a Trace.
880
876
881
877
batches : typing.Optional[typing.Sequence[str]]
882
878
Array of Batch Ids that this log is part of. Batches are used to group Logs together for offline Evaluations
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.
1901
1895
1902
-
trace_id : typing.Optional[str]
1903
-
Identifier of the Flow Log to which the Log will be associated. Multiple Logs can be associated by passing the same trace_id in subsequent log requests. Use the Flow File log endpoint to create the Trace first.
1904
-
1905
-
trace_parent_log_id : typing.Optional[str]
1906
-
Log under which this Log should be nested. Leave field blank if the Log should be nested directly under root Trace Log. Parent Log should already be added to the Trace.
1896
+
trace_parent_id : typing.Optional[str]
1897
+
The ID of the parent Log to nest this Log under in a Trace.
1907
1898
1908
1899
batches : typing.Optional[typing.Sequence[str]]
1909
1900
Array of Batch Ids that this log is part of. Batches are used to group Logs together for offline Evaluations
0 commit comments