reference.md

# Reference
## Prompts
<details><summary><code>client.prompts.<a href="src/humanloop/prompts/client.py">log</a>(...)</code></summary>
<dl>
<dd>

#### 📝 Description

<dl>
<dd>

<dl>
<dd>

Log to a Prompt.

You can use query parameters `version_id`, or `environment`, to target
an existing version of the Prompt. Otherwise, the default deployed version will be chosen.

Instead of targeting an existing version explicitly, you can instead pass in
Prompt details in the request body. In this case, we will check if the details correspond
to an existing version of the Prompt. If they do not, we will create a new version. This is helpful
in the case where you are storing or deriving your Prompt details in code.
</dd>
</dl>
</dd>
</dl>

#### 🔌 Usage

<dl>
<dd>

<dl>
<dd>

```python
from humanloop import Humanloop
import datetime
client = Humanloop(api_key="YOUR_API_KEY", )
client.prompts.log(path='persona', prompt={'model': 'gpt-4', 'template': [{'role': "system", 'content': 'You are {{person}}. Answer questions as this person. Do not break character.'}]}, messages=[{'role': "user", 'content': 'What really happened at Roswell?'}], inputs={'person': 'Trump'
}, created_at=datetime.datetime.fromisoformat("2024-07-18 23:29:35.178000+00:00", ), provider_latency=6.5931549072265625, output_message={'content': "Well, you know, there is so much secrecy involved in government, folks, it's unbelievable. They don't want to tell you everything. They don't tell me everything! But about Roswell, it's a very popular question. I know, I just know, that something very, very peculiar happened there. Was it a weather balloon? Maybe. Was it something extraterrestrial? Could be. I'd love to go down and open up all the classified documents, believe me, I would. But they don't let that happen. The Deep State, folks, the Deep State. They're unbelievable. They want to keep everything a secret. But whatever the truth is, I can tell you this: it's something big, very very big. Tremendous, in fact.", 'role': "assistant"}, prompt_tokens=100, output_tokens=220, prompt_cost=1e-05, output_cost=0.0002, finish_reason='stop', )

```
</dd>
</dl>
</dd>
</dl>

#### ⚙️ Parameters

<dl>
<dd>

<dl>
<dd>

**version_id:** `typing.Optional[str]` — A specific Version ID of the Prompt to log to.
    
</dd>
</dl>

<dl>
<dd>

**environment:** `typing.Optional[str]` — Name of the Environment identifying a deployed version to log to.
    
</dd>
</dl>

<dl>
<dd>

**run_id:** `typing.Optional[str]` — Unique identifier for the Run to associate the Log to.
    
</dd>
</dl>

<dl>
<dd>

**path:** `typing.Optional[str]` — Path of the Prompt, including the name. This locates the Prompt in the Humanloop filesystem and is used as as a unique identifier. For example: `folder/name` or just `name`.
    
</dd>
</dl>

<dl>
<dd>

**id:** `typing.Optional[str]` — ID for an existing Prompt.
    
</dd>
</dl>

<dl>
<dd>

**output_message:** `typing.Optional[ChatMessageParams]` — The message returned by the provider.
    
</dd>
</dl>

<dl>
<dd>

**prompt_tokens:** `typing.Optional[int]` — Number of tokens in the prompt used to generate the output.
    
</dd>
</dl>

<dl>
<dd>

**reasoning_tokens:** `typing.Optional[int]` — Number of reasoning tokens used to generate the output.
    
</dd>
</dl>

<dl>
<dd>

**output_tokens:** `typing.Optional[int]` — Number of tokens in the output generated by the model.
    
</dd>
</dl>

<dl>
<dd>

**prompt_cost:** `typing.Optional[float]` — Cost in dollars associated to the tokens in the prompt.
    
</dd>
</dl>

<dl>
<dd>

**output_cost:** `typing.Optional[float]` — Cost in dollars associated to the tokens in the output.
    
</dd>
</dl>

<dl>
<dd>

**finish_reason:** `typing.Optional[str]` — Reason the generation finished.
    
</dd>
</dl>

<dl>
<dd>

**messages:** `typing.Optional[typing.Sequence[ChatMessageParams]]` — The messages passed to the to provider chat endpoint.
    
</dd>
</dl>

<dl>
<dd>

**tool_choice:** `typing.Optional[PromptLogRequestToolChoiceParams]` 

Controls how the model uses tools. The following options are supported: 
- `'none'` means the model will not call any tool and instead generates a message; this is the default when no tools are provided as part of the Prompt. 
- `'auto'` means the model can decide to call one or more of the provided tools; this is the default when tools are provided as part of the Prompt. 
- `'required'` means the model must call one or more of the provided tools. 
- `{'type': 'function', 'function': {name': <TOOL_NAME>}}` forces the model to use the named function.
    
</dd>
</dl>

<dl>
<dd>

**prompt:** `typing.Optional[PromptLogRequestPromptParams]` 

The Prompt configuration to use. Two formats are supported:
- An object representing the details of the Prompt configuration
- A string representing the raw contents of a .prompt file
A new Prompt version will be created if the provided details do not match any existing version.
    
</dd>
</dl>

<dl>
<dd>

**start_time:** `typing.Optional[dt.datetime]` — When the logged event started.
    
</dd>
</dl>

<dl>
<dd>

**end_time:** `typing.Optional[dt.datetime]` — When the logged event ended.
    
</dd>
</dl>

<dl>
<dd>

**output:** `typing.Optional[str]` — Generated output from your model for the provided inputs. Can be `None` if logging an error, or if creating a parent Log with the intention to populate it later.
    
</dd>
</dl>

<dl>
<dd>

**created_at:** `typing.Optional[dt.datetime]` — User defined timestamp for when the log was created. 
    
</dd>
</dl>

<dl>
<dd>

**error:** `typing.Optional[str]` — Error message if the log is an error.
    
</dd>
</dl>

<dl>
<dd>

**provider_latency:** `typing.Optional[float]` — Duration of the logged event in seconds.
    
</dd>
</dl>

<dl>
<dd>

**stdout:** `typing.Optional[str]` — Captured log and debug statements.
    
</dd>
</dl>

<dl>
<dd>

**provider_request:** `typing.Optional[typing.Dict[str, typing.Optional[typing.Any]]]` — Raw request sent to provider.
    
</dd>
</dl>

<dl>
<dd>

**provider_response:** `typing.Optional[typing.Dict[str, typing.Optional[typing.Any]]]` — Raw response received the provider.
    
</dd>
</dl>

<dl>
<dd>

**inputs:** `typing.Optional[typing.Dict[str, typing.Optional[typing.Any]]]` — The inputs passed to the prompt template.
    
</dd>
</dl>

<dl>
<dd>

**source:** `typing.Optional[str]` — Identifies where the model was called from.
    
</dd>
</dl>

<dl>
<dd>

**metadata:** `typing.Optional[typing.Dict[str, typing.Optional[typing.Any]]]` — Any additional metadata to record.
    
</dd>
</dl>

<dl>
<dd>

**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.
    
</dd>
</dl>

<dl>
<dd>

**trace_parent_id:** `typing.Optional[str]` — The ID of the parent Log to nest this Log under in a Trace.
    
</dd>
</dl>

<dl>
<dd>

**user:** `typing.Optional[str]` — End-user ID related to the Log.
    
</dd>
</dl>

<dl>
<dd>

**prompt_log_request_environment:** `typing.Optional[str]` — The name of the Environment the Log is associated to.
    
</dd>
</dl>

<dl>
<dd>

**save:** `typing.Optional[bool]` — Whether the request/response payloads will be stored on Humanloop.
    
</dd>
</dl>

<dl>
<dd>

**log_id:** `typing.Optional[str]` — This will identify a Log. If you don't provide a Log ID, Humanloop will generate one for you.
    
</dd>
</dl>

<dl>
<dd>

**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
    
</dd>
</dl>
</dd>
</dl>


</dd>
</dl>
</details>

<details><summary><code>client.prompts.<a href="src/humanloop/prompts/client.py">update_log</a>(...)</code></summary>
<dl>
<dd>

#### 📝 Description

<dl>
<dd>

<dl>
<dd>

Update a Log.

Update the details of a Log with the given ID.
</dd>
</dl>
</dd>
</dl>

#### 🔌 Usage

<dl>
<dd>

<dl>
<dd>

```python
from humanloop import Humanloop
client = Humanloop(api_key="YOUR_API_KEY", )
client.prompts.update_log(id='id', log_id='log_id', )

```
</dd>
</dl>
</dd>
</dl>

#### ⚙️ Parameters

<dl>
<dd>

<dl>
<dd>

**id:** `str` — Unique identifier for Prompt.
    
</dd>
</dl>

<dl>
<dd>

**log_id:** `str` — Unique identifier for the Log.
    
</dd>
</dl>

<dl>
<dd>

**output_message:** `typing.Optional[ChatMessageParams]` — The message returned by the provider.
    
</dd>
</dl>

<dl>
<dd>

**prompt_tokens:** `typing.Optional[int]` — Number of tokens in the prompt used to generate the output.
    
</dd>
</dl>

<dl>
<dd>

**reasoning_tokens:** `typing.Optional[int]` — Number of reasoning tokens used to generate the output.
    
</dd>
</dl>

<dl>
<dd>

**output_tokens:** `typing.Optional[int]` — Number of tokens in the output generated by the model.
    
</dd>
</dl>

<dl>
<dd>

**prompt_cost:** `typing.Optional[float]` — Cost in dollars associated to the tokens in the prompt.
    
</dd>
</dl>

<dl>
<dd>

**output_cost:** `typing.Optional[float]` — Cost in dollars associated to the tokens in the output.
    
</dd>
</dl>

<dl>
<dd>

**finish_reason:** `typing.Optional[str]` — Reason the generation finished.
    
</dd>
</dl>

<dl>
<dd>

**messages:** `typing.Optional[typing.Sequence[ChatMessageParams]]` — The messages passed to the to provider chat endpoint.
    
</dd>
</dl>

<dl>
<dd>

**tool_choice:** `typing.Optional[PromptLogUpdateRequestToolChoiceParams]` 

Controls how the model uses tools. The following options are supported: 
- `'none'` means the model will not call any tool and instead generates a message; this is the default when no tools are provided as part of the Prompt. 
- `'auto'` means the model can decide to call one or more of the provided tools; this is the default when tools are provided as part of the Prompt. 
- `'required'` means the model must call one or more of the provided tools. 
- `{'type': 'function', 'function': {name': <TOOL_NAME>}}` forces the model to use the named function.
    
</dd>
</dl>

<dl>
<dd>

**output:** `typing.Optional[str]` — Generated output from your model for the provided inputs. Can be `None` if logging an error, or if creating a parent Log with the intention to populate it later.
    
</dd>
</dl>

<dl>
<dd>

**created_at:** `typing.Optional[dt.datetime]` — User defined timestamp for when the log was created. 
    
</dd>
</dl>

<dl>
<dd>

**error:** `typing.Optional[str]` — Error message if the log is an error.
    
</dd>
</dl>

<dl>
<dd>

**provider_latency:** `typing.Optional[float]` — Duration of the logged event in seconds.
    
</dd>
</dl>

<dl>
<dd>

**stdout:** `typing.Optional[str]` — Captured log and debug statements.
    
</dd>
</dl>

<dl>
<dd>

**provider_request:** `typing.Optional[typing.Dict[str, typing.Optional[typing.Any]]]` — Raw request sent to provider.
    
</dd>
</dl>

<dl>
<dd>

**provider_response:** `typing.Optional[typing.Dict[str, typing.Optional[typing.Any]]]` — Raw response received the provider.
    
</dd>
</dl>

<dl>
<dd>

**inputs:** `typing.Optional[typing.Dict[str, typing.Optional[typing.Any]]]` — The inputs passed to the prompt template.
    
</dd>
</dl>

<dl>
<dd>

**source:** `typing.Optional[str]` — Identifies where the model was called from.
    
</dd>
</dl>

<dl>
<dd>

**metadata:** `typing.Optional[typing.Dict[str, typing.Optional[typing.Any]]]` — Any additional metadata to record.
    
</dd>
</dl>

<dl>
<dd>

**start_time:** `typing.Optional[dt.datetime]` — When the logged event started.
    
</dd>
</dl>

<dl>
<dd>

**end_time:** `typing.Optional[dt.datetime]` — When the logged event ended.
    
</dd>
</dl>

<dl>
<dd>

**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
    
</dd>
</dl>
</dd>
</dl>


</dd>
</dl>
</details>

<details><summary><code>client.prompts.<a href="src/humanloop/prompts/client.py">call_stream</a>(...)</code></summary>
<dl>
<dd>

#### 📝 Description

<dl>
<dd>

<dl>
<dd>

Call a Prompt.

Calling a Prompt calls the model provider before logging
the request, responses and metadata to Humanloop.

You can use query parameters `version_id`, or `environment`, to target
an existing version of the Prompt. Otherwise the default deployed version will be chosen.

Instead of targeting an existing version explicitly, you can instead pass in
Prompt details in the request body. In this case, we will check if the details correspond
to an existing version of the Prompt. If they do not, we will create a new version. This is helpful
in the case where you are storing or deriving your Prompt details in code.
</dd>
</dl>
</dd>
</dl>

#### 🔌 Usage

<dl>
<dd>

<dl>
<dd>

```python
from humanloop import Humanloop
client = Humanloop(api_key="YOUR_API_KEY", )
response = client.prompts.call_stream()
for chunk in response.data:
    yield chunk

```
</dd>
</dl>
</dd>
</dl>

#### ⚙️ Parameters

<dl>
<dd>

<dl>
<dd>

**version_id:** `typing.Optional[str]` — A specific Version ID of the Prompt to log to.
    
</dd>
</dl>

<dl>
<dd>

**environment:** `typing.Optional[str]` — Name of the Environment identifying a deployed version to log to.
    
</dd>
</dl>

<dl>
<dd>

**path:** `typing.Optional[str]` — Path of the Prompt, including the name. This locates the Prompt in the Humanloop filesystem and is used as as a unique identifier. For example: `folder/name` or just `name`.
    
</dd>
</dl>

<dl>
<dd>

**id:** `typing.Optional[str]` — ID for an existing Prompt.
    
</dd>
</dl>

<dl>
<dd>

**messages:** `typing.Optional[typing.Sequence[ChatMessageParams]]` — The messages passed to the to provider chat endpoint.
    
</dd>
</dl>

<dl>
<dd>

**tool_choice:** `typing.Optional[PromptsCallStreamRequestToolChoiceParams]` 

Controls how the model uses tools. The following options are supported: 
- `'none'` means the model will not call any tool and instead generates a message; this is the default when no tools are provided as part of the Prompt. 
- `'auto'` means the model can decide to call one or more of the provided tools; this is the default when tools are provided as part of the Prompt. 
- `'required'` means the model must call one or more of the provided tools. 
- `{'type': 'function', 'function': {name': <TOOL_NAME>}}` forces the model to use the named function.
    
</dd>
</dl>

<dl>
<dd>

**prompt:** `typing.Optional[PromptsCallStreamRequestPromptParams]` 

The Prompt configuration to use. Two formats are supported:
- An object representing the details of the Prompt configuration
- A string representing the raw contents of a .prompt file
A new Prompt version will be created if the provided details do not match any existing version.
    
</dd>
</dl>

<dl>
<dd>

**inputs:** `typing.Optional[typing.Dict[str, typing.Optional[typing.Any]]]` — The inputs passed to the prompt template.
    
</dd>
</dl>

<dl>
<dd>

**source:** `typing.Optional[str]` — Identifies where the model was called from.
    
</dd>
</dl>

<dl>
<dd>

**metadata:** `typing.Optional[typing.Dict[str, typing.Optional[typing.Any]]]` — Any additional metadata to record.
    
</dd>
</dl>

<dl>
<dd>

**start_time:** `typing.Optional[dt.datetime]` — When the logged event started.
    
</dd>
</dl>

<dl>
<dd>

**end_time:** `typing.Optional[dt.datetime]` — When the logged event ended.
    
</dd>
</dl>

<dl>
<dd>

**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.
    
</dd>
</dl>

<dl>
<dd>

**trace_parent_id:** `typing.Optional[str]` — The ID of the parent Log to nest this Log under in a Trace.
    
</dd>
</dl>

<dl>
<dd>

**user:** `typing.Optional[str]` — End-user ID related to the Log.
    
</dd>
</dl>

<dl>
<dd>

**prompts_call_stream_request_environment:** `typing.Optional[str]` — The name of the Environment the Log is associated to.
    
</dd>
</dl>

<dl>
<dd>

**save:** `typing.Optional[bool]` — Whether the request/response payloads will be stored on Humanloop.
    
</dd>
</dl>

<dl>
<dd>

**log_id:** `typing.Optional[str]` — This will identify a Log. If you don't provide a Log ID, Humanloop will generate one for you.
    
</dd>
</dl>

<dl>
<dd>

**provider_api_keys:** `typing.Optional[ProviderApiKeysParams]` — API keys required by each provider to make API calls. The API keys provided here are not stored by Humanloop. If not specified here, Humanloop will fall back to the key saved to your organization.
    
</dd>
</dl>

<dl>
<dd>

**num_samples:** `typing.Optional[int]` — The number of generations.
    
</dd>
</dl>

<dl>
<dd>

**return_inputs:** `typing.Optional[bool]` — Whether to return the inputs in the response. If false, the response will contain an empty dictionary under inputs. This is useful for reducing the size of the response. Defaults to true.
    
</dd>
</dl>

<dl>
<dd>

**logprobs:** `typing.Optional[int]` — Include the log probabilities of the top n tokens in the provider_response
    
</dd>
</dl>

<dl>
<dd>

**suffix:** `typing.Optional[str]` — The suffix that comes after a completion of inserted text. Useful for completions that act like inserts.
    
</dd>
</dl>

<dl>
<dd>

**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
    
</dd>
</dl>
</dd>
</dl>


</dd>
</dl>
</details>

<details><summary><code>client.prompts.<a href="src/humanloop/prompts/client.py">call</a>(...)</code></summary>
<dl>
<dd>

#### 📝 Description

<dl>
<dd>

<dl>
<dd>

Call a Prompt.

Calling a Prompt calls the model provider before logging
the request, responses and metadata to Humanloop.

You can use query parameters `version_id`, or `environment`, to target
an existing version of the Prompt. Otherwise the default deployed version will be chosen.

Instead of targeting an existing version explicitly, you can instead pass in
Prompt details in the request body. In this case, we will check if the details correspond
to an existing version of the Prompt. If they do not, we will create a new version. This is helpful
in the case where you are storing or deriving your Prompt details in code.
</dd>
</dl>
</dd>
</dl>

#### 🔌 Usage

<dl>
<dd>

<dl>
<dd>

```python
from humanloop import Humanloop
client = Humanloop(api_key="YOUR_API_KEY", )
client.prompts.call(version_id='prv_Wu6zx1lAWJRqOyL8nWuZk', path='persona', messages=[{'role': "user", 'content': 'What really happened at Roswell?'}], inputs={'person': 'Trump'
}, )

```
</dd>
</dl>
</dd>
</dl>

#### ⚙️ Parameters

<dl>
<dd>

<dl>
<dd>

**version_id:** `typing.Optional[str]` — A specific Version ID of the Prompt to log to.
    
</dd>
</dl>

<dl>
<dd>

**environment:** `typing.Optional[str]` — Name of the Environment identifying a deployed version to log to.
    
</dd>
</dl>

<dl>
<dd>

**path:** `typing.Optional[str]` — Path of the Prompt, including the name. This locates the Prompt in the Humanloop filesystem and is used as as a unique identifier. For example: `folder/name` or just `name`.
    
</dd>
</dl>

<dl>
<dd>

**id:** `typing.Optional[str]` — ID for an existing Prompt.
    
</dd>
</dl>

<dl>
<dd>

**messages:** `typing.Optional[typing.Sequence[ChatMessageParams]]` — The messages passed to the to provider chat endpoint.
    
</dd>
</dl>

<dl>
<dd>

**tool_choice:** `typing.Optional[PromptsCallRequestToolChoiceParams]` 

Controls how the model uses tools. The following options are supported: 
- `'none'` means the model will not call any tool and instead generates a message; this is the default when no tools are provided as part of the Prompt. 
- `'auto'` means the model can decide to call one or more of the provided tools; this is the default when tools are provided as part of the Prompt. 
- `'required'` means the model must call one or more of the provided tools. 
- `{'type': 'function', 'function': {name': <TOOL_NAME>}}` forces the model to use the named function.
    
</dd>
</dl>

<dl>
<dd>

**prompt:** `typing.Optional[PromptsCallRequestPromptParams]` 

The Prompt configuration to use. Two formats are supported:
- An object representing the details of the Prompt configuration
- A string representing the raw contents of a .prompt file
A new Prompt version will be created if the provided details do not match any existing version.
    
</dd>
</dl>

<dl>
<dd>

**inputs:** `typing.Optional[typing.Dict[str, typing.Optional[typing.Any]]]` — The inputs passed to the prompt template.
    
</dd>
</dl>

<dl>
<dd>

**source:** `typing.Optional[str]` — Identifies where the model was called from.
    
</dd>
</dl>

<dl>
<dd>

**metadata:** `typing.Optional[typing.Dict[str, typing.Optional[typing.Any]]]` — Any additional metadata to record.
    
</dd>
</dl>

<dl>
<dd>

**start_time:** `typing.Optional[dt.datetime]` — When the logged event started.
    
</dd>
</dl>

<dl>
<dd>

**end_time:** `typing.Optional[dt.datetime]` — When the logged event ended.
    
</dd>
</dl>

<dl>
<dd>

**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.
    
</dd>
</dl>

<dl>
<dd>

**trace_parent_id:** `typing.Optional[str]` — The ID of the parent Log to nest this Log under in a Trace.
    
</dd>
</dl>

<dl>
<dd>

**user:** `typing.Optional[str]` — End-user ID related to the Log.
    
</dd>
</dl>

<dl>
<dd>

**prompts_call_request_environment:** `typing.Optional[str]` — The name of the Environment the Log is associated to.
    
</dd>
</dl>

<dl>
<dd>

**save:** `typing.Optional[bool]` — Whether the request/response payloads will be stored on Humanloop.
    
</dd>
</dl>

<dl>
<dd>

**log_id:** `typing.Optional[str]` — This will identify a Log. If you don't provide a Log ID, Humanloop will generate one for you.
    
</dd>
</dl>

<dl>
<dd>

**provider_api_keys:** `typing.Optional[ProviderApiKeysParams]` — API keys required by each provider to make API calls. The API keys provided here are not stored by Humanloop. If not specified here, Humanloop will fall back to the key saved to your organization.
    
</dd>
</dl>

<dl>
<dd>

**num_samples:** `typing.Optional[int]` — The number of generations.
    
</dd>
</dl>

<dl>
<dd>

**return_inputs:** `typing.Optional[bool]` — Whether to return the inputs in the response. If false, the response will contain an empty dictionary under inputs. This is useful for reducing the size of the response. Defaults to true.
    
</dd>
</dl>

<dl>
<dd>

**logprobs:** `typing.Optional[int]` — Include the log probabilities of the top n tokens in the provider_response
    
</dd>
</dl>

<dl>
<dd>

**suffix:** `typing.Optional[str]` — The suffix that comes after a completion of inserted text. Useful for completions that act like inserts.
    
</dd>
</dl>

<dl>
<dd>

**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
    
</dd>
</dl>
</dd>
</dl>


</dd>
</dl>
</details>

<details><summary><code>client.prompts.<a href="src/humanloop/prompts/client.py">list</a>(...)</code></summary>
<dl>
<dd>

#### 📝 Description

<dl>
<dd>

<dl>
<dd>

Get a list of all Prompts.
</dd>
</dl>
</dd>
</dl>

#### 🔌 Usage

<dl>
<dd>

<dl>
<dd>

```python
from humanloop import Humanloop
client = Humanloop(api_key="YOUR_API_KEY", )
response = client.prompts.list(size=1, )
for item in response:
    yield item
# alternatively, you can paginate page-by-page
for page in response.iter_pages():
    yield page

```
</dd>
</dl>
</dd>
</dl>

#### ⚙️ Parameters

<dl>
<dd>

<dl>
<dd>

**page:** `typing.Optional[int]` — Page number for pagination.
    
</dd>
</dl>

<dl>
<dd>

**size:** `typing.Optional[int]` — Page size for pagination. Number of Prompts to fetch.
    
</dd>
</dl>

<dl>
<dd>

**name:** `typing.Optional[str]` — Case-insensitive filter for Prompt name.
    
</dd>
</dl>

<dl>
<dd>

**user_filter:** `typing.Optional[str]` — Case-insensitive filter for users in the Prompt. This filter matches against both email address and name of users.
    
</dd>
</dl>

<dl>
<dd>

**sort_by:** `typing.Optional[FileSortBy]` — Field to sort Prompts by
    
</dd>
</dl>

<dl>
<dd>

**order:** `typing.Optional[SortOrder]` — Direction to sort by.
    
</dd>
</dl>

<dl>
<dd>

**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
    
</dd>
</dl>
</dd>
</dl>


</dd>
</dl>
</details>

<details><summary><code>client.prompts.<a href="src/humanloop/prompts/client.py">upsert</a>(...)</code></summary>
<dl>
<dd>

#### 📝 Description

<dl>
<dd>

<dl>
<dd>

Create a Prompt or update it with a new version if it already exists.

Prompts are identified by the `ID` or their `path`. The parameters (i.e. the prompt template, temperature, model etc.) determine the versions of the Prompt.

You can provide `version_name` and `version_description` to identify and describe your versions.
Version names must be unique within a Prompt - attempting to create a version with a name
that already exists will result in a 409 Conflict error.
</dd>
</dl>
</dd>
</dl>

#### 🔌 Usage

<dl>
<dd>

<dl>
<dd>

```python
from humanloop import Humanloop
client = Humanloop(api_key="YOUR_API_KEY", )
client.prompts.upsert(path='Personal Projects/Coding Assistant', model='gpt-4o', endpoint="chat", template=[{'content': 'You are a helpful coding assistant specialising in {{language}}', 'role': "system"}], provider="openai", max_tokens=-1, temperature=0.7, version_name='coding-assistant-v1', version_description='Initial version', )

```
</dd>
</dl>
</dd>
</dl>

#### ⚙️ Parameters

<dl>
<dd>

<dl>
<dd>

