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
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81

/*
 * 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};

/// GetMediaUploadUrlRequest : Request a presigned media upload URL. Provide exactly one context: a trace (traceId, optionally observationId) or a dataset item (datasetId + datasetItemId). field is required and must match the chosen context.
#[derive(Clone, Default, Debug, PartialEq, Serialize, Deserialize, bon::Builder)]
pub struct GetMediaUploadUrlRequest {
    /// The trace the media is associated with. Null for dataset item media uploads.
    #[serde(
        rename = "traceId",
        default,
        with = "::serde_with::rust::double_option",
        skip_serializing_if = "Option::is_none"
    )]
    pub trace_id: Option<Option<String>>,
    /// The observation ID associated with the media record. If the media record is associated directly with a trace, this will be null.
    #[serde(
        rename = "observationId",
        default,
        with = "::serde_with::rust::double_option",
        skip_serializing_if = "Option::is_none"
    )]
    pub observation_id: Option<Option<String>>,
    /// The dataset the media belongs to. Null for trace/observation media uploads.
    #[serde(
        rename = "datasetId",
        default,
        with = "::serde_with::rust::double_option",
        skip_serializing_if = "Option::is_none"
    )]
    pub dataset_id: Option<Option<String>>,
    /// The dataset item the media is associated with (need not exist yet). Null for trace/observation media uploads.
    #[serde(
        rename = "datasetItemId",
        default,
        with = "::serde_with::rust::double_option",
        skip_serializing_if = "Option::is_none"
    )]
    pub dataset_item_id: Option<Option<String>>,
    #[serde(rename = "contentType")]
    pub content_type: models::MediaContentType,
    /// The size of the media record in bytes
    #[serde(rename = "contentLength")]
    pub content_length: i32,
    /// The SHA-256 hash of the media record
    #[serde(rename = "sha256Hash")]
    pub sha256_hash: String,
    /// The item field the media is in: `input`/`output`/`metadata` (trace) or `input`/`expectedOutput`/`metadata` (dataset item).
    #[serde(rename = "field")]
    pub field: String,
}

impl GetMediaUploadUrlRequest {
    /// Request a presigned media upload URL. Provide exactly one context: a trace (traceId, optionally observationId) or a dataset item (datasetId + datasetItemId). field is required and must match the chosen context.
    pub fn new(
        content_type: models::MediaContentType,
        content_length: i32,
        sha256_hash: String,
        field: String,
    ) -> GetMediaUploadUrlRequest {
        GetMediaUploadUrlRequest {
            trace_id: None,
            observation_id: None,
            dataset_id: None,
            dataset_item_id: None,
            content_type,
            content_length,
            sha256_hash,
            field,
        }
    }
}