langfuse_client_base/models/prompt_variable_mapping_source.rs
1/*
2 * server
3 *
4 * ## Real-time data The only real-time path to get tracing data is to ingest via OpenTelemetry (`POST /api/public/otel/v1/traces`) and retrieve via Observations API v2 (`GET /api/public/v2/observations`) and Metrics API v2 (`GET /api/public/v2/metrics`). Other public API write and read endpoints can delay data by about 10 minutes. Direct OpenTelemetry exporters must send the `x-langfuse-ingestion-version: 4` header; current Python and JS SDKs already do. See the [Public API docs](https://langfuse.com/docs/api-and-data-platform/features/public-api) and [real-time ingestion](https://langfuse.com/integrations/native/opentelemetry.md#real-time-ingestion). ## Authentication Authenticate with the API using [Basic Auth](https://en.wikipedia.org/wiki/Basic_access_authentication), get API keys in the project settings: - username: Langfuse Public Key - password: Langfuse Secret Key ## Exports - OpenAPI spec: https://cloud.langfuse.com/generated/api/openapi.yml - Self-hosted deployments: interactive API reference at `/api/docs` and OpenAPI spec at `/api/openapi.yaml`
5 *
6 * The version of the OpenAPI document:
7 *
8 * Generated by: https://openapi-generator.tech
9 */
10
11use crate::models;
12use serde::{Deserialize, Serialize};
13
14/// PromptVariableMappingSource : Source field used to populate a prompt variable. Use these values when mapping evaluator prompt variables to live data. Source semantics: - `input`: the observation input payload - `output`: the observation output payload - `metadata`: the observation metadata object. Combine with `jsonPath` when you need one nested field instead of the whole object. - `tool_calls`: the tool calls recorded on the observation, as an array of `{id, name, arguments, type, index}` objects in the order the model emitted them. Combine with `jsonPath` (for example `$[*].name`) to select parts of each call. - `expected_output`: the experiment item's expected output when the observation belongs to an experiment. - `experiment_item_metadata`: the experiment item's metadata when the observation belongs to an experiment.
15/// Source field used to populate a prompt variable. Use these values when mapping evaluator prompt variables to live data. Source semantics: - `input`: the observation input payload - `output`: the observation output payload - `metadata`: the observation metadata object. Combine with `jsonPath` when you need one nested field instead of the whole object. - `tool_calls`: the tool calls recorded on the observation, as an array of `{id, name, arguments, type, index}` objects in the order the model emitted them. Combine with `jsonPath` (for example `$[*].name`) to select parts of each call. - `expected_output`: the experiment item's expected output when the observation belongs to an experiment. - `experiment_item_metadata`: the experiment item's metadata when the observation belongs to an experiment.
16#[derive(Clone, Copy, Debug, Eq, PartialEq, Ord, PartialOrd, Hash, Serialize, Deserialize)]
17pub enum PromptVariableMappingSource {
18 #[serde(rename = "input")]
19 Input,
20 #[serde(rename = "output")]
21 Output,
22 #[serde(rename = "metadata")]
23 Metadata,
24 #[serde(rename = "tool_calls")]
25 ToolCalls,
26 #[serde(rename = "expected_output")]
27 ExpectedOutput,
28 #[serde(rename = "experiment_item_metadata")]
29 ExperimentItemMetadata,
30}
31
32impl std::fmt::Display for PromptVariableMappingSource {
33 fn fmt(&self, f: &mut std::fmt::Formatter) -> std::fmt::Result {
34 match self {
35 Self::Input => write!(f, "input"),
36 Self::Output => write!(f, "output"),
37 Self::Metadata => write!(f, "metadata"),
38 Self::ToolCalls => write!(f, "tool_calls"),
39 Self::ExpectedOutput => write!(f, "expected_output"),
40 Self::ExperimentItemMetadata => write!(f, "experiment_item_metadata"),
41 }
42 }
43}
44
45impl Default for PromptVariableMappingSource {
46 fn default() -> PromptVariableMappingSource {
47 Self::Input
48 }
49}