langfuse_client_base/models/create_text_prompt_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 CreateTextPromptRequest {
16 #[serde(rename = "name")]
17 pub name: String,
18 #[serde(rename = "prompt")]
19 pub prompt: String,
20 #[serde(
21 rename = "config",
22 default,
23 with = "::serde_with::rust::double_option",
24 skip_serializing_if = "Option::is_none"
25 )]
26 pub config: Option<Option<serde_json::Value>>,
27 #[serde(rename = "type", skip_serializing_if = "Option::is_none")]
28 pub r#type: Option<models::CreateTextPromptType>,
29 /// List of deployment labels of this prompt version.
30 #[serde(
31 rename = "labels",
32 default,
33 with = "::serde_with::rust::double_option",
34 skip_serializing_if = "Option::is_none"
35 )]
36 pub labels: Option<Option<Vec<String>>>,
37 /// List of tags to apply to all versions of this prompt.
38 #[serde(
39 rename = "tags",
40 default,
41 with = "::serde_with::rust::double_option",
42 skip_serializing_if = "Option::is_none"
43 )]
44 pub tags: Option<Option<Vec<String>>>,
45 /// Commit message for this prompt version.
46 #[serde(
47 rename = "commitMessage",
48 default,
49 with = "::serde_with::rust::double_option",
50 skip_serializing_if = "Option::is_none"
51 )]
52 pub commit_message: Option<Option<String>>,
53}
54
55impl CreateTextPromptRequest {
56 pub fn new(name: String, prompt: String) -> CreateTextPromptRequest {
57 CreateTextPromptRequest {
58 name,
59 prompt,
60 config: None,
61 r#type: None,
62 labels: None,
63 tags: None,
64 commit_message: None,
65 }
66 }
67}