writer 0.8.3rc21__py3-none-any.whl → 1.25.1rc1__py3-none-any.whl

writer/blocks/writerclassification.py

@@ -1,4 +1,5 @@
 import json
+import re
 
 from writer.abstract import register_abstract_template
 from writer.blocks.base_block import WriterBlock
@@ -27,7 +28,7 @@ class WriterClassification(WriterBlock):
                             "name": "Categories",
                             "type": "Key-Value",
                             "default": "{}",
-                            "desc": "The keys should be the categories you want to classify the text in, for example 'valid' and 'invalid', and the values the criteria for each category.",
+                            "desc": "The keys should be the categories you want to classify the text into, for example 'valid' and 'invalid', and the values are the criteria for each category. Category names should contain only letters of the English alphabet, digits, underscores, and spaces.",
                         },
                         "additionalContext": {
                             "name": "Additional context",
@@ -40,7 +41,7 @@ class WriterClassification(WriterBlock):
                         "category": {"field": "categories", "style": "dynamic"},
                         "error": {
                             "name": "Error",
-                            "description": "If the function raises an Exception.",
+                            "description": "There was an error classifying the text.",
                             "style": "error",
                         },
                     },
@@ -55,6 +56,12 @@ class WriterClassification(WriterBlock):
             text = self._get_field("text", required=True)
             additional_context = self._get_field("additionalContext")
             categories = self._get_field("categories", as_json=True, required=True)
+            conversation = writer.ai.Conversation()
+
+            invalid_categories = [category for category in categories if not re.fullmatch(r"[\w ]+", category, flags=re.ASCII)]
+            if invalid_categories:
+                self.outcome = "error"
+                raise ValueError(f"Category names should contain only letters of the English alphabet, digits, underscores and spaces. Invalid categories: {', '.join(invalid_categories)}")
 
             config = {}
 
