langfuse-client-base 0.15.0

Auto-generated Langfuse API client from OpenAPI specification
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62

/*
 * server
 *
 * ## 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`
 *
 * The version of the OpenAPI document:
 *
 * Generated by: https://openapi-generator.tech
 */

use crate::models;
use serde::{Deserialize, Serialize};

#[derive(Clone, Default, Debug, PartialEq, Serialize, Deserialize, bon::Builder)]
pub struct CreateCommentRequest {
    /// The id of the project to attach the comment to.
    #[serde(rename = "projectId")]
    pub project_id: String,
    /// The type of the object to attach the comment to (trace, observation, session, prompt).
    #[serde(rename = "objectType")]
    pub object_type: String,
    /// The id of the object to attach the comment to. If this does not reference a valid existing object, an error will be thrown.
    #[serde(rename = "objectId")]
    pub object_id: String,
    /// The content of the comment. May include markdown. Currently limited to 5000 characters.
    #[serde(rename = "content")]
    pub content: String,
    /// The id of the user who created the comment. Must be a member of the organization that owns the project, otherwise an error will be thrown.
    #[serde(
        rename = "authorUserId",
        default,
        with = "::serde_with::rust::double_option",
        skip_serializing_if = "Option::is_none"
    )]
    pub author_user_id: Option<Option<String>>,
    /// The start time of the referenced object (for observations, the observation's start time). Optional performance hint - when provided, Langfuse narrows the lookup to validate the reference faster. It only affects speed - an incorrect or omitted value never changes the result.
    #[serde(
        rename = "objectStartTime",
        default,
        with = "::serde_with::rust::double_option",
        skip_serializing_if = "Option::is_none"
    )]
    pub object_start_time: Option<Option<chrono::DateTime<chrono::FixedOffset>>>,
}

impl CreateCommentRequest {
    pub fn new(
        project_id: String,
        object_type: String,
        object_id: String,
        content: String,
    ) -> CreateCommentRequest {
        CreateCommentRequest {
            project_id,
            object_type,
            object_id,
            content,
            author_user_id: None,
            object_start_time: None,
        }
    }
}