forked from humanloop/humanloop-python
-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathevaluatee_request.py
More file actions
45 lines (35 loc) · 1.61 KB
/
evaluatee_request.py
File metadata and controls
45 lines (35 loc) · 1.61 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
# This file was auto-generated by Fern from our API Definition.
import typing_extensions
class EvaluateeRequestParams(typing_extensions.TypedDict):
"""
Specification of a File version on Humanloop.
This can be done in a couple of ways:
- Specifying `version_id` directly.
- Specifying a File (and optionally an Environment).
- A File can be specified by either `path` or `file_id`.
- An Environment can be specified by `environment_id`. If no Environment is specified, the default Environment is used.
"""
version_id: typing_extensions.NotRequired[str]
"""
Unique identifier for the File Version. If provided, none of the other fields should be specified.
"""
path: typing_extensions.NotRequired[str]
"""
Path identifying a File. Provide either this or `file_id` if you want to specify a File.
"""
file_id: typing_extensions.NotRequired[str]
"""
Unique identifier for the File. Provide either this or `path` if you want to specify a File.
"""
environment: typing_extensions.NotRequired[str]
"""
Name of the Environment a Version is deployed to. Only provide this when specifying a File. If not provided (and a File is specified), the default Environment is used.
"""
batch_id: typing_extensions.NotRequired[str]
"""
Unique identifier for the batch of Logs to include in the Evaluation.
"""
orchestrated: typing_extensions.NotRequired[bool]
"""
Whether the Prompt/Tool is orchestrated by Humanloop. Default is `True`. If `False`, a log for the Prompt/Tool should be submitted by the user via the API.
"""