feat(prompts): chat message placeholders

langfuse/_client/client.py

@@ -55,6 +55,7 @@
 from langfuse.media import LangfuseMedia
 from langfuse.model import (
     ChatMessageDict,
+    ChatMessageWithPlaceholdersDict,
     ChatPromptClient,
     CreateDatasetItemRequest,
     CreateDatasetRequest,
@@ -2133,7 +2134,7 @@ def create_prompt(
         self,
         *,
         name: str,
-        prompt: List[ChatMessageDict],
+        prompt: List[Union[ChatMessageDict, ChatMessageWithPlaceholdersDict]],
         labels: List[str] = [],
         tags: Optional[List[str]] = None,
         type: Optional[Literal["chat"]],
@@ -2158,7 +2159,9 @@ def create_prompt(
         self,
         *,
         name: str,
-        prompt: Union[str, List[ChatMessageDict]],
+        prompt: Union[
+            str, List[Union[ChatMessageDict, ChatMessageWithPlaceholdersDict]]
+        ],
         labels: List[str] = [],
         tags: Optional[List[str]] = None,
         type: Optional[Literal["chat", "text"]] = "text",

langfuse/api/__init__.py

@@ -21,6 +21,9 @@
     CategoricalScore,
     CategoricalScoreV1,
     ChatMessage,
+    ChatMessageWithPlaceholders,
+    ChatMessageWithPlaceholders_Chatmessage,
+    ChatMessageWithPlaceholders_Placeholder,
     ChatPrompt,
     Comment,
     CommentObjectType,
@@ -126,6 +129,7 @@
     PaginatedModels,
     PaginatedSessions,
     PatchMediaBody,
+    PlaceholderMessage,
     Project,
     ProjectDeletionResponse,
     Projects,
@@ -230,6 +234,9 @@
     "CategoricalScore",
     "CategoricalScoreV1",
     "ChatMessage",
+    "ChatMessageWithPlaceholders",
+    "ChatMessageWithPlaceholders_Chatmessage",
+    "ChatMessageWithPlaceholders_Placeholder",
     "ChatPrompt",
     "Comment",
     "CommentObjectType",
@@ -335,6 +342,7 @@
     "PaginatedModels",
     "PaginatedSessions",
     "PatchMediaBody",
+    "PlaceholderMessage",
     "Project",
     "ProjectDeletionResponse",
     "Projects",

langfuse/api/reference.md

@@ -4290,7 +4290,10 @@ Create a new version for the prompt with the given `name`
 <dd>
 
 ```python
-from langfuse import ChatMessage, CreatePromptRequest_Chat
+from langfuse import (
+    ChatMessageWithPlaceholders_Chatmessage,
+    CreatePromptRequest_Chat,
+)
 from langfuse.client import FernLangfuse
 
 client = FernLangfuse(
@@ -4305,11 +4308,11 @@ client.prompts.create(
     request=CreatePromptRequest_Chat(
         name="name",
         prompt=[
-            ChatMessage(
+            ChatMessageWithPlaceholders_Chatmessage(
                 role="role",
                 content="content",
             ),
-            ChatMessage(
+            ChatMessageWithPlaceholders_Chatmessage(
                 role="role",
                 content="content",
             ),

langfuse/api/resources/__init__.py

@@ -173,12 +173,16 @@
 from .prompts import (
     BasePrompt,
     ChatMessage,
+    ChatMessageWithPlaceholders,
+    ChatMessageWithPlaceholders_Chatmessage,
+    ChatMessageWithPlaceholders_Placeholder,
     ChatPrompt,
     CreateChatPromptRequest,
     CreatePromptRequest,
     CreatePromptRequest_Chat,
     CreatePromptRequest_Text,
     CreateTextPromptRequest,
+    PlaceholderMessage,
     Prompt,
     PromptMeta,
     PromptMetaListResponse,
@@ -242,6 +246,9 @@
     "CategoricalScore",
     "CategoricalScoreV1",
     "ChatMessage",
+    "ChatMessageWithPlaceholders",
+    "ChatMessageWithPlaceholders_Chatmessage",
+    "ChatMessageWithPlaceholders_Placeholder",
     "ChatPrompt",
     "Comment",
     "CommentObjectType",
@@ -347,6 +354,7 @@
     "PaginatedModels",
     "PaginatedSessions",
     "PatchMediaBody",
+    "PlaceholderMessage",
     "Project",
     "ProjectDeletionResponse",
     "Projects",

langfuse/api/resources/prompts/__init__.py

@@ -3,12 +3,16 @@
 from .types import (
     BasePrompt,
     ChatMessage,
+    ChatMessageWithPlaceholders,
+    ChatMessageWithPlaceholders_Chatmessage,
+    ChatMessageWithPlaceholders_Placeholder,
     ChatPrompt,
     CreateChatPromptRequest,
     CreatePromptRequest,
     CreatePromptRequest_Chat,
     CreatePromptRequest_Text,
     CreateTextPromptRequest,
+    PlaceholderMessage,
     Prompt,
     PromptMeta,
     PromptMetaListResponse,
@@ -20,12 +24,16 @@
 __all__ = [
     "BasePrompt",
     "ChatMessage",
+    "ChatMessageWithPlaceholders",
+    "ChatMessageWithPlaceholders_Chatmessage",
+    "ChatMessageWithPlaceholders_Placeholder",
     "ChatPrompt",
     "CreateChatPromptRequest",
     "CreatePromptRequest",
     "CreatePromptRequest_Chat",
     "CreatePromptRequest_Text",
     "CreateTextPromptRequest",
+    "PlaceholderMessage",
     "Prompt",
     "PromptMeta",
     "PromptMetaListResponse",

langfuse/api/resources/prompts/client.py

@@ -228,7 +228,10 @@ def create(
 
         Examples
         --------
-        from langfuse import ChatMessage, CreatePromptRequest_Chat
+        from langfuse import (
+            ChatMessageWithPlaceholders_Chatmessage,
+            CreatePromptRequest_Chat,
+        )
         from langfuse.client import FernLangfuse
 
         client = FernLangfuse(
@@ -243,11 +246,11 @@ def create(
             request=CreatePromptRequest_Chat(
                 name="name",
                 prompt=[
-                    ChatMessage(
+                    ChatMessageWithPlaceholders_Chatmessage(
                         role="role",
                         content="content",
                     ),
-                    ChatMessage(
+                    ChatMessageWithPlaceholders_Chatmessage(
                         role="role",
                         content="content",
                     ),
@@ -512,7 +515,10 @@ async def create(
         --------
         import asyncio
 
-        from langfuse import ChatMessage, CreatePromptRequest_Chat
+        from langfuse import (
+            ChatMessageWithPlaceholders_Chatmessage,
+            CreatePromptRequest_Chat,
+        )
         from langfuse.client import AsyncFernLangfuse
 
         client = AsyncFernLangfuse(
@@ -530,11 +536,11 @@ async def main() -> None:
                 request=CreatePromptRequest_Chat(
                     name="name",
                     prompt=[
-                        ChatMessage(
+                        ChatMessageWithPlaceholders_Chatmessage(
                             role="role",
                             content="content",
                         ),
-                        ChatMessage(
+                        ChatMessageWithPlaceholders_Chatmessage(
                             role="role",
                             content="content",
                         ),

langfuse/api/resources/prompts/types/__init__.py

@@ -2,6 +2,11 @@
 
 from .base_prompt import BasePrompt
 from .chat_message import ChatMessage
+from .chat_message_with_placeholders import (
+    ChatMessageWithPlaceholders,
+    ChatMessageWithPlaceholders_Chatmessage,
+    ChatMessageWithPlaceholders_Placeholder,
+)
 from .chat_prompt import ChatPrompt
 from .create_chat_prompt_request import CreateChatPromptRequest
 from .create_prompt_request import (
@@ -10,6 +15,7 @@
     CreatePromptRequest_Text,
 )
 from .create_text_prompt_request import CreateTextPromptRequest
+from .placeholder_message import PlaceholderMessage
 from .prompt import Prompt, Prompt_Chat, Prompt_Text
 from .prompt_meta import PromptMeta
 from .prompt_meta_list_response import PromptMetaListResponse
@@ -18,12 +24,16 @@
 __all__ = [
     "BasePrompt",
     "ChatMessage",
+    "ChatMessageWithPlaceholders",
+    "ChatMessageWithPlaceholders_Chatmessage",
+    "ChatMessageWithPlaceholders_Placeholder",
     "ChatPrompt",
     "CreateChatPromptRequest",
     "CreatePromptRequest",
     "CreatePromptRequest_Chat",
     "CreatePromptRequest_Text",
     "CreateTextPromptRequest",
+    "PlaceholderMessage",
     "Prompt",
     "PromptMeta",
     "PromptMetaListResponse",

langfuse/api/resources/prompts/types/chat_message_with_placeholders.py

@@ -0,0 +1,87 @@
+# This file was auto-generated by Fern from our API Definition.
+
+from __future__ import annotations
+
+import datetime as dt
+import typing
+
+from ....core.datetime_utils import serialize_datetime
+from ....core.pydantic_utilities import deep_union_pydantic_dicts, pydantic_v1
+
+
+class ChatMessageWithPlaceholders_Chatmessage(pydantic_v1.BaseModel):
+    role: str
+    content: str
+    type: typing.Literal["chatmessage"] = "chatmessage"
+
+    def json(self, **kwargs: typing.Any) -> str:
+        kwargs_with_defaults: typing.Any = {
+            "by_alias": True,
+            "exclude_unset": True,
+            **kwargs,
+        }
+        return super().json(**kwargs_with_defaults)
+
+    def dict(self, **kwargs: typing.Any) -> typing.Dict[str, typing.Any]:
+        kwargs_with_defaults_exclude_unset: typing.Any = {
+            "by_alias": True,
+            "exclude_unset": True,
+            **kwargs,
+        }
+        kwargs_with_defaults_exclude_none: typing.Any = {
+            "by_alias": True,
+            "exclude_none": True,
+            **kwargs,
+        }
+
+        return deep_union_pydantic_dicts(
+            super().dict(**kwargs_with_defaults_exclude_unset),
+            super().dict(**kwargs_with_defaults_exclude_none),
+        )
+
+    class Config:
+        frozen = True
+        smart_union = True
+        extra = pydantic_v1.Extra.allow
+        json_encoders = {dt.datetime: serialize_datetime}
+
+
+class ChatMessageWithPlaceholders_Placeholder(pydantic_v1.BaseModel):
+    name: str
+    type: typing.Literal["placeholder"] = "placeholder"
+
+    def json(self, **kwargs: typing.Any) -> str:
+        kwargs_with_defaults: typing.Any = {
+            "by_alias": True,
+            "exclude_unset": True,
+            **kwargs,
+        }
+        return super().json(**kwargs_with_defaults)
+
+    def dict(self, **kwargs: typing.Any) -> typing.Dict[str, typing.Any]:
+        kwargs_with_defaults_exclude_unset: typing.Any = {
+            "by_alias": True,
+            "exclude_unset": True,
+            **kwargs,
+        }
+        kwargs_with_defaults_exclude_none: typing.Any = {
+            "by_alias": True,
+            "exclude_none": True,
+            **kwargs,
+        }
+
+        return deep_union_pydantic_dicts(
+            super().dict(**kwargs_with_defaults_exclude_unset),
+            super().dict(**kwargs_with_defaults_exclude_none),
+        )
+
+    class Config:
+        frozen = True
+        smart_union = True
+        extra = pydantic_v1.Extra.allow
+        json_encoders = {dt.datetime: serialize_datetime}
+
+
+ChatMessageWithPlaceholders = typing.Union[
+    ChatMessageWithPlaceholders_Chatmessage, ChatMessageWithPlaceholders_Placeholder
+]

langfuse/api/resources/prompts/types/chat_prompt.py

@@ -6,11 +6,11 @@
 from ....core.datetime_utils import serialize_datetime
 from ....core.pydantic_utilities import deep_union_pydantic_dicts, pydantic_v1
 from .base_prompt import BasePrompt
-from .chat_message import ChatMessage
+from .chat_message_with_placeholders import ChatMessageWithPlaceholders
 
 
 class ChatPrompt(BasePrompt):
-    prompt: typing.List[ChatMessage]
+    prompt: typing.List[ChatMessageWithPlaceholders]
 
     def json(self, **kwargs: typing.Any) -> str:
         kwargs_with_defaults: typing.Any = {

langfuse/api/resources/prompts/types/create_chat_prompt_request.py

@@ -5,12 +5,12 @@
 
 from ....core.datetime_utils import serialize_datetime
 from ....core.pydantic_utilities import deep_union_pydantic_dicts, pydantic_v1
-from .chat_message import ChatMessage
+from .chat_message_with_placeholders import ChatMessageWithPlaceholders
 
 
 class CreateChatPromptRequest(pydantic_v1.BaseModel):
     name: str
-    prompt: typing.List[ChatMessage]
+    prompt: typing.List[ChatMessageWithPlaceholders]
     config: typing.Optional[typing.Any] = None
     labels: typing.Optional[typing.List[str]] = pydantic_v1.Field(default=None)
     """

langfuse/api/resources/prompts/types/create_prompt_request.py

@@ -7,12 +7,12 @@
 
 from ....core.datetime_utils import serialize_datetime
 from ....core.pydantic_utilities import deep_union_pydantic_dicts, pydantic_v1
-from .chat_message import ChatMessage
+from .chat_message_with_placeholders import ChatMessageWithPlaceholders
 
 
 class CreatePromptRequest_Chat(pydantic_v1.BaseModel):
     name: str
-    prompt: typing.List[ChatMessage]
+    prompt: typing.List[ChatMessageWithPlaceholders]
     config: typing.Optional[typing.Any] = None
     labels: typing.Optional[typing.List[str]] = None
     tags: typing.Optional[typing.List[str]] = None