Skip to main content

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