langfuse_client_base/models/prompt_variable_mapping_read.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/// PromptVariableMappingRead : Connects one prompt variable to source data. `source` is `null` when the mapping is incomplete.
15#[derive(Clone, Default, Debug, PartialEq, Serialize, Deserialize, bon::Builder)]
16pub struct PromptVariableMappingRead {
17 /// Prompt variable name without braces.
18 #[serde(rename = "variable")]
19 pub variable: String,
20 /// Stored source field populating the variable, or `null` when the mapping is incomplete.
21 #[serde(rename = "source", deserialize_with = "Option::deserialize")]
22 pub source: Option<String>,
23 /// Optional JSONPath selector applied to the selected source.
24 #[serde(
25 rename = "jsonPath",
26 default,
27 with = "::serde_with::rust::double_option",
28 skip_serializing_if = "Option::is_none"
29 )]
30 pub json_path: Option<Option<String>>,
31}
32
33impl PromptVariableMappingRead {
34 /// Connects one prompt variable to source data. `source` is `null` when the mapping is incomplete.
35 pub fn new(variable: String, source: Option<String>) -> PromptVariableMappingRead {
36 PromptVariableMappingRead {
37 variable,
38 source,
39 json_path: None,
40 }
41 }
42}