@@ -73,9 +80,39 @@ CONTENT:
 ------
 { text }
 """
-            result = writer.ai.complete(prompt, config).strip()
-            self.result = result
-            self.outcome = f"category_{result}"
+            
+            response_format = {
+                "type": "json_schema",
+                "json_schema": {
+                    "schema": {
+                        "type": "string",
+                        "enum": list(categories.keys())
+                    }
+                }
+            }
+
+            conversation += {
+                "role": "user",
+                "content": prompt,
+            }
+
+            msg = conversation.complete(response_format=response_format, config=config)
+            raw_content = msg.get("content")
+            if not raw_content:
+                self.outcome = "error"
+                raise RuntimeError("No content returned from the model. Please validate the prompt and model configuration.")
+
+            try:
+                # Attempt to parse the raw content as JSON
+                category_result = json.loads(raw_content)
+            except json.JSONDecodeError:
+                self.outcome = "error"
+                raise RuntimeError(
+                    f"Failed to decode JSON content. The raw content was: {raw_content}. Please validate the prompt and model configuration."
+                )
+
+            self.result = category_result
+            self.outcome = f"category_{category_result}"
         except BaseException as e:
             self.outcome = "error"
             raise e

writer/blocks/writercompletion.py

@@ -2,7 +2,7 @@ from writer.abstract import register_abstract_template
 from writer.blocks.base_block import WriterBlock
 from writer.ss_types import AbstractTemplate
 
-DEFAULT_MODEL = "palmyra-x-004"
+DEFAULT_MODEL = "palmyra-x5"
 
 class WriterCompletion(WriterBlock):
     @classmethod
@@ -36,19 +36,19 @@ class WriterCompletion(WriterBlock):
                             "validator": {
                                 "type": "number",
                                 "minimum": 1,
-                                "maximum": 8192,
+                                "maximum": 16384,
                             }
                         }
                     },
                     "outs": {
                         "success": {
                             "name": "Success",
-                            "description": "If the function doesn't raise an Exception.",
+                            "description": "Text was generated successfully.",
                             "style": "success",
                         },
                         "error": {
                             "name": "Error",
-                            "description": "If the function raises an Exception.",
+                            "description": "There was an error generating text.",
                             "style": "error",
                         },
                     },

writer/blocks/writerfileapi.py

@@ -13,7 +13,7 @@ class WriterUploadFile(WriterBlock):
         register_abstract_template(type, AbstractTemplate(
             baseType="blueprints_node",
             writer={
-                "name": "Add files to Writer Cloud",
+                "name": "Add files to Writer cloud",
                 "description": "Uploads files to the Writer platform.",
                 "category": "Writer",
                 "fields": {
@@ -21,7 +21,7 @@ class WriterUploadFile(WriterBlock):
                         "name": "Files",
                         "type": "Object",
                         "default": "[]",
-                        "desc": "A list of files to be uploaded and added to the knowledge graph. You can use files uploaded via the File Input component or specify dictionaries with data, type and name.",
+                        "desc": "A list of files to be uploaded to the Writer platform. You can use files uploaded via the File input component or specify dictionaries with data, type and name.",
                         "validator": {
                             "type": "array"
                         }
@@ -35,7 +35,7 @@ class WriterUploadFile(WriterBlock):
                     },
                     "error": {
                         "name": "Error",
-                        "description": "If the function raises an Exception.",
+                        "description": "There was an error uploading the files.",
                         "style": "error"
                     }
                 }
@@ -73,7 +73,7 @@ class WriterUploadFile(WriterBlock):
                     "id": file.id,
                     "name": file.name,
                     "status": file.status,
-                    "created_at": file.created_at,
+                    "created_at": file.created_at.isoformat(),
                     "graph_ids": file.graph_ids
                 })
             if len(outputs) == 0:

writer/blocks/writerinitchat.py

@@ -2,7 +2,7 @@ from writer.abstract import register_abstract_template
 from writer.blocks.base_block import WriterBlock
 from writer.ss_types import AbstractTemplate, WriterConfigurationError
 
-DEFAULT_MODEL = "palmyra-x-004"
+DEFAULT_MODEL = "palmyra-x5"
 
 
 class WriterInitChat(WriterBlock):
@@ -16,6 +16,7 @@ class WriterInitChat(WriterBlock):
                 "name": "Start chat conversation",
                 "description": "Starts a new chat conversation. Use to initialize context for AI interactions.",
                 "category": "Writer",
+                "deprecated": True,
                 "fields": {
                     "conversationStateElement": {
                         "name": "Conversation state element",
@@ -44,19 +45,19 @@ class WriterInitChat(WriterBlock):
                         "validator": {
                             "type": "number",
                             "minimum": 1,
-                            "maximum": 8192,
+                            "maximum": 16384,
                         }
                     }
                 },
                 "outs": {
                     "success": {
                         "name": "Success",
-                        "description": "If the function doesn't raise an Exception.",
+                        "description": "The conversation was initialized.",
                         "style": "success",
                     },
                     "error": {
                         "name": "Error",
-                        "description": "If the function raises an Exception.",
+                        "description": "There was an error initializing the conversation.",
                         "style": "error",
                     },
                 },

writer/blocks/writerkeyvaluestorage.py

@@ -0,0 +1,106 @@
+import re
+
+from writer.abstract import register_abstract_template
+from writer.blocks.base_block import WriterBlock
+from writer.ss_types import AbstractTemplate, WriterConfigurationError
+
+ALLOWED_CHARS = re.compile(r'^[A-Za-z0-9\-_]+$')
+
+class WriterKeyValueStorage(WriterBlock):
+    @classmethod
+    def register(cls, type: str):
+        super(WriterKeyValueStorage, cls).register(type)
+        register_abstract_template(
+            type,
+            AbstractTemplate(
+                baseType="blueprints_node",
+                writer={
+                    "name": "Key-Value Storage",
+                    "description": "Stores data between sessions. Uses unique keys (names) to identify the data. Keys can only contain alphanumeric characters, underscores, and hyphens.",
+                    "category": "Writer",
+                    "fields": {
+                        "action": {
+                            "name": "Action",
+                            "type": "Text",
+                            "description": "What action to perform on the data (save, get, delete, list all keys).",
+                            "options": {
+                                "Save": "Save",
+                                "Get": "Get",
+                                "Delete": "Delete",
+                                "List keys": "List keys",
+                            },
+                            "default": "Save",
+                        },
+                        "key": {
+                            "name": "Key",
+                            "type": "Text",
+                            "description": "Unique identifier of your data that will be used to retrieve, update and delete it.",
+                        },
+                        "valueType": {
+                            "name": "Value type",
+                            "type": "Text",
+                            "description": "Specify whether to interpret the value as plain text or JSON.",
+                            "options": {
+                                "text": "Plain text",
+                                "JSON": "JSON",
+                            },
+                            "default": "text",
+                        },
+                        "value": {
+                            "name": "Value",
+                            "type": "Text",
+                            "description": "Data that you want to store.",
+                            "control": "Textarea",
+                        },
+                    },
+                    "outs": {
+                        "success": {
+                            "name": "Success",
+                            "description": "The request was successful.",
+                            "style": "success",
+                        },
+                        "error": {
+                            "name": "Error",
+                            "description": "The request wasn't successful.",
+                            "style": "error",
+                        },
+                    },
+                },
+            ),
+        )
+
+    def run(self):
+        try:
+            self.result = self._execute_action()
+            self.outcome = "success"
+        except BaseException as e:
+            self.outcome = "error"
+            raise e
+
+    def _execute_action(self):
+        from writer.journal import JOURNAL_KEY_PREFIX
+        from writer.keyvalue_storage import KeyValueStorage
+
+        action = self._get_field("action", default_field_value="Save")
+
+        with self.acquire_httpx_client() as client:
+            writer_kv_storage = KeyValueStorage(client=client)
+
+            if action == "List keys":
+                response = writer_kv_storage.get_data_keys()
+                return [key for key in response if not key.startswith(JOURNAL_KEY_PREFIX)]
+
+            key = self._get_field("key", required=True)
+            if not ALLOWED_CHARS.fullmatch(key):
+                raise WriterConfigurationError("Key can only contain alphanumeric characters, underscores and hyphens")
+
+            if action == "Save":
+                value_type = self._get_field("valueType")
+                value = self._get_field("value", as_json=value_type == "JSON")
+                return writer_kv_storage.save(key, value)
+            if action == "Get":
+                return writer_kv_storage.get(key, type_="data")["data"]
+            if action == "Delete":
+                return writer_kv_storage.delete(key)
+
+            raise WriterConfigurationError(f"Unknown action for the Key-Value Storage: {action}")

writer/blocks/writernocodeapp.py

@@ -12,8 +12,8 @@ class WriterNoCodeApp(WriterBlock):
             AbstractTemplate(
                 baseType="blueprints_node",
                 writer={
-                    "name": "AI Studio Agent",
-                    "description": "Runs an Writer AI Studio Agent app by ID.",
+                    "name": "AI Studio agent",
+                    "description": "Runs a Writer AI Studio agent app by ID.",
                     "category": "Writer",
                     "fields": {
                         "appId": {
@@ -30,12 +30,12 @@ class WriterNoCodeApp(WriterBlock):
                     "outs": {
                         "success": {
                             "name": "Success",
-                            "description": "If the execution was successful.",
+                            "description": "The agent ran successfully.",
                             "style": "success",
                         },
                         "error": {
                             "name": "Error",
-                            "description": "If the function raises an Exception.",
+                            "description": "There was an error running the agent.",
                             "style": "error",
                         },
                     },

writer/blocks/writerparsepdf.py

@@ -25,23 +25,25 @@ class WriterParsePDFByFileID(WriterBlock):
                                     "type": "string",
                                     "format": "uuid"
                                 }
-                            },
+                        },
                         "markdown": {
-                            "name": "Use Markdown",
-                            "type": "Text",
+                            "name": "Enable markdown",
+                            "type": "Boolean",
                             "default": "yes",
-                            "options": {"yes": "Yes", "no": "No"},
+                            "validator": {
+                                "type": "boolean",
+                            },
                         }
                     },
                     "outs": {
                         "success": {
                             "name": "Success",
-                            "description": "If the execution was successful.",
+                            "description": "The PDF was parsed successfully.",
                             "style": "success",
                         },
                         "error": {
                             "name": "Error",
-                            "description": "If the function raises an Exception.",
+                            "description": "There was an error parsing the PDF.",
                             "style": "error",
                         },
                     },

writer/blocks/writerstructuredoutput.py

@@ -0,0 +1,105 @@
+import json
+
+from writer.abstract import register_abstract_template
+from writer.blocks.base_block import WriterBlock
+from writer.ss_types import AbstractTemplate
+
+DEFAULT_MODEL = "palmyra-x5"
+
+
+class WriterStructuredOutput(WriterBlock):
+    @classmethod
+    def register(cls, type: str):
+        super(WriterStructuredOutput, cls).register(type)
+        register_abstract_template(
+            type,
+            AbstractTemplate(
+                baseType="blueprints_node",
+                writer={
+                    "name": "Structured output",
+                    "description": "Defines a JSON response format that the agent will use to structure its output.",
+                    "category": "Writer",
+                    "fields": {
+                        "prompt": {"name": "Prompt", "type": "Text", "control": "Textarea", "desc": "Description of a JSON object to be created."},
+                        "modelId": {
+                            "name": "Model",
+                            "type": "Model Id",
+                            "default": DEFAULT_MODEL
+                        },
+                        "jsonSchema": {
+                            "name": "JSON Schema",
+                            "desc": "JSON schema that defines the structure of the response. For example, `{\"type\": \"object\", \"properties\": {...}, \"required\": [...]}`.",
+                            "type": "JSON",
+                            "default": "{}"
+                        },
+                        "max_tokens": {
+                            "name": "Max output tokens",
+                            "type": "Number",
+                            "default": "1024",
+                            "validator": {
+                                "type": "number",
+                                "minimum": 1,
+                                "maximum": 16384,
+                            }
+                        }
+                    },
+                    "outs": {
+                        "success": {
+                            "name": "Success",
+                            "description": "The structured output was generated.",
+                            "style": "success",
+                        },
+                        "error": {
+                            "name": "Error",
+                            "description": "There was an error generating the output.",
+                            "style": "error",
+                        },
+                    },
+                },
+            ),
+        )
+
+    def run(self):
+        import writer.ai
+
+        try:
+            prompt = self._get_field("prompt")
+            model_id = self._get_field("modelId", False, default_field_value=DEFAULT_MODEL)
+            conversation = writer.ai.Conversation()
+            schema = self._get_field("jsonSchema", True, default_field_value="{}")
+            max_tokens = int(self._get_field("max_tokens", False, "1024"))
+
+            response_format = {
+                "type": "json_schema",
+                "json_schema": {
+                    "schema": schema
+                    }
+                }
+
+            conversation += {
+                "role": "user",
+                "content": prompt,
+            }
+            config = { "model": model_id, "max_tokens": max_tokens }
+            msg = conversation.complete(response_format=response_format, config=config)
+            conversation += msg
+
+            raw_content = msg.get("content")
+            if not raw_content:
+                self.outcome = "error"
+                raise RuntimeError("No content returned from the model. Please validate the prompt and model configuration.")
+
+            try:
+                # Attempt to parse the raw content as JSON
+                content = json.loads(raw_content)
+            except json.JSONDecodeError:
+                self.outcome = "error"
+                raise RuntimeError(
+                    f"Failed to decode JSON content. The raw content was: {raw_content}. Please validate the prompt and model configuration."
+                )
+
+            self.result = content
+            self.outcome = "success"
+        except BaseException as e:
+            self.outcome = "error"
+            raise e