**model:** `str` — The model instance used, e.g. `gpt-4`. See [supported models](https://humanloop.com/docs/reference/supported-models)
    
</dd>
</dl>

<dl>
<dd>

**path:** `typing.Optional[str]` — Path of the Prompt, including the name. This locates the Prompt in the Humanloop filesystem and is used as as a unique identifier. For example: `folder/name` or just `name`.
    
</dd>
</dl>

<dl>
<dd>

**id:** `typing.Optional[str]` — ID for an existing Prompt.
    
</dd>
</dl>

<dl>
<dd>

**endpoint:** `typing.Optional[ModelEndpoints]` — The provider model endpoint used.
    
</dd>
</dl>

<dl>
<dd>

**template:** `typing.Optional[PromptRequestTemplateParams]` 

The template contains the main structure and instructions for the model, including input variables for dynamic values. 

For chat models, provide the template as a ChatTemplate (a list of messages), e.g. a system message, followed by a user message with an input variable.
For completion models, provide a prompt template as a string. 

Input variables should be specified with double curly bracket syntax: `{{input_name}}`.
    
</dd>
</dl>

<dl>
<dd>

**template_language:** `typing.Optional[TemplateLanguage]` — The template language to use for rendering the template.
    
</dd>
</dl>

<dl>
<dd>

**provider:** `typing.Optional[ModelProviders]` — The company providing the underlying model service.
    
</dd>
</dl>

<dl>
<dd>

**max_tokens:** `typing.Optional[int]` — The maximum number of tokens to generate. Provide max_tokens=-1 to dynamically calculate the maximum number of tokens to generate given the length of the prompt
    
</dd>
</dl>

<dl>
<dd>

**temperature:** `typing.Optional[float]` — What sampling temperature to use when making a generation. Higher values means the model will be more creative.
    
</dd>
</dl>

<dl>
<dd>

**top_p:** `typing.Optional[float]` — An alternative to sampling with temperature, called nucleus sampling, where the model considers the results of the tokens with top_p probability mass.
    
</dd>
</dl>

<dl>
<dd>

**stop:** `typing.Optional[PromptRequestStopParams]` — The string (or list of strings) after which the model will stop generating. The returned text will not contain the stop sequence.
    
</dd>
</dl>

<dl>
<dd>

**presence_penalty:** `typing.Optional[float]` — Number between -2.0 and 2.0. Positive values penalize new tokens based on whether they appear in the generation so far.
    
</dd>
</dl>

<dl>
<dd>

**frequency_penalty:** `typing.Optional[float]` — Number between -2.0 and 2.0. Positive values penalize new tokens based on how frequently they appear in the generation so far.
    
</dd>
</dl>

<dl>
<dd>

**other:** `typing.Optional[typing.Dict[str, typing.Optional[typing.Any]]]` — Other parameter values to be passed to the provider call.
    
</dd>
</dl>

<dl>
<dd>

**seed:** `typing.Optional[int]` — If specified, model will make a best effort to sample deterministically, but it is not guaranteed.
    
</dd>
</dl>

<dl>
<dd>

**response_format:** `typing.Optional[ResponseFormatParams]` — The format of the response. Only `{"type": "json_object"}` is currently supported for chat.
    
</dd>
</dl>

<dl>
<dd>

**reasoning_effort:** `typing.Optional[PromptRequestReasoningEffortParams]` — Guidance on how many reasoning tokens it should generate before creating a response to the prompt. OpenAI reasoning models (o1, o3-mini) expect a OpenAIReasoningEffort enum. Anthropic reasoning models expect an integer, which signifies the maximum token budget.
    
</dd>
</dl>

<dl>
<dd>

**tools:** `typing.Optional[typing.Sequence[ToolFunctionParams]]` — The tool specification that the model can choose to call if Tool calling is supported.
    
</dd>
</dl>

<dl>
<dd>

**linked_tools:** `typing.Optional[typing.Sequence[str]]` — The IDs of the Tools in your organization that the model can choose to call if Tool calling is supported. The default deployed version of that tool is called.
    
</dd>
</dl>

<dl>
<dd>

**attributes:** `typing.Optional[typing.Dict[str, typing.Optional[typing.Any]]]` — Additional fields to describe the Prompt. Helpful to separate Prompt versions from each other with details on how they were created or used.
    
</dd>
</dl>

<dl>
<dd>

**version_name:** `typing.Optional[str]` — Unique name for the Prompt version. Version names must be unique for a given Prompt.
    
</dd>
</dl>

<dl>
<dd>

**version_description:** `typing.Optional[str]` — Description of the version, e.g., the changes made in this version.
    
</dd>
</dl>

<dl>
<dd>

**description:** `typing.Optional[str]` — Description of the Prompt.
    
</dd>
</dl>

<dl>
<dd>

**tags:** `typing.Optional[typing.Sequence[str]]` — List of tags associated with this prompt.
    
</dd>
</dl>

<dl>
<dd>

**readme:** `typing.Optional[str]` — Long description of the Prompt.
    
</dd>
</dl>

<dl>
<dd>

**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
    
</dd>
</dl>
</dd>
</dl>


</dd>
</dl>
</details>

<details><summary><code>client.prompts.<a href="src/humanloop/prompts/client.py">get</a>(...)</code></summary>
<dl>
<dd>

#### 📝 Description

<dl>
<dd>

<dl>
<dd>

Retrieve the Prompt with the given ID.

By default, the deployed version of the Prompt is returned. Use the query parameters
`version_id` or `environment` to target a specific version of the Prompt.
</dd>
</dl>
</dd>
</dl>

#### 🔌 Usage

<dl>
<dd>

<dl>
<dd>

```python
from humanloop import Humanloop
client = Humanloop(api_key="YOUR_API_KEY", )
client.prompts.get(id='pr_30gco7dx6JDq4200GVOHa', )

```
</dd>
</dl>
</dd>
</dl>

#### ⚙️ Parameters

<dl>
<dd>

<dl>
<dd>

**id:** `str` — Unique identifier for Prompt.
    
</dd>
</dl>

<dl>
<dd>

**version_id:** `typing.Optional[str]` — A specific Version ID of the Prompt to retrieve.
    
</dd>
</dl>

<dl>
<dd>

**environment:** `typing.Optional[str]` — Name of the Environment to retrieve a deployed Version from.
    
</dd>
</dl>

<dl>
<dd>

**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
    
</dd>
</dl>
</dd>
</dl>


</dd>
</dl>
</details>

<details><summary><code>client.prompts.<a href="src/humanloop/prompts/client.py">delete</a>(...)</code></summary>
<dl>
<dd>

#### 📝 Description

<dl>
<dd>

<dl>
<dd>

Delete the Prompt with the given ID.
</dd>
</dl>
</dd>
</dl>

#### 🔌 Usage

<dl>
<dd>

<dl>
<dd>

```python
from humanloop import Humanloop
client = Humanloop(api_key="YOUR_API_KEY", )
client.prompts.delete(id='pr_30gco7dx6JDq4200GVOHa', )

```
</dd>
</dl>
</dd>
</dl>

#### ⚙️ Parameters

<dl>
<dd>

<dl>
<dd>

**id:** `str` — Unique identifier for Prompt.
    
</dd>
</dl>

<dl>
<dd>

**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
    
</dd>
</dl>
</dd>
</dl>


</dd>
</dl>
</details>

<details><summary><code>client.prompts.<a href="src/humanloop/prompts/client.py">move</a>(...)</code></summary>
<dl>
<dd>

#### 📝 Description

<dl>
<dd>

<dl>
<dd>

Move the Prompt to a different path or change the name.
</dd>
</dl>
</dd>
</dl>

#### 🔌 Usage

<dl>
<dd>

<dl>
<dd>

```python
from humanloop import Humanloop
client = Humanloop(api_key="YOUR_API_KEY", )
client.prompts.move(id='pr_30gco7dx6JDq4200GVOHa', path='new directory/new name', )

```
</dd>
</dl>
</dd>
</dl>

#### ⚙️ Parameters

<dl>
<dd>

<dl>
<dd>

**id:** `str` — Unique identifier for Prompt.
    
</dd>
</dl>

<dl>
<dd>

**path:** `typing.Optional[str]` — Path of the Prompt including the Prompt name, which is used as a unique identifier.
    
</dd>
</dl>

<dl>
<dd>

**name:** `typing.Optional[str]` — Name of the Prompt.
    
</dd>
</dl>

<dl>
<dd>

**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
    
</dd>
</dl>
</dd>
</dl>


</dd>
</dl>
</details>

<details><summary><code>client.prompts.<a href="src/humanloop/prompts/client.py">populate</a>(...)</code></summary>
<dl>
<dd>

#### 📝 Description

<dl>
<dd>

<dl>
<dd>

Retrieve the Prompt with the given ID, including the populated template.

By default, the deployed version of the Prompt is returned. Use the query parameters
`version_id` or `environment` to target a specific version of the Prompt.
</dd>
</dl>
</dd>
</dl>

#### 🔌 Usage

<dl>
<dd>

<dl>
<dd>

```python
from humanloop import Humanloop
client = Humanloop(api_key="YOUR_API_KEY", )
client.prompts.populate(id='id', request={'key': 'value'
}, )

```
</dd>
</dl>
</dd>
</dl>

#### ⚙️ Parameters

<dl>
<dd>

<dl>
<dd>

**id:** `str` — Unique identifier for Prompt.
    
</dd>
</dl>

<dl>
<dd>

**request:** `typing.Dict[str, typing.Optional[typing.Any]]` 
    
</dd>
</dl>

<dl>
<dd>

**version_id:** `typing.Optional[str]` — A specific Version ID of the Prompt to retrieve to populate the template.
    
</dd>
</dl>

<dl>
<dd>

**environment:** `typing.Optional[str]` — Name of the Environment to retrieve a deployed Version from to populate the template.
    
</dd>
</dl>

<dl>
<dd>

**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
    
</dd>
</dl>
</dd>
</dl>


</dd>
</dl>
</details>

<details><summary><code>client.prompts.<a href="src/humanloop/prompts/client.py">list_versions</a>(...)</code></summary>
<dl>
<dd>

#### 📝 Description

<dl>
<dd>

<dl>
<dd>

Get a list of all the versions of a Prompt.
</dd>
</dl>
</dd>
</dl>

#### 🔌 Usage

<dl>
<dd>

<dl>
<dd>

```python
from humanloop import Humanloop
client = Humanloop(api_key="YOUR_API_KEY", )
client.prompts.list_versions(id='pr_30gco7dx6JDq4200GVOHa', )

```
</dd>
</dl>
</dd>
</dl>

#### ⚙️ Parameters

<dl>
<dd>

<dl>
<dd>

**id:** `str` — Unique identifier for Prompt.
    
</dd>
</dl>

<dl>
<dd>

**evaluator_aggregates:** `typing.Optional[bool]` — Whether to include Evaluator aggregate results for the versions in the response
    
</dd>
</dl>

<dl>
<dd>

**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
    
</dd>
</dl>
</dd>
</dl>


</dd>
</dl>
</details>

<details><summary><code>client.prompts.<a href="src/humanloop/prompts/client.py">delete_prompt_version</a>(...)</code></summary>
<dl>
<dd>

#### 📝 Description

<dl>
<dd>

<dl>
<dd>

Delete a version of the Prompt.
</dd>
</dl>
</dd>
</dl>

#### 🔌 Usage

<dl>
<dd>

<dl>
<dd>

```python
from humanloop import Humanloop
client = Humanloop(api_key="YOUR_API_KEY", )
client.prompts.delete_prompt_version(id='id', version_id='version_id', )

```
</dd>
</dl>
</dd>
</dl>

#### ⚙️ Parameters

<dl>
<dd>

<dl>
<dd>

**id:** `str` — Unique identifier for Prompt.
    
</dd>
</dl>

<dl>
<dd>

**version_id:** `str` — Unique identifier for the specific version of the Prompt.
    
</dd>
</dl>

<dl>
<dd>

**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
    
</dd>
</dl>
</dd>
</dl>


</dd>
</dl>
</details>

<details><summary><code>client.prompts.<a href="src/humanloop/prompts/client.py">patch_prompt_version</a>(...)</code></summary>
<dl>
<dd>

#### 📝 Description

<dl>
<dd>

<dl>
<dd>

Update the name or description of the Prompt version.
</dd>
</dl>
</dd>
</dl>

#### 🔌 Usage

<dl>
<dd>

<dl>
<dd>

```python
from humanloop import Humanloop
client = Humanloop(api_key="YOUR_API_KEY", )
client.prompts.patch_prompt_version(id='id', version_id='version_id', )

```
</dd>
</dl>
</dd>
</dl>

#### ⚙️ Parameters

<dl>
<dd>

<dl>
<dd>

**id:** `str` — Unique identifier for Prompt.
    
</dd>
</dl>

<dl>
<dd>

**version_id:** `str` — Unique identifier for the specific version of the Prompt.
    
</dd>
</dl>

<dl>
<dd>

**name:** `typing.Optional[str]` — Name of the version.
    
</dd>
</dl>

<dl>
<dd>

**description:** `typing.Optional[str]` — Description of the version.
    
</dd>
</dl>

<dl>
<dd>

**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
    
</dd>
</dl>
</dd>
</dl>


</dd>
</dl>
</details>

<details><summary><code>client.prompts.<a href="src/humanloop/prompts/client.py">set_deployment</a>(...)</code></summary>
<dl>
<dd>

#### 📝 Description

<dl>
<dd>

<dl>
<dd>

Deploy Prompt to an Environment.

Set the deployed version for the specified Environment. This Prompt
will be used for calls made to the Prompt in this Environment.
</dd>
</dl>
</dd>
</dl>

#### 🔌 Usage

<dl>
<dd>

<dl>
<dd>

```python
from humanloop import Humanloop
client = Humanloop(api_key="YOUR_API_KEY", )
client.prompts.set_deployment(id='id', environment_id='environment_id', version_id='version_id', )

```
</dd>
</dl>
</dd>
</dl>

#### ⚙️ Parameters

<dl>
<dd>

<dl>
<dd>

**id:** `str` — Unique identifier for Prompt.
    
</dd>
</dl>

<dl>
<dd>

**environment_id:** `str` — Unique identifier for the Environment to deploy the Version to.
    
</dd>
</dl>

<dl>
<dd>

**version_id:** `str` — Unique identifier for the specific version of the Prompt.
    
</dd>
</dl>

<dl>
<dd>

**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
    
</dd>
</dl>
</dd>
</dl>


</dd>
</dl>
</details>

<details><summary><code>client.prompts.<a href="src/humanloop/prompts/client.py">remove_deployment</a>(...)</code></summary>
<dl>
<dd>

#### 📝 Description

<dl>
<dd>

<dl>
<dd>

Remove deployed Prompt from the Environment.

Remove the deployed version for the specified Environment. This Prompt
will no longer be used for calls made to the Prompt in this Environment.
</dd>
</dl>
</dd>
</dl>

#### 🔌 Usage

<dl>
<dd>

<dl>
<dd>

```python
from humanloop import Humanloop
client = Humanloop(api_key="YOUR_API_KEY", )
client.prompts.remove_deployment(id='id', environment_id='environment_id', )

```
</dd>
</dl>
</dd>
</dl>

#### ⚙️ Parameters

<dl>
<dd>

<dl>
<dd>

**id:** `str` — Unique identifier for Prompt.
    
</dd>
</dl>

<dl>
<dd>

**environment_id:** `str` — Unique identifier for the Environment to remove the deployment from.
    
</dd>
</dl>

<dl>
<dd>

**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
    
</dd>
</dl>
</dd>
</dl>


</dd>
</dl>
</details>

<details><summary><code>client.prompts.<a href="src/humanloop/prompts/client.py">list_environments</a>(...)</code></summary>
<dl>
<dd>

#### 📝 Description

<dl>
<dd>

<dl>
<dd>

List all Environments and their deployed versions for the Prompt.
</dd>
</dl>
</dd>
</dl>

#### 🔌 Usage

<dl>
<dd>

<dl>
<dd>

```python
from humanloop import Humanloop
client = Humanloop(api_key="YOUR_API_KEY", )
client.prompts.list_environments(id='pr_30gco7dx6JDq4200GVOHa', )

```
</dd>
</dl>
</dd>
</dl>

#### ⚙️ Parameters

<dl>
<dd>

<dl>
<dd>

**id:** `str` — Unique identifier for Prompt.
    
</dd>
</dl>

<dl>
<dd>

**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
    
</dd>
</dl>
</dd>
</dl>


</dd>
</dl>
</details>

<details><summary><code>client.prompts.<a href="src/humanloop/prompts/client.py">update_monitoring</a>(...)</code></summary>
<dl>
<dd>

#### 📝 Description

<dl>
<dd>

<dl>
<dd>

Activate and deactivate Evaluators for monitoring the Prompt.

An activated Evaluator will automatically be run on all new Logs
within the Prompt for monitoring purposes.
</dd>
</dl>
</dd>
</dl>

#### 🔌 Usage

<dl>
<dd>

<dl>
<dd>

```python
from humanloop import Humanloop
client = Humanloop(api_key="YOUR_API_KEY", )
client.prompts.update_monitoring(id='pr_30gco7dx6JDq4200GVOHa', activate=[{'evaluator_version_id': 'evv_1abc4308abd'}], )

```
</dd>
</dl>
</dd>
</dl>

#### ⚙️ Parameters

<dl>
<dd>

<dl>
<dd>

**id:** `str` 
    
</dd>
</dl>

<dl>
<dd>

**activate:** `typing.Optional[typing.Sequence[EvaluatorActivationDeactivationRequestActivateItemParams]]` — Evaluators to activate for Monitoring. These will be automatically run on new Logs.
    
</dd>
</dl>

<dl>
<dd>

**deactivate:** `typing.Optional[typing.Sequence[EvaluatorActivationDeactivationRequestDeactivateItemParams]]` — Evaluators to deactivate. These will not be run on new Logs.
    
</dd>
</dl>

<dl>
<dd>

**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
    
</dd>
</dl>
</dd>
</dl>


</dd>
</dl>
</details>

<details><summary><code>client.prompts.<a href="src/humanloop/prompts/client.py">serialize</a>(...)</code></summary>
<dl>
<dd>

#### 📝 Description

<dl>
<dd>

<dl>
<dd>

Serialize a Prompt to the .prompt file format.

Useful for storing the Prompt with your code in a version control system,
or for editing with an AI tool.

By default, the deployed version of the Prompt is returned. Use the query parameters
`version_id` or `environment` to target a specific version of the Prompt.
</dd>
</dl>
</dd>
</dl>

#### 🔌 Usage

<dl>
<dd>

<dl>
<dd>

```python
from humanloop import Humanloop
client = Humanloop(api_key="YOUR_API_KEY", )
client.prompts.serialize(id='id', )

```
</dd>
</dl>
</dd>
</dl>

#### ⚙️ Parameters

<dl>
<dd>

<dl>
<dd>

**id:** `str` — Unique identifier for Prompt.
    
</dd>
</dl>

<dl>
<dd>

**version_id:** `typing.Optional[str]` — A specific Version ID of the Prompt to retrieve.
    
</dd>
</dl>

<dl>
<dd>

**environment:** `typing.Optional[str]` — Name of the Environment to retrieve a deployed Version from.
    
</dd>
</dl>

<dl>
<dd>

**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
    
</dd>
</dl>
</dd>
</dl>


</dd>
</dl>
</details>

<details><summary><code>client.prompts.<a href="src/humanloop/prompts/client.py">deserialize</a>(...)</code></summary>
<dl>
<dd>

#### 📝 Description

<dl>
<dd>

<dl>
<dd>

Deserialize a Prompt from the .prompt file format.

This returns a subset of the attributes required by a Prompt.
This subset is the bit that defines the Prompt version (e.g. with `model` and `temperature` etc)
</dd>
</dl>
</dd>
</dl>

#### 🔌 Usage

<dl>
<dd>

<dl>
<dd>

```python
from humanloop import Humanloop
client = Humanloop(api_key="YOUR_API_KEY", )
client.prompts.deserialize(prompt='prompt', )

```
</dd>
</dl>
</dd>
</dl>

#### ⚙️ Parameters

<dl>
<dd>

<dl>
<dd>

**prompt:** `str` 
    
</dd>
</dl>

<dl>
<dd>

**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
    
</dd>
</dl>
</dd>
</dl>


</dd>
</dl>
</details>

## Tools
<details><summary><code>client.tools.<a href="src/humanloop/tools/client.py">call</a>(...)</code></summary>
<dl>
<dd>

#### 📝 Description

<dl>
<dd>

<dl>
<dd>

Call a Tool.

Calling a Tool with inputs runs the tool's source code and logs the result and metadata to Humanloop.

You can use query parameters `version_id`, or `environment`, to target
an existing version of the Tool. Otherwise, the default deployed version will be chosen.

Instead of targeting an existing version explicitly, you can instead pass in
Tool details in the request body. In this case, we will check if the details correspond
to an existing version of the Tool. If they do not, we will create a new version. This is helpful
in the case where you are storing or deriving your Tool details in code.
</dd>
</dl>
</dd>
</dl>

#### 🔌 Usage

<dl>
<dd>

<dl>
<dd>

```python
from humanloop import Humanloop
client = Humanloop(api_key="YOUR_API_KEY", )
client.tools.call()

```
</dd>
</dl>
</dd>
</dl>

#### ⚙️ Parameters

<dl>
<dd>

<dl>
<dd>

**version_id:** `typing.Optional[str]` — A specific Version ID of the Tool to call.
    
</dd>
</dl>

<dl>
<dd>

**environment:** `typing.Optional[str]` — Name of the Environment identifying a deployed version to call.
    
</dd>
</dl>

<dl>
<dd>

**path:** `typing.Optional[str]` — Path of the Tool, including the name. This locates the Tool in the Humanloop filesystem and is used as as a unique identifier. For example: `folder/name` or just `name`.
    
</dd>
</dl>

<dl>
<dd>

**id:** `typing.Optional[str]` — ID for an existing Tool.
    
</dd>
</dl>

<dl>
<dd>

**tool:** `typing.Optional[ToolKernelRequestParams]` — Details of your Tool. A new Tool version will be created if the provided details are new.
    
</dd>
</dl>

<dl>
<dd>

**inputs:** `typing.Optional[typing.Dict[str, typing.Optional[typing.Any]]]` — The inputs passed to the prompt template.
    
</dd>
</dl>

<dl>
<dd>

**source:** `typing.Optional[str]` — Identifies where the model was called from.
    
</dd>
</dl>

<dl>
<dd>

**metadata:** `typing.Optional[typing.Dict[str, typing.Optional[typing.Any]]]` — Any additional metadata to record.
    
</dd>
</dl>

<dl>
<dd>

**start_time:** `typing.Optional[dt.datetime]` — When the logged event started.
    
</dd>
</dl>

<dl>
<dd>

**end_time:** `typing.Optional[dt.datetime]` — When the logged event ended.
    
</dd>
</dl>

<dl>
<dd>

**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.
    
</dd>
</dl>

<dl>
<dd>

**trace_parent_id:** `typing.Optional[str]` — The ID of the parent Log to nest this Log under in a Trace.
    
</dd>
</dl>

<dl>
<dd>

**user:** `typing.Optional[str]` — End-user ID related to the Log.
    
</dd>
</dl>

<dl>
<dd>

**tool_call_request_environment:** `typing.Optional[str]` — The name of the Environment the Log is associated to.
    
</dd>
</dl>

<dl>
<dd>

**save:** `typing.Optional[bool]` — Whether the request/response payloads will be stored on Humanloop.
    
</dd>
</dl>

<dl>
<dd>

**log_id:** `typing.Optional[str]` — This will identify a Log. If you don't provide a Log ID, Humanloop will generate one for you.
    
</dd>
</dl>

<dl>
<dd>

**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
    
</dd>
</dl>
</dd>
</dl>


</dd>
</dl>
</details>

<details><summary><code>client.tools.<a href="src/humanloop/tools/client.py">log</a>(...)</code></summary>
<dl>
<dd>

#### 📝 Description

<dl>
<dd>

<dl>
<dd>

Log to a Tool.

You can use query parameters `version_id`, or `environment`, to target
an existing version of the Tool. Otherwise the default deployed version will be chosen.

Instead of targeting an existing version explicitly, you can instead pass in
Tool details in the request body. In this case, we will check if the details correspond
to an existing version of the Tool, if not we will create a new version. This is helpful
in the case where you are storing or deriving your Tool details in code.
</dd>
</dl>
</dd>
</dl>

#### 🔌 Usage

<dl>
<dd>

<dl>
<dd>

```python
from humanloop import Humanloop
client = Humanloop(api_key="YOUR_API_KEY", )
client.tools.log(path='math-tool', tool={'function': {'name': 'multiply', 'description': 'Multiply two numbers', 'parameters': {'type': 'object'
, 'properties': {'a': {'type': 'number'}, 'b': {'type': 'number'}}
, 'required': ['a', 'b']
}}}, inputs={'a': 5
, 'b': 7
}, output='35', )

```
</dd>
</dl>
</dd>
</dl>

#### ⚙️ Parameters

<dl>
<dd>

<dl>
<dd>

**version_id:** `typing.Optional[str]` — A specific Version ID of the Tool to log to.
    
</dd>
</dl>

<dl>
<dd>

**environment:** `typing.Optional[str]` — Name of the Environment identifying a deployed version to log to.
    
</dd>
</dl>

<dl>
<dd>

**path:** `typing.Optional[str]` — Path of the Tool, including the name. This locates the Tool in the Humanloop filesystem and is used as as a unique identifier. For example: `folder/name` or just `name`.
    
</dd>
</dl>

<dl>
<dd>

**id:** `typing.Optional[str]` — ID for an existing Tool.
    
</dd>
</dl>

<dl>
<dd>

**tool:** `typing.Optional[ToolKernelRequestParams]` — Details of your Tool. A new Tool version will be created if the provided details are new.
    
</dd>
</dl>

<dl>
<dd>

**start_time:** `typing.Optional[dt.datetime]` — When the logged event started.
    
</dd>
</dl>

<dl>
<dd>

**end_time:** `typing.Optional[dt.datetime]` — When the logged event ended.
    
</dd>
</dl>

<dl>
<dd>

**output:** `typing.Optional[str]` — Generated output from your model for the provided inputs. Can be `None` if logging an error, or if creating a parent Log with the intention to populate it later.
    
</dd>
</dl>

<dl>
<dd>

**created_at:** `typing.Optional[dt.datetime]` — User defined timestamp for when the log was created. 
    
</dd>
</dl>

<dl>
<dd>

**error:** `typing.Optional[str]` — Error message if the log is an error.
    
</dd>
</dl>

<dl>
<dd>

**provider_latency:** `typing.Optional[float]` — Duration of the logged event in seconds.
    
</dd>
</dl>

<dl>
<dd>

**stdout:** `typing.Optional[str]` — Captured log and debug statements.
    
</dd>
</dl>

<dl>
<dd>

**provider_request:** `typing.Optional[typing.Dict[str, typing.Optional[typing.Any]]]` — Raw request sent to provider.
    
</dd>
</dl>

<dl>
<dd>

**provider_response:** `typing.Optional[typing.Dict[str, typing.Optional[typing.Any]]]` — Raw response received the provider.
    
</dd>
</dl>

<dl>
<dd>

**inputs:** `typing.Optional[typing.Dict[str, typing.Optional[typing.Any]]]` — The inputs passed to the prompt template.
    
</dd>
</dl>

<dl>
<dd>

**source:** `typing.Optional[str]` — Identifies where the model was called from.
    
</dd>
</dl>

<dl>
<dd>

**metadata:** `typing.Optional[typing.Dict[str, typing.Optional[typing.Any]]]` — Any additional metadata to record.
    
</dd>
</dl>

<dl>
<dd>

**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.
    
</dd>
</dl>

<dl>
<dd>

**trace_parent_id:** `typing.Optional[str]` — The ID of the parent Log to nest this Log under in a Trace.
    
</dd>
</dl>

<dl>
<dd>

**user:** `typing.Optional[str]` — End-user ID related to the Log.
    
</dd>
</dl>

<dl>
<dd>

**tool_log_request_environment:** `typing.Optional[str]` — The name of the Environment the Log is associated to.
    
</dd>
</dl>

<dl>
<dd>

**save:** `typing.Optional[bool]` — Whether the request/response payloads will be stored on Humanloop.
    
</dd>
</dl>

<dl>
<dd>

**log_id:** `typing.Optional[str]` — This will identify a Log. If you don't provide a Log ID, Humanloop will generate one for you.
    
</dd>
</dl>

<dl>
<dd>

**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
    
</dd>
</dl>
</dd>
</dl>


</dd>
</dl>
</details>

<details><summary><code>client.tools.<a href="src/humanloop/tools/client.py">update</a>(...)</code></summary>
<dl>
<dd>

#### 📝 Description

<dl>
<dd>

<dl>
<dd>

Update a Log.

Update the details of a Log with the given ID.
</dd>
</dl>
</dd>
</dl>

#### 🔌 Usage

<dl>
<dd>

<dl>
<dd>

```python
from humanloop import Humanloop
client = Humanloop(api_key="YOUR_API_KEY", )
client.tools.update(id='id', log_id='log_id', )

```
</dd>
</dl>
</dd>
</dl>

#### ⚙️ Parameters

<dl>
<dd>

<dl>
<dd>

**id:** `str` — Unique identifier for Prompt.
    
</dd>
</dl>

<dl>
<dd>

**log_id:** `str` — Unique identifier for the Log.
    
</dd>
</dl>

<dl>
<dd>

**output:** `typing.Optional[str]` — Generated output from your model for the provided inputs. Can be `None` if logging an error, or if creating a parent Log with the intention to populate it later.
    
</dd>
</dl>

<dl>
<dd>

**created_at:** `typing.Optional[dt.datetime]` — User defined timestamp for when the log was created. 
    
</dd>
</dl>

<dl>
<dd>

**error:** `typing.Optional[str]` — Error message if the log is an error.
    
</dd>
</dl>

<dl>
<dd>

**provider_latency:** `typing.Optional[float]` — Duration of the logged event in seconds.
    
</dd>
</dl>

<dl>
<dd>

**stdout:** `typing.Optional[str]` — Captured log and debug statements.
    
</dd>
</dl>

<dl>
<dd>

**provider_request:** `typing.Optional[typing.Dict[str, typing.Optional[typing.Any]]]` — Raw request sent to provider.
    
</dd>
</dl>

<dl>
<dd>

**provider_response:** `typing.Optional[typing.Dict[str, typing.Optional[typing.Any]]]` — Raw response received the provider.
    
</dd>
</dl>

<dl>
<dd>

**inputs:** `typing.Optional[typing.Dict[str, typing.Optional[typing.Any]]]` — The inputs passed to the prompt template.
    
</dd>
</dl>

<dl>
<dd>

**source:** `typing.Optional[str]` — Identifies where the model was called from.
    
</dd>
</dl>

<dl>
<dd>

**metadata:** `typing.Optional[typing.Dict[str, typing.Optional[typing.Any]]]` — Any additional metadata to record.
    
</dd>
</dl>

<dl>
<dd>

**start_time:** `typing.Optional[dt.datetime]` — When the logged event started.
    
</dd>
</dl>

<dl>
<dd>

**end_time:** `typing.Optional[dt.datetime]` — When the logged event ended.
    
</dd>
</dl>

<dl>
<dd>

**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
    
</dd>
</dl>
</dd>
</dl>


</dd>
</dl>
</details>

<details><summary><code>client.tools.<a href="src/humanloop/tools/client.py">list</a>(...)</code></summary>
<dl>
<dd>

#### 📝 Description

<dl>
<dd>

<dl>
<dd>

Get a list of all Tools.
</dd>
</dl>
</dd>
</dl>

#### 🔌 Usage

<dl>
<dd>

<dl>
<dd>

```python
from humanloop import Humanloop
client = Humanloop(api_key="YOUR_API_KEY", )
response = client.tools.list(size=1, )
for item in response:
    yield item
# alternatively, you can paginate page-by-page
for page in response.iter_pages():
    yield page

```
</dd>
</dl>
</dd>
</dl>

#### ⚙️ Parameters

<dl>
<dd>

<dl>
<dd>

**page:** `typing.Optional[int]` — Page offset for pagination.
    
</dd>
</dl>

<dl>
<dd>

**size:** `typing.Optional[int]` — Page size for pagination. Number of Tools to fetch.
    
</dd>
</dl>

<dl>
<dd>

**name:** `typing.Optional[str]` — Case-insensitive filter for Tool name.
    
</dd>
</dl>

<dl>
<dd>

**user_filter:** `typing.Optional[str]` — Case-insensitive filter for users in the Tool. This filter matches against both email address and name of users.
    
</dd>
</dl>

<dl>
<dd>

**sort_by:** `typing.Optional[FileSortBy]` — Field to sort Tools by
    
</dd>
</dl>

<dl>
<dd>

**order:** `typing.Optional[SortOrder]` — Direction to sort by.
    
</dd>
</dl>

<dl>
<dd>

**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
    
</dd>
</dl>
</dd>
</dl>


</dd>
</dl>
</details>

<details><summary><code>client.tools.<a href="src/humanloop/tools/client.py">upsert</a>(...)</code></summary>
<dl>
<dd>

#### 📝 Description

<dl>
<dd>

<dl>
<dd>

Create a Tool or update it with a new version if it already exists.

Tools are identified by the `ID` or their `path`. The name, description and parameters determine the versions of the Tool.

You can provide `version_name` and `version_description` to identify and describe your versions.
Version names must be unique within a Tool - attempting to create a version with a name
that already exists will result in a 409 Conflict error.
</dd>
</dl>
</dd>
</dl>

#### 🔌 Usage

<dl>
<dd>

<dl>
<dd>

```python
from humanloop import Humanloop
client = Humanloop(api_key="YOUR_API_KEY", )
client.tools.upsert(path='math-tool', function={'name': 'multiply', 'description': 'Multiply two numbers', 'parameters': {'type': 'object'
, 'properties': {'a': {'type': 'number'}, 'b': {'type': 'number'}}
, 'required': ['a', 'b']
}}, version_name='math-tool-v1', version_description='Simple math tool that multiplies two numbers', )

```
</dd>
</dl>
</dd>
</dl>

#### ⚙️ Parameters

<dl>
<dd>

<dl>
<dd>

**path:** `typing.Optional[str]` — Path of the Tool, including the name. This locates the Tool in the Humanloop filesystem and is used as as a unique identifier. For example: `folder/name` or just `name`.
    
</dd>
</dl>

<dl>
<dd>

**id:** `typing.Optional[str]` — ID for an existing Tool.
    
</dd>
</dl>

<dl>
<dd>

**function:** `typing.Optional[ToolFunctionParams]` — Callable function specification of the Tool shown to the model for tool calling.
    
</dd>
</dl>

<dl>
<dd>

**source_code:** `typing.Optional[str]` — Code source of the Tool.
    
</dd>
</dl>

<dl>
<dd>

**setup_values:** `typing.Optional[typing.Dict[str, typing.Optional[typing.Any]]]` — Values needed to setup the Tool, defined in JSON Schema format: https://json-schema.org/
    
</dd>
</dl>

<dl>
<dd>

**attributes:** `typing.Optional[typing.Dict[str, typing.Optional[typing.Any]]]` — Additional fields to describe the Tool. Helpful to separate Tool versions from each other with details on how they were created or used.
    
</dd>
</dl>

<dl>
<dd>

**tool_type:** `typing.Optional[FilesToolType]` — Type of Tool.
    
</dd>
</dl>

<dl>
<dd>

**version_name:** `typing.Optional[str]` — Unique identifier for this Tool version. Each Tool can only have one version with a given name.
    
</dd>
</dl>

<dl>
<dd>

**version_description:** `typing.Optional[str]` — Description of the Version.
    
</dd>
</dl>

<dl>
<dd>

**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
    
</dd>
</dl>
</dd>
</dl>


</dd>
</dl>
</details>

<details><summary><code>client.tools.<a href="src/humanloop/tools/client.py">get</a>(...)</code></summary>
<dl>
<dd>

#### 📝 Description

<dl>
<dd>

<dl>
<dd>

Retrieve the Tool with the given ID.

By default, the deployed version of the Tool is returned. Use the query parameters
`version_id` or `environment` to target a specific version of the Tool.
</dd>
</dl>
</dd>
</dl>

#### 🔌 Usage

<dl>
<dd>

<dl>
<dd>

```python
from humanloop import Humanloop
client = Humanloop(api_key="YOUR_API_KEY", )
client.tools.get(id='tl_789ghi', )

```
</dd>
</dl>
</dd>
</dl>

#### ⚙️ Parameters

<dl>
<dd>

<dl>
<dd>

**id:** `str` — Unique identifier for Tool.
    
</dd>
</dl>

<dl>
<dd>

**version_id:** `typing.Optional[str]` — A specific Version ID of the Tool to retrieve.
    
</dd>
</dl>

<dl>
<dd>

**environment:** `typing.Optional[str]` — Name of the Environment to retrieve a deployed Version from.
    
</dd>
</dl>

<dl>
<dd>

**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
    
</dd>
</dl>
</dd>
</dl>


</dd>
</dl>
</details>

<details><summary><code>client.tools.<a href="src/humanloop/tools/client.py">delete</a>(...)</code></summary>
<dl>
<dd>

#### 📝 Description

<dl>
<dd>

<dl>
<dd>

Delete the Tool with the given ID.
</dd>
</dl>
</dd>
</dl>

#### 🔌 Usage

<dl>
<dd>

<dl>
<dd>

```python
from humanloop import Humanloop
client = Humanloop(api_key="YOUR_API_KEY", )
client.tools.delete(id='tl_789ghi', )

```
</dd>
</dl>
</dd>
</dl>

#### ⚙️ Parameters

<dl>
<dd>

<dl>
<dd>

**id:** `str` — Unique identifier for Tool.
    
</dd>
</dl>

<dl>
<dd>

**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
    
</dd>
</dl>
</dd>
</dl>


</dd>
</dl>
</details>

<details><summary><code>client.tools.<a href="src/humanloop/tools/client.py">move</a>(...)</code></summary>
<dl>
<dd>

#### 📝 Description

<dl>
<dd>

<dl>
<dd>

Move the Tool to a different path or change the name.
</dd>
</dl>
</dd>
</dl>

#### 🔌 Usage

<dl>
<dd>

<dl>
<dd>

```python
from humanloop import Humanloop
client = Humanloop(api_key="YOUR_API_KEY", )
client.tools.move(id='tl_789ghi', path='new directory/new name', )

```
</dd>
</dl>
</dd>
</dl>

#### ⚙️ Parameters

<dl>
<dd>

<dl>
<dd>

**id:** `str` — Unique identifier for Tool.
    
</dd>
</dl>

<dl>
<dd>

**path:** `typing.Optional[str]` — Path of the Tool including the Tool name, which is used as a unique identifier.
    
</dd>
</dl>

<dl>
<dd>

**name:** `typing.Optional[str]` — Name of the Tool, which is used as a unique identifier.
    
</dd>
</dl>

<dl>
<dd>

**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
    
</dd>
</dl>
</dd>
</dl>


</dd>
</dl>
</details>

<details><summary><code>client.tools.<a href="src/humanloop/tools/client.py">list_versions</a>(...)</code></summary>
<dl>
<dd>

#### 📝 Description

<dl>
<dd>

<dl>
<dd>

Get a list of all the versions of a Tool.
</dd>
</dl>
</dd>
</dl>

#### 🔌 Usage

<dl>
<dd>

<dl>
<dd>

```python
from humanloop import Humanloop
client = Humanloop(api_key="YOUR_API_KEY", )
client.tools.list_versions(id='tl_789ghi', )

```
</dd>
</dl>
</dd>
</dl>

#### ⚙️ Parameters

<dl>
<dd>

<dl>
<dd>

**id:** `str` — Unique identifier for the Tool.
    
</dd>
</dl>

<dl>
<dd>

**evaluator_aggregates:** `typing.Optional[bool]` — Whether to include Evaluator aggregate results for the versions in the response
    
</dd>
</dl>

<dl>
<dd>

**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
    
</dd>
</dl>
</dd>
</dl>


</dd>
</dl>
</details>

<details><summary><code>client.tools.<a href="src/humanloop/tools/client.py">delete_tool_version</a>(...)</code></summary>
<dl>
<dd>

#### 📝 Description

<dl>
<dd>

<dl>
<dd>

Delete a version of the Tool.
</dd>
</dl>
</dd>
</dl>

#### 🔌 Usage

<dl>
<dd>

<dl>
<dd>

```python
from humanloop import Humanloop
client = Humanloop(api_key="YOUR_API_KEY", )
client.tools.delete_tool_version(id='id', version_id='version_id', )

```
</dd>
</dl>
</dd>
</dl>

#### ⚙️ Parameters

<dl>
<dd>

<dl>
<dd>

**id:** `str` — Unique identifier for Tool.
    
</dd>
</dl>

<dl>
<dd>

**version_id:** `str` — Unique identifier for the specific version of the Tool.
    
</dd>
</dl>

<dl>
<dd>

**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
    
</dd>
</dl>
</dd>
</dl>


</dd>
</dl>
</details>

<details><summary><code>client.tools.<a href="src/humanloop/tools/client.py">update_tool_version</a>(...)</code></summary>
<dl>
<dd>

#### 📝 Description

<dl>
<dd>

<dl>
<dd>

Update the name or description of the Tool version.
</dd>
</dl>
</dd>
</dl>

#### 🔌 Usage

<dl>
<dd>

<dl>
<dd>

```python
from humanloop import Humanloop
client = Humanloop(api_key="YOUR_API_KEY", )
client.tools.update_tool_version(id='id', version_id='version_id', )

```
</dd>
</dl>
</dd>
</dl>

#### ⚙️ Parameters

<dl>
<dd>

<dl>
<dd>

**id:** `str` — Unique identifier for Tool.
    
</dd>
</dl>

<dl>
<dd>

**version_id:** `str` — Unique identifier for the specific version of the Tool.
    
</dd>
</dl>

<dl>
<dd>

**name:** `typing.Optional[str]` — Name of the version.
    
</dd>
</dl>

<dl>
<dd>

**description:** `typing.Optional[str]` — Description of the version.
    
</dd>
</dl>

<dl>
<dd>

**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
    
</dd>
</dl>
</dd>
</dl>


</dd>
</dl>
</details>

<details><summary><code>client.tools.<a href="src/humanloop/tools/client.py">set_deployment</a>(...)</code></summary>
<dl>
<dd>

#### 📝 Description

<dl>
<dd>

<dl>
<dd>

Deploy Tool to an Environment.

Set the deployed version for the specified Environment. This Prompt
will be used for calls made to the Tool in this Environment.
</dd>
</dl>
</dd>
</dl>

#### 🔌 Usage

<dl>
<dd>

<dl>
<dd>

```python
from humanloop import Humanloop
client = Humanloop(api_key="YOUR_API_KEY", )
client.tools.set_deployment(id='tl_789ghi', environment_id='staging', version_id='tv_012jkl', )

```
</dd>
</dl>
</dd>
</dl>

#### ⚙️ Parameters

<dl>
<dd>

<dl>
<dd>

**id:** `str` — Unique identifier for Tool.
    
</dd>
</dl>

<dl>
<dd>

**environment_id:** `str` — Unique identifier for the Environment to deploy the Version to.
    
</dd>
</dl>

<dl>
<dd>

**version_id:** `str` — Unique identifier for the specific version of the Tool.
    
</dd>
</dl>

<dl>
<dd>

**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
    
</dd>
</dl>
</dd>
</dl>


</dd>
</dl>
</details>

<details><summary><code>client.tools.<a href="src/humanloop/tools/client.py">remove_deployment</a>(...)</code></summary>
<dl>
<dd>

#### 📝 Description

<dl>
<dd>

<dl>
<dd>

Remove deployed Tool from the Environment.

Remove the deployed version for the specified Environment. This Tool
will no longer be used for calls made to the Tool in this Environment.
</dd>
</dl>
</dd>
</dl>

#### 🔌 Usage

<dl>
<dd>

<dl>
<dd>

```python
from humanloop import Humanloop
client = Humanloop(api_key="YOUR_API_KEY", )
client.tools.remove_deployment(id='tl_789ghi', environment_id='staging', )

```
</dd>
</dl>
</dd>
</dl>

#### ⚙️ Parameters

<dl>
<dd>

<dl>
<dd>

**id:** `str` — Unique identifier for Tool.
    
</dd>
</dl>

<dl>
<dd>

**environment_id:** `str` — Unique identifier for the Environment to remove the deployment from.
    
</dd>
</dl>

<dl>
<dd>

**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
    
</dd>
</dl>
</dd>
</dl>


</dd>
</dl>
</details>

<details><summary><code>client.tools.<a href="src/humanloop/tools/client.py">list_environments</a>(...)</code></summary>
<dl>
<dd>

#### 📝 Description

<dl>
<dd>

<dl>
<dd>

List all Environments and their deployed versions for the Tool.
</dd>
</dl>
</dd>
</dl>

#### 🔌 Usage

<dl>
<dd>

<dl>
<dd>

```python
from humanloop import Humanloop
client = Humanloop(api_key="YOUR_API_KEY", )
client.tools.list_environments(id='tl_789ghi', )

```
</dd>
</dl>
</dd>
</dl>

#### ⚙️ Parameters

<dl>
<dd>

<dl>
<dd>

**id:** `str` — Unique identifier for Tool.
    
</dd>
</dl>

<dl>
<dd>

**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
    
</dd>
</dl>
</dd>
</dl>


</dd>
</dl>
</details>

<details><summary><code>client.tools.<a href="src/humanloop/tools/client.py">update_monitoring</a>(...)</code></summary>
<dl>
<dd>

#### 📝 Description

<dl>
<dd>

<dl>
<dd>

Activate and deactivate Evaluators for monitoring the Tool.

An activated Evaluator will automatically be run on all new Logs
within the Tool for monitoring purposes.
</dd>
</dl>
</dd>
</dl>

#### 🔌 Usage

<dl>
<dd>

<dl>
<dd>

```python
from humanloop import Humanloop
client = Humanloop(api_key="YOUR_API_KEY", )
client.tools.update_monitoring(id='tl_789ghi', activate=[{'evaluator_version_id': 'evv_1abc4308abd'}], )

```
</dd>
</dl>
</dd>
</dl>

#### ⚙️ Parameters

<dl>
<dd>

<dl>
<dd>

**id:** `str` 
    
</dd>
</dl>

<dl>
<dd>

**activate:** `typing.Optional[typing.Sequence[EvaluatorActivationDeactivationRequestActivateItemParams]]` — Evaluators to activate for Monitoring. These will be automatically run on new Logs.
    
</dd>
</dl>

<dl>
<dd>

**deactivate:** `typing.Optional[typing.Sequence[EvaluatorActivationDeactivationRequestDeactivateItemParams]]` — Evaluators to deactivate. These will not be run on new Logs.
    
</dd>
</dl>

<dl>
<dd>

**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
    
</dd>
</dl>
</dd>
</dl>


</dd>
</dl>
</details>

<details><summary><code>client.tools.<a href="src/humanloop/tools/client.py">get_environment_variables</a>(...)</code></summary>
<dl>
<dd>

#### 🔌 Usage

<dl>
<dd>

<dl>
<dd>

```python
from humanloop import Humanloop
client = Humanloop(api_key="YOUR_API_KEY", )
client.tools.get_environment_variables(id='id', )

```
</dd>
</dl>
</dd>
</dl>

#### ⚙️ Parameters

<dl>
<dd>

<dl>
<dd>

**id:** `str` — Unique identifier for File.
    
</dd>
</dl>

<dl>
<dd>

**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
    
</dd>
</dl>
</dd>
</dl>


</dd>
</dl>
</details>

<details><summary><code>client.tools.<a href="src/humanloop/tools/client.py">add_environment_variable</a>(...)</code></summary>
<dl>
<dd>

#### 📝 Description

<dl>
<dd>

<dl>
<dd>

Add an environment variable to a Tool.
</dd>
</dl>
</dd>
</dl>

#### 🔌 Usage

<dl>
<dd>

<dl>
<dd>

```python
from humanloop import Humanloop
client = Humanloop(api_key="YOUR_API_KEY", )
client.tools.add_environment_variable(id='id', request=[{'name': 'name', 'value': 'value'}], )

```
</dd>
</dl>
</dd>
</dl>

#### ⚙️ Parameters

<dl>
<dd>

<dl>
<dd>

**id:** `str` — Unique identifier for Tool.
    
</dd>
</dl>

<dl>
<dd>

**request:** `typing.Sequence[FileEnvironmentVariableRequestParams]` 
    
</dd>
</dl>

<dl>
<dd>

**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
    
</dd>
</dl>
</dd>
</dl>


</dd>
</dl>
</details>

<details><summary><code>client.tools.<a href="src/humanloop/tools/client.py">delete_environment_variable</a>(...)</code></summary>
<dl>
<dd>

#### 🔌 Usage

<dl>
<dd>

<dl>
<dd>

```python
from humanloop import Humanloop
client = Humanloop(api_key="YOUR_API_KEY", )
client.tools.delete_environment_variable(id='id', name='name', )

```
</dd>
</dl>
</dd>
</dl>

#### ⚙️ Parameters

<dl>
<dd>

<dl>
<dd>

**id:** `str` — Unique identifier for File.
    
</dd>
</dl>

<dl>
<dd>

**name:** `str` — Name of the Environment Variable to delete.
    
</dd>
</dl>

<dl>
<dd>

**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
    
</dd>
</dl>
</dd>
</dl>


</dd>
</dl>
</details>

## Datasets
<details><summary><code>client.datasets.<a href="src/humanloop/datasets/client.py">list</a>(...)</code></summary>
<dl>
<dd>

#### 📝 Description

<dl>
<dd>

<dl>
<dd>

List all Datasets.
</dd>
</dl>
</dd>
</dl>

#### 🔌 Usage

<dl>
<dd>

<dl>
<dd>

```python
from humanloop import Humanloop
client = Humanloop(api_key="YOUR_API_KEY", )
response = client.datasets.list(size=1, )
for item in response:
    yield item
# alternatively, you can paginate page-by-page
for page in response.iter_pages():
    yield page

```
</dd>
</dl>
</dd>
</dl>

#### ⚙️ Parameters

<dl>
<dd>

<dl>
<dd>

**page:** `typing.Optional[int]` — Page offset for pagination.
    
</dd>
</dl>

<dl>
<dd>

**size:** `typing.Optional[int]` — Page size for pagination. Number of Datasets to fetch.
    
</dd>
</dl>

<dl>
<dd>

**name:** `typing.Optional[str]` — Case-insensitive filter for Dataset name.
    
</dd>
</dl>

<dl>
<dd>

**user_filter:** `typing.Optional[str]` — Case-insensitive filter for users in the Dataset. This filter matches against both email address and name of users.
    
</dd>
</dl>

<dl>
<dd>

**sort_by:** `typing.Optional[FileSortBy]` — Field to sort Datasets by
    
</dd>
</dl>

<dl>
<dd>

**order:** `typing.Optional[SortOrder]` — Direction to sort by.
    
</dd>
</dl>

<dl>
<dd>

**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
    
</dd>
</dl>
</dd>
</dl>


</dd>
</dl>
</details>

<details><summary><code>client.datasets.<a href="src/humanloop/datasets/client.py">upsert</a>(...)</code></summary>
<dl>
<dd>

#### 📝 Description

<dl>
<dd>

<dl>
<dd>

Create a Dataset or update it with a new version if it already exists.

Datasets are identified by the `ID` or their `path`. The datapoints determine the versions of the Dataset.

By default, the new Dataset version will be set to the list of Datapoints provided in
the request. You can also create a new version by adding or removing Datapoints from an existing version
by specifying `action` as `add` or `remove` respectively. In this case, you may specify
the `version_id` or `environment` query parameters to identify the existing version to base
the new version on. If neither is provided, the latest created version will be used.

You can provide `version_name` and `version_description` to identify and describe your versions.
Version names must be unique within a Dataset - attempting to create a version with a name
that already exists will result in a 409 Conflict error.

Humanloop also deduplicates Datapoints. If you try to add a Datapoint that already
exists, it will be ignored. If you intentionally want to add a duplicate Datapoint,
you can add a unique identifier to the Datapoint's inputs such as `{_dedupe_id: <unique ID>}`.
</dd>
</dl>
</dd>
</dl>

#### 🔌 Usage

<dl>
<dd>

<dl>
<dd>

```python
from humanloop import Humanloop
client = Humanloop(api_key="YOUR_API_KEY", )
client.datasets.upsert(path='datasets/support-queries', datapoints=[{'messages': [{'role': "user", 'content': 'How do i manage my organizations API keys?\n'}], 'target': {'response': 'Hey, thanks for your questions. Here are steps for how to achieve: 1. Log in to the Humanloop Dashboard \n\n2. Click on "Organization Settings."\n If you do not see this option, you might need to contact your organization admin to gain the necessary permissions.\n\n3. Within the settings or organization settings, select the option labeled "API Keys" on the left. Here you will be able to view and manage your API keys.\n\n4. You will see a list of existing API keys. You can perform various actions, such as:\n     - **Generate New API Key:** Click on the "Generate New Key" button if you need a new API key.\n     - **Revoke an API Key:** If you need to disable an existing key, find the key in the list and click the "Revoke" or "Delete" button.\n     - **Copy an API Key:** If you need to use an existing key, you can copy it to your clipboard by clicking the "Copy" button next to the key.\n\n5. **Save and Secure API Keys:** Make sure to securely store any new or existing API keys you are using. Treat them like passwords and do not share them publicly.\n\nIf you encounter any issues or need further assistance, it might be helpful to engage with an engineer or your IT department to ensure you have the necessary permissions and support.\n\nWould you need help with anything else?'}}, {'messages': [{'role': "user", 'content': 'Hey, can do I use my code evaluator for monitoring my legal-copilot prompt?'}], 'target': {'response': 'Hey, thanks for your questions. Here are steps for how to achieve: 1. Navigate to your Prompt dashboard. \n 2. Select the `Monitoring` button on the top right of the Prompt dashboard \n 3. Within the model select the Version of the Evaluator you want to turn on for monitoring. \n\nWould you need help with anything else?'}}], version_name='Initial version', version_description='Add two new questions and answers', )

```
</dd>
</dl>
</dd>
</dl>

#### ⚙️ Parameters

<dl>
<dd>

<dl>
<dd>

**datapoints:** `typing.Sequence[CreateDatapointRequestParams]` — The Datapoints to create this Dataset version with. Modify the `action` field to determine how these Datapoints are used.
    
</dd>
</dl>

<dl>
<dd>

**version_id:** `typing.Optional[str]` — ID of the specific Dataset version to base the created Version on. Only used when `action` is `"add"` or `"remove"`.
    
</dd>
</dl>

<dl>
<dd>

**environment:** `typing.Optional[str]` — Name of the Environment identifying a deployed Version to base the created Version on. Only used when `action` is `"add"` or `"remove"`.
    
</dd>
</dl>

<dl>
<dd>

**include_datapoints:** `typing.Optional[bool]` — If set to `true`, include all Datapoints in the response. Defaults to `false`. Consider using the paginated List Datapoints endpoint instead.
    
</dd>
</dl>

<dl>
<dd>

**path:** `typing.Optional[str]` — Path of the Dataset, including the name. This locates the Dataset in the Humanloop filesystem and is used as as a unique identifier. For example: `folder/name` or just `name`.
    
</dd>
</dl>

<dl>
<dd>

**id:** `typing.Optional[str]` — ID for an existing Dataset.
    
</dd>
</dl>

<dl>
<dd>

**action:** `typing.Optional[UpdateDatesetAction]` 

The action to take with the provided Datapoints.

 - If `"set"`, the created version will only contain the Datapoints provided in this request. 
 - If `"add"`, the created version will contain the Datapoints provided in this request in addition to the Datapoints in the target version. 
 - If `"remove"`, the created version will contain the Datapoints in the target version except for the Datapoints provided in this request. 

If `"add"` or `"remove"`, one of the `version_id` or `environment` query parameters may be provided.
    
</dd>
</dl>

<dl>
<dd>

**attributes:** `typing.Optional[typing.Dict[str, typing.Optional[typing.Any]]]` — Additional fields to describe the Dataset. Helpful to separate Dataset versions from each other with details on how they were created or used.
    
</dd>
</dl>

<dl>
<dd>

**version_name:** `typing.Optional[str]` — Unique name for the Dataset version. Version names must be unique for a given Dataset.
    
</dd>
</dl>

<dl>
<dd>

**version_description:** `typing.Optional[str]` — Description of the version, e.g., the changes made in this version.
    
</dd>
</dl>

<dl>
<dd>

**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
    
</dd>
</dl>
</dd>
</dl>


</dd>
</dl>
</details>

<details><summary><code>client.datasets.<a href="src/humanloop/datasets/client.py">get</a>(...)</code></summary>
<dl>
<dd>

#### 📝 Description

<dl>
<dd>

<dl>
<dd>

Retrieve the Dataset with the given ID.

Unless `include_datapoints` is set to `true`, the response will not include
the Datapoints.
Use the List Datapoints endpoint (`GET /{id}/datapoints`) to efficiently
retrieve Datapoints for a large Dataset.

By default, the deployed version of the Dataset is returned. Use the query parameters
`version_id` or `environment` to target a specific version of the Dataset.
</dd>
</dl>
</dd>
</dl>

#### 🔌 Usage

<dl>
<dd>

<dl>
<dd>

```python
from humanloop import Humanloop
client = Humanloop(api_key="YOUR_API_KEY", )
client.datasets.get(id='ds_b0baF1ca7652', version_id='dsv_6L78pqrdFi2xa', include_datapoints=True, )

```
</dd>
</dl>
</dd>
</dl>

#### ⚙️ Parameters

<dl>
<dd>

<dl>
<dd>

**id:** `str` — Unique identifier for Dataset.
    
</dd>
</dl>

<dl>
<dd>

**version_id:** `typing.Optional[str]` — A specific Version ID of the Dataset to retrieve.
    
</dd>
</dl>

<dl>
<dd>

**environment:** `typing.Optional[str]` — Name of the Environment to retrieve a deployed Version from.
    
</dd>
</dl>

<dl>
<dd>

**include_datapoints:** `typing.Optional[bool]` — If set to `true`, include all Datapoints in the response. Defaults to `false`. Consider using the paginated List Datapoints endpoint instead.
    
</dd>
</dl>

<dl>
<dd>

**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
    
</dd>
</dl>
</dd>
</dl>


</dd>
</dl>
</details>

<details><summary><code>client.datasets.<a href="src/humanloop/datasets/client.py">delete</a>(...)</code></summary>
<dl>
<dd>

#### 📝 Description

<dl>
<dd>

<dl>
<dd>

Delete the Dataset with the given ID.
</dd>
</dl>
</dd>
</dl>

#### 🔌 Usage

<dl>
<dd>

<dl>
<dd>

```python
from humanloop import Humanloop
client = Humanloop(api_key="YOUR_API_KEY", )
client.datasets.delete(id='id', )

```
</dd>
</dl>
</dd>
</dl>

#### ⚙️ Parameters

<dl>
<dd>

<dl>
<dd>

**id:** `str` — Unique identifier for Dataset.
    
</dd>
</dl>

<dl>
<dd>

**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
    
</dd>
</dl>
</dd>
</dl>


</dd>
</dl>
</details>

<details><summary><code>client.datasets.<a href="src/humanloop/datasets/client.py">move</a>(...)</code></summary>
<dl>
<dd>

#### 📝 Description

<dl>
<dd>

<dl>
<dd>

Move the Dataset to a different path or change the name.
</dd>
</dl>
</dd>
</dl>

#### 🔌 Usage

<dl>
<dd>

<dl>
<dd>

```python
from humanloop import Humanloop
client = Humanloop(api_key="YOUR_API_KEY", )
client.datasets.move(id='id', )

```
</dd>
</dl>
</dd>
</dl>

#### ⚙️ Parameters

<dl>
<dd>

<dl>
<dd>

**id:** `str` — Unique identifier for Dataset.
    
</dd>
</dl>

<dl>
<dd>

**path:** `typing.Optional[str]` — Path of the Dataset including the Dataset name, which is used as a unique identifier.
    
</dd>
</dl>

<dl>
<dd>

**name:** `typing.Optional[str]` — Name of the Dataset, which is used as a unique identifier.
    
</dd>
</dl>

<dl>
<dd>

**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
    
</dd>
</dl>
</dd>
</dl>


</dd>
</dl>
</details>

<details><summary><code>client.datasets.<a href="src/humanloop/datasets/client.py">list_datapoints</a>(...)</code></summary>
<dl>
<dd>

#### 📝 Description

<dl>
<dd>

<dl>
<dd>

List all Datapoints for the Dataset with the given ID.
</dd>
</dl>
</dd>
</dl>

#### 🔌 Usage

<dl>
<dd>

<dl>
<dd>

```python
from humanloop import Humanloop
client = Humanloop(api_key="YOUR_API_KEY", )
response = client.datasets.list_datapoints(id='ds_b0baF1ca7652', size=1, )
for item in response:
    yield item
# alternatively, you can paginate page-by-page
for page in response.iter_pages():
    yield page

```
</dd>
</dl>
</dd>
</dl>

#### ⚙️ Parameters

<dl>
<dd>

<dl>
<dd>

**id:** `str` — Unique identifier for Dataset.
    
</dd>
</dl>

<dl>
<dd>

**version_id:** `typing.Optional[str]` — A specific Version ID of the Dataset to retrieve.
    
</dd>
</dl>

<dl>
<dd>

**environment:** `typing.Optional[str]` — Name of the Environment to retrieve a deployed Version from.
    
</dd>
</dl>

<dl>
<dd>

**page:** `typing.Optional[int]` — Page number for pagination.
    
</dd>
</dl>

<dl>
<dd>

**size:** `typing.Optional[int]` — Page size for pagination. Number of Datapoints to fetch.
    
</dd>
</dl>

<dl>
<dd>

**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
    
</dd>
</dl>
</dd>
</dl>


</dd>
</dl>
</details>

<details><summary><code>client.datasets.<a href="src/humanloop/datasets/client.py">list_versions</a>(...)</code></summary>
<dl>
<dd>

#### 📝 Description

<dl>
<dd>

<dl>
<dd>

Get a list of the versions for a Dataset.
</dd>
</dl>
</dd>
</dl>

#### 🔌 Usage

<dl>
<dd>

<dl>
<dd>

```python
from humanloop import Humanloop
client = Humanloop(api_key="YOUR_API_KEY", )
client.datasets.list_versions(id='ds_b0baF1ca7652', )

```
</dd>
</dl>
</dd>
</dl>

#### ⚙️ Parameters

<dl>
<dd>

<dl>
<dd>

**id:** `str` — Unique identifier for Dataset.
    
</dd>
</dl>

<dl>
<dd>

**include_datapoints:** `typing.Optional[ListVersionsDatasetsIdVersionsGetRequestIncludeDatapoints]` — If set to 'latest_saved', include datapoints for the latest saved version. Alternatively, 'latest_committed' (deprecated) includes datapoints for the latest committed version only.
    
</dd>
</dl>

<dl>
<dd>

**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
    
</dd>
</dl>
</dd>
</dl>


</dd>
</dl>
</details>

<details><summary><code>client.datasets.<a href="src/humanloop/datasets/client.py">delete_dataset_version</a>(...)</code></summary>
<dl>
<dd>

#### 📝 Description

<dl>
<dd>

<dl>
<dd>

Delete a version of the Dataset.
</dd>
</dl>
</dd>
</dl>

#### 🔌 Usage

<dl>
<dd>

<dl>
<dd>

```python
from humanloop import Humanloop
client = Humanloop(api_key="YOUR_API_KEY", )
client.datasets.delete_dataset_version(id='id', version_id='version_id', )

```
</dd>
</dl>
</dd>
</dl>

#### ⚙️ Parameters

<dl>
<dd>

<dl>
<dd>

**id:** `str` — Unique identifier for Dataset.
    
</dd>
</dl>

<dl>
<dd>

**version_id:** `str` — Unique identifier for the specific version of the Dataset.
    
</dd>
</dl>

<dl>
<dd>

**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
    
</dd>
</dl>
</dd>
</dl>


</dd>
</dl>
</details>

<details><summary><code>client.datasets.<a href="src/humanloop/datasets/client.py">update_dataset_version</a>(...)</code></summary>
<dl>
<dd>

#### 📝 Description

<dl>
<dd>

<dl>
<dd>

Update the name or description of the Dataset version.
</dd>
</dl>
</dd>
</dl>

#### 🔌 Usage

<dl>
<dd>

<dl>
<dd>

```python
from humanloop import Humanloop
client = Humanloop(api_key="YOUR_API_KEY", )
client.datasets.update_dataset_version(id='id', version_id='version_id', )

```
</dd>
</dl>
</dd>
</dl>

#### ⚙️ Parameters

<dl>
<dd>

<dl>
<dd>

**id:** `str` — Unique identifier for Dataset.
    
</dd>
</dl>

<dl>
<dd>

**version_id:** `str` — Unique identifier for the specific version of the Dataset.
    
</dd>
</dl>

<dl>
<dd>

**name:** `typing.Optional[str]` — Name of the version.
    
</dd>
</dl>

<dl>
<dd>

**description:** `typing.Optional[str]` — Description of the version.
    
</dd>
</dl>

<dl>
<dd>

**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
    
</dd>
</dl>
</dd>
</dl>


</dd>
</dl>
</details>

<details><summary><code>client.datasets.<a href="src/humanloop/datasets/client.py">upload_csv</a>(...)</code></summary>
<dl>
<dd>

#### 📝 Description

<dl>
<dd>

<dl>
<dd>

Add Datapoints from a CSV file to a Dataset.

This will create a new version of the Dataset with the Datapoints from the CSV file.

If either `version_id` or `environment` is provided, the new version will be based on the specified version,
with the Datapoints from the CSV file added to the existing Datapoints in the version.
If neither `version_id` nor `environment` is provided, the new version will be based on the version
of the Dataset that is deployed to the default Environment.

You can optionally provide a name and description for the new version using `version_name`
and `version_description` parameters.
</dd>
</dl>
</dd>
</dl>

#### 🔌 Usage

<dl>
<dd>

<dl>
<dd>

```python
from humanloop import Humanloop
client = Humanloop(api_key="YOUR_API_KEY", )
client.datasets.upload_csv(id='id', )

```
</dd>
</dl>
</dd>
</dl>

#### ⚙️ Parameters

<dl>
<dd>

<dl>
<dd>

**id:** `str` — Unique identifier for the Dataset
    
</dd>
</dl>

<dl>
<dd>

**file:** `from __future__ import annotations
core.File` — See core.File for more documentation
    
</dd>
</dl>

<dl>
<dd>

**version_id:** `typing.Optional[str]` — ID of the specific Dataset version to base the created Version on.
    
</dd>
</dl>

<dl>
<dd>

**environment:** `typing.Optional[str]` — Name of the Environment identifying a deployed Version to base the created Version on.
    
</dd>
</dl>

<dl>
<dd>

**version_name:** `typing.Optional[str]` — Name for the new Dataset version.
    
</dd>
</dl>

<dl>
<dd>

**version_description:** `typing.Optional[str]` — Description for the new Dataset version.
    
</dd>
</dl>

<dl>
<dd>

**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
    
</dd>
</dl>
</dd>
</dl>


</dd>
</dl>
</details>

<details><summary><code>client.datasets.<a href="src/humanloop/datasets/client.py">set_deployment</a>(...)</code></summary>
<dl>
<dd>

#### 📝 Description

<dl>
<dd>

<dl>
<dd>

Deploy Dataset to Environment.

Set the deployed version for the specified Environment.
</dd>
</dl>
</dd>
</dl>

#### 🔌 Usage

<dl>
<dd>

<dl>
<dd>

```python
from humanloop import Humanloop
client = Humanloop(api_key="YOUR_API_KEY", )
client.datasets.set_deployment(id='ds_b0baF1ca7652', environment_id='staging', version_id='dsv_6L78pqrdFi2xa', )

```
</dd>
</dl>
</dd>
</dl>

#### ⚙️ Parameters

<dl>
<dd>

<dl>
<dd>

**id:** `str` — Unique identifier for Dataset.
    
</dd>
</dl>

<dl>
<dd>

**environment_id:** `str` — Unique identifier for the Environment to deploy the Version to.
    
</dd>
</dl>

<dl>
<dd>

**version_id:** `str` — Unique identifier for the specific version of the Dataset.
    
</dd>
</dl>

<dl>
<dd>

**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
    
</dd>
</dl>
</dd>
</dl>


</dd>
</dl>
</details>

<details><summary><code>client.datasets.<a href="src/humanloop/datasets/client.py">remove_deployment</a>(...)</code></summary>
<dl>
<dd>

#### 📝 Description

<dl>
<dd>

<dl>
<dd>

Remove deployed Dataset from Environment.

Remove the deployed version for the specified Environment.
</dd>
</dl>
</dd>
</dl>

#### 🔌 Usage

<dl>
<dd>

<dl>
<dd>

```python
from humanloop import Humanloop
client = Humanloop(api_key="YOUR_API_KEY", )
client.datasets.remove_deployment(id='ds_b0baF1ca7652', environment_id='staging', )

```
</dd>
</dl>
</dd>
</dl>

#### ⚙️ Parameters

<dl>
<dd>

<dl>
<dd>

**id:** `str` — Unique identifier for Dataset.
    
</dd>
</dl>

<dl>
<dd>

**environment_id:** `str` — Unique identifier for the Environment to remove the deployment from.
    
</dd>
</dl>

<dl>
<dd>

**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
    
</dd>
</dl>
</dd>
</dl>


</dd>
</dl>
</details>

<details><summary><code>client.datasets.<a href="src/humanloop/datasets/client.py">list_environments</a>(...)</code></summary>
<dl>
<dd>

#### 📝 Description

<dl>
<dd>

<dl>
<dd>

List all Environments and their deployed versions for the Dataset.
</dd>
</dl>
</dd>
</dl>

#### 🔌 Usage

<dl>
<dd>

<dl>
<dd>

```python
from humanloop import Humanloop
client = Humanloop(api_key="YOUR_API_KEY", )
client.datasets.list_environments(id='id', )

```
</dd>
</dl>
</dd>
</dl>

#### ⚙️ Parameters

<dl>
<dd>

<dl>
<dd>

**id:** `str` — Unique identifier for Dataset.
    
</dd>
</dl>

<dl>
<dd>

**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
    
</dd>
</dl>
</dd>
</dl>


</dd>
</dl>
</details>

## Evaluators
<details><summary><code>client.evaluators.<a href="src/humanloop/evaluators/client.py">log</a>(...)</code></summary>
<dl>
<dd>

#### 📝 Description

<dl>
<dd>

<dl>
<dd>

Submit Evaluator judgment for an existing Log.

Creates a new Log. The evaluated Log will be set as the parent of the created Log.
</dd>
</dl>
</dd>
</dl>

#### 🔌 Usage

<dl>
<dd>

<dl>
<dd>

```python
from humanloop import Humanloop
client = Humanloop(api_key="YOUR_API_KEY", )
client.evaluators.log(parent_id='parent_id', )

```
</dd>
</dl>
</dd>
</dl>

#### ⚙️ Parameters

<dl>
<dd>

<dl>
<dd>

**parent_id:** `str` — Identifier of the evaluated Log. The newly created Log will have this one set as parent.
    
</dd>
</dl>

<dl>
<dd>

**version_id:** `typing.Optional[str]` — ID of the Evaluator version to log against.
    
</dd>
</dl>

<dl>
<dd>

**environment:** `typing.Optional[str]` — Name of the Environment identifying a deployed version to log to.
    
</dd>
</dl>

<dl>
<dd>

**path:** `typing.Optional[str]` — Path of the Evaluator, including the name. This locates the Evaluator in the Humanloop filesystem and is used as as a unique identifier. For example: `folder/name` or just `name`.
    
</dd>
</dl>

<dl>
<dd>

**id:** `typing.Optional[str]` — ID for an existing Evaluator.
    
</dd>
</dl>

<dl>
<dd>

**start_time:** `typing.Optional[dt.datetime]` — When the logged event started.
    
</dd>
</dl>

<dl>
<dd>

**end_time:** `typing.Optional[dt.datetime]` — When the logged event ended.
    
</dd>
</dl>

<dl>
<dd>

**output:** `typing.Optional[str]` — Generated output from the LLM. Only populated for LLM Evaluator Logs.
    
</dd>
</dl>

<dl>
<dd>

**created_at:** `typing.Optional[dt.datetime]` — User defined timestamp for when the log was created. 
    
</dd>
</dl>

<dl>
<dd>

**error:** `typing.Optional[str]` — Error message if the log is an error.
    
</dd>
</dl>

<dl>
<dd>

**provider_latency:** `typing.Optional[float]` — Duration of the logged event in seconds.
    
</dd>
</dl>

<dl>
<dd>

**stdout:** `typing.Optional[str]` — Captured log and debug statements.
    
</dd>
</dl>

<dl>
<dd>

**provider_request:** `typing.Optional[typing.Dict[str, typing.Optional[typing.Any]]]` — Raw request sent to provider. Only populated for LLM Evaluator Logs.
    
</dd>
</dl>

<dl>
<dd>

**provider_response:** `typing.Optional[typing.Dict[str, typing.Optional[typing.Any]]]` — Raw response received the provider. Only populated for LLM Evaluator Logs.
    
</dd>
</dl>

<dl>
<dd>

**inputs:** `typing.Optional[typing.Dict[str, typing.Optional[typing.Any]]]` — The inputs passed to the prompt template.
    
</dd>
</dl>

<dl>
<dd>

**source:** `typing.Optional[str]` — Identifies where the model was called from.
    
</dd>
</dl>

<dl>
<dd>

**metadata:** `typing.Optional[typing.Dict[str, typing.Optional[typing.Any]]]` — Any additional metadata to record.
    
</dd>
</dl>

<dl>
<dd>

**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.
    
</dd>
</dl>

<dl>
<dd>

**trace_parent_id:** `typing.Optional[str]` — The ID of the parent Log to nest this Log under in a Trace.
    
</dd>
</dl>

<dl>
<dd>

**user:** `typing.Optional[str]` — End-user ID related to the Log.
    
</dd>
</dl>

<dl>
<dd>

**create_evaluator_log_request_environment:** `typing.Optional[str]` — The name of the Environment the Log is associated to.
    
</dd>
</dl>

<dl>
<dd>

**save:** `typing.Optional[bool]` — Whether the request/response payloads will be stored on Humanloop.
    
</dd>
</dl>

<dl>
<dd>

**log_id:** `typing.Optional[str]` — This will identify a Log. If you don't provide a Log ID, Humanloop will generate one for you.
    
</dd>
</dl>

<dl>
<dd>

**output_message:** `typing.Optional[ChatMessageParams]` — The message returned by the LLM. Only populated for LLM Evaluator Logs.
    
</dd>
</dl>

<dl>
<dd>

**judgment:** `typing.Optional[CreateEvaluatorLogRequestJudgmentParams]` — Evaluator assessment of the Log.
    
</dd>
</dl>

<dl>
<dd>

**marked_completed:** `typing.Optional[bool]` — Whether the Log has been manually marked as completed by a user.
    
</dd>
</dl>

<dl>
<dd>

**spec:** `typing.Optional[CreateEvaluatorLogRequestSpecParams]` 
    
</dd>
</dl>

<dl>
<dd>

**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
    
</dd>
</dl>
</dd>
</dl>


</dd>
</dl>
</details>

<details><summary><code>client.evaluators.<a href="src/humanloop/evaluators/client.py">list</a>(...)</code></summary>
<dl>
<dd>

#### 📝 Description

<dl>
<dd>

<dl>
<dd>

Get a list of all Evaluators.
</dd>
</dl>
</dd>
</dl>

#### 🔌 Usage

<dl>
<dd>

<dl>
<dd>

```python
from humanloop import Humanloop
client = Humanloop(api_key="YOUR_API_KEY", )
response = client.evaluators.list(size=1, )
for item in response:
    yield item
# alternatively, you can paginate page-by-page
for page in response.iter_pages():
    yield page

```
</dd>
</dl>
</dd>
</dl>

#### ⚙️ Parameters

<dl>
<dd>

<dl>
<dd>

**page:** `typing.Optional[int]` — Page offset for pagination.
    
</dd>
</dl>

<dl>
<dd>

**size:** `typing.Optional[int]` — Page size for pagination. Number of Evaluators to fetch.
    
</dd>
</dl>

<dl>
<dd>

**name:** `typing.Optional[str]` — Case-insensitive filter for Evaluator name.
    
</dd>
</dl>

<dl>
<dd>

**user_filter:** `typing.Optional[str]` — Case-insensitive filter for users in the Evaluator. This filter matches against both email address and name of users.
    
</dd>
</dl>

<dl>
<dd>

**sort_by:** `typing.Optional[FileSortBy]` — Field to sort Evaluators by
    
</dd>
</dl>

<dl>
<dd>

**order:** `typing.Optional[SortOrder]` — Direction to sort by.
    
</dd>
</dl>

<dl>
<dd>

**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
    
</dd>
</dl>
</dd>
</dl>


</dd>
</dl>
</details>

<details><summary><code>client.evaluators.<a href="src/humanloop/evaluators/client.py">upsert</a>(...)</code></summary>
<dl>
<dd>

#### 📝 Description

<dl>
<dd>

<dl>
<dd>

Create an Evaluator or update it with a new version if it already exists.

Evaluators are identified by the `ID` or their `path`. The spec provided determines the version of the Evaluator.

You can provide `version_name` and `version_description` to identify and describe your versions.
Version names must be unique within an Evaluator - attempting to create a version with a name
that already exists will result in a 409 Conflict error.
</dd>
</dl>
</dd>
</dl>

#### 🔌 Usage

<dl>
<dd>

<dl>
<dd>

```python
from humanloop import Humanloop
client = Humanloop(api_key="YOUR_API_KEY", )
client.evaluators.upsert(path='Shared Evaluators/Accuracy Evaluator', spec={'arguments_type': "target_required", 'return_type': "number", 'evaluator_type': 'python', 'code': 'def evaluate(answer, target):\n    return 0.5'}, version_name='simple-evaluator', version_description='Simple evaluator that returns 0.5', )

```
</dd>
</dl>
</dd>
</dl>

#### ⚙️ Parameters

<dl>
<dd>

<dl>
<dd>

**spec:** `EvaluatorRequestSpecParams` 
    
</dd>
</dl>

<dl>
<dd>

**path:** `typing.Optional[str]` — Path of the Evaluator, including the name. This locates the Evaluator in the Humanloop filesystem and is used as as a unique identifier. For example: `folder/name` or just `name`.
    
</dd>
</dl>

<dl>
<dd>

**id:** `typing.Optional[str]` — ID for an existing Evaluator.
    
</dd>
</dl>

<dl>
<dd>

**version_name:** `typing.Optional[str]` — Unique name for the Evaluator version. Version names must be unique for a given Evaluator.
    
</dd>
</dl>

<dl>
<dd>

**version_description:** `typing.Optional[str]` — Description of the version, e.g., the changes made in this version.
    
</dd>
</dl>

<dl>
<dd>

**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
    
</dd>
</dl>
</dd>
</dl>


</dd>
</dl>
</details>

<details><summary><code>client.evaluators.<a href="src/humanloop/evaluators/client.py">get</a>(...)</code></summary>
<dl>
<dd>

#### 📝 Description

<dl>
<dd>

<dl>
<dd>

Retrieve the Evaluator with the given ID.

By default, the deployed version of the Evaluator is returned. Use the query parameters
`version_id` or `environment` to target a specific version of the Evaluator.
</dd>
</dl>
</dd>
</dl>

#### 🔌 Usage

<dl>
<dd>

<dl>
<dd>

```python
from humanloop import Humanloop
client = Humanloop(api_key="YOUR_API_KEY", )
client.evaluators.get(id='ev_890bcd', )

```
</dd>
</dl>
</dd>
</dl>

#### ⚙️ Parameters

<dl>
<dd>

<dl>
<dd>

**id:** `str` — Unique identifier for Evaluator.
    
</dd>
</dl>

<dl>
<dd>

**version_id:** `typing.Optional[str]` — A specific Version ID of the Evaluator to retrieve.
    
</dd>
</dl>

<dl>
<dd>

**environment:** `typing.Optional[str]` — Name of the Environment to retrieve a deployed Version from.
    
</dd>
</dl>

<dl>
<dd>

**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
    
</dd>
</dl>
</dd>
</dl>


</dd>
</dl>
</details>

<details><summary><code>client.evaluators.<a href="src/humanloop/evaluators/client.py">delete</a>(...)</code></summary>
<dl>
<dd>

#### 📝 Description

<dl>
<dd>

<dl>
<dd>

Delete the Evaluator with the given ID.
</dd>
</dl>
</dd>
</dl>

#### 🔌 Usage

<dl>
<dd>

<dl>
<dd>

```python
from humanloop import Humanloop
client = Humanloop(api_key="YOUR_API_KEY", )
client.evaluators.delete(id='ev_890bcd', )

```
</dd>
</dl>
</dd>
</dl>

#### ⚙️ Parameters

<dl>
<dd>

<dl>
<dd>

**id:** `str` — Unique identifier for Evaluator.
    
</dd>
</dl>

<dl>
<dd>

**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
    
</dd>
</dl>
</dd>
</dl>


</dd>
</dl>
</details>

<details><summary><code>client.evaluators.<a href="src/humanloop/evaluators/client.py">move</a>(...)</code></summary>
<dl>
<dd>

#### 📝 Description

<dl>
<dd>

<dl>
<dd>

Move the Evaluator to a different path or change the name.
</dd>
</dl>
</dd>
</dl>

#### 🔌 Usage

<dl>
<dd>

<dl>
<dd>

```python
from humanloop import Humanloop
client = Humanloop(api_key="YOUR_API_KEY", )
client.evaluators.move(id='ev_890bcd', path='new directory/new name', )

```
</dd>
</dl>
</dd>
</dl>

#### ⚙️ Parameters

<dl>
<dd>

<dl>
<dd>

**id:** `str` — Unique identifier for Evaluator.
    
</dd>
</dl>

<dl>
<dd>

**path:** `typing.Optional[str]` — Path of the Evaluator including the Evaluator name, which is used as a unique identifier.
    
</dd>
</dl>

<dl>
<dd>

**name:** `typing.Optional[str]` — Name of the Evaluator, which is used as a unique identifier.
    
</dd>
</dl>

<dl>
<dd>

**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
    
</dd>
</dl>
</dd>
</dl>


</dd>
</dl>
</details>

<details><summary><code>client.evaluators.<a href="src/humanloop/evaluators/client.py">list_versions</a>(...)</code></summary>
<dl>
<dd>

#### 📝 Description

<dl>
<dd>

<dl>
<dd>

Get a list of all the versions of an Evaluator.
</dd>
</dl>
</dd>
</dl>

#### 🔌 Usage

<dl>
<dd>

<dl>
<dd>

```python
from humanloop import Humanloop
client = Humanloop(api_key="YOUR_API_KEY", )
client.evaluators.list_versions(id='ev_890bcd', )

```
</dd>
</dl>
</dd>
</dl>

#### ⚙️ Parameters

<dl>
<dd>

<dl>
<dd>

**id:** `str` — Unique identifier for the Evaluator.
    
</dd>
</dl>

<dl>
<dd>

**evaluator_aggregates:** `typing.Optional[bool]` — Whether to include Evaluator aggregate results for the versions in the response
    
</dd>
</dl>

<dl>
<dd>

**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
    
</dd>
</dl>
</dd>
</dl>


</dd>
</dl>
</details>

<details><summary><code>client.evaluators.<a href="src/humanloop/evaluators/client.py">delete_evaluator_version</a>(...)</code></summary>
<dl>
<dd>

#### 📝 Description

<dl>
<dd>

<dl>
<dd>

Delete a version of the Evaluator.
</dd>
</dl>
</dd>
</dl>

#### 🔌 Usage

<dl>
<dd>

<dl>
<dd>

```python
from humanloop import Humanloop
client = Humanloop(api_key="YOUR_API_KEY", )
client.evaluators.delete_evaluator_version(id='id', version_id='version_id', )

```
</dd>
</dl>
</dd>
</dl>

#### ⚙️ Parameters

<dl>
<dd>

<dl>
<dd>

**id:** `str` — Unique identifier for Evaluator.
    
</dd>
</dl>

<dl>
<dd>

**version_id:** `str` — Unique identifier for the specific version of the Evaluator.
    
</dd>
</dl>

<dl>
<dd>

**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
    
</dd>
</dl>
</dd>
</dl>


</dd>
</dl>
</details>

<details><summary><code>client.evaluators.<a href="src/humanloop/evaluators/client.py">update_evaluator_version</a>(...)</code></summary>
<dl>
<dd>

#### 📝 Description

<dl>
<dd>

<dl>
<dd>

Update the name or description of the Evaluator version.
</dd>
</dl>
</dd>
</dl>

#### 🔌 Usage

<dl>
<dd>

<dl>
<dd>

```python
from humanloop import Humanloop
client = Humanloop(api_key="YOUR_API_KEY", )
client.evaluators.update_evaluator_version(id='id', version_id='version_id', )

```
</dd>
</dl>
</dd>
</dl>

#### ⚙️ Parameters

<dl>
<dd>

<dl>
<dd>

**id:** `str` — Unique identifier for Evaluator.
    
</dd>
</dl>

<dl>
<dd>

**version_id:** `str` — Unique identifier for the specific version of the Evaluator.
    
</dd>
</dl>

<dl>
<dd>

**name:** `typing.Optional[str]` — Name of the version.
    
</dd>
</dl>

<dl>
<dd>

**description:** `typing.Optional[str]` — Description of the version.
    
</dd>
</dl>

<dl>
<dd>

**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
    
</dd>
</dl>
</dd>
</dl>


</dd>
</dl>
</details>

<details><summary><code>client.evaluators.<a href="src/humanloop/evaluators/client.py">set_deployment</a>(...)</code></summary>
<dl>
<dd>

#### 📝 Description

<dl>
<dd>

<dl>
<dd>

Deploy Evaluator to an Environment.

Set the deployed version for the specified Environment. This Evaluator
will be used for calls made to the Evaluator in this Environment.
</dd>
</dl>
</dd>
</dl>

#### 🔌 Usage

<dl>
<dd>

<dl>
<dd>

```python
from humanloop import Humanloop
client = Humanloop(api_key="YOUR_API_KEY", )
client.evaluators.set_deployment(id='ev_890bcd', environment_id='staging', version_id='evv_012def', )

```
</dd>
</dl>
</dd>
</dl>

#### ⚙️ Parameters

<dl>
<dd>

<dl>
<dd>

**id:** `str` — Unique identifier for Evaluator.
    
</dd>
</dl>

<dl>
<dd>

**environment_id:** `str` — Unique identifier for the Environment to deploy the Version to.
    
</dd>
</dl>

<dl>
<dd>

**version_id:** `str` — Unique identifier for the specific version of the Evaluator.
    
</dd>
</dl>

<dl>
<dd>

**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
    
</dd>
</dl>
</dd>
</dl>


</dd>
</dl>
</details>

<details><summary><code>client.evaluators.<a href="src/humanloop/evaluators/client.py">remove_deployment</a>(...)</code></summary>
<dl>
<dd>

#### 📝 Description

<dl>
<dd>

<dl>
<dd>

Remove deployed Evaluator from the Environment.

Remove the deployed version for the specified Environment. This Evaluator
will no longer be used for calls made to the Evaluator in this Environment.
</dd>
</dl>
</dd>
</dl>

#### 🔌 Usage

<dl>
<dd>

<dl>
<dd>

```python
from humanloop import Humanloop
client = Humanloop(api_key="YOUR_API_KEY", )
client.evaluators.remove_deployment(id='ev_890bcd', environment_id='staging', )

```
</dd>
</dl>
</dd>
</dl>

#### ⚙️ Parameters

<dl>
<dd>

<dl>
<dd>

**id:** `str` — Unique identifier for Evaluator.
    
</dd>
</dl>

<dl>
<dd>

**environment_id:** `str` — Unique identifier for the Environment to remove the deployment from.
    
</dd>
</dl>

<dl>
<dd>

**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
    
</dd>
</dl>
</dd>
</dl>


</dd>
</dl>
</details>

<details><summary><code>client.evaluators.<a href="src/humanloop/evaluators/client.py">list_environments</a>(...)</code></summary>
<dl>
<dd>

#### 📝 Description

<dl>
<dd>

<dl>
<dd>

List all Environments and their deployed versions for the Evaluator.
</dd>
</dl>
</dd>
</dl>

#### 🔌 Usage

<dl>
<dd>

<dl>
<dd>

```python
from humanloop import Humanloop
client = Humanloop(api_key="YOUR_API_KEY", )
client.evaluators.list_environments(id='ev_890bcd', )

```
</dd>
</dl>
</dd>
</dl>

#### ⚙️ Parameters

<dl>
<dd>

<dl>
<dd>

**id:** `str` — Unique identifier for Evaluator.
    
</dd>
</dl>

<dl>
<dd>

**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
    
</dd>
</dl>
</dd>
</dl>


</dd>
</dl>
</details>

<details><summary><code>client.evaluators.<a href="src/humanloop/evaluators/client.py">update_monitoring</a>(...)</code></summary>
<dl>
<dd>

#### 📝 Description

<dl>
<dd>

<dl>
<dd>

Activate and deactivate Evaluators for monitoring the Evaluator.

An activated Evaluator will automatically be run on all new Logs
within the Evaluator for monitoring purposes.
</dd>
</dl>
</dd>
</dl>

#### 🔌 Usage

<dl>
<dd>

<dl>
<dd>

```python
from humanloop import Humanloop
client = Humanloop(api_key="YOUR_API_KEY", )
client.evaluators.update_monitoring(id='id', )

```
</dd>
</dl>
</dd>
</dl>

#### ⚙️ Parameters

<dl>
<dd>

<dl>
<dd>

**id:** `str` 
    
</dd>
</dl>

<dl>
<dd>

**activate:** `typing.Optional[typing.Sequence[EvaluatorActivationDeactivationRequestActivateItemParams]]` — Evaluators to activate for Monitoring. These will be automatically run on new Logs.
    
</dd>
</dl>

<dl>
<dd>

**deactivate:** `typing.Optional[typing.Sequence[EvaluatorActivationDeactivationRequestDeactivateItemParams]]` — Evaluators to deactivate. These will not be run on new Logs.
    
</dd>
</dl>

<dl>
<dd>

**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
    
</dd>
</dl>
</dd>
</dl>


</dd>
</dl>
</details>

## Flows
<details><summary><code>client.flows.<a href="src/humanloop/flows/client.py">log</a>(...)</code></summary>
<dl>
<dd>

#### 📝 Description

<dl>
<dd>

<dl>
<dd>

Log to a Flow.

You can use query parameters `version_id`, or `environment`, to target
an existing version of the Flow. Otherwise, the default deployed version will be chosen.
</dd>
</dl>
</dd>
</dl>

#### 🔌 Usage

<dl>
<dd>

<dl>
<dd>

```python
from humanloop import Humanloop
import datetime
client = Humanloop(api_key="YOUR_API_KEY", )
client.flows.log(id='fl_6o701g4jmcanPVHxdqD0O', flow={'attributes': {'prompt': {'template': 'You are a helpful assistant helping with medical anamnesis', 'model': 'gpt-4o', 'temperature': 0.8}
, 'tool': {'name': 'retrieval_tool_v3', 'description': 'Retrieval tool for MedQA.', 'source_code': 'def retrieval_tool(question: str) -> str:\n    pass\n'}
}}, inputs={'question': 'Patient with a history of diabetes and hypertension presents with chest pain and shortness of breath.'
}, output='The patient is likely experiencing a myocardial infarction. Immediate medical attention is required.', log_status="incomplete", start_time=datetime.datetime.fromisoformat("2024-07-08 21:40:35+00:00", ), end_time=datetime.datetime.fromisoformat("2024-07-08 21:40:39+00:00", ), )

```
</dd>
</dl>
</dd>
</dl>

#### ⚙️ Parameters

<dl>
<dd>

<dl>
<dd>

**version_id:** `typing.Optional[str]` — A specific Version ID of the Flow to log to.
    
</dd>
</dl>

<dl>
<dd>

**environment:** `typing.Optional[str]` — Name of the Environment identifying a deployed version to log to.
    
</dd>
</dl>

<dl>
<dd>

**messages:** `typing.Optional[typing.Sequence[ChatMessageParams]]` — List of chat messages that were used as an input to the Flow.
    
</dd>
</dl>

<dl>
<dd>

**output_message:** `typing.Optional[ChatMessageParams]` — The output message returned by this Flow.
    
</dd>
</dl>

<dl>
<dd>

**run_id:** `typing.Optional[str]` — Unique identifier for the Run to associate the Log to.
    
</dd>
</dl>

<dl>
<dd>

**path:** `typing.Optional[str]` — Path of the Flow, including the name. This locates the Flow in the Humanloop filesystem and is used as as a unique identifier. For example: `folder/name` or just `name`.
    
</dd>
</dl>

<dl>
<dd>

**id:** `typing.Optional[str]` — ID for an existing Flow.
    
</dd>
</dl>

<dl>
<dd>

**start_time:** `typing.Optional[dt.datetime]` — The start time of the Trace. Will be updated if a child Log with an earlier start time is added.
    
</dd>
</dl>

<dl>
<dd>

**end_time:** `typing.Optional[dt.datetime]` — The end time of the Trace. Will be updated if a child Log with a later end time is added.
    
</dd>
</dl>

<dl>
<dd>

**output:** `typing.Optional[str]` — Generated output from your model for the provided inputs. Can be `None` if logging an error, or if creating a parent Log with the intention to populate it later.
    
</dd>
</dl>

<dl>
<dd>

**created_at:** `typing.Optional[dt.datetime]` — User defined timestamp for when the log was created. 
    
</dd>
</dl>

<dl>
<dd>

**error:** `typing.Optional[str]` — Error message if the log is an error.
    
</dd>
</dl>

<dl>
<dd>

**provider_latency:** `typing.Optional[float]` — Duration of the logged event in seconds.
    
</dd>
</dl>

<dl>
<dd>

**stdout:** `typing.Optional[str]` — Captured log and debug statements.
    
</dd>
</dl>

<dl>
<dd>

**provider_request:** `typing.Optional[typing.Dict[str, typing.Optional[typing.Any]]]` — Raw request sent to provider.
    
</dd>
</dl>

<dl>
<dd>

**provider_response:** `typing.Optional[typing.Dict[str, typing.Optional[typing.Any]]]` — Raw response received the provider.
    
</dd>
</dl>

<dl>
<dd>

**inputs:** `typing.Optional[typing.Dict[str, typing.Optional[typing.Any]]]` — The inputs passed to the prompt template.
    
</dd>
</dl>

<dl>
<dd>

**source:** `typing.Optional[str]` — Identifies where the model was called from.
    
</dd>
</dl>

<dl>
<dd>

**metadata:** `typing.Optional[typing.Dict[str, typing.Optional[typing.Any]]]` — Any additional metadata to record.
    
</dd>
</dl>

<dl>
<dd>

**log_status:** `typing.Optional[LogStatus]` — Status of the Flow Log. When a Log is updated from `incomplete` to `complete`, no more Logs can be added to it.
    
</dd>
</dl>

<dl>
<dd>

**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.
    
</dd>
</dl>

<dl>
<dd>

**trace_parent_id:** `typing.Optional[str]` — The ID of the parent Log to nest this Log under in a Trace.
    
</dd>
</dl>

<dl>
<dd>

**user:** `typing.Optional[str]` — End-user ID related to the Log.
    
</dd>
</dl>

<dl>
<dd>

**flow_log_request_environment:** `typing.Optional[str]` — The name of the Environment the Log is associated to.
    
</dd>
</dl>

<dl>
<dd>

**save:** `typing.Optional[bool]` — Whether the request/response payloads will be stored on Humanloop.
    
</dd>
</dl>

<dl>
<dd>

**log_id:** `typing.Optional[str]` — This will identify a Log. If you don't provide a Log ID, Humanloop will generate one for you.
    
</dd>
</dl>

<dl>
<dd>

**flow:** `typing.Optional[FlowKernelRequestParams]` — Flow used to generate the Trace.
    
</dd>
</dl>

<dl>
<dd>

**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
    
</dd>
</dl>
</dd>
</dl>


</dd>
</dl>
</details>

<details><summary><code>client.flows.<a href="src/humanloop/flows/client.py">update_log</a>(...)</code></summary>
<dl>
<dd>

#### 📝 Description

<dl>
<dd>

<dl>
<dd>

Update the status, inputs, output of a Flow Log.

Marking a Flow Log as complete will trigger any monitoring Evaluators to run.
Inputs and output (or error) must be provided in order to mark it as complete.

The end_time log attribute will be set to match the time the log is marked as complete.
</dd>
</dl>
</dd>
</dl>

#### 🔌 Usage

<dl>
<dd>

<dl>
<dd>

```python
from humanloop import Humanloop
client = Humanloop(api_key="YOUR_API_KEY", )
client.flows.update_log(log_id='medqa_experiment_0001', inputs={'question': 'Patient with a history of diabetes and normal tension presents with chest pain and shortness of breath.'
}, output='The patient is likely experiencing a myocardial infarction. Immediate medical attention is required.', log_status="complete", )

```
</dd>
</dl>
</dd>
</dl>

#### ⚙️ Parameters

<dl>
<dd>

<dl>
<dd>

**log_id:** `str` — Unique identifier of the Flow Log.
    
</dd>
</dl>

<dl>
<dd>

**messages:** `typing.Optional[typing.Sequence[ChatMessageParams]]` — List of chat messages that were used as an input to the Flow.
    
</dd>
</dl>

<dl>
<dd>

**output_message:** `typing.Optional[ChatMessageParams]` — The output message returned by this Flow.
    
</dd>
</dl>

<dl>
<dd>

**inputs:** `typing.Optional[typing.Dict[str, typing.Optional[typing.Any]]]` — The inputs passed to the Flow Log.
    
</dd>
</dl>

<dl>
<dd>

**output:** `typing.Optional[str]` — The output of the Flow Log. Provide None to unset existing `output` value. Provide either this, `output_message` or `error`.
    
</dd>
</dl>

<dl>
<dd>

**error:** `typing.Optional[str]` — The error message of the Flow Log. Provide None to unset existing `error` value. Provide either this, `output_message` or `output`.
    
</dd>
</dl>

<dl>
<dd>

**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`.
    
</dd>
</dl>

<dl>
<dd>

**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
    
</dd>
</dl>
</dd>
</dl>


</dd>
</dl>
</details>

<details><summary><code>client.flows.<a href="src/humanloop/flows/client.py">get</a>(...)</code></summary>
<dl>
<dd>

#### 📝 Description

<dl>
<dd>

<dl>
<dd>

Retrieve the Flow with the given ID.

By default, the deployed version of the Flow is returned. Use the query parameters
`version_id` or `environment` to target a specific version of the Flow.
</dd>
</dl>
</dd>
</dl>

#### 🔌 Usage

<dl>
<dd>

<dl>
<dd>

```python
from humanloop import Humanloop
client = Humanloop(api_key="YOUR_API_KEY", )
client.flows.get(id='fl_6o701g4jmcanPVHxdqD0O', )

```
</dd>
</dl>
</dd>
</dl>

#### ⚙️ Parameters

<dl>
<dd>

<dl>
<dd>

**id:** `str` — Unique identifier for Flow.
    
</dd>
</dl>

<dl>
<dd>

**version_id:** `typing.Optional[str]` — A specific Version ID of the Flow to retrieve.
    
</dd>
</dl>

<dl>
<dd>

**environment:** `typing.Optional[str]` — Name of the Environment to retrieve a deployed Version from.
    
</dd>
</dl>

<dl>
<dd>

**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
    
</dd>
</dl>
</dd>
</dl>


</dd>
</dl>
</details>

<details><summary><code>client.flows.<a href="src/humanloop/flows/client.py">delete</a>(...)</code></summary>
<dl>
<dd>

#### 📝 Description

<dl>
<dd>

<dl>
<dd>

Delete the Flow with the given ID.
</dd>
</dl>
</dd>
</dl>

#### 🔌 Usage

<dl>
<dd>

<dl>
<dd>

```python
from humanloop import Humanloop
client = Humanloop(api_key="YOUR_API_KEY", )
client.flows.delete(id='fl_6o701g4jmcanPVHxdqD0O', )

```
</dd>
</dl>
</dd>
</dl>

#### ⚙️ Parameters

<dl>
<dd>

<dl>
<dd>

**id:** `str` — Unique identifier for Flow.
    
</dd>
</dl>

<dl>
<dd>

**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
    
</dd>
</dl>
</dd>
</dl>


</dd>
</dl>
</details>

<details><summary><code>client.flows.<a href="src/humanloop/flows/client.py">move</a>(...)</code></summary>
<dl>
<dd>

#### 📝 Description

<dl>
<dd>

<dl>
<dd>

Move the Flow to a different path or change the name.
</dd>
</dl>
</dd>
</dl>

#### 🔌 Usage

<dl>
<dd>

<dl>
<dd>

```python
from humanloop import Humanloop
client = Humanloop(api_key="YOUR_API_KEY", )
client.flows.move(id='fl_6o701g4jmcanPVHxdqD0O', path='new directory/new name', )

```
</dd>
</dl>
</dd>
</dl>

#### ⚙️ Parameters

<dl>
<dd>

<dl>
<dd>

**id:** `str` — Unique identifier for Flow.
    
</dd>
</dl>

<dl>
<dd>

**path:** `typing.Optional[str]` — Path of the Flow including the Flow name, which is used as a unique identifier.
    
</dd>
</dl>

<dl>
<dd>

**name:** `typing.Optional[str]` — Name of the Flow.
    
</dd>
</dl>

<dl>
<dd>

**directory_id:** `typing.Optional[str]` — Unique identifier for the Directory to move Flow to. Starts with `dir_`.
    
</dd>
</dl>

<dl>
<dd>

**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
    
</dd>
</dl>
</dd>
</dl>


</dd>
</dl>
</details>

<details><summary><code>client.flows.<a href="src/humanloop/flows/client.py">list</a>(...)</code></summary>
<dl>
<dd>

#### 📝 Description

<dl>
<dd>

<dl>
<dd>

Get a list of Flows.
</dd>
</dl>
</dd>
</dl>

#### 🔌 Usage

<dl>
<dd>

<dl>
<dd>

```python
from humanloop import Humanloop
client = Humanloop(api_key="YOUR_API_KEY", )
response = client.flows.list(size=1, )
for item in response:
    yield item
# alternatively, you can paginate page-by-page
for page in response.iter_pages():
    yield page

```
</dd>
</dl>
</dd>
</dl>

#### ⚙️ Parameters

<dl>
<dd>

<dl>
<dd>

**page:** `typing.Optional[int]` — Page number for pagination.
    
</dd>
</dl>

<dl>
<dd>

**size:** `typing.Optional[int]` — Page size for pagination. Number of Flows to fetch.
    
</dd>
</dl>

<dl>
<dd>

**name:** `typing.Optional[str]` — Case-insensitive filter for Flow name.
    
</dd>
</dl>

<dl>
<dd>

**user_filter:** `typing.Optional[str]` — Case-insensitive filter for users in the Flow. This filter matches against both email address and name of users.
    
</dd>
</dl>

<dl>
<dd>

**sort_by:** `typing.Optional[FileSortBy]` — Field to sort Flows by
    
</dd>
</dl>

<dl>
<dd>

**order:** `typing.Optional[SortOrder]` — Direction to sort by.
    
</dd>
</dl>

<dl>
<dd>

**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
    
</dd>
</dl>
</dd>
</dl>


</dd>
</dl>
</details>

<details><summary><code>client.flows.<a href="src/humanloop/flows/client.py">upsert</a>(...)</code></summary>
<dl>
<dd>

#### 📝 Description

<dl>
<dd>

<dl>
<dd>

Create or update a Flow.

Flows can also be identified by the `ID` or their `path`.

You can provide `version_name` and `version_description` to identify and describe your versions.
Version names must be unique within a Flow - attempting to create a version with a name
that already exists will result in a 409 Conflict error.
</dd>
</dl>
</dd>
</dl>

#### 🔌 Usage

<dl>
<dd>

<dl>
<dd>

```python
from humanloop import Humanloop
client = Humanloop(api_key="YOUR_API_KEY", )
client.flows.upsert(path='Personal Projects/MedQA Flow', attributes={'prompt': {'template': 'You are a helpful medical assistant helping with medical anamnesis. Answer {{question}}', 'model': 'gpt-4o', 'temperature': 0.8}
, 'tool': {'name': 'retrieval_tool_v3', 'description': 'Retrieval tool for MedQA.', 'source_code': 'def retrieval_tool(question: str) -> str:\n    pass\n'}
, 'version_name': 'medqa-flow-v1'
, 'version_description': 'Initial version'
}, )

```
</dd>
</dl>
</dd>
</dl>

#### ⚙️ Parameters

<dl>
<dd>

<dl>
<dd>

**attributes:** `typing.Dict[str, typing.Optional[typing.Any]]` — A key-value object identifying the Flow Version.
    
</dd>
</dl>

<dl>
<dd>

**path:** `typing.Optional[str]` — Path of the Flow, including the name. This locates the Flow in the Humanloop filesystem and is used as as a unique identifier. For example: `folder/name` or just `name`.
    
</dd>
</dl>

<dl>
<dd>

**id:** `typing.Optional[str]` — ID for an existing Flow.
    
</dd>
</dl>

<dl>
<dd>

**version_name:** `typing.Optional[str]` — Unique name for the Flow version. Version names must be unique for a given Flow.
    
</dd>
</dl>

<dl>
<dd>

**version_description:** `typing.Optional[str]` — Description of the version, e.g., the changes made in this version.
    
</dd>
</dl>

<dl>
<dd>

**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
    
</dd>
</dl>
</dd>
</dl>


</dd>
</dl>
</details>

<details><summary><code>client.flows.<a href="src/humanloop/flows/client.py">list_versions</a>(...)</code></summary>
<dl>
<dd>

#### 📝 Description

<dl>
<dd>

<dl>
<dd>

Get a list of all the versions of a Flow.
</dd>
</dl>
</dd>
</dl>

#### 🔌 Usage

<dl>
<dd>

<dl>
<dd>

```python
from humanloop import Humanloop
client = Humanloop(api_key="YOUR_API_KEY", )
client.flows.list_versions(id='fl_6o701g4jmcanPVHxdqD0O', )

```
</dd>
</dl>
</dd>
</dl>

#### ⚙️ Parameters

<dl>
<dd>

<dl>
<dd>

**id:** `str` — Unique identifier for Flow.
    
</dd>
</dl>

<dl>
<dd>

**evaluator_aggregates:** `typing.Optional[bool]` — Whether to include Evaluator aggregate results for the versions in the response
    
</dd>
</dl>

<dl>
<dd>

**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
    
</dd>
</dl>
</dd>
</dl>


</dd>
</dl>
</details>

<details><summary><code>client.flows.<a href="src/humanloop/flows/client.py">delete_flow_version</a>(...)</code></summary>
<dl>
<dd>

#### 📝 Description

<dl>
<dd>

<dl>
<dd>

Delete a version of the Flow.
</dd>
</dl>
</dd>
</dl>

#### 🔌 Usage

<dl>
<dd>

<dl>
<dd>

```python
from humanloop import Humanloop
client = Humanloop(api_key="YOUR_API_KEY", )
client.flows.delete_flow_version(id='id', version_id='version_id', )

```
</dd>
</dl>
</dd>
</dl>

#### ⚙️ Parameters

<dl>
<dd>

<dl>
<dd>

**id:** `str` — Unique identifier for Flow.
    
</dd>
</dl>

<dl>
<dd>

**version_id:** `str` — Unique identifier for the specific version of the Flow.
    
</dd>
</dl>

<dl>
<dd>

**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
    
</dd>
</dl>
</dd>
</dl>


</dd>
</dl>
</details>

<details><summary><code>client.flows.<a href="src/humanloop/flows/client.py">update_flow_version</a>(...)</code></summary>
<dl>
<dd>

#### 📝 Description

<dl>
<dd>

<dl>
<dd>

Update the name or description of the Flow version.
</dd>
</dl>
</dd>
</dl>

#### 🔌 Usage

<dl>
<dd>

<dl>
<dd>

```python
from humanloop import Humanloop
client = Humanloop(api_key="YOUR_API_KEY", )
client.flows.update_flow_version(id='id', version_id='version_id', )

```
</dd>
</dl>
</dd>
</dl>

#### ⚙️ Parameters

<dl>
<dd>

<dl>
<dd>

**id:** `str` — Unique identifier for Flow.
    
</dd>
</dl>

<dl>
<dd>

**version_id:** `str` — Unique identifier for the specific version of the Flow.
    
</dd>
</dl>

<dl>
<dd>

**name:** `typing.Optional[str]` — Name of the version.
    
</dd>
</dl>

<dl>
<dd>

**description:** `typing.Optional[str]` — Description of the version.
    
</dd>
</dl>

<dl>
<dd>

**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
    
</dd>
</dl>
</dd>
</dl>


</dd>
</dl>
</details>

<details><summary><code>client.flows.<a href="src/humanloop/flows/client.py">set_deployment</a>(...)</code></summary>
<dl>
<dd>

#### 📝 Description

<dl>
<dd>

<dl>
<dd>

Deploy Flow to an Environment.

Set the deployed version for the specified Environment. This Flow
will be used for calls made to the Flow in this Environment.
</dd>
</dl>
</dd>
</dl>

#### 🔌 Usage

<dl>
<dd>

<dl>
<dd>

```python
from humanloop import Humanloop
client = Humanloop(api_key="YOUR_API_KEY", )
client.flows.set_deployment(id='fl_6o701g4jmcanPVHxdqD0O', environment_id='staging', version_id='flv_6o701g4jmcanPVHxdqD0O', )

```
</dd>
</dl>
</dd>
</dl>

#### ⚙️ Parameters

<dl>
<dd>

<dl>
<dd>

**id:** `str` — Unique identifier for Flow.
    
</dd>
</dl>

<dl>
<dd>

**environment_id:** `str` — Unique identifier for the Environment to deploy the Version to.
    
</dd>
</dl>

<dl>
<dd>

**version_id:** `str` — Unique identifier for the specific version of the Flow.
    
</dd>
</dl>

<dl>
<dd>

**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
    
</dd>
</dl>
</dd>
</dl>


</dd>
</dl>
</details>

<details><summary><code>client.flows.<a href="src/humanloop/flows/client.py">remove_deployment</a>(...)</code></summary>
<dl>
<dd>

#### 📝 Description

<dl>
<dd>

<dl>
<dd>

Remove deployed Flow from the Environment.

Remove the deployed version for the specified Environment. This Flow
will no longer be used for calls made to the Flow in this Environment.
</dd>
</dl>
</dd>
</dl>

#### 🔌 Usage

<dl>
<dd>

<dl>
<dd>

```python
from humanloop import Humanloop
client = Humanloop(api_key="YOUR_API_KEY", )
client.flows.remove_deployment(id='fl_6o701g4jmcanPVHxdqD0O', environment_id='staging', )

```
</dd>
</dl>
</dd>
</dl>

#### ⚙️ Parameters

<dl>
<dd>

<dl>
<dd>

**id:** `str` — Unique identifier for Flow.
    
</dd>
</dl>

<dl>
<dd>

**environment_id:** `str` — Unique identifier for the Environment to remove the deployment from.
    
</dd>
</dl>

<dl>
<dd>

**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
    
</dd>
</dl>
</dd>
</dl>


</dd>
</dl>
</details>

<details><summary><code>client.flows.<a href="src/humanloop/flows/client.py">list_environments</a>(...)</code></summary>
<dl>
<dd>

#### 📝 Description

<dl>
<dd>

<dl>
<dd>

List all Environments and their deployed versions for the Flow.
</dd>
</dl>
</dd>
</dl>

#### 🔌 Usage

<dl>
<dd>

<dl>
<dd>

```python
from humanloop import Humanloop
client = Humanloop(api_key="YOUR_API_KEY", )
client.flows.list_environments(id='fl_6o701g4jmcanPVHxdqD0O', )

```
</dd>
</dl>
</dd>
</dl>

#### ⚙️ Parameters

<dl>
<dd>

<dl>
<dd>

**id:** `str` — Unique identifier for Flow.
    
</dd>
</dl>

<dl>
<dd>

**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
    
</dd>
</dl>
</dd>
</dl>


</dd>
</dl>
</details>

<details><summary><code>client.flows.<a href="src/humanloop/flows/client.py">update_monitoring</a>(...)</code></summary>
<dl>
<dd>

#### 📝 Description

<dl>
<dd>

<dl>
<dd>

Activate and deactivate Evaluators for monitoring the Flow.

An activated Evaluator will automatically be run on all new "completed" Logs
within the Flow for monitoring purposes.
</dd>
</dl>
</dd>
</dl>

#### 🔌 Usage

<dl>
<dd>

<dl>
<dd>

```python
from humanloop import Humanloop
client = Humanloop(api_key="YOUR_API_KEY", )
client.flows.update_monitoring(id='fl_6o701g4jmcanPVHxdqD0O', activate=[{'evaluator_version_id': 'evv_1abc4308abd'}], )

```
</dd>
</dl>
</dd>
</dl>

#### ⚙️ Parameters

<dl>
<dd>

<dl>
<dd>

**id:** `str` 
    
</dd>
</dl>

<dl>
<dd>

**activate:** `typing.Optional[typing.Sequence[EvaluatorActivationDeactivationRequestActivateItemParams]]` — Evaluators to activate for Monitoring. These will be automatically run on new Logs.
    
</dd>
</dl>

<dl>
<dd>

**deactivate:** `typing.Optional[typing.Sequence[EvaluatorActivationDeactivationRequestDeactivateItemParams]]` — Evaluators to deactivate. These will not be run on new Logs.
    
</dd>
</dl>

<dl>
<dd>

**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
    
</dd>
</dl>
</dd>
</dl>


</dd>
</dl>
</details>

## Agents
<details><summary><code>client.agents.<a href="src/humanloop/agents/client.py">log</a>(...)</code></summary>
<dl>
<dd>

#### 📝 Description

<dl>
<dd>

<dl>
<dd>

Create an Agent Log.

You can use query parameters `version_id`, or `environment`, to target
an existing version of the Agent. Otherwise, the default deployed version will be chosen.

If you create the Agent Log with a `log_status` of `incomplete`, you should later update it to `complete`
in order to trigger Evaluators.
</dd>
</dl>
</dd>
</dl>

#### 🔌 Usage

<dl>
<dd>

<dl>
<dd>

```python
from humanloop import Humanloop
client = Humanloop(api_key="YOUR_API_KEY", )
client.agents.log(path='Banking/Teller Agent', agent={'provider': "anthropic", 'endpoint': "chat", 'model': 'claude-3-7-sonnet-latest', 'reasoning_effort': 1024, 'template': [{'role': "system", 'content': 'You are a helpful digital assistant, helping users navigate our digital banking platform.'}], 'max_iterations': 3, 'tools': [{'type': 'file', 'link': {'file_id': 'pr_1234567890', 'version_id': 'prv_1234567890'}, 'on_agent_call': "continue"}, {'type': 'inline', 'json_schema': {'name': 'stop', 'description': 'Call this tool when you have finished your task.', 'parameters': {'type': 'object'
, 'properties': {'output': {'type': 'string', 'description': 'The final output to return to the user.'}}
, 'additionalProperties': False
, 'required': ['output']
}, 'strict': True}, 'on_agent_call': "stop"}]}, )

```
</dd>
</dl>
</dd>
</dl>

#### ⚙️ Parameters

<dl>
<dd>

<dl>
<dd>

**version_id:** `typing.Optional[str]` — A specific Version ID of the Agent to log to.
    
</dd>
</dl>

<dl>
<dd>

**environment:** `typing.Optional[str]` — Name of the Environment identifying a deployed version to log to.
    
</dd>
</dl>

<dl>
<dd>

**run_id:** `typing.Optional[str]` — Unique identifier for the Run to associate the Log to.
    
</dd>
</dl>

<dl>
<dd>

**path:** `typing.Optional[str]` — Path of the Agent, including the name. This locates the Agent in the Humanloop filesystem and is used as as a unique identifier. For example: `folder/name` or just `name`.
    
</dd>
</dl>

<dl>
<dd>

**id:** `typing.Optional[str]` — ID for an existing Agent.
    
</dd>
</dl>

<dl>
<dd>

**output_message:** `typing.Optional[ChatMessageParams]` — The message returned by the provider.
    
</dd>
</dl>

<dl>
<dd>

**prompt_tokens:** `typing.Optional[int]` — Number of tokens in the prompt used to generate the output.
    
</dd>
</dl>

<dl>
<dd>

**reasoning_tokens:** `typing.Optional[int]` — Number of reasoning tokens used to generate the output.
    
</dd>
</dl>

<dl>
<dd>

**output_tokens:** `typing.Optional[int]` — Number of tokens in the output generated by the model.
    
</dd>
</dl>

<dl>
<dd>

**prompt_cost:** `typing.Optional[float]` — Cost in dollars associated to the tokens in the prompt.
    
</dd>
</dl>

<dl>
<dd>

**output_cost:** `typing.Optional[float]` — Cost in dollars associated to the tokens in the output.
    
</dd>
</dl>

<dl>
<dd>

**finish_reason:** `typing.Optional[str]` — Reason the generation finished.
    
</dd>
</dl>

<dl>
<dd>

**messages:** `typing.Optional[typing.Sequence[ChatMessageParams]]` — The messages passed to the to provider chat endpoint.
    
</dd>
</dl>

<dl>
<dd>

**tool_choice:** `typing.Optional[AgentLogRequestToolChoiceParams]` 

Controls how the model uses tools. The following options are supported: 
- `'none'` means the model will not call any tool and instead generates a message; this is the default when no tools are provided as part of the Prompt. 
- `'auto'` means the model can decide to call one or more of the provided tools; this is the default when tools are provided as part of the Prompt. 
- `'required'` means the model must call one or more of the provided tools. 
- `{'type': 'function', 'function': {name': <TOOL_NAME>}}` forces the model to use the named function.
    
</dd>
</dl>

<dl>
<dd>

**agent:** `typing.Optional[AgentLogRequestAgentParams]` 

The Agent configuration to use. Two formats are supported:
- An object representing the details of the Agent configuration
- A string representing the raw contents of a .agent file
A new Agent version will be created if the provided details do not match any existing version.
    
</dd>
</dl>

<dl>
<dd>

**start_time:** `typing.Optional[dt.datetime]` — When the logged event started.
    
</dd>
</dl>

<dl>
<dd>

**end_time:** `typing.Optional[dt.datetime]` — When the logged event ended.
    
</dd>
</dl>

<dl>
<dd>

**output:** `typing.Optional[str]` — Generated output from your model for the provided inputs. Can be `None` if logging an error, or if creating a parent Log with the intention to populate it later.
    
</dd>
</dl>

<dl>
<dd>

**created_at:** `typing.Optional[dt.datetime]` — User defined timestamp for when the log was created. 
    
</dd>
</dl>

<dl>
<dd>

**error:** `typing.Optional[str]` — Error message if the log is an error.
    
</dd>
</dl>

<dl>
<dd>

**provider_latency:** `typing.Optional[float]` — Duration of the logged event in seconds.
    
</dd>
</dl>

<dl>
<dd>

**stdout:** `typing.Optional[str]` — Captured log and debug statements.
    
</dd>
</dl>

<dl>
<dd>

**provider_request:** `typing.Optional[typing.Dict[str, typing.Optional[typing.Any]]]` — Raw request sent to provider.
    
</dd>
</dl>

<dl>
<dd>

**provider_response:** `typing.Optional[typing.Dict[str, typing.Optional[typing.Any]]]` — Raw response received the provider.
    
</dd>
</dl>

<dl>
<dd>

**inputs:** `typing.Optional[typing.Dict[str, typing.Optional[typing.Any]]]` — The inputs passed to the prompt template.
    
</dd>
</dl>

<dl>
<dd>

**source:** `typing.Optional[str]` — Identifies where the model was called from.
    
</dd>
</dl>

<dl>
<dd>

**metadata:** `typing.Optional[typing.Dict[str, typing.Optional[typing.Any]]]` — Any additional metadata to record.
    
</dd>
</dl>

<dl>
<dd>

**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.
    
</dd>
</dl>

<dl>
<dd>

**trace_parent_id:** `typing.Optional[str]` — The ID of the parent Log to nest this Log under in a Trace.
    
</dd>
</dl>

<dl>
<dd>

**user:** `typing.Optional[str]` — End-user ID related to the Log.
    
</dd>
</dl>

<dl>
<dd>

**agent_log_request_environment:** `typing.Optional[str]` — The name of the Environment the Log is associated to.
    
</dd>
</dl>

<dl>
<dd>

**save:** `typing.Optional[bool]` — Whether the request/response payloads will be stored on Humanloop.
    
</dd>
</dl>

<dl>
<dd>

**log_id:** `typing.Optional[str]` — This will identify a Log. If you don't provide a Log ID, Humanloop will generate one for you.
    
</dd>
</dl>

<dl>
<dd>

**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
    
</dd>
</dl>
</dd>
</dl>


</dd>
</dl>
</details>

<details><summary><code>client.agents.<a href="src/humanloop/agents/client.py">update_log</a>(...)</code></summary>
<dl>
<dd>

#### 📝 Description

<dl>
<dd>

<dl>
<dd>

Update a Log.

Update the details of a Log with the given ID.
</dd>
</dl>
</dd>
</dl>

#### 🔌 Usage

<dl>
<dd>

<dl>
<dd>

```python
from humanloop import Humanloop
client = Humanloop(api_key="YOUR_API_KEY", )
client.agents.update_log(id='ag_1234567890', log_id='log_1234567890', messages=[{'role': "user", 'content': 'I need to withdraw $1000'}, {'role': "assistant", 'content': 'Of course! Would you like to use your savings or checking account?'}], output_message={'role': "assistant", 'content': "I'm sorry, I can't help with that."}, log_status="complete", )

```
</dd>
</dl>
</dd>
</dl>

#### ⚙️ Parameters

<dl>
<dd>

<dl>
<dd>

**id:** `str` — Unique identifier for Agent.
    
</dd>
</dl>

<dl>
<dd>

**log_id:** `str` — Unique identifier for the Log.
    
</dd>
</dl>

<dl>
<dd>

**messages:** `typing.Optional[typing.Sequence[ChatMessageParams]]` — List of chat messages that were used as an input to the Flow.
    
</dd>
</dl>

<dl>
<dd>

**output_message:** `typing.Optional[ChatMessageParams]` — The output message returned by this Flow.
    
</dd>
</dl>

<dl>
<dd>

**inputs:** `typing.Optional[typing.Dict[str, typing.Optional[typing.Any]]]` — The inputs passed to the Flow Log.
    
</dd>
</dl>

<dl>
<dd>

**output:** `typing.Optional[str]` — The output of the Flow Log. Provide None to unset existing `output` value. Provide either this, `output_message` or `error`.
    
</dd>
</dl>

<dl>
<dd>

**error:** `typing.Optional[str]` — The error message of the Flow Log. Provide None to unset existing `error` value. Provide either this, `output_message` or `output`.
    
</dd>
</dl>

<dl>
<dd>

**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`.
    
</dd>
</dl>

<dl>
<dd>

**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
    
</dd>
</dl>
</dd>
</dl>


</dd>
</dl>
</details>

<details><summary><code>client.agents.<a href="src/humanloop/agents/client.py">call_stream</a>(...)</code></summary>
<dl>
<dd>

#### 📝 Description

<dl>
<dd>

<dl>
<dd>

Call an Agent. The Agent will run on the Humanloop runtime and return a completed Agent Log.

If the Agent requires a tool call that cannot be ran by Humanloop, execution will halt. To continue,
pass the ID of the incomplete Log and the required tool call to the /agents/continue endpoint.

The agent will run for the maximum number of iterations, or until it encounters a stop condition,
according to its configuration.

You can use query parameters `version_id`, or `environment`, to target
an existing version of the Agent. Otherwise the default deployed version will be chosen.

Instead of targeting an existing version explicitly, you can instead pass in
Agent details in the request body. A new version is created if it does not match
any existing ones. This is helpful in the case where you are storing or deriving
your Agent details in code.
</dd>
</dl>
</dd>
</dl>

#### 🔌 Usage

<dl>
<dd>

<dl>
<dd>

```python
from humanloop import Humanloop
client = Humanloop(api_key="YOUR_API_KEY", )
response = client.agents.call_stream()
for chunk in response.data:
    yield chunk

```
</dd>
</dl>
</dd>
</dl>

#### ⚙️ Parameters

<dl>
<dd>

<dl>
<dd>

**version_id:** `typing.Optional[str]` — A specific Version ID of the Agent to log to.
    
</dd>
</dl>

<dl>
<dd>

**environment:** `typing.Optional[str]` — Name of the Environment identifying a deployed version to log to.
    
</dd>
</dl>

<dl>
<dd>

**path:** `typing.Optional[str]` — Path of the Agent, including the name. This locates the Agent in the Humanloop filesystem and is used as as a unique identifier. For example: `folder/name` or just `name`.
    
</dd>
</dl>

<dl>
<dd>

**id:** `typing.Optional[str]` — ID for an existing Agent.
    
</dd>
</dl>

<dl>
<dd>

**messages:** `typing.Optional[typing.Sequence[ChatMessageParams]]` — The messages passed to the to provider chat endpoint.
    
</dd>
</dl>

<dl>
<dd>

**tool_choice:** `typing.Optional[AgentsCallStreamRequestToolChoiceParams]` 

Controls how the model uses tools. The following options are supported: 
- `'none'` means the model will not call any tool and instead generates a message; this is the default when no tools are provided as part of the Prompt. 
- `'auto'` means the model can decide to call one or more of the provided tools; this is the default when tools are provided as part of the Prompt. 
- `'required'` means the model must call one or more of the provided tools. 
- `{'type': 'function', 'function': {name': <TOOL_NAME>}}` forces the model to use the named function.
    
</dd>
</dl>

<dl>
<dd>

**agent:** `typing.Optional[AgentsCallStreamRequestAgentParams]` 

The Agent configuration to use. Two formats are supported:
- An object representing the details of the Agent configuration
- A string representing the raw contents of a .agent file
A new Agent version will be created if the provided details do not match any existing version.
    
</dd>
</dl>

<dl>
<dd>

**inputs:** `typing.Optional[typing.Dict[str, typing.Optional[typing.Any]]]` — The inputs passed to the prompt template.
    
</dd>
</dl>

<dl>
<dd>

**source:** `typing.Optional[str]` — Identifies where the model was called from.
    
</dd>
</dl>

<dl>
<dd>

**metadata:** `typing.Optional[typing.Dict[str, typing.Optional[typing.Any]]]` — Any additional metadata to record.
    
</dd>
</dl>

<dl>
<dd>

**start_time:** `typing.Optional[dt.datetime]` — When the logged event started.
    
</dd>
</dl>

<dl>
<dd>

**end_time:** `typing.Optional[dt.datetime]` — When the logged event ended.
    
</dd>
</dl>

<dl>
<dd>

**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.
    
</dd>
</dl>

<dl>
<dd>

**trace_parent_id:** `typing.Optional[str]` — The ID of the parent Log to nest this Log under in a Trace.
    
</dd>
</dl>

<dl>
<dd>

**user:** `typing.Optional[str]` — End-user ID related to the Log.
    
</dd>
</dl>

<dl>
<dd>

**agents_call_stream_request_environment:** `typing.Optional[str]` — The name of the Environment the Log is associated to.
    
</dd>
</dl>

<dl>
<dd>

**save:** `typing.Optional[bool]` — Whether the request/response payloads will be stored on Humanloop.
    
</dd>
</dl>

<dl>
<dd>

**log_id:** `typing.Optional[str]` — This will identify a Log. If you don't provide a Log ID, Humanloop will generate one for you.
    
</dd>
</dl>

<dl>
<dd>

**provider_api_keys:** `typing.Optional[ProviderApiKeysParams]` — API keys required by each provider to make API calls. The API keys provided here are not stored by Humanloop. If not specified here, Humanloop will fall back to the key saved to your organization.
    
</dd>
</dl>

<dl>
<dd>

**return_inputs:** `typing.Optional[bool]` — Whether to return the inputs in the response. If false, the response will contain an empty dictionary under inputs. This is useful for reducing the size of the response. Defaults to true.
    
</dd>
</dl>

<dl>
<dd>

**include_trace_children:** `typing.Optional[bool]` — If true, populate `trace_children` for the returned Agent Log. Only applies when not streaming. Defaults to false.
    
</dd>
</dl>

<dl>
<dd>

**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
    
</dd>
</dl>
</dd>
</dl>


</dd>
</dl>
</details>

<details><summary><code>client.agents.<a href="src/humanloop/agents/client.py">call</a>(...)</code></summary>
<dl>
<dd>

#### 📝 Description

<dl>
<dd>

<dl>
<dd>

Call an Agent. The Agent will run on the Humanloop runtime and return a completed Agent Log.

If the Agent requires a tool call that cannot be ran by Humanloop, execution will halt. To continue,
pass the ID of the incomplete Log and the required tool call to the /agents/continue endpoint.

The agent will run for the maximum number of iterations, or until it encounters a stop condition,
according to its configuration.

You can use query parameters `version_id`, or `environment`, to target
an existing version of the Agent. Otherwise the default deployed version will be chosen.

Instead of targeting an existing version explicitly, you can instead pass in
Agent details in the request body. A new version is created if it does not match
any existing ones. This is helpful in the case where you are storing or deriving
your Agent details in code.
</dd>
</dl>
</dd>
</dl>

#### 🔌 Usage

<dl>
<dd>

<dl>
<dd>

```python
from humanloop import Humanloop
client = Humanloop(api_key="YOUR_API_KEY", )
client.agents.call(path='Banking/Teller Agent', messages=[{'role': "user", 'content': "I'd like to deposit $1000 to my savings account from my checking account."}], )

```
</dd>
</dl>
</dd>
</dl>

#### ⚙️ Parameters

<dl>
<dd>

<dl>
<dd>

**version_id:** `typing.Optional[str]` — A specific Version ID of the Agent to log to.
    
</dd>
</dl>

<dl>
<dd>

**environment:** `typing.Optional[str]` — Name of the Environment identifying a deployed version to log to.
    
</dd>
</dl>

<dl>
<dd>

**path:** `typing.Optional[str]` — Path of the Agent, including the name. This locates the Agent in the Humanloop filesystem and is used as as a unique identifier. For example: `folder/name` or just `name`.
    
</dd>
</dl>

<dl>
<dd>

**id:** `typing.Optional[str]` — ID for an existing Agent.
    
</dd>
</dl>

<dl>
<dd>

**messages:** `typing.Optional[typing.Sequence[ChatMessageParams]]` — The messages passed to the to provider chat endpoint.
    
</dd>
</dl>

<dl>
<dd>

**tool_choice:** `typing.Optional[AgentsCallRequestToolChoiceParams]` 

Controls how the model uses tools. The following options are supported: 
- `'none'` means the model will not call any tool and instead generates a message; this is the default when no tools are provided as part of the Prompt. 
- `'auto'` means the model can decide to call one or more of the provided tools; this is the default when tools are provided as part of the Prompt. 
- `'required'` means the model must call one or more of the provided tools. 
- `{'type': 'function', 'function': {name': <TOOL_NAME>}}` forces the model to use the named function.
    
</dd>
</dl>

<dl>
<dd>

**agent:** `typing.Optional[AgentsCallRequestAgentParams]` 

The Agent configuration to use. Two formats are supported:
- An object representing the details of the Agent configuration
- A string representing the raw contents of a .agent file
A new Agent version will be created if the provided details do not match any existing version.
    
</dd>
</dl>

<dl>
<dd>

**inputs:** `typing.Optional[typing.Dict[str, typing.Optional[typing.Any]]]` — The inputs passed to the prompt template.
    
</dd>
</dl>

<dl>
<dd>

**source:** `typing.Optional[str]` — Identifies where the model was called from.
    
</dd>
</dl>

<dl>
<dd>

**metadata:** `typing.Optional[typing.Dict[str, typing.Optional[typing.Any]]]` — Any additional metadata to record.
    
</dd>
</dl>

<dl>
<dd>

**start_time:** `typing.Optional[dt.datetime]` — When the logged event started.
    
</dd>
</dl>

<dl>
<dd>

**end_time:** `typing.Optional[dt.datetime]` — When the logged event ended.
    
</dd>
</dl>

<dl>
<dd>

**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.
    
</dd>
</dl>

<dl>
<dd>

**trace_parent_id:** `typing.Optional[str]` — The ID of the parent Log to nest this Log under in a Trace.
    
</dd>
</dl>

<dl>
<dd>

**user:** `typing.Optional[str]` — End-user ID related to the Log.
    
</dd>
</dl>

<dl>
<dd>

**agents_call_request_environment:** `typing.Optional[str]` — The name of the Environment the Log is associated to.
    
</dd>
</dl>

<dl>
<dd>

**save:** `typing.Optional[bool]` — Whether the request/response payloads will be stored on Humanloop.
    
</dd>
</dl>

<dl>
<dd>

**log_id:** `typing.Optional[str]` — This will identify a Log. If you don't provide a Log ID, Humanloop will generate one for you.
    
</dd>
</dl>

<dl>
<dd>

**provider_api_keys:** `typing.Optional[ProviderApiKeysParams]` — API keys required by each provider to make API calls. The API keys provided here are not stored by Humanloop. If not specified here, Humanloop will fall back to the key saved to your organization.
    
</dd>
</dl>

<dl>
<dd>

**return_inputs:** `typing.Optional[bool]` — Whether to return the inputs in the response. If false, the response will contain an empty dictionary under inputs. This is useful for reducing the size of the response. Defaults to true.
    
</dd>
</dl>

<dl>
<dd>

**include_trace_children:** `typing.Optional[bool]` — If true, populate `trace_children` for the returned Agent Log. Only applies when not streaming. Defaults to false.
    
</dd>
</dl>

<dl>
<dd>

**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
    
</dd>
</dl>
</dd>
</dl>


</dd>
</dl>
</details>

<details><summary><code>client.agents.<a href="src/humanloop/agents/client.py">continue_call_stream</a>(...)</code></summary>
<dl>
<dd>

#### 📝 Description

<dl>
<dd>

<dl>
<dd>

Continue an incomplete Agent call.

This endpoint allows continuing an existing incomplete Agent call, by passing the tool call
requested by the Agent. The Agent will resume processing from where it left off.

The messages in the request will be appended to the original messages in the Log. You do not
have to provide the previous conversation history.

The original log must be in an incomplete state to be continued.
</dd>
</dl>
</dd>
</dl>

#### 🔌 Usage

<dl>
<dd>

<dl>
<dd>

```python
from humanloop import Humanloop
client = Humanloop(api_key="YOUR_API_KEY", )
response = client.agents.continue_call_stream(log_id='log_id', messages=[{'role': "user"}], )
for chunk in response.data:
    yield chunk

```
</dd>
</dl>
</dd>
</dl>

#### ⚙️ Parameters

<dl>
<dd>

<dl>
<dd>

**log_id:** `str` — This identifies the Agent Log to continue.
    
</dd>
</dl>

<dl>
<dd>

**messages:** `typing.Sequence[ChatMessageParams]` — The additional messages with which to continue the Agent Log. Often, these should start with the Tool messages with results for the previous Assistant message's tool calls.
    
</dd>
</dl>

<dl>
<dd>

**provider_api_keys:** `typing.Optional[ProviderApiKeysParams]` — API keys required by each provider to make API calls. The API keys provided here are not stored by Humanloop. If not specified here, Humanloop will fall back to the key saved to your organization.
    
</dd>
</dl>

<dl>
<dd>

**include_trace_children:** `typing.Optional[bool]` — If true, populate `trace_children` for the returned Agent Log. Defaults to false.
    
</dd>
</dl>

<dl>
<dd>

**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
    
</dd>
</dl>
</dd>
</dl>


</dd>
</dl>
</details>

<details><summary><code>client.agents.<a href="src/humanloop/agents/client.py">continue_call</a>(...)</code></summary>
<dl>
<dd>

#### 📝 Description

<dl>
<dd>

<dl>
<dd>

Continue an incomplete Agent call.

This endpoint allows continuing an existing incomplete Agent call, by passing the tool call
requested by the Agent. The Agent will resume processing from where it left off.

The messages in the request will be appended to the original messages in the Log. You do not
have to provide the previous conversation history.

The original log must be in an incomplete state to be continued.
</dd>
</dl>
</dd>
</dl>

#### 🔌 Usage

<dl>
<dd>

<dl>
<dd>

```python
from humanloop import Humanloop
client = Humanloop(api_key="YOUR_API_KEY", )
client.agents.continue_call(log_id='log_1234567890', messages=[{'role': "tool", 'content': '{"type": "checking", "balance": 5200}', 'tool_call_id': 'tc_1234567890'}], )

```
</dd>
</dl>
</dd>
</dl>

#### ⚙️ Parameters

<dl>
<dd>

<dl>
<dd>

**log_id:** `str` — This identifies the Agent Log to continue.
    
</dd>
</dl>

<dl>
<dd>

**messages:** `typing.Sequence[ChatMessageParams]` — The additional messages with which to continue the Agent Log. Often, these should start with the Tool messages with results for the previous Assistant message's tool calls.
    
</dd>
</dl>

<dl>
<dd>

**provider_api_keys:** `typing.Optional[ProviderApiKeysParams]` — API keys required by each provider to make API calls. The API keys provided here are not stored by Humanloop. If not specified here, Humanloop will fall back to the key saved to your organization.
    
</dd>
</dl>

<dl>
<dd>

**include_trace_children:** `typing.Optional[bool]` — If true, populate `trace_children` for the returned Agent Log. Defaults to false.
    
</dd>
</dl>

<dl>
<dd>

**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
    
</dd>
</dl>
</dd>
</dl>


</dd>
</dl>
</details>

<details><summary><code>client.agents.<a href="src/humanloop/agents/client.py">list</a>(...)</code></summary>
<dl>
<dd>

#### 📝 Description

<dl>
<dd>

<dl>
<dd>

Get a list of all Agents.
</dd>
</dl>
</dd>
</dl>

#### 🔌 Usage

<dl>
<dd>

<dl>
<dd>

```python
from humanloop import Humanloop
client = Humanloop(api_key="YOUR_API_KEY", )
response = client.agents.list(size=1, )
for item in response:
    yield item
# alternatively, you can paginate page-by-page
for page in response.iter_pages():
    yield page

```
</dd>
</dl>
</dd>
</dl>

#### ⚙️ Parameters

<dl>
<dd>

<dl>
<dd>

**page:** `typing.Optional[int]` — Page number for pagination.
    
</dd>
</dl>

<dl>
<dd>

**size:** `typing.Optional[int]` — Page size for pagination. Number of Agents to fetch.
    
</dd>
</dl>

<dl>
<dd>

**name:** `typing.Optional[str]` — Case-insensitive filter for Agent name.
    
</dd>
</dl>

<dl>
<dd>

**user_filter:** `typing.Optional[str]` — Case-insensitive filter for users in the Agent. This filter matches against both email address and name of users.
    
</dd>
</dl>

<dl>
<dd>

**sort_by:** `typing.Optional[FileSortBy]` — Field to sort Agents by
    
</dd>
</dl>

<dl>
<dd>

**order:** `typing.Optional[SortOrder]` — Direction to sort by.
    
</dd>
</dl>

<dl>
<dd>

**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
    
</dd>
</dl>
</dd>
</dl>


</dd>
</dl>
</details>

<details><summary><code>client.agents.<a href="src/humanloop/agents/client.py">upsert</a>(...)</code></summary>
<dl>
<dd>

#### 📝 Description

<dl>
<dd>

<dl>
<dd>

Create an Agent or update it with a new version if it already exists.

Agents are identified by the `ID` or their `path`. The parameters (i.e. the template, temperature, model etc.) and
tools determine the versions of the Agent.

You can provide `version_name` and `version_description` to identify and describe your versions.
Version names must be unique within an Agent - attempting to create a version with a name
that already exists will result in a 409 Conflict error.
</dd>
</dl>
</dd>
</dl>

#### 🔌 Usage

<dl>
<dd>

<dl>
<dd>

```python
from humanloop import Humanloop
client = Humanloop(api_key="YOUR_API_KEY", )
client.agents.upsert(path='Banking/Teller Agent', provider="anthropic", endpoint="chat", model='claude-3-7-sonnet-latest', reasoning_effort=1024, template=[{'role': "system", 'content': 'You are a helpful digital assistant, helping users navigate our digital banking platform.'}], max_iterations=3, tools=[{'type': 'inline', 'json_schema': {'name': 'stop', 'description': 'Call this tool when you have finished your task.', 'parameters': {'type': 'object'
, 'properties': {'output': {'type': 'string', 'description': 'The final output to return to the user.'}}
, 'additionalProperties': False
, 'required': ['output']
}, 'strict': True}, 'on_agent_call': "stop"}], version_name='teller-agent-v1', version_description='Initial version', )

```
</dd>
</dl>
</dd>
</dl>

#### ⚙️ Parameters

<dl>
<dd>

<dl>
<dd>

**model:** `str` — The model instance used, e.g. `gpt-4`. See [supported models](https://humanloop.com/docs/reference/supported-models)
    
</dd>
</dl>

<dl>
<dd>

**path:** `typing.Optional[str]` — Path of the Agent, including the name. This locates the Agent in the Humanloop filesystem and is used as as a unique identifier. For example: `folder/name` or just `name`.
    
</dd>
</dl>

<dl>
<dd>

**id:** `typing.Optional[str]` — ID for an existing Agent.
    
</dd>
</dl>

<dl>
<dd>

**endpoint:** `typing.Optional[ModelEndpoints]` — The provider model endpoint used.
    
</dd>
</dl>

<dl>
<dd>

**template:** `typing.Optional[AgentRequestTemplateParams]` 

The template contains the main structure and instructions for the model, including input variables for dynamic values. 

For chat models, provide the template as a ChatTemplate (a list of messages), e.g. a system message, followed by a user message with an input variable.
For completion models, provide a prompt template as a string. 

Input variables should be specified with double curly bracket syntax: `{{input_name}}`.
    
</dd>
</dl>

<dl>
<dd>

**template_language:** `typing.Optional[TemplateLanguage]` — The template language to use for rendering the template.
    
</dd>
</dl>

<dl>
<dd>

**provider:** `typing.Optional[ModelProviders]` — The company providing the underlying model service.
    
</dd>
</dl>

<dl>
<dd>

**max_tokens:** `typing.Optional[int]` — The maximum number of tokens to generate. Provide max_tokens=-1 to dynamically calculate the maximum number of tokens to generate given the length of the prompt
    
</dd>
</dl>

<dl>
<dd>

**temperature:** `typing.Optional[float]` — What sampling temperature to use when making a generation. Higher values means the model will be more creative.
    
</dd>
</dl>

<dl>
<dd>

**top_p:** `typing.Optional[float]` — An alternative to sampling with temperature, called nucleus sampling, where the model considers the results of the tokens with top_p probability mass.
    
</dd>
</dl>

<dl>
<dd>

**stop:** `typing.Optional[AgentRequestStopParams]` — The string (or list of strings) after which the model will stop generating. The returned text will not contain the stop sequence.
    
</dd>
</dl>

<dl>
<dd>

**presence_penalty:** `typing.Optional[float]` — Number between -2.0 and 2.0. Positive values penalize new tokens based on whether they appear in the generation so far.
    
</dd>
</dl>

<dl>
<dd>

**frequency_penalty:** `typing.Optional[float]` — Number between -2.0 and 2.0. Positive values penalize new tokens based on how frequently they appear in the generation so far.
    
</dd>
</dl>

<dl>
<dd>

**other:** `typing.Optional[typing.Dict[str, typing.Optional[typing.Any]]]` — Other parameter values to be passed to the provider call.
    
</dd>
</dl>

<dl>
<dd>

**seed:** `typing.Optional[int]` — If specified, model will make a best effort to sample deterministically, but it is not guaranteed.
    
</dd>
</dl>

<dl>
<dd>

**response_format:** `typing.Optional[ResponseFormatParams]` — The format of the response. Only `{"type": "json_object"}` is currently supported for chat.
    
</dd>
</dl>

<dl>
<dd>

**reasoning_effort:** `typing.Optional[AgentRequestReasoningEffortParams]` — Guidance on how many reasoning tokens it should generate before creating a response to the prompt. OpenAI reasoning models (o1, o3-mini) expect a OpenAIReasoningEffort enum. Anthropic reasoning models expect an integer, which signifies the maximum token budget.
    
</dd>
</dl>

<dl>
<dd>

**tools:** `typing.Optional[typing.Sequence[AgentRequestToolsItemParams]]` 
    
</dd>
</dl>

<dl>
<dd>

**attributes:** `typing.Optional[typing.Dict[str, typing.Optional[typing.Any]]]` — Additional fields to describe the Prompt. Helpful to separate Prompt versions from each other with details on how they were created or used.
    
</dd>
</dl>

<dl>
<dd>

**max_iterations:** `typing.Optional[int]` — The maximum number of iterations the Agent can run. This is used to limit the number of times the Agent model is called.
    
</dd>
</dl>

<dl>
<dd>

**version_name:** `typing.Optional[str]` — Unique name for the Prompt version. Each Prompt can only have one version with a given name.
    
</dd>
</dl>

<dl>
<dd>

**version_description:** `typing.Optional[str]` — Description of the Version.
    
</dd>
</dl>

<dl>
<dd>

**description:** `typing.Optional[str]` — Description of the Prompt.
    
</dd>
</dl>

<dl>
<dd>

**tags:** `typing.Optional[typing.Sequence[str]]` — List of tags associated with this prompt.
    
</dd>
</dl>

<dl>
<dd>

**readme:** `typing.Optional[str]` — Long description of the Prompt.
    
</dd>
</dl>

<dl>
<dd>

**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
    
</dd>
</dl>
</dd>
</dl>


</dd>
</dl>
</details>

<details><summary><code>client.agents.<a href="src/humanloop/agents/client.py">delete_agent_version</a>(...)</code></summary>
<dl>
<dd>

#### 📝 Description

<dl>
<dd>

<dl>
<dd>

Delete a version of the Agent.
</dd>
</dl>
</dd>
</dl>

#### 🔌 Usage

<dl>
<dd>

<dl>
<dd>

```python
from humanloop import Humanloop
client = Humanloop(api_key="YOUR_API_KEY", )
client.agents.delete_agent_version(id='ag_1234567890', version_id='agv_1234567890', )

```
</dd>
</dl>
</dd>
</dl>

#### ⚙️ Parameters

<dl>
<dd>

<dl>
<dd>

**id:** `str` — Unique identifier for Agent.
    
</dd>
</dl>

<dl>
<dd>

**version_id:** `str` — Unique identifier for the specific version of the Agent.
    
</dd>
</dl>

<dl>
<dd>

**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
    
</dd>
</dl>
</dd>
</dl>


</dd>
</dl>
</details>

<details><summary><code>client.agents.<a href="src/humanloop/agents/client.py">patch_agent_version</a>(...)</code></summary>
<dl>
<dd>

#### 📝 Description

<dl>
<dd>

<dl>
<dd>

Update the name or description of the Agent version.
</dd>
</dl>
</dd>
</dl>

#### 🔌 Usage

<dl>
<dd>

<dl>
<dd>

```python
from humanloop import Humanloop
client = Humanloop(api_key="YOUR_API_KEY", )
client.agents.patch_agent_version(id='ag_1234567890', version_id='agv_1234567890', name='teller-agent-v2', description='Updated version', )

```
</dd>
</dl>
</dd>
</dl>

#### ⚙️ Parameters

<dl>
<dd>

<dl>
<dd>

**id:** `str` — Unique identifier for Agent.
    
</dd>
</dl>

<dl>
<dd>

**version_id:** `str` — Unique identifier for the specific version of the Agent.
    
</dd>
</dl>

<dl>
<dd>

**name:** `typing.Optional[str]` — Name of the version.
    
</dd>
</dl>

<dl>
<dd>

**description:** `typing.Optional[str]` — Description of the version.
    
</dd>
</dl>

<dl>
<dd>

**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
    
</dd>
</dl>
</dd>
</dl>


</dd>
</dl>
</details>

<details><summary><code>client.agents.<a href="src/humanloop/agents/client.py">get</a>(...)</code></summary>
<dl>
<dd>

#### 📝 Description

<dl>
<dd>

<dl>
<dd>

Retrieve the Agent with the given ID.

By default, the deployed version of the Agent is returned. Use the query parameters
`version_id` or `environment` to target a specific version of the Agent.
</dd>
</dl>
</dd>
</dl>

#### 🔌 Usage

<dl>
<dd>

<dl>
<dd>

```python
from humanloop import Humanloop
client = Humanloop(api_key="YOUR_API_KEY", )
client.agents.get(id='ag_1234567890', )

```
</dd>
</dl>
</dd>
</dl>

#### ⚙️ Parameters

<dl>
<dd>

<dl>
<dd>

**id:** `str` — Unique identifier for Agent.
    
</dd>
</dl>

<dl>
<dd>

**version_id:** `typing.Optional[str]` — A specific Version ID of the Agent to retrieve.
    
</dd>
</dl>

<dl>
<dd>

**environment:** `typing.Optional[str]` — Name of the Environment to retrieve a deployed Version from.
    
</dd>
</dl>

<dl>
<dd>

**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
    
</dd>
</dl>
</dd>
</dl>


</dd>
</dl>
</details>

<details><summary><code>client.agents.<a href="src/humanloop/agents/client.py">delete</a>(...)</code></summary>
<dl>
<dd>

#### 📝 Description

<dl>
<dd>

<dl>
<dd>

Delete the Agent with the given ID.
</dd>
</dl>
</dd>
</dl>

#### 🔌 Usage

<dl>
<dd>

<dl>
<dd>

```python
from humanloop import Humanloop
client = Humanloop(api_key="YOUR_API_KEY", )
client.agents.delete(id='ag_1234567890', )

```
</dd>
</dl>
</dd>
</dl>

#### ⚙️ Parameters

<dl>
<dd>

<dl>
<dd>

**id:** `str` — Unique identifier for Agent.
    
</dd>
</dl>

<dl>
<dd>

**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
    
</dd>
</dl>
</dd>
</dl>


</dd>
</dl>
</details>

<details><summary><code>client.agents.<a href="src/humanloop/agents/client.py">move</a>(...)</code></summary>
<dl>
<dd>

#### 📝 Description

<dl>
<dd>

<dl>
<dd>

Move the Agent to a different path or change the name.
</dd>
</dl>
</dd>
</dl>

#### 🔌 Usage

<dl>
<dd>

<dl>
<dd>

```python
from humanloop import Humanloop
client = Humanloop(api_key="YOUR_API_KEY", )
client.agents.move(id='ag_1234567890', path='new directory/new name', )

```
</dd>
</dl>
</dd>
</dl>

#### ⚙️ Parameters

<dl>
<dd>

<dl>
<dd>

**id:** `str` — Unique identifier for Agent.
    
</dd>
</dl>

<dl>
<dd>

**path:** `typing.Optional[str]` — Path of the Flow including the Flow name, which is used as a unique identifier.
    
</dd>
</dl>

<dl>
<dd>

**name:** `typing.Optional[str]` — Name of the Flow.
    
</dd>
</dl>

<dl>
<dd>

**directory_id:** `typing.Optional[str]` — Unique identifier for the Directory to move Flow to. Starts with `dir_`.
    
</dd>
</dl>

<dl>
<dd>

**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
    
</dd>
</dl>
</dd>
</dl>


</dd>
</dl>
</details>

<details><summary><code>client.agents.<a href="src/humanloop/agents/client.py">list_versions</a>(...)</code></summary>
<dl>
<dd>

#### 📝 Description

<dl>
<dd>

<dl>
<dd>

Get a list of all the versions of a Agent.
</dd>
</dl>
</dd>
</dl>

#### 🔌 Usage

<dl>
<dd>

<dl>
<dd>

```python
from humanloop import Humanloop
client = Humanloop(api_key="YOUR_API_KEY", )
client.agents.list_versions(id='ag_1234567890', )

```
</dd>
</dl>
</dd>
</dl>

#### ⚙️ Parameters

<dl>
<dd>

<dl>
<dd>

**id:** `str` — Unique identifier for Agent.
    
</dd>
</dl>

<dl>
<dd>

**evaluator_aggregates:** `typing.Optional[bool]` — Whether to include Evaluator aggregate results for the versions in the response
    
</dd>
</dl>

<dl>
<dd>

**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
    
</dd>
</dl>
</dd>
</dl>


</dd>
</dl>
</details>

<details><summary><code>client.agents.<a href="src/humanloop/agents/client.py">set_deployment</a>(...)</code></summary>
<dl>
<dd>

#### 📝 Description

<dl>
<dd>

<dl>
<dd>

Deploy Agent to an Environment.

Set the deployed version for the specified Environment. This Agent
will be used for calls made to the Agent in this Environment.
</dd>
</dl>
</dd>
</dl>

#### 🔌 Usage

<dl>
<dd>

<dl>
<dd>

```python
from humanloop import Humanloop
client = Humanloop(api_key="YOUR_API_KEY", )
client.agents.set_deployment(id='id', environment_id='environment_id', version_id='version_id', )

```
</dd>
</dl>
</dd>
</dl>

#### ⚙️ Parameters

<dl>
<dd>

<dl>
<dd>

**id:** `str` — Unique identifier for Agent.
    
</dd>
</dl>

<dl>
<dd>

**environment_id:** `str` — Unique identifier for the Environment to deploy the Version to.
    
</dd>
</dl>

<dl>
<dd>

**version_id:** `str` — Unique identifier for the specific version of the Agent.
    
</dd>
</dl>

<dl>
<dd>

**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
    
</dd>
</dl>
</dd>
</dl>


</dd>
</dl>
</details>

<details><summary><code>client.agents.<a href="src/humanloop/agents/client.py">remove_deployment</a>(...)</code></summary>
<dl>
<dd>

#### 📝 Description

<dl>
<dd>

<dl>
<dd>

Remove deployed Agent from the Environment.

Remove the deployed version for the specified Environment. This Agent
will no longer be used for calls made to the Agent in this Environment.
</dd>
</dl>
</dd>
</dl>

#### 🔌 Usage

<dl>
<dd>

<dl>
<dd>

```python
from humanloop import Humanloop
client = Humanloop(api_key="YOUR_API_KEY", )
client.agents.remove_deployment(id='id', environment_id='environment_id', )

```
</dd>
</dl>
</dd>
</dl>

#### ⚙️ Parameters

<dl>
<dd>

<dl>
<dd>

**id:** `str` — Unique identifier for Agent.
    
</dd>
</dl>

<dl>
<dd>

**environment_id:** `str` — Unique identifier for the Environment to remove the deployment from.
    
</dd>
</dl>

<dl>
<dd>

**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
    
</dd>
</dl>
</dd>
</dl>


</dd>
</dl>
</details>

<details><summary><code>client.agents.<a href="src/humanloop/agents/client.py">list_environments</a>(...)</code></summary>
<dl>
<dd>

#### 📝 Description

<dl>
<dd>

<dl>
<dd>

List all Environments and their deployed versions for the Agent.
</dd>
</dl>
</dd>
</dl>

#### 🔌 Usage

<dl>
<dd>

<dl>
<dd>

```python
from humanloop import Humanloop
client = Humanloop(api_key="YOUR_API_KEY", )
client.agents.list_environments(id='ag_1234567890', )

```
</dd>
</dl>
</dd>
</dl>

#### ⚙️ Parameters

<dl>
<dd>

<dl>
<dd>

**id:** `str` — Unique identifier for Agent.
    
</dd>
</dl>

<dl>
<dd>

**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
    
</dd>
</dl>
</dd>
</dl>


</dd>
</dl>
</details>

<details><summary><code>client.agents.<a href="src/humanloop/agents/client.py">update_monitoring</a>(...)</code></summary>
<dl>
<dd>

#### 📝 Description

<dl>
<dd>

<dl>
<dd>

Activate and deactivate Evaluators for monitoring the Agent.

An activated Evaluator will automatically be run on all new Logs
within the Agent for monitoring purposes.
</dd>
</dl>
</dd>
</dl>

#### 🔌 Usage

<dl>
<dd>

<dl>
<dd>

```python
from humanloop import Humanloop
client = Humanloop(api_key="YOUR_API_KEY", )
client.agents.update_monitoring(id='ag_1234567890', activate=[{'evaluator_version_id': 'ev_1234567890'}, {'evaluator_id': 'ev_2345678901', 'environment_id': 'env_1234567890'}], deactivate=[{'evaluator_version_id': 'ev_0987654321'}], )

```
</dd>
</dl>
</dd>
</dl>

#### ⚙️ Parameters

<dl>
<dd>

<dl>
<dd>

**id:** `str` 
    
</dd>
</dl>

<dl>
<dd>

**activate:** `typing.Optional[typing.Sequence[EvaluatorActivationDeactivationRequestActivateItemParams]]` — Evaluators to activate for Monitoring. These will be automatically run on new Logs.
    
</dd>
</dl>

<dl>
<dd>

**deactivate:** `typing.Optional[typing.Sequence[EvaluatorActivationDeactivationRequestDeactivateItemParams]]` — Evaluators to deactivate. These will not be run on new Logs.
    
</dd>
</dl>

<dl>
<dd>

**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
    
</dd>
</dl>
</dd>
</dl>


</dd>
</dl>
</details>

<details><summary><code>client.agents.<a href="src/humanloop/agents/client.py">serialize</a>(...)</code></summary>
<dl>
<dd>

#### 📝 Description

<dl>
<dd>

<dl>
<dd>

Serialize an Agent to the .agent file format.

Useful for storing the Agent with your code in a version control system,
or for editing with an AI tool.

By default, the deployed version of the Agent is returned. Use the query parameters
`version_id` or `environment` to target a specific version of the Agent.
</dd>
</dl>
</dd>
</dl>

#### 🔌 Usage

<dl>
<dd>

<dl>
<dd>

```python
from humanloop import Humanloop
client = Humanloop(api_key="YOUR_API_KEY", )
client.agents.serialize(id='id', )

```
</dd>
</dl>
</dd>
</dl>

#### ⚙️ Parameters

<dl>
<dd>

<dl>
<dd>

**id:** `str` — Unique identifier for Agent.
    
</dd>
</dl>

<dl>
<dd>

**version_id:** `typing.Optional[str]` — A specific Version ID of the Agent to retrieve.
    
</dd>
</dl>

<dl>
<dd>

**environment:** `typing.Optional[str]` — Name of the Environment to retrieve a deployed Version from.
    
</dd>
</dl>

<dl>
<dd>

**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
    
</dd>
</dl>
</dd>
</dl>


</dd>
</dl>
</details>

<details><summary><code>client.agents.<a href="src/humanloop/agents/client.py">deserialize</a>(...)</code></summary>
<dl>
<dd>

#### 📝 Description

<dl>
<dd>

<dl>
<dd>

Deserialize an Agent from the .agent file format.

This returns a subset of the attributes required by an Agent.
This subset is the bit that defines the Agent version (e.g. with `model` and `temperature` etc)
</dd>
</dl>
</dd>
</dl>

#### 🔌 Usage

<dl>
<dd>

<dl>
<dd>

```python
from humanloop import Humanloop
client = Humanloop(api_key="YOUR_API_KEY", )
client.agents.deserialize(agent='agent', )

```
</dd>
</dl>
</dd>
</dl>

#### ⚙️ Parameters

<dl>
<dd>

<dl>
<dd>

**agent:** `str` 
    
</dd>
</dl>

<dl>
<dd>

**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
    
</dd>
</dl>
</dd>
</dl>


</dd>
</dl>
</details>

## Directories
<details><summary><code>client.directories.<a href="src/humanloop/directories/client.py">list</a>()</code></summary>
<dl>
<dd>

#### 📝 Description

<dl>
<dd>

<dl>
<dd>

Retrieve a list of all Directories.
</dd>
</dl>
</dd>
</dl>

#### 🔌 Usage

<dl>
<dd>

<dl>
<dd>

```python
from humanloop import Humanloop
client = Humanloop(api_key="YOUR_API_KEY", )
client.directories.list()

```
</dd>
</dl>
</dd>
</dl>

#### ⚙️ Parameters

<dl>
<dd>

<dl>
<dd>

**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
    
</dd>
</dl>
</dd>
</dl>


</dd>
</dl>
</details>

<details><summary><code>client.directories.<a href="src/humanloop/directories/client.py">create</a>(...)</code></summary>
<dl>
<dd>

#### 📝 Description

<dl>
<dd>

<dl>
<dd>

Creates a Directory.
</dd>
</dl>
</dd>
</dl>

#### 🔌 Usage

<dl>
<dd>

<dl>
<dd>

```python
from humanloop import Humanloop
client = Humanloop(api_key="YOUR_API_KEY", )
client.directories.create()

```
</dd>
</dl>
</dd>
</dl>

#### ⚙️ Parameters

<dl>
<dd>

<dl>
<dd>

**name:** `typing.Optional[str]` — Name of the directory to create.
    
</dd>
</dl>

<dl>
<dd>

**parent_id:** `typing.Optional[str]` — ID of the parent directory. Starts with `dir_`.
    
</dd>
</dl>

<dl>
<dd>

**path:** `typing.Optional[str]` — Path to create the directory in, relative to the root directory. If the path does not exist, it will be created. Includes name, e.g. `path/to/directory`.
    
</dd>
</dl>

<dl>
<dd>

**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
    
</dd>
</dl>
</dd>
</dl>


</dd>
</dl>
</details>

<details><summary><code>client.directories.<a href="src/humanloop/directories/client.py">get</a>(...)</code></summary>
<dl>
<dd>

#### 📝 Description

<dl>
<dd>

<dl>
<dd>

Fetches a directory by ID.
</dd>
</dl>
</dd>
</dl>

#### 🔌 Usage

<dl>
<dd>

<dl>
<dd>

```python
from humanloop import Humanloop
client = Humanloop(api_key="YOUR_API_KEY", )
client.directories.get(id='id', )

```
</dd>
</dl>
</dd>
</dl>

#### ⚙️ Parameters

<dl>
<dd>

<dl>
<dd>

**id:** `str` — String ID of directory. Starts with `dir_`.
    
</dd>
</dl>

<dl>
<dd>

**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
    
</dd>
</dl>
</dd>
</dl>


</dd>
</dl>
</details>

<details><summary><code>client.directories.<a href="src/humanloop/directories/client.py">delete</a>(...)</code></summary>
<dl>
<dd>

#### 📝 Description

<dl>
<dd>

<dl>
<dd>

Delete the Directory with the given ID.

The Directory must be empty (i.e. contain no Directories or Files).
</dd>
</dl>
</dd>
</dl>

#### 🔌 Usage

<dl>
<dd>

<dl>
<dd>

```python
from humanloop import Humanloop
client = Humanloop(api_key="YOUR_API_KEY", )
client.directories.delete(id='id', )

```
</dd>
</dl>
</dd>
</dl>

#### ⚙️ Parameters

<dl>
<dd>

<dl>
<dd>

**id:** `str` — Unique identifier for Directory. Starts with `dir_`.
    
</dd>
</dl>

<dl>
<dd>

**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
    
</dd>
</dl>
</dd>
</dl>


</dd>
</dl>
</details>

<details><summary><code>client.directories.<a href="src/humanloop/directories/client.py">update</a>(...)</code></summary>
<dl>
<dd>

#### 📝 Description

<dl>
<dd>

<dl>
<dd>

Update the Directory with the given ID.
</dd>
</dl>
</dd>
</dl>

#### 🔌 Usage

<dl>
<dd>

<dl>
<dd>

```python
from humanloop import Humanloop
client = Humanloop(api_key="YOUR_API_KEY", )
client.directories.update(id='id', )

```
</dd>
</dl>
</dd>
</dl>

#### ⚙️ Parameters

<dl>
<dd>

<dl>
<dd>

**id:** `str` — Unique identifier for Directory. Starts with `dir_`.
    
</dd>
</dl>

<dl>
<dd>

**name:** `typing.Optional[str]` — Name to set for the directory.
    
</dd>
</dl>

<dl>
<dd>

**parent_id:** `typing.Optional[str]` — ID of the parent directory. Specify this to move directories. Starts with `dir_`.
    
</dd>
</dl>

<dl>
<dd>

**path:** `typing.Optional[str]` — Path to move the directory to, relative to the root directory. Specify this to move directories. Includes name, e.g. `path/to/directory`.
    
</dd>
</dl>

<dl>
<dd>

**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
    
</dd>
</dl>
</dd>
</dl>


</dd>
</dl>
</details>

## Files
<details><summary><code>client.files.<a href="src/humanloop/files/client.py">list_files</a>(...)</code></summary>
<dl>
<dd>

#### 📝 Description

<dl>
<dd>

<dl>
<dd>

Get a paginated list of files.
</dd>
</dl>
</dd>
</dl>

#### 🔌 Usage

<dl>
<dd>

<dl>
<dd>

```python
from humanloop import Humanloop
client = Humanloop(api_key="YOUR_API_KEY", )
client.files.list_files()

```
</dd>
</dl>
</dd>
</dl>

#### ⚙️ Parameters

<dl>
<dd>

<dl>
<dd>

**page:** `typing.Optional[int]` — Page offset for pagination.
    
</dd>
</dl>

<dl>
<dd>

**size:** `typing.Optional[int]` — Page size for pagination. Number of files to fetch.
    
</dd>
</dl>

<dl>
<dd>

**name:** `typing.Optional[str]` — Case-insensitive filter for file name.
    
</dd>
</dl>

<dl>
<dd>

**path:** `typing.Optional[str]` — Path of the directory to filter for. Returns files in this directory and all its subdirectories.
    
</dd>
</dl>

<dl>
<dd>

**template:** `typing.Optional[bool]` — Filter to include only template files.
    
</dd>
</dl>

<dl>
<dd>

**type:** `typing.Optional[typing.Union[FileType, typing.Sequence[FileType]]]` — List of file types to filter for.
    
</dd>
</dl>

<dl>
<dd>

**environment:** `typing.Optional[str]` — Case-sensitive filter for files with a deployment in the specified environment. Requires the environment name.
    
</dd>
</dl>

<dl>
<dd>

**sort_by:** `typing.Optional[FileSortBy]` — Field to sort files by
    
</dd>
</dl>

<dl>
<dd>

**order:** `typing.Optional[SortOrder]` — Direction to sort by.
    
</dd>
</dl>

<dl>
<dd>

**include_raw_file_content:** `typing.Optional[bool]` — Whether to include the raw file content in the response. Currently only supported for Agents and Prompts.
    
</dd>
</dl>

<dl>
<dd>

**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
    
</dd>
</dl>
</dd>
</dl>


</dd>
</dl>
</details>

<details><summary><code>client.files.<a href="src/humanloop/files/client.py">retrieve_by_path</a>(...)</code></summary>
<dl>
<dd>

#### 📝 Description

<dl>
<dd>

<dl>
<dd>

Retrieve a File by path.
</dd>
</dl>
</dd>
</dl>

#### 🔌 Usage

<dl>
<dd>

<dl>
<dd>

```python
from humanloop import Humanloop
client = Humanloop(api_key="YOUR_API_KEY", )
client.files.retrieve_by_path(path='path', )

```
</dd>
</dl>
</dd>
</dl>

#### ⚙️ Parameters

<dl>
<dd>

<dl>
<dd>

**path:** `str` — Path of the File to retrieve.
    
</dd>
</dl>

<dl>
<dd>

**environment:** `typing.Optional[str]` — Name of the Environment to retrieve a deployed Version from.
    
</dd>
</dl>

<dl>
<dd>

**include_raw_file_content:** `typing.Optional[bool]` — Whether to include the raw file content in the response. Currently only supported for Agents and Prompts.
    
</dd>
</dl>

<dl>
<dd>

**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
    
</dd>
</dl>
</dd>
</dl>


</dd>
</dl>
</details>

## Evaluations
<details><summary><code>client.evaluations.<a href="src/humanloop/evaluations/client.py">list</a>(...)</code></summary>
<dl>
<dd>

#### 📝 Description

<dl>
<dd>

<dl>
<dd>

Retrieve a list of Evaluations for the specified File.
</dd>
</dl>
</dd>
</dl>

#### 🔌 Usage

<dl>
<dd>

<dl>
<dd>

```python
from humanloop import Humanloop
client = Humanloop(api_key="YOUR_API_KEY", )
response = client.evaluations.list(file_id='pr_30gco7dx6JDq4200GVOHa', size=1, )
for item in response:
    yield item
# alternatively, you can paginate page-by-page
for page in response.iter_pages():
    yield page

```
</dd>
</dl>
</dd>
</dl>

#### ⚙️ Parameters

<dl>
<dd>

<dl>
<dd>

**file_id:** `str` — Filter by File ID. Only Evaluations for the specified File will be returned.
    
</dd>
</dl>

<dl>
<dd>

**page:** `typing.Optional[int]` — Page number for pagination.
    
</dd>
</dl>

<dl>
<dd>

**size:** `typing.Optional[int]` — Page size for pagination. Number of Evaluations to fetch.
    
</dd>
</dl>

<dl>
<dd>

**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
    
</dd>
</dl>
</dd>
</dl>


</dd>
</dl>
</details>

<details><summary><code>client.evaluations.<a href="src/humanloop/evaluations/client.py">create</a>(...)</code></summary>
<dl>
<dd>

#### 📝 Description

<dl>
<dd>

<dl>
<dd>

Create an Evaluation.

Create a new Evaluation by specifying the File to evaluate, and a name
for the Evaluation.
You can then add Runs to this Evaluation using the `POST /evaluations/{id}/runs` endpoint.
</dd>
</dl>
</dd>
</dl>

#### 🔌 Usage

<dl>
<dd>

<dl>
<dd>

```python
from humanloop import Humanloop
client = Humanloop(api_key="YOUR_API_KEY", )
client.evaluations.create(evaluators=[{'version_id': 'version_id'}], )

```
</dd>
</dl>
</dd>
</dl>

#### ⚙️ Parameters

<dl>
<dd>

<dl>
<dd>

**evaluators:** `typing.Sequence[CreateEvaluationRequestEvaluatorsItemParams]` — The Evaluators used to evaluate.
    
</dd>
</dl>

<dl>
<dd>

**file:** `typing.Optional[FileRequestParams]` — The File to associate with the Evaluation. This File contains the Logs you're evaluating.
    
</dd>
</dl>

<dl>
<dd>

**name:** `typing.Optional[str]` — Name of the Evaluation to help identify it. Must be unique within the associated File.
    
</dd>
</dl>

<dl>
<dd>

**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
    
</dd>
</dl>
</dd>
</dl>


</dd>
</dl>
</details>

<details><summary><code>client.evaluations.<a href="src/humanloop/evaluations/client.py">add_evaluators</a>(...)</code></summary>
<dl>
<dd>

#### 📝 Description

<dl>
<dd>

<dl>
<dd>

Add Evaluators to an Evaluation.

The Evaluators will be run on the Logs generated for the Evaluation.
</dd>
</dl>
</dd>
</dl>

#### 🔌 Usage

<dl>
<dd>

<dl>
<dd>

```python
from humanloop import Humanloop
client = Humanloop(api_key="YOUR_API_KEY", )
client.evaluations.add_evaluators(id='id', evaluators=[{'version_id': 'version_id'}], )

```
</dd>
</dl>
</dd>
</dl>

#### ⚙️ Parameters

<dl>
<dd>

<dl>
<dd>

**id:** `str` — Unique identifier for Evaluation.
    
</dd>
</dl>

<dl>
<dd>

**evaluators:** `typing.Sequence[AddEvaluatorsRequestEvaluatorsItemParams]` — The Evaluators to add to this Evaluation.
    
</dd>
</dl>

<dl>
<dd>

**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
    
</dd>
</dl>
</dd>
</dl>


</dd>
</dl>
</details>

<details><summary><code>client.evaluations.<a href="src/humanloop/evaluations/client.py">remove_evaluator</a>(...)</code></summary>
<dl>
<dd>

#### 📝 Description

<dl>
<dd>

<dl>
<dd>

Remove an Evaluator from an Evaluation.

The Evaluator will no longer be run on the Logs in the Evaluation.
</dd>
</dl>
</dd>
</dl>

#### 🔌 Usage

<dl>
<dd>

<dl>
<dd>

```python
from humanloop import Humanloop
client = Humanloop(api_key="YOUR_API_KEY", )
client.evaluations.remove_evaluator(id='id', evaluator_version_id='evaluator_version_id', )

```
</dd>
</dl>
</dd>
</dl>

#### ⚙️ Parameters

<dl>
<dd>

<dl>
<dd>

**id:** `str` — Unique identifier for Evaluation.
    
</dd>
</dl>

<dl>
<dd>

**evaluator_version_id:** `str` — Unique identifier for Evaluator Version.
    
</dd>
</dl>

<dl>
<dd>

**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
    
</dd>
</dl>
</dd>
</dl>


</dd>
</dl>
</details>

<details><summary><code>client.evaluations.<a href="src/humanloop/evaluations/client.py">get</a>(...)</code></summary>
<dl>
<dd>

#### 📝 Description

<dl>
<dd>

<dl>
<dd>

Get an Evaluation.

This includes the Evaluators associated with the Evaluation and metadata about the Evaluation,
such as its name.

To get the Runs associated with the Evaluation, use the `GET /evaluations/{id}/runs` endpoint.
To retrieve stats for the Evaluation, use the `GET /evaluations/{id}/stats` endpoint.
</dd>
</dl>
</dd>
</dl>

#### 🔌 Usage

<dl>
<dd>

<dl>
<dd>

```python
from humanloop import Humanloop
client = Humanloop(api_key="YOUR_API_KEY", )
client.evaluations.get(id='ev_567yza', )

```
</dd>
</dl>
</dd>
</dl>

#### ⚙️ Parameters

<dl>
<dd>

<dl>
<dd>

**id:** `str` — Unique identifier for Evaluation.
    
</dd>
</dl>

<dl>
<dd>

**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
    
</dd>
</dl>
</dd>
</dl>


</dd>
</dl>
</details>

<details><summary><code>client.evaluations.<a href="src/humanloop/evaluations/client.py">delete</a>(...)</code></summary>
<dl>
<dd>

#### 📝 Description

<dl>
<dd>

<dl>
<dd>

Delete an Evaluation.

The Runs and Evaluators in the Evaluation will not be deleted.
</dd>
</dl>
</dd>
</dl>

#### 🔌 Usage

<dl>
<dd>

<dl>
<dd>

```python
from humanloop import Humanloop
client = Humanloop(api_key="YOUR_API_KEY", )
client.evaluations.delete(id='ev_567yza', )

```
</dd>
</dl>
</dd>
</dl>

#### ⚙️ Parameters

<dl>
<dd>

<dl>
<dd>

**id:** `str` — Unique identifier for Evaluation.
    
</dd>
</dl>

<dl>
<dd>

**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
    
</dd>
</dl>
</dd>
</dl>


</dd>
</dl>
</details>

<details><summary><code>client.evaluations.<a href="src/humanloop/evaluations/client.py">list_runs_for_evaluation</a>(...)</code></summary>
<dl>
<dd>

#### 📝 Description

<dl>
<dd>

<dl>
<dd>

List all Runs for an Evaluation.
</dd>
</dl>
</dd>
</dl>

#### 🔌 Usage

<dl>
<dd>

<dl>
<dd>

```python
from humanloop import Humanloop
client = Humanloop(api_key="YOUR_API_KEY", )
client.evaluations.list_runs_for_evaluation(id='id', )

```
</dd>
</dl>
</dd>
</dl>

#### ⚙️ Parameters

<dl>
<dd>

<dl>
<dd>

**id:** `str` — Unique identifier for Evaluation.
    
</dd>
</dl>

<dl>
<dd>

**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
    
</dd>
</dl>
</dd>
</dl>


</dd>
</dl>
</details>

<details><summary><code>client.evaluations.<a href="src/humanloop/evaluations/client.py">create_run</a>(...)</code></summary>
<dl>
<dd>

#### 📝 Description

<dl>
<dd>

<dl>
<dd>

Create an Evaluation Run.

Optionally specify the Dataset and version to be evaluated.

Humanloop will automatically start generating Logs and running Evaluators where
`orchestrated=true`. If you are generating Logs yourself, you can set `orchestrated=false`
and then generate and submit the required Logs via the API.

If `dataset` and `version` are provided, you can set `use_existing_logs=True` to reuse existing Logs,
avoiding generating new Logs unnecessarily. Logs that are associated with the specified Version and have `source_datapoint_id`
referencing a datapoint in the specified Dataset will be associated with the Run.

To keep updated on the progress of the Run, you can poll the Run using
the `GET /evaluations/{id}/runs` endpoint and check its status.
</dd>
</dl>
</dd>
</dl>

#### 🔌 Usage

<dl>
<dd>

<dl>
<dd>

```python
from humanloop import Humanloop
client = Humanloop(api_key="YOUR_API_KEY", )
client.evaluations.create_run(id='id', )

```
</dd>
</dl>
</dd>
</dl>

#### ⚙️ Parameters

<dl>
<dd>

<dl>
<dd>

**id:** `str` — Unique identifier for Evaluation.
    
</dd>
</dl>

<dl>
<dd>

**dataset:** `typing.Optional[CreateRunRequestDatasetParams]` — Dataset to use in this Run.
    
</dd>
</dl>

<dl>
<dd>

**version:** `typing.Optional[CreateRunRequestVersionParams]` — Version to use in this Run.
    
</dd>
</dl>

<dl>
<dd>

**orchestrated:** `typing.Optional[bool]` — Whether the Run is orchestrated by Humanloop. If `True`, Humanloop will generate Logs for the Run; `dataset` and `version` must be provided. If `False`, a log for the Prompt/Tool should be submitted by the user via the API.
    
</dd>
</dl>

<dl>
<dd>

**use_existing_logs:** `typing.Optional[bool]` — If `True`, the Run will be initialized with existing Logs associated with the Dataset and Version. If `False`, the Run will be initialized with no Logs. Can only be set to `True` when both `dataset` and `version` are provided.
    
</dd>
</dl>

<dl>
<dd>

**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
    
</dd>
</dl>
</dd>
</dl>


</dd>
</dl>
</details>

<details><summary><code>client.evaluations.<a href="src/humanloop/evaluations/client.py">add_existing_run</a>(...)</code></summary>
<dl>
<dd>

#### 📝 Description

<dl>
<dd>

<dl>
<dd>

Add an existing Run to the specified Evaluation.

This is useful if you want to compare the Runs in this Evaluation with an existing Run
that exists within another Evaluation.
</dd>
</dl>
</dd>
</dl>

#### 🔌 Usage

<dl>
<dd>

<dl>
<dd>

```python
from humanloop import Humanloop
client = Humanloop(api_key="YOUR_API_KEY", )
client.evaluations.add_existing_run(id='id', run_id='run_id', )

```
</dd>
</dl>
</dd>
</dl>

#### ⚙️ Parameters

<dl>
<dd>

<dl>
<dd>

**id:** `str` — Unique identifier for Evaluation.
    
</dd>
</dl>

<dl>
<dd>

**run_id:** `str` — Unique identifier for Run.
    
</dd>
</dl>

<dl>
<dd>

**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
    
</dd>
</dl>
</dd>
</dl>


</dd>
</dl>
</details>

<details><summary><code>client.evaluations.<a href="src/humanloop/evaluations/client.py">remove_run</a>(...)</code></summary>
<dl>
<dd>

#### 📝 Description

<dl>
<dd>

<dl>
<dd>

Remove a Run from an Evaluation.

The Logs and Versions used in the Run will not be deleted.
If this Run is used in any other Evaluations, it will still be available in those Evaluations.
</dd>
</dl>
</dd>
</dl>

#### 🔌 Usage

<dl>
<dd>

<dl>
<dd>

```python
from humanloop import Humanloop
client = Humanloop(api_key="YOUR_API_KEY", )
client.evaluations.remove_run(id='id', run_id='run_id', )

```
</dd>
</dl>
</dd>
</dl>

#### ⚙️ Parameters

<dl>
<dd>

<dl>
<dd>

**id:** `str` — Unique identifier for Evaluation.
    
</dd>
</dl>

<dl>
<dd>

**run_id:** `str` — Unique identifier for Run.
    
</dd>
</dl>

<dl>
<dd>

**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
    
</dd>
</dl>
</dd>
</dl>


</dd>
</dl>
</details>

<details><summary><code>client.evaluations.<a href="src/humanloop/evaluations/client.py">update_evaluation_run</a>(...)</code></summary>
<dl>
<dd>

#### 📝 Description

<dl>
<dd>

<dl>
<dd>

Update an Evaluation Run.

Specify `control=true` to use this Run as the control Run for the Evaluation.
You can cancel a running/pending Run, or mark a Run that uses external or human Evaluators as completed.
</dd>
</dl>
</dd>
</dl>

#### 🔌 Usage

<dl>
<dd>

<dl>
<dd>

```python
from humanloop import Humanloop
client = Humanloop(api_key="YOUR_API_KEY", )
client.evaluations.update_evaluation_run(id='id', run_id='run_id', )

```
</dd>
</dl>
</dd>
</dl>

#### ⚙️ Parameters

<dl>
<dd>

<dl>
<dd>

**id:** `str` — Unique identifier for Evaluation.
    
</dd>
</dl>

<dl>
<dd>

**run_id:** `str` — Unique identifier for Run.
    
</dd>
</dl>

<dl>
<dd>

**control:** `typing.Optional[bool]` — If `True`, this Run will be used as the control in the Evaluation. Stats for other Runs will be compared to this Run. This will replace any existing control Run.
    
</dd>
</dl>

<dl>
<dd>

**status:** `typing.Optional[EvaluationStatus]` — Used to set the Run to `cancelled` or `completed`. Can only be used if the Run is currently `pending` or `running`.
    
</dd>
</dl>

<dl>
<dd>

**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
    
</dd>
</dl>
</dd>
</dl>


</dd>
</dl>
</details>

<details><summary><code>client.evaluations.<a href="src/humanloop/evaluations/client.py">add_logs_to_run</a>(...)</code></summary>
<dl>
<dd>

#### 📝 Description

<dl>
<dd>

<dl>
<dd>

Add the specified Logs to a Run.
</dd>
</dl>
</dd>
</dl>

#### 🔌 Usage

<dl>
<dd>

<dl>
<dd>

```python
from humanloop import Humanloop
client = Humanloop(api_key="YOUR_API_KEY", )
client.evaluations.add_logs_to_run(id='id', run_id='run_id', log_ids=['log_ids'], )

```
</dd>
</dl>
</dd>
</dl>

#### ⚙️ Parameters

<dl>
<dd>

<dl>
<dd>

**id:** `str` — Unique identifier for Evaluation.
    
</dd>
</dl>

<dl>
<dd>

**run_id:** `str` — Unique identifier for Run.
    
</dd>
</dl>

<dl>
<dd>

**log_ids:** `typing.Sequence[str]` — The IDs of the Logs to add to the Run.
    
</dd>
</dl>

<dl>
<dd>

**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
    
</dd>
</dl>
</dd>
</dl>


</dd>
</dl>
</details>

<details><summary><code>client.evaluations.<a href="src/humanloop/evaluations/client.py">get_stats</a>(...)</code></summary>
<dl>
<dd>

#### 📝 Description

<dl>
<dd>

<dl>
<dd>

Get Evaluation Stats.

Retrieve aggregate stats for the specified Evaluation. This includes the number of generated Logs for each Run and the
corresponding Evaluator statistics (such as the mean and percentiles).
</dd>
</dl>
</dd>
</dl>

#### 🔌 Usage

<dl>
<dd>

<dl>
<dd>

```python
from humanloop import Humanloop
client = Humanloop(api_key="YOUR_API_KEY", )
client.evaluations.get_stats(id='id', )

```
</dd>
</dl>
</dd>
</dl>

#### ⚙️ Parameters

<dl>
<dd>

<dl>
<dd>

**id:** `str` — Unique identifier for Evaluation.
    
</dd>
</dl>

<dl>
<dd>

**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
    
</dd>
</dl>
</dd>
</dl>


</dd>
</dl>
</details>

<details><summary><code>client.evaluations.<a href="src/humanloop/evaluations/client.py">get_logs</a>(...)</code></summary>
<dl>
<dd>

#### 📝 Description

<dl>
<dd>

<dl>
<dd>

Get the Logs associated to a specific Evaluation.

This returns the Logs associated to all Runs within with the Evaluation.
</dd>
</dl>
</dd>
</dl>

#### 🔌 Usage

<dl>
<dd>

<dl>
<dd>

```python
from humanloop import Humanloop
client = Humanloop(api_key="YOUR_API_KEY", )
client.evaluations.get_logs(id='id', )

```
</dd>
</dl>
</dd>
</dl>

#### ⚙️ Parameters

<dl>
<dd>

<dl>
<dd>

**id:** `str` — String ID of evaluation. Starts with `ev_` or `evr_`.
    
</dd>
</dl>

<dl>
<dd>

**page:** `typing.Optional[int]` — Page number for pagination.
    
</dd>
</dl>

<dl>
<dd>

**size:** `typing.Optional[int]` — Page size for pagination. Number of Logs to fetch.
    
</dd>
</dl>

<dl>
<dd>

**run_id:** `typing.Optional[typing.Union[str, typing.Sequence[str]]]` — Filter by Run IDs. Only Logs for the specified Runs will be returned.
    
</dd>
</dl>

<dl>
<dd>

**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
    
</dd>
</dl>
</dd>
</dl>


</dd>
</dl>
</details>

## Logs
<details><summary><code>client.logs.<a href="src/humanloop/logs/client.py">list</a>(...)</code></summary>
<dl>
<dd>

#### 📝 Description

<dl>
<dd>

<dl>
<dd>

List all Logs for the given filter criteria.
</dd>
</dl>
</dd>
</dl>

#### 🔌 Usage

<dl>
<dd>

<dl>
<dd>

```python
from humanloop import Humanloop
client = Humanloop(api_key="YOUR_API_KEY", )
response = client.logs.list(file_id='file_123abc', size=1, )
for item in response:
    yield item
# alternatively, you can paginate page-by-page
for page in response.iter_pages():
    yield page

```
</dd>
</dl>
</dd>
</dl>

#### ⚙️ Parameters

<dl>
<dd>

<dl>
<dd>

**file_id:** `str` — Unique identifier for the File to list Logs for.
    
</dd>
</dl>

<dl>
<dd>

**page:** `typing.Optional[int]` — Page number for pagination.
    
</dd>
</dl>

<dl>
<dd>

**size:** `typing.Optional[int]` — Page size for pagination. Number of Logs to fetch.
    
</dd>
</dl>

<dl>
<dd>

**version_id:** `typing.Optional[str]` — If provided, only Logs belonging to the specified Version will be returned.
    
</dd>
</dl>

<dl>
<dd>

**id:** `typing.Optional[typing.Union[str, typing.Sequence[str]]]` — If provided, returns Logs whose IDs contain any of the specified values as substrings.
    
</dd>
</dl>

<dl>
<dd>

**search:** `typing.Optional[str]` — If provided, only Logs that contain the provided string in its inputs and output will be returned.
    
</dd>
</dl>

<dl>
<dd>

**metadata_search:** `typing.Optional[str]` — If provided, only Logs that contain the provided string in its metadata will be returned.
    
</dd>
</dl>

<dl>
<dd>

**start_date:** `typing.Optional[dt.datetime]` — If provided, only Logs created after the specified date will be returned.
    
</dd>
</dl>

<dl>
<dd>

**end_date:** `typing.Optional[dt.datetime]` — If provided, only Logs created before the specified date will be returned.
    
</dd>
</dl>

<dl>
<dd>

**include_parent:** `typing.Optional[bool]` — If true, include the full parent Log in the response. Only applicable when retrieving Evaluator Logs.
    
</dd>
</dl>

<dl>
<dd>

**in_trace_filter:** `typing.Optional[typing.Union[bool, typing.Sequence[bool]]]` — If true, return Logs that are associated to a Trace. False, return Logs that are not associated to a Trace.
    
</dd>
</dl>

<dl>
<dd>

**sample:** `typing.Optional[int]` — If provided, limit the response to a random subset of logs from the filtered results. (This will be an approximate sample, not a strict limit.)
    
</dd>
</dl>

<dl>
<dd>

**include_trace_children:** `typing.Optional[bool]` — If true, populate `trace_children` for the retrieved Logs. Only applicable when retrieving Flow or Agent Logs.
    
</dd>
</dl>

<dl>
<dd>

**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
    
</dd>
</dl>
</dd>
</dl>


</dd>
</dl>
</details>

<details><summary><code>client.logs.<a href="src/humanloop/logs/client.py">delete</a>(...)</code></summary>
<dl>
<dd>

#### 📝 Description

<dl>
<dd>

<dl>
<dd>

Delete Logs with the given IDs.
</dd>
</dl>
</dd>
</dl>

#### 🔌 Usage

<dl>
<dd>

<dl>
<dd>

```python
from humanloop import Humanloop
client = Humanloop(api_key="YOUR_API_KEY", )
client.logs.delete(id='prv_Wu6zx1lAWJRqOyL8nWuZk', )

```
</dd>
</dl>
</dd>
</dl>

#### ⚙️ Parameters

<dl>
<dd>

<dl>
<dd>

**id:** `typing.Optional[typing.Union[str, typing.Sequence[str]]]` — Unique identifiers for the Logs to delete.
    
</dd>
</dl>

<dl>
<dd>

**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
    
</dd>
</dl>
</dd>
</dl>


</dd>
</dl>
</details>

<details><summary><code>client.logs.<a href="src/humanloop/logs/client.py">get</a>(...)</code></summary>
<dl>
<dd>

#### 📝 Description

<dl>
<dd>

<dl>
<dd>

Retrieve the Log with the given ID.
</dd>
</dl>
</dd>
</dl>

#### 🔌 Usage

<dl>
<dd>

<dl>
<dd>

```python
from humanloop import Humanloop
client = Humanloop(api_key="YOUR_API_KEY", )
client.logs.get(id='prv_Wu6zx1lAWJRqOyL8nWuZk', )

```
</dd>
</dl>
</dd>
</dl>

#### ⚙️ Parameters

<dl>
<dd>

<dl>
<dd>

**id:** `str` — Unique identifier for Log.
    
</dd>
</dl>

<dl>
<dd>

**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
    
</dd>
</dl>
</dd>
</dl>


</dd>
</dl>
</details>