unique_sdk 0.10.47__py3-none-any.whl → 0.10.53__py3-none-any.whl

unique_sdk-0.10.47.dist-info/METADATA

@@ -1,2431 +0,0 @@
-Metadata-Version: 2.1
-Name: unique_sdk
-Version: 0.10.47
-Summary: 
-License: MIT
-Author: Martin Fadler
-Author-email: martin.fadler@unique.ch
-Requires-Python: >=3.11,<4.0
-Classifier: License :: OSI Approved :: MIT License
-Classifier: Programming Language :: Python :: 3
-Classifier: Programming Language :: Python :: 3.11
-Classifier: Programming Language :: Python :: 3.12
-Provides-Extra: openai
-Requires-Dist: openai (>=1.105.0,<2.0.0) ; extra == "openai"
-Requires-Dist: requests (>=2.32.3,<3.0.0)
-Requires-Dist: typing-extensions (>=4.9.0,<5.0.0)
-Description-Content-Type: text/markdown
-
-# Unique Python SDK
-
-Unique AI is a tailored solution for the financial industry, designed to increase productivity by automating manual workloads through AI and ChatGPT solutions.
-
-The Unique Python SDK provides access to the public API of Unique AI. It also enables verification of Webhook signatures to ensure the authenticity of incoming Webhook requests.
-
-## Table of Contents
-
-1. [Installation](#installation)
-2. [Requirements](#requirements)
-3. [Usage Instructions](#usage-instructions)
-4. [Webhook Triggers](#webhook-triggers)
-5. [Available API Resources](#available-api-resources)
-   - [Content](#content)
-   - [Message](#message)
-   - [Message Log](#message-log)
-   - [Message Execution](#message-execution)
-   - [Chat Completion](#chat-completion)
-   - [Embeddings](#embeddings)
-   - [Acronyms](#acronyms)
-   - [Search](#search)
-   - [Search String](#search-string)
-   - [Short Term Memory](#short-term-memory)
-   - [Message Assessment](#message-assessment)
-   - [Folder](#folder)
-   - [Space](#space)
-   - [LLM Models](#llm-models)
-   - [User](#user)
-   - [Group](#group)
-   - [Agentic Table](#agentic-table)
-6. [UniqueQL](#uniqueql)
-   - [Query Structure](#uniqueql-query-structure)
-   - [Metadata Filtering](#metadata-filtering)
-7. [Util functions](#utils)
-   - [Chat History](#chat-history)
-   - [File Io](#file-io)
-   - [Sources](#sources)
-   - [token](#token)
-   - [Chat In Space](#chat-in-space)
-8. [Error Handling](#error-handling)
-9. [Examples](#examples)
-
-## Installation
-
-Install UniqueSDK and its peer dependency `requests` and when planning to run async requests also `httpx` or `aiohttp` via pip using the following commands:
-
-```bash
-pip install unique_sdk
-pip install requests
-```
-
-Optional for async requests:
-
-```bash
-pip install httpx
-```
-
-or
-
-```bash
-pip install aiohttp
-```
-
-## Requirements
-
-- Python >=3.11 (Other Python versions 3.6+ might work but are not tested)
-- requests (peer dependency. Other HTTP request libraries might be supported in the future)
-- Unique App-ID & API Key
-
-Please contact your customer success manager at Unique for your personal developer App-ID & API Key.
-
-## Usage instructions
-
-The library needs to be configured with your Unique `app_id` & `api_key`. Additionally, each individual request must be scoped to a User and provide a `user_id` & `company_id`.
-
-```python
-import unique_sdk
-unique_sdk.api_key = "ukey_..."
-unique_sdk.app_id = "app_..."
-```
-
-The SDK includes a set of classes for API resources. Each class contains CRUD methods to interact with the resource.
-
-### Example
-
-```python
-import unique_sdk
-unique_sdk.api_key = "ukey_..."
-unique_sdk.app_id = "app_..."
-
-# list messages for a single chat
-messages = unique_sdk.Message.list(
-    user_id=user_id,
-    company_id=company_id,
-    chatId=chat_id,
-)
-
-print(messages.data[0].text)
-```
-
-## Webhook Triggers
-
-A core functionality of Unique AI is the ability for users to engage in an interactive chat feature. SDK developers can hook into this chat to provide new functionalities.
-
-Your App (refer to `app-id` in [Requirements](#requirements)) must be subscribed to each individual Unique event in order to receive a webhook.
-
-Each webhook sent by Unique includes a set of headers:
-
-```yaml
-X-Unique-Id: evt_... # Event id, same as in the body.
-X-Unique-Signature: ... # A HMAC-SHA256 hex signature of the entire body.
-X-Unique-Version: 1.0.0 # Event payload version.
-X-Unique-Created-At: 1705960141 # Unix timestamp (seconds) of the delivery time.
-X-Unique-User-Id: ... # The user who initiated the message.
-X-Unique-Company-Id: ... # The company to which the user belongs.
-```
-
-### Success & Retry on Failure
-
-- Webhooks are considered successfully delivered if your endpoint returns a status code between `200` and `299`.
-- If your endpoint returns a status code of `300` - `399`, `429`, or `500` - `599`, Unique will retry the delivery of the webhook with an exponential backoff up to five times.
-- If your endpoint returns any other status (e.g., `404`), it is marked as expired and will not receive any further requests.
-
-### Webhook Signature Verification
-
-The webhook body, containing a timestamp of the delivery time, is signed with HMAC-SHA256. Verify the signature by constructing the `event` with the `unique_sdk.Webhook` class:
-
-```python
-from http import HTTPStatus
-from flask import Flask, jsonify, request
-import unique_sdk
-
-endpoint_secret = "YOUR_ENDPOINT_SECRET"
-
-@app.route("/webhook", methods=["POST"])
-def webhook():
-    event = None
-    payload = request.data
-
-    sig_header = request.headers.get("X-Unique-Signature")
-    timestamp = request.headers.get("X-Unique-Created-At")
-
-    if not sig_header or not timestamp:
-        print("⚠️  Webhook signature or timestamp headers missing.")
-        return jsonify(success=False), HTTPStatus.BAD_REQUEST
-
-    try:
-        event = unique_sdk.Webhook.construct_event(
-            payload, sig_header, timestamp, endpoint_secret
-        )
-    except unique_sdk.SignatureVerificationError as e:
-        print("⚠️  Webhook signature verification failed. " + str(e))
-        return jsonify(success=False), HTTPStatus.BAD_REQUEST
-```
-
-The `construct_event` method will compare the signature and raise a `unique_sdk.SignatureVerificationError` if the signature does not match. It will also raise this error if the `createdAt` timestamp is outside of a default tolerance of 5 minutes. Adjust the `tolerance` by passing a fifth parameter to the method (tolerance in seconds), e.g.:
-
-```python
-event = unique_sdk.Webhook.construct_event(
-    payload, sig_header, timestamp, endpoint_secret, 0
-)
-```
-
-### Available Unique Events
-
-#### User Message Created
-
-```json
-{
-  "id": "evt_...", // see header
-  "version": "1.0.0", // see header
-  "event": "unique.chat.user-message.created", // The name of the event
-  "createdAt": "1705960141", // see header
-  "userId": "...", // see header
-  "companyId": "...", // see header
-  "payload": {
-    "chatId": "chat_...", // The id of the chat
-    "assistantId": "assistant_...", // The id of the selected assistant
-    "text": "Hello, how can I help you?" // The user message
-  }
-}
-```
-
-This webhook is triggered for every new chat message sent by the user. This event occurs regardless of whether it is the first or a subsequent message in a chat. Use the `unique_sdk.Message` class to retrieve other messages from the same `chatId` or maintain a local state of the messages in a single chat.
-
-This trigger can be used in combination with assistants marked as `external`. Those assistants will not execute any logic, enabling your code to respond to the user message and create an answer.
-
-#### External Module Chosen
-
-```json
-{
-  "id": "evt_...",
-  "version": "1.0.0",
-  "event": "unique.chat.external-module.chosen",
-  "createdAt": "1705960141", // Unix timestamp (seconds)
-  "userId": "...",
-  "companyId": "...",
-  "payload": {
-    "name": "example-sdk", // The name of the module selected by the module chooser
-    "description": "Example SDK", // The description of the module
-    "configuration": {}, // Module configuration in JSON format
-    "chatid": "chat_...", // The chat ID
-    "assistantId:": "assistant_...", // The assistant ID
-    "userMessage": {
-      "id": "msg_...",
-      "text": "Hello World!", // The user message leading to the module selection
-      "createdAt": "2024-01-01T00:00:00.000Z" // ISO 8601
-    },
-    "assistantMessage": {
-      "id": "msg_...",
-      "createdAt": "2024-01-01T00:00:00.000Z" // ISO 8601
-    }
-  }
-}
-```
-
-This Webhook is triggered when the Unique AI selects an external module as the best response to a user message. The module must be marked as `external` and available for the assistant used in the chat to be selected by the AI.
-
-Unique's UI will create an empty `assistantMessage` below the user message and update this message with status updates.
-
-**The SDK is expected to modify this assistantMessage with its answer to the user message.**
-
-```python
-unique_sdk.Message.modify(
-    user_id=user_id,
-    company_id=company_id,
-    id=assistant_message_id,
-    chatId=chat_id,
-    text="Here is your answer.",
-)
-```
-
-## Available API Resources
-
-- [Content](#content)
-- [Message](#message)
-- [Message Log](#message-log)
-- [Message Execution](#message-execution)
-- [Chat Completion](#chat-completion)
-- [Embeddings](#embeddings)
-- [Acronyms](#acronyms)
-- [Search](#search)
-- [Search String](#search-string)
-- [Short Term Memory](#short-term-memory)
-- [Message Assessment](#message-assessment)
-- [Folder](#folder)
-- [Space](#space)
-- [LLM Models](#llm-models)
-- [User](#user)
-- [Group](#group)
-- [Agentic Table](#agentic-table)
-
-Most of the API services provide an asynchronous version of the method. The async methods are suffixed with `_async`.
-
-### Content
-
-#### `unique_sdk.Content.search`
-
-Allows you to load full content/files from the knowledge-base of unique with the rights of the userId and companyId. Provided a `where` query for filtering. Filtering can be done on any of the following fields: `
-
-- `id`
-- `key`
-- `ownerId`
-- `title`
-- `url`
-
-Here an example of retrieving all files that contain the number 42 in the `title` or the `key` typically this is used to search by filename.
-
-```python
-unique_sdk.Content.search(
-    user_id=userId,
-    company_id=companyId,
-    where={
-        "OR": [
-            {
-                "title": {
-                    "contains": "42",
-                },
-            },
-            {
-                "key": {
-                    "contains": "42",
-                },
-            },
-        ],
-    },
-    chatId=chatId,
-)
-```
-
-#### `unique_sdk.Content.get_info`
-
-[Deprecated, use `unique_sdk.Content.get_infos` instead.] Allows you to get content info. To filter the results you can define a metadata filter in UniqueQL language. Find out more about it in the UniqueQL section. An example of a metadata filter defined with UniqueQL is the following:
-
-```python
-    metadataFilter: {
-        "or": [
-            {
-                "and": [
-                    {
-                        "operator": "contains",
-                        "path": [
-                            "folderIdPath"
-                        ],
-                        "value": "uniquepathid://test_id"
-                    },
-                    {
-                        "operator": "contains",
-                        "path": [
-                            "title"
-                        ],
-                        "value": "ai"
-                    }
-                ]
-            }
-        ]
-    },
-```
-
-Pagination is also enabled for this functionality, and the default number of returned results is 50 with no entries skipped. Use the following paramteres to get the desired page:`
-
-- `skip`
-- `take`
-
-Here is an example of retrieving the first 3 content infos that contain the value `uniquepathid://scope_abcdibgznc4bkdcx120zm5d` in the `folderIdPath` metadata and the value `ai` for the `title` metadata.
-
-```python
-content_info_result = unique_sdk.Content.get_info(
-    user_id=user_id,
-    company_id=company_id,
-    metadataFilter={
-        "or": [
-            {
-                "and": [
-                    {
-                        "operator": "contains",
-                        "path": [
-                            "folderIdPath"
-                        ],
-                        "value": "uniquepathid://scope_abcdibgznc4bkdcx120zm5d"
-                    },
-                    {
-                        "operator": "contains",
-                        "path": [
-                            "title"
-                        ],
-                        "value": "ai"
-                    }
-                ]
-            }
-        ]
-    },
-    skip=0,
-    take=3,
-)
-```
-
-#### `unique_sdk.Content.get_infos`
-
-Allows you to get content infos. To filter the results you can define a either metadata filter in UniqueQL language or specify a parentId. If both are defined, the function will throw an error.
-
-I f you want to learn more about UniqueQL, you can find out more about it in the [UniqueQL](#uniqueql) section. An example of a metadata filter defined with UniqueQL is the following:
-
-```python
-    metadataFilter: {
-        "or": [
-            {
-                "and": [
-                    {
-                        "operator": "contains",
-                        "path": [
-                            "folderIdPath"
-                        ],
-                        "value": "uniquepathid://test_id"
-                    },
-                    {
-                        "operator": "contains",
-                        "path": [
-                            "title"
-                        ],
-                        "value": "ai"
-                    }
-                ]
-            }
-        ]
-    },
-```
-
-Pagination is also enabled for this functionality, and the default number of returned results is 50 with no entries skipped. Use the following paramteres to get the desired page:`
-
-- `skip`
-- `take`
-
-Here is an example of retrieving the first 3 content infos that contain the value `uniquepathid://scope_abcdibgznc4bkdcx120zm5d` in the `folderIdPath` metadata and the value `ai` for the `title` metadata.
-
-```python
-content_info_result = unique_sdk.Content.get_infos(
-    user_id=user_id,
-    company_id=company_id,
-    metadataFilter={
-        "or": [
-            {
-                "and": [
-                    {
-                        "operator": "contains",
-                        "path": [
-                            "folderIdPath"
-                        ],
-                        "value": "uniquepathid://scope_abcdibgznc4bkdcx120zm5d"
-                    },
-                    {
-                        "operator": "contains",
-                        "path": [
-                            "title"
-                        ],
-                        "value": "ai"
-                    }
-                ]
-            }
-        ]
-    },
-    skip=0,
-    take=3,
-)
-```
-
-Here is an example of retrieving the contents based on a parentId.
-
-```python
-content_info_result = unique_sdk.Content.get_infos(
-    user_id=user_id,
-    company_id=company_id,
-    parentId="scope_ahefgj389srjbfejkkk98u"
-)
-```
-
-#### `unique_sdk.Content.upsert`
-
-Enables upload of a new Content into the Knowledge base of unique into a specific scope with `scopeId` or a specific `chatId`. One of the two must be set.
-
-Typical usage is the following. That creates a Content and uploads a file
-
-```python
-
-createdContent = upload_file(
-    userId,
-    companyId,
-    "/path/to/file.pdf",
-    "test.pdf",
-    "application/pdf",
-    "scope_stcj2osgbl722m22jayidx0n",
-    ingestionConfig={
-        "chunkMaxTokens": 1000,
-        "chunkStrategy": "default",
-        "uniqueIngestionMode": "standard",
-    },
-    metadata={
-        "folderIdPath": "uniquepathid://scope_id"
-    }
-)
-
-def upload_file(
-    userId,
-    companyId,
-    path_to_file,
-    displayed_filename,
-    mimeType,
-    description=None,
-    scope_or_unique_path,
-    ingestion_config=None,
-    metadata=None,
-):
-    size = os.path.getsize(path_to_file)
-    createdContent = unique_sdk.Content.upsert(
-        user_id=userId,
-        company_id=companyId,
-        input={
-            "key": displayed_filename,
-            "title": displayed_filename,
-            "mimeType": mimeType,
-            "description": description,
-            "ingestionConfig": ingestionConfig,
-            "metadata": metadata,
-        },
-        scopeId=scope_or_unique_path,
-    )
-
-    uploadUrl = createdContent.writeUrl
-
-    # upload to azure blob storage SAS url uploadUrl the pdf file translatedFile make sure it is treated as a application/pdf
-    with open(path_to_file, "rb") as file:
-        requests.put(
-            uploadUrl,
-            data=file,
-            headers={
-                "X-Ms-Blob-Content-Type": mimeType,
-                "X-Ms-Blob-Type": "BlockBlob",
-            },
-        )
-
-    unique_sdk.Content.upsert(
-        user_id=userId,
-        company_id=companyId,
-        input={
-            "key": displayed_filename,
-            "title": displayed_filename,
-            "mimeType": mimeType,
-            "description": description,
-            "byteSize": size,
-            "ingestionConfig": ingestionConfig,
-            "metadata": metadata,
-        },
-        scopeId=scope_or_unique_path,
-        readUrl=createdContent.readUrl,
-    )
-
-    return createdContent
-
-```
-
-#### `unique_sdk.Content.ingest_magic_table_sheets`
-
-Allows you to ingest a magic table sheet, each row is processed and converted into a content.
-```python
-    params = {
-      "user_id": user_id,
-      "company_id": company_id,
-      "data": [
-         {
-            "rowId": "2",
-            "columns": [
-               {"columnId": "0", "columnName": "Section", "content": "Other"},
-               {"columnId": "1", "columnName": "Question", "content": "What do you know?"},
-               {
-                  "columnId": "2",
-                  "columnName": "Knowledge Base Answer",
-                  "content": "Lorem Ipsum is simply dummy texktop publishing software.",
-               },
-            ],
-         },
-      ],
-      "ingestionConfiguration": {
-         "columnIdsInMetadata": ["1", "2"],
-         "columnIdsInChunkText": ["1", "2"],
-      },
-      "metadata": {
-         "libraryName": "foo",
-      },
-      "scopeId": scope_id,
-      "sheetName": "Sheet1",
-   }
-
-    unique_sdk.Content.ingest_magic_table_sheets(**params)
-```
-
-#### `unique_sdk.Content.update` (Compatible with release >.36)
-
-Allows you to update a file specified by its `contentId` or by its `filePath`.
-
-- `contentId` optional if `filePath` is provided, the id of the file to be updated
-- `filePath` optional if `contentId` is provided, the absolute path of the file to be updated
-
-Currently, the following updates are supported:
-
-Title update:
-- `title` optional, allows updating the title of the file
-
-Move the file to a different folder. This can be done by specifying either the `ownerId` or the `parentFolderPath`.
-- `ownerId` optional, allows moving the file to a different folder. Represents the new folder for the file and it should be the id of a folder e.g.: `scope_dhjfieurfloakmdle`.
-- `parentFolderPath` optional, allows moving the file to a different folder. Represents the path new folder for the file.
-
-Metadata update:
-- `metadata` optional, allows updating the metadata of the file. Default metadata can not be overridden. (Available with release >.40)
-
-Example of updating the title of a file specified by its path.
-
-```python
-unique_sdk.Content.update(
-    user_id=user_id,
-    company_id=company_id,
-    filePath="/Company/finance/january.xls",
-    title="Revision Deck"
-)
-```
-
-Example of moving a file specified by its content id.
-
-```python
-unique_sdk.Content.update(
-    user_id=user_id,
-    company_id=company_id,
-    contentId="cont_ok2343q5owbce80w78hudawu5",
-    ownerId="scope_e68yz5asho7glfh7c7d041el",
-    metadata={
-        "quarter": "q1",
-    }
-)
-```
-
-Example of moving a file and updating its title.
-
-```python
-unique_sdk.Content.update(
-    user_id=user_id,
-    company_id=company_id,
-    contentId="cont_ok2343q5owbce80w78hudawu5",
-    ownerId="scope_e68yz5asho7glfh7c7d041el",
-    title="Revision Deck (1)"
-)
-```
-
-Example of moving a file to a folder specified by its path.
-
-```python
-unique_sdk.Content.update(
-    user_id=user_id,
-    company_id=company_id,
-    contentId="cont_ok2343q5owbce80w78hudawu5",
-    ownerId="scope_e68yz5asho7glfh7c7d041el",
-    parentFolderPath="/Company/Revisions"
-)
-```
-
-#### `unique_sdk.Content.delete` (Compatible with release >.36)
-
-Allows you to delete a file by its `contentId`. If the file is part of a chat, the `chatId` also needs do be set.
-
-- `contentId` optional if `filePath` is provided, the id of the file to be deleted
-- `chatId` optional, the id of the chat where the file is. Only needed if the file is part of a chat
-- `filePath` optional if `contentId` is provided, the absolute path of the file to be deleted
-
-Example of deleting a file from a chat.
-
-```python
-unique_sdk.Content.delete(
-    user_id=user_id,
-    company_id=company_id,
-    contentId="cont_ok2343q5owbce80w78hudawu5",
-    chatId="chat_v3xfa7liv876h89vuiibus1"
-)
-```
-
-Example of deleting a file by its path.
-
-```python
-unique_sdk.Content.delete(
-    user_id=user_id,
-    company_id=company_id,
-    filePath="/Company/finance/january.xls",
-)
-```
-
-
-### Message
-
-#### `unique_sdk.Message.list`
-
-Retrieve a list of messages for a provided `chatId`.
-
-```python
-messages = unique_sdk.Message.list(
-    user_id=user_id,
-    company_id=company_id,
-    chatId=chat_id,
-)
-```
-
-#### `unique_sdk.Message.retrieve`
-
-Get a single chat message.
-
-```python
-message = unique_sdk.Message.retrieve(
-    user_id=user_id,
-    company_id=company_id,
-    id=message_id,
-    chatId=chat_id,
-)
-```
-
-#### `unique_sdk.Message.create`
-
-Create a new message in a chat.
-
-```python
-message = unique_sdk.Message.create(
-    user_id=user_id,
-    company_id=company_id,
-    chatId=chat_id,
-    assistantId=assistant_id,
-    text="Hello.",
-    role="ASSISTANT",
-)
-```
-
-#### `unique_sdk.Message.create_event`
-
-Create a new message event in a chat. Updating the text of a message in the chat UI is possible by creating a message update event. This function can be used for custom streaming to the chat. (Compatible with release >.42)
-
-The event only changes the text in the UI, it *does not* update the database.
-
-```python
-message = unique_sdk.Message.create_event(
-    user_id=user_id,
-    company_id=company_id,
-    messageId="msg_l4ushn85yqbewpf6tllh2cl7",
-    chatId="chat_kc8p3kgkn7393qhgmv5js5nt",
-    text="Hello.",                  #optional
-    originalText="Hello.",          #optional
-    references=[],                  #optional
-    gptRequest={}                   #optional
-    debugInfo={  "hello": "test" }, #optional
-)
-```
-
-#### `unique_sdk.Message.modify`
-
-Modify an existing chat message.
-
-ℹ️ if you modify the debugInfo only do it on the user message as this is the only place that is displayed in the frontend.
-
-```python
-message = unique_sdk.Message.modify(
-    user_id=user_id,
-    company_id=company_id,
-    id=message_id,
-    chatId=chat_id,
-    text="Updated message text"
-)
-```
-
-#### `unique_sdk.Message.delete`
-
-Delete a chat message.
-
-```python
-message = unique_sdk.Message.delete(
-    message_id,
-    user_id=user_id,
-    company_id=company_id,
-    chatId=chat_id,
-)
-```
-
-#### `unique_sdk.Integrated.stream`
-
-Streams the answer to the chat frontend. Given the messages.
-
-if the stream creates [source0] it is referenced with the references from the search context.
-
-E.g.
-
-```
-Hello this information is from [srouce1]
-```
-
-adds the reference at index 1 and then changes the text to:
-
-```
-Hello this information is from <sub>0</sub>
-```
-
-```python
-unique_sdk.Integrated.chat_stream_completion(
-    user_id=userId,
-    company_id=companyId,
-    assistantMessageId=assistantMessageId,
-    userMessageId=userMessageId,
-    messages=[
-        {
-            "role": "system",
-            "content": "be friendly and helpful"
-        },
-        {
-            "role": "user",
-            "content": "hello"
-        }
-    ],
-    chatId=chatId,
-
-    searchContext=  [
-        {
-            "id": "ref_qavsg0dcl5cbfwm1fvgogrvo",
-            "chunkId": "0",
-            "key": "some reference.pdf : 8,9,10,11",
-            "sequenceNumber": 1,
-            "url": "unique://content/cont_p8n339trfsf99oc9f36rn4wf"
-        }
-    ],  # optional
-    debugInfo={
-        "hello": "test"
-    }, # optional
-    startText= "I want to tell you about: ", # optional
-    model= "AZURE_GPT_4_32K_0613", # optional
-    timeout=8000,  # optional in ms
-    options={
-                "temperature": 0.5
-            } # optional
-)
-```
-
-**Warning:** Currently, the deletion of a chat message does not automatically sync with the user UI. Users must refresh the chat page to view the updated state. This issue will be addressed in a future update of our API.
-
-
-#### `unique_sdk.Integrated.responses_stream`
-
-Streams the answer to the chat frontend using the Responses API. Given the messages.
-
-if the stream creates [source0] it is referenced with the references from the search context.
-
-E.g.
-
-```
-Hello this information is from [source1]
-```
-
-adds the reference at index 1 and then changes the text to:
-
-```
-Hello this information is from <sub>0</sub>
-```
-
-```python
-unique_sdk.Integrated.responses_stream(
-    user_id=userId,
-    company_id=companyId,
-    model="AZURE_o3_2025_0416",
-    assistantMessageId=assistantMessageId,
-    userMessageId=userMessageId,
-    input="Tell me about the curious case of neural text degeneration",
-    chatId=chatId,
-)
-```
-
-**Warning:** Currently, the deletion of a chat message does not automatically sync with the user UI. Users must refresh the chat page to view the updated state. This issue will be addressed in a future update of our API.
-
-### Message Log
-
-#### `unique_sdk.MessageLog.create`
-
-Function to update the steps section of a message in the chat UI. This is possible by creating a message log record during a message execution.
-
-```python
-msg_log = unique_sdk.MessageLog.create(
-    user_id=user_id,
-    company_id=company_id,
-    messageId="msg_a0jgnt1jrqv1d3uzr450waxw",
-    text="Create message log text",
-    order=1,
-    status="RUNNING",                             # one of "RUNNING", "COMPLETED", "FAILED"
-    details={},                                   # optional, details dictionary
-    uncitedReferences={},                         # optional, references dictionary
-    references=[],                                # optional, list of references
-)
-```
-
-#### `unique_sdk.MessageLog.update`
-
-Update a message log for a provided `messageId`.
-
-```python
-msg_log = unique_sdk.MessageLog.update(
-    user_id=user_id,
-    company_id=company_id,
-    message_log_id="message_log_fd7z7gjljo1z2wu5g6l9q7r9",
-    text="Update a message log text",             # optional
-    order=1,                                      # optional
-    status="RUNNING",                             # one of "RUNNING", "COMPLETED", "FAILED"
-    details={},                                   # optional, details dictionary
-    uncitedReferences={},                         # optional, references dictionary
-    references=[],                                # optional, list of references
-)
-```
-
-### Message Execution
-
-#### `unique_sdk.MessageExecution.create`
-
-Create a message execution for a provided `messageId` and `chatId`.
-
-```python
-msg_execution = unique_sdk.MessageExecution.create(
-    user_id=user_id,
-    company_id=company_id,
-    messageId="msg_a0jgnt1jrqv143uzr750waxw",
-    type="DEEP_RESEARCH",
-)
-```
-
-#### `unique_sdk.MessageExecution.get`
-
-Get a message execution for a provided `messageId`.
-
-```python
-msg_execution = unique_sdk.MessageExecution.get(
-    user_id=user_id,
-    company_id=company_id,
-    messageId="msg_a0jgnt1jrqv143uzr750waxw",
-)
-```
-
-#### `unique_sdk.MessageExecution.update`
-
-Update a message execution for a provided `messageId`.
-
-```python
-msg_execution = unique_sdk.MessageExecution.update(
-    user_id=user_id,
-    company_id=company_id,
-    messageId="msg_a0jgnt1jrqv143uzr750waxw",
-    status="COMPLETED",                        # optional, one of: COMPLETED, FAILED - not specifying the status will have no effect over the status
-    secondsRemaining=55,                       # optional, number defining the seconds remaining
-    percentageCompleted=10,                    # optional, number defining the percentage completed
-)
-```
-
-### Chat Completion
-
-#### `unique_sdk.ChatCompletion.create`
-
-Send a prompt to an AI model supported by Unique AI and receive a result. The `messages` attribute must follow the [OpenAI API format](https://platform.openai.com/docs/api-reference/chat).
-
-```python
-chat_completion = unique_sdk.ChatCompletion.create(
-    company_id=company_id,
-    user_id=user_id
-    model="AZURE_GPT_4o_2024_1120",
-    messages=[
-        {"role": "system", "content": "You are a helpful assistant."},
-        {"role": "user", "content": "Hello!"},
-    ],
-    options={
-        "temperature": 0.5,             # optional
-    } # optional
-)
-```
-
-### Embeddings
-
-#### `unique_sdk.Embeddings.create`
-
-Sends an array of `text` to the AI model for embedding. And retrieve a vector of embeddings.
-
-```python
-result = unique_sdk.Embeddings.create(
-    user_id=user_id,
-    company_id=company_id,
-    texts=["hello", "hello"],
-)
-print(result.embeddings[0][0])
-```
-
-### Acronyms
-
-#### `unique_sdk.Acronyms.get`
-
-Fetches the acronyms defined on the company. Often used to replace in user prompts, so the acronym is resolved to give better guidance to the LLM during completion.
-
-```python
-result = unique_sdk.Acronyms.get(
-    user_id=user_id,
-    company_id=company_id,
-)
-print(result)
-```
-
-### Search
-
-#### `unique_sdk.Search.create`
-
-Search the Unique AI Knowledge database for RAG (Retrieval-Augmented Generation). The API supports vector search and a `searchType` that combines vector and full-text search, enhancing the precision of search results.
-
-These are the options are available for `searchType`:
-
-- `VECTOR`
-- `COMBINED`
-
-`limit` (max 1000) and `page` are optional for iterating over results.
-`chatOnly` Restricts the search exclusively to documents uploaded within the chat.
-`scopeIds` Specifies a collection of scope IDs to confine the search.
-`language` Optional. The language specification for full text search.
-`reranker` Optional. The reranker service to be used for re-ranking the search results.
-`chatId` Optional, adds the documents uploaded in this chat to the scope of searched documents.
-`scoreThreshold` Optional, sets the minimum similarity score for search results to be considered. Using 0 is recommended.
-
-```python
-search = unique_sdk.Search.create(
-    user_id=user_id,
-    company_id=company_id,
-    chatId=chat_id
-    searchString="What is the meaning of life, the universe and everything?",
-    searchType="VECTOR",
-    chatOnly=false,
-    scopeIds=["scope_..."],
-    language="German",
-    reranker={"deploymentName": "my_deployment"},
-    limit=20,
-    page=1
-    scoreThreshold=0
-)
-```
-
-### Search String
-
-#### `unique_sdk.SearchString.create`
-
-User messages are sometimes suboptimal as input prompts for vector or full-text knowledge base searches. This is particularly true as a conversation progresses and a user question may lack crucial context for a successful search.
-
-This API transforms and translates (into English) the user's message into an ideal search string for use in the [Search.create](#unique_sdksearchcreate) API method.
-
-Adding a `chatId` or `messages` as arguments allows the message history to provide additional context to the search string. For example, "Who is the author?" will be expanded to "Who is the author of the book 'The Hitchhiker's Guide to the Galaxy'?" if previous messages referenced the book.
-
-```python
-search_string = unique_sdk.SearchString.create(
-    user_id=user_id,
-    company_id=company_id,
-    prompt="Was ist der Sinn des Lebens, des Universums und des ganzen Rests?",
-    chat_id=chat_id
-)
-```
-
-### Short Term Memory
-
-For saving data in between chats there is the Short Term Memory functionality to save small data in between rounds of chat e.g. language, search results and so on.
-For this 10k chars can be used. You can save a short term memory for a chat `chatId` or for a message `messageId`.
-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
-c = unique_sdk.ShortTermMemory.create(
-    user_id=user_id,
-    company_id=company_id,
-    data="hello",
-    chatId="chat_x0xxtj89f7drjp4vmued3q",
-    # messageId = "msg_id",
-    memoryName="your memory name",
-)
-print(c)
-```
-
-#### `unique_sdk.ShortTermMemory.find-latest`
-
-```python
-m = unique_sdk.ShortTermMemory.find_latest(
-    user_id=user_id,
-    company_id=company_id,
-    chatId="chat_x0xxtj89f7drjp4vmued3q",
-     # messageId = "msg_id",
-    memoryName="your memory name",
-)
-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="RED",
-    type="HALLUCINATION",
-    title="Hallucination detected",
-    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="RED",
-    title="update title"
-    type="HALLUCINATION"
-)
-```
-
-### Folder
-
-#### `unique_sdk.Folder.get_info`
-
-Get a folder by scope id or by path.
-
-By scope id:
-
-```python
-unique_sdk.Folder.get_info(
-   user_id=user_id,
-   company_id=company_id,
-   scopeId="scope_w78wfn114va9o22s13r03yq",
-)
-```
-
-By path:
-
-```python
-unique_sdk.Folder.get_info(
-   user_id=user_id,
-   company_id=company_id,
-   folderPath="/Company/Atlas/Due Dilligence/Arch,
-)
-```
-
-#### `unique_sdl.Folder.get_infos`
-
-Get paginated folders info based on parentId. If the parentId is not defined, the root folders will be returned.
-
-```python
-unique_sdk.Folder.get_infos(
-    user_id=user_id,
-    company_id=company_id,
-    take=10,                                    #optional
-    skip=5,                                     #optional
-    parentId="scope_s18seqpnltf35niydg77xgyp"   #optional
-)
-```
-
-#### `unique_sdk.Folder.create_paths`
-
-Create each folder in the provided list of paths if it does not already exist.
-
-```python
-unique_sdk.Folder.create_paths(
-   user_id=user_id,
-   company_id=company_id,
-   paths=["/unique/path1", "/unique/path2"],
-)
-```
-
-#### `unique_sdk.Folder.update_ingestion_config`
-
-Allows you to update the ingestion config of a folder and choose whether to apply to the subscopes or not: `
-
-- `ingestionConfig`
-- `applyToSubScopes`
-
-The update can be done by referencing the folder by id or by path. If none of them are provided. the API will return an error. If both of them are provided, the scope id will take precedence.
-
-Example of updating the ingestion config of a folder and its subfolders using the id.
-
-```python
-unique_sdk.Folder.update_ingestion_config(
-    user_id=user_id,
-    company_id=company_id,
-    scopeId="scope_qbnkde820dbmuw2900,
-    ingestionConfig={
-        "chunkStrategy": "default",
-        "uniqueIngestionMode": "standard",
-    },
-    applyToSubScopes=True
-)
-```
-
-Example of updating the ingestion config of a folder and its subfolders using the path.
-
-```python
-unique_sdk.Folder.update_ingestion_config(
-    user_id=user_id,
-    company_id=company_id,
-    folderPath="/Company/folder1/folder2",
-    ingestionConfig={
-        "chunkStrategy": "default",
-        "uniqueIngestionMode": "standard",
-    },
-    applyToSubScopes=True
-)
-```
-
-#### `unique_sdk.Folder.add_access`
-
-Allows you to add access to a folder and apply to the subfolders or not: `
-
-- `scopeAccesses`
-- `applyToSubScopes`
-
-The update can be done by referencing the folder by id or by path. If none of them are provided. the API will return an error. If both of them are provided, the scope id will take precedence.
-
-Example of adding access to a folder and its subfolders using the id.
-
-```python
-unique_sdk.Folder.add_access(
-    user_id=user_id,
-    company_id=company_id,
-    scopeId="scope_231e4kjn4foffww34",
-    scopeAccesses=[
-        {
-            "entityId": "group_id",
-            "type": "WRITE",
-            "entityType": "GROUP",
-        }
-    ],
-    applyToSubScopes=True,
-)
-```
-
-Example of adding access to a folder and its subfolders using the folder path.
-
-```python
-unique_sdk.Folder.add_access(
-    user_id=user_id,
-    company_id=company_id,
-    folderPath="/Company/folder1/folder2"
-    scopeAccesses=[
-        {
-            "entityId": "group_id",
-            "type": "WRITE",
-            "entityType": "GROUP",
-        }
-    ],
-    applyToSubScopes=True,
-)
-```
-
-#### `unique_sdk.Folder.remove_access`
-
-Allows you to delete access from a folder and apply to the subfolders or not:
-
-- `scopeAccesses`
-- `applyToSubScopes`
-
-The update can be done by referencing the folder by id or by path. If none of them are provided. the API will return an error. If both of them are provided, the scope id will take precedence.
-
-
-Example of deleting the access from a folder and its subfolders using the id.
-
-```python
-unique_sdk.Folder.remove_access(
-    user_id=user_id,
-    company_id=company_id,
-    scopeId="scope_dwekjnf3330woioppm,
-    scopeAccesses=[
-        {
-            "entityId": "group_id",
-            "type": "WRITE",
-            "entityType": "GROUP",
-        }
-    ],
-    applyToSubScopes=True,
-)
-```
-
-
-Example of deleting the access from a folder and its subfolders using the path.
-
-```python
-unique_sdk.Folder.remove_access(
-    user_id=user_id,
-    company_id=company_id,
-    folderPath="/Company/folder1/folder2"
-    scopeAccesses=[
-        {
-            "entityId": "group_id",
-            "type": "WRITE",
-            "entityType": "GROUP",
-        }
-    ],
-    applyToSubScopes=True,
-)
-```
-
-#### `unique_sdk.Folder.update`
-Uupdate a folder specified by its `scopeId` or path. The following properties can be updated:
-- parent folder - move the folder to a new parent folder specified by its `scopeId` or path. If the new parent folder is the root folder, the `parentId` should be explicitly specificed by setting `newParentId` to `None`.
-- name - update the name by setting the `name` field to the new name.
-
-Examples:
-
-Move the folder specified by its `scopeId` to a new parent folder specified by its path.
-
-```python
-unique_sdk.Folder.update(
-    user_id=user_id,
-    company_id=company_id,
-    scopeId="scope_dwekjnf3330woioppm",
-    parentFolderPath="/Company/folder1/folder2"
-)
-```
-
-Move the parent of a folder specified by its path to a new parent folder specified by its `scopeId` and update the name to "January".
-
-```python
-unique_sdk.Folder.update(
-    user_id=user_id,
-    company_id=company_id,
-    folderPath="/Company/folder1",
-    parentId="scope_dweekjrfhirtuhgroppm",
-    name="January"
-)
-```
-
-Move the parent of a folder specified by its path to the root folder and update the name to "January".
-
-```python
-unique_sdk.Folder.update(
-    user_id=user_id,
-    company_id=company_id,
-    folderPath="/Company/folder1",
-    parentId=None,
-    name="January"
-)
-```
-
-
-#### `unique_sdk.Folder.delete` (Compatible with release >.36)
-
-Given a `scopeId` or `folderPath`, the function deletes the folder. If the folder is not empty or if the user has no WRITE access, the delete will fail.
-
-If `recursive` is set to true, the function also deletes its subfolders and its contents, behaving exactly like the `rm -rf`. In case a subfolder has no write access, that folder is considered as failed to delete and the function continues with the other subfolders. At the end, the function returns a list of `successFolders` and `failedFolders`.
-
-Examples:
-Deleting recursively by scope id:
-
-```python
-unique_sdk.Folder.delete(
-   user_id=user_id,
-   company_id=company_id,
-   scopeId="scope_w78wfn114va9o22s13r03yq",
-   recursive=True
-)
-```
-
-Deleting by path (non-recursive):
-
-```python
-unique_sdk.Folder.delete(
-   user_id=user_id,
-   company_id=company_id,
-   folderPath="/Company/Atlas/Due Dilligence/Arch",
-)
-```
-
-### Space
-
-#### `unique_sdk.Space.create_message`
-
-Send a message in a space. You can optionally provide a chat ID to continue an existing conversation, or omit it to start a new chat.
-
-```python
-message = unique_sdk.Space.create_message(
-    user_id=user_id,
-    company_id=company_id,
-    chatId="chat_dejfhe729br398",  # Optional - if not provided, a new chat will be created
-    assistantId="assistant_abc123",
-    text="Hello, how can you help me?",
-    toolChoices=["WebSearch"],  # Optional - list of tools to use
-    scopeRules={  # Optional - scope rules for filtering
-        "or": [
-            {
-                "operator": "contains",
-                "path": ["folderIdPath"],
-                "value": "uniquepathid://scope_123"
-            }
-        ]
-    },
-)
-```
-
-#### `unique_sdk.Space.get_chat_messages` (Compatible with release >.48)
-
-Get all messages in a space chat. Returns a list of paginated messages in the specified chat.
-
-```python
-messages = unique_sdk.Space.get_chat_messages(
-    user_id=user_id,
-    company_id=company_id,
-    chat_id="chat_dejfhe729br398",
-    skip=0,  # Optional (defaults to 0) - number of messages to skip for pagination
-    take=50,  # Optional (defaults to 10) - number of messages to return
-)
-```
-
-#### `unique_sdk.Space.get_latest_message`
-
-Get the latest message in a space chat.
-
-```python
-message = unique_sdk.Space.get_latest_message(
-    user_id=user_id,
-    company_id=company_id,
-    chat_id="chat_dejfhe729br398",
-)
-```
-
-#### `unique_sdk.Space.delete_chat`
-
-Delete a space chat by id. If the chat does not exist, the function will return an error.
-
-```python
-unique_sdk.Space.delete_chat(
-    user_id=user_id,
-    company_id=company_id,
-    chat_id="chat_dejfhe729br398",
-)
-```
-
-### LLM Models
-
-#### `unique_sdk.LLMModels.get` (Compatible with release >.46)
-
-Get available LLM models. You can optionally filter by module and skip cache to fetch fresh data.
-
-```python
-models = unique_sdk.LLMModels.get(
-    user_id=user_id,
-    company_id=company_id,
-    module="UNIQUE_AI",  # Optional - filter models by module, only UNIQUE_AI is supported right now
-)
-```
-
-### User
-
-#### `unique_sdk.User.get_users` (Compatible with release >.48)
-
-Get users in a company. You can filter by email, display name, and use pagination with skip and take parameters.
-
-```python
-users = unique_sdk.User.get_users(
-    user_id=user_id,
-    company_id=company_id,
-    skip=0,  # Optional - number of records to skip for pagination
-    take=50,  # Optional - number of records to return (max 1000)
-    email="user@example.com",  # Optional - filter by email
-    displayName="John",  # Optional - filter by display name
-)
-```
-
-### Group
-
-#### `unique_sdk.Group.create_group` (Compatible with release >.48)
-
-Create a new group in a company. You can specify the group name (required), external ID and parent group ID.
-
-```python
-group = unique_sdk.Group.create_group(
-    user_id=user_id,
-    company_id=company_id,
-    name="New Group",  # Required - the name of the group
-    externalId="ext_123",  # Optional - external ID for the group
-    parentId="group_a9cs7wr2z1bg2sxczvltgjch",  # Optional - parent group ID
-)
-```
-
-#### `unique_sdk.Group.get_groups` (Compatible with release >.48)
-
-Get groups in a company. You can filter by name and use pagination with skip and take parameters.
-
-```python
-groups = unique_sdk.Group.get_groups(
-    user_id=user_id,
-    company_id=company_id,
-    skip=0,  # Optional - number of records to skip for pagination
-    take=50,  # Optional - number of records to return (max 1000)
-    name="Admin",  # Optional - filter by group name
-)
-```
-
-#### `unique_sdk.Group.update_group` (Compatible with release >.48)
-
-Update a group in a company. You can update the group's name.
-
-```python
-updated_group = unique_sdk.Group.update_group(
-    user_id=user_id,
-    company_id=company_id,
-    group_id="group_a9cs7wr2z1bg2sxczvltgjch",
-    name="New Group Name",  # Optional - update the group name
-)
-```
-
-#### `unique_sdk.Group.add_users_to_group` (Compatible with release >.48)
-
-Add users to a group. Provide an array of user IDs to add as members to the specified group.
-
-```python
-result = unique_sdk.Group.add_users_to_group(
-    user_id=user_id,
-    company_id=company_id,
-    group_id="group_a9cs7wr2z1bg2sxczvltgjch",
-    userIds=["299420877169688584", "325402458132058201", "299426678160031752"],  # Required - array of user IDs to add
-)
-```
-
-#### `unique_sdk.Group.remove_users_from_group` (Compatible with release >.48)
-
-Remove users from a group. Provide an array of user IDs to remove from the specified group.
-
-```python
-result = unique_sdk.Group.remove_users_from_group(
-    user_id=user_id,
-    company_id=company_id,
-    group_id="group_a9cs7wr2z1bg2sxczvltgjch",
-    userIds=["299426678160031752", "299426678160031752"],  # Required - array of user IDs to remove
-)
-```
-
-#### `unique_sdk.Group.delete_group` (Compatible with release >.48)
-
-Delete a group in a company by its group ID.
-
-```python
-result = unique_sdk.Group.delete_group(
-    user_id=user_id,
-    company_id=company_id,
-    group_id="group_a9cs7wr2z1bg2sxczvltgjch",
-)
-```
-
-### Agentic Table
-
-The Agentic Table (Magic Table) API provides functionality for managing interactive tables with AI-powered cells, activity tracking, and metadata management.
-
-#### `unique_sdk.AgenticTable.set_cell`
-
-Set the content of a specific cell in the magic table. This method allows you to update cell text and optionally add log entries to track changes.
-
-```python
-cell = await unique_sdk.AgenticTable.set_cell(
-    user_id=user_id,
-    company_id=company_id,
-    tableId="sheet_abc123",
-    rowOrder=0,
-    columnOrder=1,
-    text="Updated cell content",
-    logEntries=[  # optional
-        {
-            "text": "Cell updated by automation",
-            "createdAt": "2024-01-01T00:00:00.000Z",
-            "actorType": "SYSTEM",  # One of: "USER", "SYSTEM", "ASSISTANT", "TOOL"
-            "messageId": "msg_123",  # optional
-            "details": [  # optional
-                {
-                    "text": "Processing completed",
-                    "messageId": "msg_456"  # optional
-                }
-            ]
-        }
-    ]
-)
-```
-
-#### `unique_sdk.AgenticTable.get_cell`
-
-Retrieve the content and metadata of a specific cell.
-
-```python
-cell = await unique_sdk.AgenticTable.get_cell(
-    user_id=user_id,
-    company_id=company_id,
-    tableId="sheet_abc123",
-    rowOrder=0,
-    columnOrder=1,
-)
-```
-
-#### `unique_sdk.AgenticTable.set_multiple_cells`
-
-Bulk update multiple cells in a single operation for better performance.
-
-```python
-result = await unique_sdk.AgenticTable.set_multiple_cells(
-    user_id=user_id,
-    company_id=company_id,
-    tableId="sheet_abc123",
-    cells=[
-        {
-            "rowOrder": 0,
-            "columnOrder": 0,
-            "text": "Cell A1"
-        },
-        {
-            "rowOrder": 0,
-            "columnOrder": 1,
-            "text": "Cell B1"
-        },
-        {
-            "rowOrder": 1,
-            "columnOrder": 0,
-            "text": "Cell A2"
-        }
-    ]
-)
-```
-
-#### `unique_sdk.AgenticTable.get_sheet_data`
-
-Retrieve comprehensive data about a magic table sheet, including cells, log history, and metadata.
-
-```python
-sheet = await unique_sdk.AgenticTable.get_sheet_data(
-    user_id=user_id,
-    company_id=company_id,
-    tableId="sheet_abc123",
-    includeCells=True,             # optional
-    includeLogHistory=True,        # optional
-    includeRowCount=True,          # optional
-    includeCellMetaData=True,      # optional
-    startRow=0,                    # optional: specify row range
-    endRow=10                      # optional: specify row range
-)
-```
-
-#### `unique_sdk.AgenticTable.get_sheet_state`
-
-Get the current state of a magic table sheet.
-
-```python
-state = await unique_sdk.AgenticTable.get_sheet_state(
-    user_id=user_id,
-    company_id=company_id,
-    tableId="sheet_abc123"
-)
-# Returns: "PROCESSING", "IDLE", or "STOPPED_BY_USER"
-```
-
-#### `unique_sdk.AgenticTable.update_sheet_state`
-
-Update the name or state of a magic table sheet.
-
-```python
-result = await unique_sdk.AgenticTable.update_sheet_state(
-    user_id=user_id,
-    company_id=company_id,
-    tableId="sheet_abc123",
-    name="Updated Sheet Name",  # optional
-    state="IDLE"  # optional, one of: "PROCESSING", "IDLE", "STOPPED_BY_USER"
-)
-```
-
-#### `unique_sdk.AgenticTable.set_activity`
-
-Set the status of an activity on the magic table sheet. This is useful for tracking long-running operations.
-
-```python
-result = await unique_sdk.AgenticTable.set_activity(
-    user_id=user_id,
-    company_id=company_id,
-    tableId="sheet_abc123",
-    activity="UpdateCell",
-    # activity: one of "DeleteRow", "DeleteColumn", "UpdateCell", "AddQuestionText", 
-    # "AddMetaData", "GenerateArtifact", "SheetCompleted", "LibrarySheetRowVerified"
-    status="IN_PROGRESS",
-    # status: one of "IN_PROGRESS", "COMPLETED", "FAILED"
-    text="Updating cells with AI-generated content"
-)
-```
-
-#### `unique_sdk.AgenticTable.set_artifact`
-
-Attach an artifact (such as a generated document) to the magic table sheet.
-
-```python
-result = await unique_sdk.AgenticTable.set_artifact(
-    user_id=user_id,
-    company_id=company_id,
-    tableId="sheet_abc123",
-    name="Generated Report",
-    contentId="cont_xyz789",
-    mimeType="application/pdf",
-    artifactType="FULL_REPORT"  # One of: "QUESTIONS", "FULL_REPORT"
-)
-```
-
-#### `unique_sdk.AgenticTable.set_column_metadata`
-
-Configure metadata for a specific column, including width, filters, and cell renderers.
-
-```python
-result = await unique_sdk.AgenticTable.set_column_metadata(
-    user_id=user_id,
-    company_id=company_id,
-    tableId="sheet_abc123",
-    columnOrder=2,
-    columnWidth=200,  # optional
-    filter="ValueMatchFilter",  # optional
-    # filter: one of "ValueMatchFilter", "PartialMatchFilter", "ReferenceFilter", 
-    # "HallucinationFilter", "ReviewStatusFilter", "AssigneeFilter"
-    cellRenderer="CheckboxLockCellRenderer",  # optional
-    # cellRenderer: one of "CheckboxLockCellRenderer", "CollaboratorDropdown", 
-    # "ReviewStatusDropdown", "CustomCellRenderer", "SelectableCellRenderer"
-    editable=True  # optional
-)
-```
-
-#### `unique_sdk.AgenticTable.set_cell_metadata`
-
-Set metadata for a specific cell, including selection status and agreement status.
-
-```python
-result = await unique_sdk.AgenticTable.set_cell_metadata(
-    user_id=user_id,
-    company_id=company_id,
-    tableId="sheet_abc123",
-    rowOrder=0,
-    columnOrder=1,
-    selected=True,                # optional
-    selectionMethod="MANUAL",     # optional, one of: "DEFAULT", "MANUAL"
-    agreementStatus="MATCH"       # optional, one of: "MATCH", "NO_MATCH"
-)
-```
-
-#### `unique_sdk.AgenticTable.bulk_update_status`
-
-Update the verification status of multiple rows at once.
-
-```python
-result = await unique_sdk.AgenticTable.bulk_update_status(
-    user_id=user_id,
-    company_id=company_id,
-    tableId="sheet_abc123",
-    rowOrders=[0, 1, 2, 3, 4],
-    status="VERIFIED"
-    # status: one of "NEED_REVIEW", "READY_FOR_VERIFICATION", "VERIFIED"
-)
-```
-
-## 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.
-
-### UniqueQL Query Structure
-
-A UniqueQL query is composed of a path, an operator, and a value. The path specifies the metadata attribute to be filtered, the operator defines the type of comparison, and the value provides the criteria for the filter.
-
-A metadata filter can be designed with UniqueQL's `UQLOperator` and `UQLCombinator` as follows:
-
-```python
-metadata_filter = {
-        "path": ['diet', '*'],
-        "operator": UQLOperator.NESTED,
-        "value": {
-            UQLCombinator.OR : [
-                {
-                    UQLCombinator.OR: [
-                        {
-                            "path": ['food'],
-                            "operator": UQLOperator.EQUALS,
-                            "value": "meat",
-                        },
-                        {
-                            "path": ['food'],
-                            "operator": UQLOperator.EQUALS,
-                            "value": 'vegis',
-                        },
-                    ],
-                },
-                {
-                    "path": ['likes'],
-                    "operator": UQLOperator.EQUALS,
-                    "value": true,
-                },
-            ],
-        },
-    }
-```
-
-### Metadata Filtering
-
-A metadata filter such as the one designed above can be used in a `Search.create` call by passing it the `metaDataFilter` parameter.
-
-```python
-    search_results = unique_sdk.Search.create(
-        user_id=user_id,
-        company_id=company_id,
-        chatId=chat_id,
-        searchString=search_string,
-        searchType="COMBINED",
-        # limit=2,
-        metaDataFilter=metadata_filter,
-    )
-```
-
-## Utils
-
-- [Chat History](#chat-history)
-- [File Io](#file-io)
-- [Sources](#sources)
-- [token](#token)
-- [Chat In Space](#chat-in-space)
-
-### Chat History
-
-#### `unique_sdk.utils.chat_history.load_history`
-
-A helper function that makes sure the chat history is fully loaded and cut to the size of the token window that it fits into the next round of chat interactions.
-
-- `maxTokens` max tokens of the model used
-- `percentOfMaxTokens`=0.15 % max history in % of `maxTokens`
-- `maxMessages`=4, maximal number of messages included in the history.
-
-this method also directly returns a correct formatted history that can be used in the next chat round.
-
-```python
-history = unique_sdk.utils.chat_history.load_history(
-    userId,
-    companyId,
-    chatId
-)
-```
-
-#### `unique_sdk.utils.chat_history.convert_chat_history_to_injectable_string`
-
-convert history into a string that can be injected into a prompt. it als returns the token length of the converted history.
-
-```
-chat_history-string, chat_context_token_length = unique_sdk.utils.chat_history.convert_chat_history_to_injectable_string(
-    history
-)
-```
-
-### File Io
-
-Interacting with the knowledge-base.
-
-#### `unique_sdk.utils.file_io.download_content`
-
-download files and save them into a folder in `/tmp`
-
-for example using the readUrl from a content.
-
-```python
-pdfFile = download_content(
-    companyId=companyId,
-    userId=userId,
-    content_id="cont_12412",
-    filename="hello.pdf",
-    chat_id=None # If specified, it downloads it from the chat
-)
-```
-
-#### `unique_sdk.utils.file_io.upload_file`
-
-Allows for uploading files that then get ingested in a scope or a chat.
-
-```python
-createdContent = upload_file(
-    companyId=companyId,
-    userId=userId,
-    path_to_file="/tmp/hello.pdf",
-    displayed_filename="hello.pdf",
-    mime_type="application/pdf",
-    scope_or_unique_path="scope_stcj2osgbl722m22jayidx0n",
-    chat_id=None,
-)
-```
-
-### Sources
-
-#### `unique_sdk.utils.sources.merge_sources`
-
-Merges multiple search results based on their 'id', removing redundant document and info markers.
-
-This function groups search results by their 'id' and then concatenates their texts,
-cleaning up any document or info markers in subsequent chunks beyond the first one.
-
-Parameters:
-
-- searchContext (list): A list of dictionaries, each representing a search result with 'id' and 'text' keys.
-
-Returns:
-
-- list: A list of dictionaries with merged texts for each unique 'id'.
-
-`searchContext` is an list of search objects that are returned by the search.
-
-```python
-search = unique_sdk.Search.create(
-    user_id=userId,
-    company_id=companyId,
-    chatId=chatId,
-    searchString="Who is Harry P?",
-    searchType="COMBINED",
-    scopeIds="scope_dsf...",
-    limit=30,
-    chatOnly=False,
-)
-
-searchContext = unique_sdk.utils.token.pick_search_results_for_token_window(
-        search["data"], config["maxTokens"] - historyLength
-    )
-
-searchContext = unique_sdk.utils.sources.merge_sources(search)
-
-```
-
-#### `unique_sdk.utils.sources.sort_sources`
-
-Sort sources by order of appearance in documents
-
-```python
-
-search = unique_sdk.Search.create(
-    user_id=userId,
-    company_id=companyId,
-    chatId=chatId,
-    searchString="Who is Harry P?",
-    searchType="COMBINED",
-    scopeIds="scope_dsf...",
-    limit=30,
-    chatOnly=False,
-)
-
-searchContext = unique_sdk.utils.token.pick_search_results_for_token_window(
-        search["data"], config["maxTokens"] - historyLength
-    )
-
-searchContext = unique_sdk.utils.sources.sort_sources(search)
-```
-
-#### `unique_sdk.utils.sources.post_process_sources`
-
-Post-processes the provided text by converting source references into superscript numerals (required
-format by backend to display sources in the chat window)
-
-This function searches the input text for patterns that represent source references (e.g., [source1])
-and replaces them with superscript tags, incrementing the number by one.
-
-Parameters:
-
-- text (str): The text to be post-processed.
-
-Returns:
-
-- str: The text with source references replaced by superscript numerals.
-
-Examples:
-
-- postprocessSources("This is a reference [source0]") will return "This is a reference <sup>1</sup>".
-
-```python
-
-text_with_sup = post_process_sources(text)
-```
-
-### Token
-
-#### unique_sdk.utils.token.pick_search_results_for_token_window
-
-Selects and returns a list of search results that fit within a specified token limit.
-
-This function iterates over a list of search results, each with a 'text' field, and
-encodes the text using a predefined encoding scheme. It accumulates search results
-until the token limit is reached or exceeded.
-
-Parameters:
-
-- searchResults (list): A list of dictionaries, each containing a 'text' key with string value.
-- tokenLimit (int): The maximum number of tokens to include in the output.
-
-Returns:
-
-- list: A list of dictionaries representing the search results that fit within the token limit.
-
-```python
-search = unique_sdk.Search.create(
-    user_id=userId,
-    company_id=companyId,
-    chatId=chatId,
-    searchString="Who is Harry P?",
-    searchType="COMBINED",
-    scopeIds="scope_dsf...",
-    limit=30,
-    chatOnly=False,
-)
-
-searchContext = unique_sdk.utils.token.pick_search_results_for_token_window(
-        search["data"], config["maxTokens"] - historyLength
-    )
-```
-
-#### unique_sdk.utils.token.count_tokens
-
-Counts the number of tokens in the provided text.
-
-This function encodes the input text using a predefined encoding scheme
-and returns the number of tokens in the encoded text.
-
-Parameters:
-
-- text (str): The text to count tokens for.
-
-Returns:
-
-- int: The number of tokens in the text.
-
-```python
-hello = "hello you!"
-searchContext = unique_sdk.utils.token.count_tokens(hello)
-```
-
-### Chat In Space
-
-#### `unique_sdk.utils.chat_in_space.send_message_and_wait_for_completion`
-
-The following script enables you to chat within a space using an assistant. You must provide an `assistantId` (e.g., `assistant_hjcdga64bkcjnhu4`) and the message `text` to initiate the conversation. You can send the message in an existing chat by specifying a `chat_id`, or omit the `chat_id` to automatically create a new chat session. Check the optional parameteres list for more configs.
-
-The script sends a prompt asynchronously and continuously polls for completion, which is determined when the `stoppedStreamingAt` field of the message becomes non-null.
-
-**Optional parameters:**
-- `tool_choices`: A list of tool names to be used for the message (e.g., `["WebSearch"]`). If not provided, no tools will be used. The tools supported right now are `WebSearch` and `InternalSearch`.
-- `scope_rules`: A filter to specify the scope rules for the message, allowing you to restrict the context or data sources available to the assistant. The filter is written in UniqueQL language. Find out more about the language in the UniqueQL section.
-- `chat_id`: The ID of the chat where the message should be sent. If omitted, a new chat will be created.
-- `poll_interval`: The number of seconds to wait between polling attempts (default: `1` second).
-- `max_wait`: The maximum number of seconds to wait for the message to complete (default: `60` seconds).
-- `stop_condition`: Defines when to expect a response back, when the assistant stop streaming or when it completes the message. (default: "stoppedStreamingAt")
-
-The script ensures you can flexibly interact with spaces in new or ongoing chats, with fine-grained control over tools, context, and polling behavior.
-
-```python
-from unique_sdk.utils.chat_in_space import send_message_and_wait_for_completion
-latest_message = await send_message_and_wait_for_completion(
-    user_id=user_id,
-    company_id=company_id,
-    assistant_id=assistant_id,
-    text="Tell me a short story.",
-    chat_id=chat_id,                # Optional - if no chat id is specified, a new chat will be created
-    tool_choices=["WebSearch"],
-    scope_rules={
-        "or": [
-            {
-                "operator": "in",
-                "path": [
-                    "contentId"
-                ],
-                "value": [
-                    "cont_u888z7cazxxm4lugfdjq7pks"
-                ]
-            },
-            {
-                "operator": "contains",
-                "path": [
-                    "folderIdPath"
-                ],
-                "value": "uniquepathid://scope_btfo28b3eeelwh5obwgea71bl/scope_fn56ta67knd6w4medgq3028fx"
-            }
-        ]
-    },
-    stop_condition = "completedAt" # If not specified, stoppedStreamingAt will be set by default
-)
-```
-
-#### `unique_sdk.utils.chat_in_space.chat_against_file`
-
-The following script enables you to chat against a file.
-
-You must provide the following parameters:
-- `assistantId`: The assistant to be used for the chat.
-- `path_to_file`: The local path of the file to be uploaded.
-- `displayed_filename`: The name of the file to be displayed.
-- `mime_type`: The mime type of the ifle to be uploaded.
-- `text`: The text to be sent to the chat for chatting against the file.
-
-The script creates a chat and uploads the file to it. It then keeps polling the `ingestionState` field of the message, waiting for it to reach `FINISHED`, signaling the upload is complete. Once the file uploads successfully, the script sends the text, continues polling for completion, and finally retrieves the response message. The function deletes the chat at the end unless the `should_delete_chat` is set to false.
-
-**Optional parameters:**
-- `poll_interval`: The number of seconds to wait between polling attempts (default: `1` second).
-- `max_wait`: The maximum number of seconds to wait for the message to complete (default: `60` seconds).
-- `should_delete_chat`: Setting this flag determines whether the chat should be deleted at the end or not. Default is True.
-
-Example of chatting against a PDF. (The usage can be extended to any supported file type)
-
-```python
-latest_message = await unique_sdk.utils.chat_in_space.chat_against_file(
-    user_id=user_id,
-    company_id=company_id,
-    assistant_id="assistant_hjcdga64bkcjnhu4",
-    path_to_file="/files/hello.pdf",
-    displayed_filename="hello.pdf",
-    mime_type="application/pdf",
-    text="Give me a bullet point summary of the file.",
-)
-```
-
-#### `unique_sdk.utils.chat_in_space.wait_for_ingestion_completion`
-
-The following script enables you to wait for the ingestion of a file. This should be used carefully as it continuously polls for the status. In case of bigger files, adjust the `poll_interval` and `max_waits`.
-
-You must provide the following parameter:
-- `content_id`: The id of the content to check.
-
-The script polls until the content ingestion is finished or the maximum wait time is reached and throws in case ingestion fails. The function assumes that the content exists.
-
-**Optional parameters:**
-- `chat_id`: In case the content is uploaded to a chat, the `chat_id` must be provided.
-- `poll_interval`: The number of seconds to wait between polling attempts (default: `1` second).
-- `max_wait`: The maximum number of seconds to wait for the message to complete (default: `60` seconds).
-
-Example of waiting for the ingestion of a file in the Knowledge Base.
-
-```python
-await unique_sdk.utils.chat_in_space.wait_for_ingestion_completion(
-    user_id=user_id,
-    company_id=company_id,
-    content_id="cont_ddlezvag4kzxudfr24lrjc5mx",
-)
-```
-
-## Error Handling
-
-## Examples
-
-An example Flask app demonstrating the usage of each API resource and how to interact with Webhooks is available in our repository at `/examples/custom-assistant`.
-
-## Credits
-
-This is a _fork_ / inspired-by the fantastic Stripe Python SDK (https://github.com/stripe/stripe-python).
-
-# Changelog
-
-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.10.47] - 2025-11-19
-- Add expired/s at fields on content search result.
-
-## [0.10.46] - 2025-11-18
-- chat_against_file function allows now a should_delete_chat flag.
-
-## [0.10.45] - 2025-11-18
-- Create group and manage users functions.
-
-## [0.10.44] - 2025-11-18
-- add function to get all messages in a chat.
-
-## [0.10.43] - 2025-11-14
-- Add get, delete and update groups functions.
-
-## [0.10.42] - 2025-11-14
-- Add get_users function.
-
-## [0.10.41] - 2025-11-13
-- Add create_message and get_latest_message.
-
-## [0.10.40] - 2025-11-10
-- Don't send description if not defined.
-
-## [0.10.39] - 2025-11-07
-- Add function to get llm models
-
-## [0.10.38] - 2025-11-06
-- Add description property to Reference and Content.
-
-## [0.10.37] - 2025-11-04
-- Introduce local integration tests for Content API Resource
-
-## [0.10.36] - 2025-11-04
-- Introduce local integration tests for Folder API Resource
-
-## [0.10.35] - 2025-11-04
-- Inmprove folder get infos types.
-
-## [0.10.34] - 2025-10-29
-- Add documentation for agentic table.
-
-## [0.10.33] - 2025-10-27
-- Improve messagelog and message execution types.
-
-## [0.10.32] - 2025-10-14
-- Add function to stream to chat frontend.
-
-## [0.10.31] - 2025-10-13
-- Add readme for message log and execution.
-
-## [0.10.30] - 2025-10-07
-- Improve types for content get infos.
-
-## [0.10.29] - 2025-10-06
-- Switch default model used from `GPT-3.5-turbo (0125)` to `GPT-4o (1120)`
-
-## [0.10.28] - 2025-10-03
-- Use non blocking versions of `Space.get_latest_message` and `Message.retrieve` in `send_message_and_wait_for_completion`.
-
-## [0.10.27] - 2025-09-24
-- Improve readme to use Unique AI.
-
-## [0.10.26] - 2025-09-22
-- Improve typing.
-
-## [0.10.25] - 2025-09-18
-- Add support for udpate and delete files by file or folder path.
-
-## [0.10.24] - 2025-09-17
-- Add function to update a folder.
-
-## [0.10.23] - 2025-09-12
-- Revert to using default reasoning effort.
-
-## [0.10.22] - 2025-09-12
-- Add support for metadata update of a file.
-
-## [0.10.21] - 2025-09-04
-- Update Chat Completions API types and add support for reasoning effort.
-
-## [0.10.20] - 2025-09-04
-- Update Responses API types
-
-## [0.10.19] - 2025-09-02
-- Improve `send_message_and_wait_for_completion`:
-    - Add option to select stop_condition `["stoppedStreamingAt", "completedAt"]`. 
-    - Load `debugInfo` from `last_user_message` for better developer experience.
-
-## [0.10.18] - 2025-09-02
-- Temporarily remove support for update and delete files by filePath.
-
-## [0.10.17] - 2025-09-01
-- Add function to update a file
-
-## [0.10.16] - 2025-08-31
-- Add function to delete a content.
-
-## [0.10.15] - 2025-08-28
-- Add default values for message log types
-
-## [0.10.14] - 2025-08-28
-- Add function to delete folders and files recursively
-
-## [0.10.13] - 2025-08-24
-- Add functions to create, get and update a message eecution and create and update a message log.
-
-## [0.10.12] - 2025-08-24
-- Switch to using Content get info deprecated endpoint to make sure we support older release versions.
-
-## [0.10.11] - 2025-08-24
-- Enforce usage of ruff using pipeline
-
-## [0.10.10] - 2025-08-18
-- Fix wrong name of references in `Space.Message`. 
-- Fix wrong name of assessment in `Space.Message`.
-- Remove default values for `text`, `originalText` and `debugInfo` in `Space.Message` as these don't have an effect.
-
-## [0.10.9] - 2025-08-15
-- Add script to wait for content ingestion finished.
-
-## [0.10.8] - 2025-08-13
-- Add support for Agentic Table.
-
-## [0.10.7] - 2025-08-13
-- Make metadata optional when uploading a file.
-
-## [0.10.6] - 2025-08-06
-- Make tools optional for running an agent.
-
-## [0.10.5] - 2025-08-06
-- Get paginated files and folders info.
-
-## [0.10.4] - 2025-08-05
-- Add support for reasoning API with streaming within a chat.
-
-## [0.10.3] - 2025-08-05
-- Expose scoreThreshold param for search.
-
-## [0.10.2] - 2025-08-05
-- Add script to chat against file.
-
-## [0.10.1] - 2025-08-05
-- Allow deletion of a space chat.
-
-## [0.10.0] - 2025-08-04
-- Add MCP support
-
-## [0.9.42] - 2025-07-31
-- Fix wrong chat in space example.
-
-## [0.9.41] - 2025-07-31
-- Fix double-slash error in open ai proxy script.
-
-## [0.9.40] - 2025-07-22
-- Fixed bug where get requests send body with the request. This is not allowed by WAF policies.
-
-## [0.9.39] - 2025-07-18
-- Add script to chat in a space.
-
-## [0.9.38] - 2025-07-18
-- [Experimental] Add support for Unique OpenAI proxy. You can now use the OpenAI SDK directly through Unique. Checkout how to do this and a few examples here: `tutorials/unique_basics/sdk_examples/openai_scripts.py`.
-
-## [0.9.37] - 2025-07-10
-- Add `sheetName` property to the `MagicTableSheetIngestParams` object used by function that ingests magic table sheets.
-
-## [0.9.36] - 2025-06-23
-- Allow passing a user id when creating chat completions. This is optional and it does not impact the current behaviour.
-
-## [0.9.35] - 2025-06-18
-- Allow scope access updates (add/remove) on folder based on scope id or path.
-
-## [0.9.34] - 2025-06-17
-- Allow ingestion config updates on folder based on scope id or path.
-
-## [0.9.33] - 2025-06-11
-- Add function to get a folder by id or by path.
-
-## [0.9.32] - 2025-06-11
-- Add function to ingest magic table sheets.
-
-## [0.9.31] - 2025-05-21
-- Add function to update folder access (add or remove).
-
-## [0.9.30] - 2025-05-21
-- Add function to update folder ingestion config.
-
-## [0.9.29] - 2025-05-20
-- Add function to create folder paths if they do not exist.
-
-## [0.9.28] - 2025-05-20
-- Add function to search content info. This also allows filtering content info by metadata info.
-
-## [0.9.27] - 2025-05-14
-- Add the possibility to specify metadata when creating or updating a Content.
-
-## [0.9.26] - 2025-05-13
-- Add the possibility to specify ingestionConfig when creating or updating a Content.
-
-## [0.9.25] - 2025-05-02
-- Fixed typos in `README.md`, including incorrect `sdk.utils` imports and code example errors.
-
-## [0.9.24] - 2025-04-23
-- Make `chatId` property in `Search.CreateParams` optional
-
-## [0.9.23] - 2025-03-25
-- Define programming language classifier explicitly for python 3.11
-
-## [0.9.22] - 2025-02-25
-- update the retry_on_error to only `APIError` and `APIConnectionError` update the `resp["error"]` to be `resp.get("error")` to avoid key error
-
-## [0.9.21] - 2025-02-21
-- Add title parameter and change labels in `MessageAssessment`
-
-## [0.9.20] - 2025-02-01
-- Add url parameter to `MessageAssessment.create_async` and `MessageAssessment.modify_async`
-
-## [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.
-
-## [0.9.17] - 2025-01-03
-- BREAKING CHANGE!! Removed unused `id` from `ShortTermMemory` create and find methods.
-
-## [0.9.16] - 2024-12-19
-- Corrected return type of `Search.create` and `Search.create_async` to `List[Search]`
-- Retry on `Connection aborted` error
-
-## [0.9.15] - 2024-12-06
-- Add `Internal server error` and `You can retry your request` to the retry logic
-
-## [0.9.14] - 2024-12-06
-- Add `contentIds` to `Search.create` and `Search.create_async`
-
-## [0.9.13] - 2024-10-23
-- Add retry for `5xx` errors, add additional error message.
-
-## [0.9.12] - 2024-11-21
-- Include original error message in returned exceptions
-
-## [0.9.11] - 2024-11-18
-- Add  `ingestionConfig` to `UpsertParams.Input` parameters 
-
-## [0.9.10] - 2024-10-23
-- Remove `temperature` parameter from `Integrated.chat_stream_completion`, `Integrated.chat_stream_completion_async`, `ChatCompletion.create` and `ChatCompletion.create_async` methods. To use `temperature` parameter, set the attribute in `options` parameter instead.
-
-## [0.9.9] - 2024-10-23
-- Revert deletion of `Message.retrieve` method
-
-## [0.9.8] - 2024-10-16
-- Add `retries` for `_static_request` and `_static_request_async` in `APIResource` - When the error messages contains either  `"problem proxying the request"`,
-        or `"Upstream service reached a hard timeout"`,
-## [0.9.7] - 2024-09-23
-- Add `completedAt` to `CreateParams` of `Message`
-
-## [0.9.6] - 2024-09-03
-- Added `metaDataFilter` to `Search` parameters.
-
-## [0.9.5] - 2024-08-07
-- Add `completedAt` to `ModifyParams`
-
-## [0.9.4] - 2024-07-31
-- Add `close` and `close_async` to `http_client`
-- Make `httpx` the default client for async requests
-
-## [0.9.3] - 2024-07-31
-- `Search.create`, `Message`, `ChatCompletion` parameters that were marked `NotRequired` are now also `Optional`
-
-## [0.9.2] - 2024-07-30
-- Bug fix in `Search.create`: langugage -> language 
-
-## [0.9.1] - 2024-07-30
-- Added parameters to `Search.create` and `Search.create_async`
-    - `language` for full text search
-    - `reranker` to reranker search results
-
-## [0.9.0] - 2024-07-29
-- Added the possibility to make async requests to the unique APIs using either aiohttp or httpx as client
-