Skip to main content

langfuse_client_base/models/
create_dataset_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 CreateDatasetRequest {
16    #[serde(rename = "name")]
17    pub name: String,
18    #[serde(
19        rename = "description",
20        default,
21        with = "::serde_with::rust::double_option",
22        skip_serializing_if = "Option::is_none"
23    )]
24    pub description: Option<Option<String>>,
25    #[serde(
26        rename = "metadata",
27        default,
28        with = "::serde_with::rust::double_option",
29        skip_serializing_if = "Option::is_none"
30    )]
31    pub metadata: Option<Option<serde_json::Value>>,
32    /// JSON Schema for validating dataset item inputs. When set, all new and existing dataset items will be validated against this schema.
33    #[serde(
34        rename = "inputSchema",
35        default,
36        with = "::serde_with::rust::double_option",
37        skip_serializing_if = "Option::is_none"
38    )]
39    pub input_schema: Option<Option<std::collections::HashMap<String, serde_json::Value>>>,
40    /// JSON Schema for validating dataset item expected outputs. When set, all new and existing dataset items will be validated against this schema.
41    #[serde(
42        rename = "expectedOutputSchema",
43        default,
44        with = "::serde_with::rust::double_option",
45        skip_serializing_if = "Option::is_none"
46    )]
47    pub expected_output_schema:
48        Option<Option<std::collections::HashMap<String, serde_json::Value>>>,
49}
50
51impl CreateDatasetRequest {
52    pub fn new(name: String) -> CreateDatasetRequest {
53        CreateDatasetRequest {
54            name,
55            description: None,
56            metadata: None,
57            input_schema: None,
58            expected_output_schema: None,
59        }
60    }
61}