langfuse_client_base/models/
prompt_variable_mapping_input.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/// PromptVariableMappingInput : Connects one prompt variable to data from an observation or experiment.  Manual mappings are used for `llm_as_judge` evaluators. `code` evaluators use a fixed runtime mapping managed by Langfuse.  How to build a valid mapping list: 1. Create the evaluator or fetch it with `GET /evaluators/{id}`. 2. Read the evaluator `variables` array. 3. Add exactly one mapping object for each variable in that array. 4. Use the variable name exactly as returned, without braces such as `{{` or `}}`. 5. Choose the source field that should populate the variable.  `jsonPath` is optional. Use it only when the selected source is a JSON object and you want to extract one nested field before inserting it into the evaluator prompt.  Invalid, missing, or duplicate mappings return a validation error. Malformed JSONPath expressions are also rejected.
15#[derive(Clone, Default, Debug, PartialEq, Serialize, Deserialize, bon::Builder)]
16pub struct PromptVariableMappingInput {
17    /// Prompt variable name without braces.  Example: for the prompt `Judge {{input}} against {{output}}`, use `input` and `output`.
18    #[serde(rename = "variable")]
19    pub variable: String,
20    #[serde(rename = "source")]
21    pub source: models::PromptVariableMappingSource,
22    /// Optional JSONPath selector applied to the selected source before it is passed to the evaluator prompt.  Requirements: - Must start with `$` - Must be a syntactically valid JSONPath expression - Most useful with `source=metadata`
23    #[serde(
24        rename = "jsonPath",
25        default,
26        with = "::serde_with::rust::double_option",
27        skip_serializing_if = "Option::is_none"
28    )]
29    pub json_path: Option<Option<String>>,
30}
31
32impl PromptVariableMappingInput {
33    /// Connects one prompt variable to data from an observation or experiment.  Manual mappings are used for `llm_as_judge` evaluators. `code` evaluators use a fixed runtime mapping managed by Langfuse.  How to build a valid mapping list: 1. Create the evaluator or fetch it with `GET /evaluators/{id}`. 2. Read the evaluator `variables` array. 3. Add exactly one mapping object for each variable in that array. 4. Use the variable name exactly as returned, without braces such as `{{` or `}}`. 5. Choose the source field that should populate the variable.  `jsonPath` is optional. Use it only when the selected source is a JSON object and you want to extract one nested field before inserting it into the evaluator prompt.  Invalid, missing, or duplicate mappings return a validation error. Malformed JSONPath expressions are also rejected.
34    pub fn new(
35        variable: String,
36        source: models::PromptVariableMappingSource,
37    ) -> PromptVariableMappingInput {
38        PromptVariableMappingInput {
39            variable,
40            source,
41            json_path: None,
42        }
43    }
44}
langfuse_client_base/models/prompt_variable_mapping_input.rs

langfuse_client_base/models/
prompt_variable_mapping_input.rs
