add data_event type

src/fastapi_poe/__init__.py

@@ -18,6 +18,7 @@
     "PartialResponse",
     "ErrorResponse",
     "MetaResponse",
+    "DataResponse",
     "RequestContext",
     "ToolDefinition",
     "ToolCallDefinition",
@@ -41,6 +42,7 @@
 from .types import (
     Attachment,
     CostItem,
+    DataResponse,
     ErrorResponse,
     MessageFeedback,
     MetaResponse,

src/fastapi_poe/base.py

@@ -33,6 +33,7 @@
     AttachmentUploadResponse,
     ContentType,
     CostItem,
+    DataResponse,
     ErrorResponse,
     Identifier,
     MetaResponse,
@@ -772,6 +773,10 @@ async def _cost_requests_inner(
     def text_event(text: str) -> ServerSentEvent:
         return ServerSentEvent(data=json.dumps({"text": text}), event="text")
 
+    @staticmethod
+    def data_event(metadata: str) -> ServerSentEvent:
+        return ServerSentEvent(data=json.dumps({"metadata": metadata}), event="data")
+
     @staticmethod
     def replace_response_event(text: str) -> ServerSentEvent:
         return ServerSentEvent(
@@ -882,6 +887,8 @@ async def handle_query(
                         linkify=event.linkify,
                         suggested_replies=event.suggested_replies,
                     )
+                elif isinstance(event, DataResponse):
+                    yield self.data_event(event.metadata)
                 elif event.is_suggested_reply:
                     yield self.suggested_reply_event(event.text)
                 elif event.is_replace_response:

src/fastapi_poe/types.py

@@ -80,6 +80,7 @@ class ProtocolMessage(BaseModel):
     message_id: str = ""
     feedback: list[MessageFeedback] = Field(default_factory=list)
     attachments: list[Attachment] = Field(default_factory=list)
+    metadata: Optional[str] = None
 
 
 class RequestContext(BaseModel):
@@ -237,6 +238,23 @@ class AttachmentUploadResponse(BaseModel):
     attachment_url: Optional[str]
 
 
+class DataResponse(BaseModel):
+    """
+
+    A response that contains arbitrary data to attach to the bot response.
+    This data can be retrieved in later requests to the bot within the same chat.
+    Note that only the final DataResponse object in the stream will be attached to the bot response.
+
+    #### Fields:
+    - `metadata` (`str`): String of data to attach to the bot response.
+
+    """
+
+    model_config = ConfigDict(extra="forbid")
+
+    metadata: str
+
+
 class PartialResponse(BaseModel):
     """