unique_sdk 0.9.18__tar.gz → 0.9.19__tar.gz

{unique_sdk-0.9.18 → unique_sdk-0.9.19}/CHANGELOG.md

@@ -5,6 +5,9 @@ All notable changes to this project will be documented in this file.
 The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/), 
 and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
+## [0.9.19] - 2025-01-31
+- Add `MessageAssessment` resource
+
 ## [0.9.18] - 2025-01-22
 - Removed `Invalid response body from API` from `retry_dict` as it's our own artificail error.
 

{unique_sdk-0.9.18 → unique_sdk-0.9.19}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: unique_sdk
-Version: 0.9.18
+Version: 0.9.19
 Summary: 
 License: MIT
 Author: Martin Fadler
@@ -34,6 +34,7 @@ The Unique Python SDK provides access to the public API of Unique FinanceGPT. It
    - [Search](#search)
    - [Search String](#search-string)
    - [Short Term Memory](#short-term-memory)
+   - [Message Assessment](#message-assessment)
 6. [UniqueQL](#uniqueql)
    - [Query Structure](#uniqueql-query-structure)
    - [Metadata Filtering](#metadata-filtering)
@@ -587,6 +588,7 @@ you need to provide an `memoryName` as an identifier.
 
 you can then save it and retreive it live defined below.
 
+
 #### `unique_sdk.ShortTermMemory.create`
 
 ```python
@@ -614,6 +616,43 @@ m = unique_sdk.ShortTermMemory.find_latest(
 print(m)
 ```
 
+### Message Assessment
+
+Used to create and modify message assessments for tracking hallucinations and compliance evaluations of assistant messages.
+
+#### `unique_sdk.MessageAssessment.create`
+
+Create a new message assessment for an assistant message.
+
+```python
+assessment = unique_sdk.MessageAssessment.create(
+    user_id=user_id,
+    company_id=company_id,
+    assistant_message_id="msg_...",
+    status="DONE",
+    explanation="This response contains incorrect information about...",
+    label="NEGATIVE",
+    type="HALLUCINATION",
+    isVisible=True
+)
+```
+
+#### `unique_sdk.MessageAssessment.modify` 
+
+Modify an existing message assessment.
+
+```python
+assessment = unique_sdk.MessageAssessment.modify(
+    user_id=user_id,
+    company_id=company_id,
+    assistant_message_id="msg_...",
+    status="DONE",
+    explanation="Updated explanation...",
+    label="NEGATIVE",
+    type="HALLUCINATION"
+)
+```
+
 ## UniqueQL
 
 [UniqueQL](https://unique-ch.atlassian.net/wiki/x/coAXHQ) is an advanced query language designed to enhance search capabilities within various search modes such as Vector, Full-Text Search (FTS), and Combined. This query language enables users to perform detailed searches by filtering through metadata attributes like filenames, URLs, dates, and more. UniqueQL is versatile and can be translated into different query formats for various database systems, including PostgreSQL and Qdrant.
@@ -899,6 +938,9 @@ All notable changes to this project will be documented in this file.
 The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/), 
 and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
+## [0.9.19] - 2025-01-31
+- Add `MessageAssessment` resource
+
 ## [0.9.18] - 2025-01-22
 - Removed `Invalid response body from API` from `retry_dict` as it's our own artificail error.
 

{unique_sdk-0.9.18 → unique_sdk-0.9.19}/README.md

@@ -19,6 +19,7 @@ The Unique Python SDK provides access to the public API of Unique FinanceGPT. It
    - [Search](#search)
    - [Search String](#search-string)
    - [Short Term Memory](#short-term-memory)
+   - [Message Assessment](#message-assessment)
 6. [UniqueQL](#uniqueql)
    - [Query Structure](#uniqueql-query-structure)
    - [Metadata Filtering](#metadata-filtering)
@@ -572,6 +573,7 @@ you need to provide an `memoryName` as an identifier.
 
 you can then save it and retreive it live defined below.
 
+
 #### `unique_sdk.ShortTermMemory.create`
 
 ```python
@@ -599,6 +601,43 @@ m = unique_sdk.ShortTermMemory.find_latest(
 print(m)
 ```
 
+### Message Assessment
+
+Used to create and modify message assessments for tracking hallucinations and compliance evaluations of assistant messages.
+
+#### `unique_sdk.MessageAssessment.create`
+
+Create a new message assessment for an assistant message.
+
+```python
+assessment = unique_sdk.MessageAssessment.create(
+    user_id=user_id,
+    company_id=company_id,
+    assistant_message_id="msg_...",
+    status="DONE",
+    explanation="This response contains incorrect information about...",
+    label="NEGATIVE",
+    type="HALLUCINATION",
+    isVisible=True
+)
+```
+
+#### `unique_sdk.MessageAssessment.modify` 
+
+Modify an existing message assessment.
+
+```python
+assessment = unique_sdk.MessageAssessment.modify(
+    user_id=user_id,
+    company_id=company_id,
+    assistant_message_id="msg_...",
+    status="DONE",
+    explanation="Updated explanation...",
+    label="NEGATIVE",
+    type="HALLUCINATION"
+)
+```
+
 ## UniqueQL
 
 [UniqueQL](https://unique-ch.atlassian.net/wiki/x/coAXHQ) is an advanced query language designed to enhance search capabilities within various search modes such as Vector, Full-Text Search (FTS), and Combined. This query language enables users to perform detailed searches by filtering through metadata attributes like filenames, URLs, dates, and more. UniqueQL is versatile and can be translated into different query formats for various database systems, including PostgreSQL and Qdrant.

{unique_sdk-0.9.18 → unique_sdk-0.9.19}/pyproject.toml

@@ -1,6 +1,6 @@
 [tool.poetry]
 name = "unique_sdk"
-version = "0.9.18"
+version = "0.9.19"
 description = ""
 authors = [
     "Martin Fadler <martin.fadler@unique.ch>",

{unique_sdk-0.9.18 → unique_sdk-0.9.19}/unique_sdk/__init__.py

@@ -82,6 +82,9 @@ from unique_sdk.api_resources._short_term_memory import (
 )
 from unique_sdk.api_resources._embedding import Embeddings as Embeddings
 from unique_sdk.api_resources._acronyms import Acronyms as Acronyms
+from unique_sdk.api_resources._message_assessment import (
+    MessageAssessment as MessageAssessment,
+)
 
 # Unique QL
 

unique_sdk-0.9.19/unique_sdk/api_resources/_message_assessment.py

@@ -0,0 +1,72 @@
+from typing import (
+    ClassVar,
+    Literal,
+    Unpack,
+)
+
+from unique_sdk._api_resource import APIResource
+from unique_sdk._request_options import RequestOptions
+
+
+class MessageAssessment(APIResource["MessageAssessment"]):
+    OBJECT_NAME: ClassVar[Literal["message_assessment"]] = "message_assessment"
+    RESOURCE_URL = "/message-assessment"
+
+    class CreateParams(RequestOptions):
+        assistant_message_id: str
+        status: Literal["PENDING", "DONE", "ERROR"]
+        explanation: str
+        label: Literal["POSITIVE", "NEGATIVE", "VERIFIED", "UNVERIFIED"]
+        type: Literal["HALLUCINATION", "COMPLIANCE"]
+        isVisible: bool
+
+    class ModifyParams(RequestOptions):
+        assistant_message_id: str
+        status: Literal["PENDING", "DONE", "ERROR"]
+        explanation: str
+        label: Literal["POSITIVE", "NEGATIVE", "VERIFIED", "UNVERIFIED"]
+        type: Literal["HALLUCINATION", "COMPLIANCE"]
+
+    @classmethod
+    def create(
+        cls,
+        user_id: str,
+        company_id: str,
+        **params: Unpack["MessageAssessment.CreateParams"],
+    ) -> "MessageAssessment":
+        return cls._static_request(
+            "post", cls.RESOURCE_URL, user_id, company_id, params=params
+        )
+
+    @classmethod
+    async def create_async(
+        cls,
+        user_id: str,
+        company_id: str,
+        **params: Unpack["MessageAssessment.CreateParams"],
+    ) -> "MessageAssessment":
+        return cls._static_request_async(
+            "post", cls.RESOURCE_URL, user_id, company_id, params=params
+        )
+
+    @classmethod
+    def modify(
+        cls,
+        user_id: str,
+        company_id: str,
+        **params: Unpack["MessageAssessment.ModifyParams"],
+    ) -> "MessageAssessment":
+        return cls._static_request(
+            "patch", cls.RESOURCE_URL, user_id, company_id, params=params
+        )
+
+    @classmethod
+    async def modify_async(
+        cls,
+        user_id: str,
+        company_id: str,
+        **params: Unpack["MessageAssessment.ModifyParams"],
+    ) -> "MessageAssessment":
+        return cls._static_request_async(
+            "patch", cls.RESOURCE_URL, user_id, company_id, params=params
+        )