Skip to main content

langfuse_client_base/models/
submit_feedback_request.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#[derive(Clone, Default, Debug, PartialEq, Serialize, Deserialize, bon::Builder)]
15pub struct SubmitFeedbackRequest {
16    #[serde(rename = "targetType")]
17    pub target_type: models::FeedbackTargetType,
18    /// The specific instance within targetType: the skill name, MCP tool name, CLI command, API endpoint path, or docs page path (e.g. 'queryMetrics', '/docs/mcp'). An identifier, not a sentence. Must be between 1 and 200 characters.
19    #[serde(rename = "target")]
20    pub target: String,
21    /// Concise feedback text approved by the user. Must be between 1 and 3000 characters.
22    #[serde(rename = "feedback")]
23    pub feedback: String,
24    /// Optional user-approved goal or use case they were trying to achieve. Must be between 1 and 1500 characters when provided. Do not include secrets, customer data, trace payloads, or broad unrelated context.
25    #[serde(
26        rename = "goal",
27        default,
28        with = "::serde_with::rust::double_option",
29        skip_serializing_if = "Option::is_none"
30    )]
31    pub goal: Option<Option<String>>,
32    /// Optional HTTP(S) reference URL. Langfuse stores it as text for triage and does not fetch it.
33    #[serde(
34        rename = "referenceUrl",
35        default,
36        with = "::serde_with::rust::double_option",
37        skip_serializing_if = "Option::is_none"
38    )]
39    pub reference_url: Option<Option<String>>,
40}
41
42impl SubmitFeedbackRequest {
43    pub fn new(
44        target_type: models::FeedbackTargetType,
45        target: String,
46        feedback: String,
47    ) -> SubmitFeedbackRequest {
48        SubmitFeedbackRequest {
49            target_type,
50            target,
51            feedback,
52            goal: None,
53            reference_url: None,
54        }
55    }
56}