liminal-sdk-python 2024.3.0__tar.gz

liminal_sdk_python-2024.3.0/LICENSE

@@ -0,0 +1,201 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

liminal_sdk_python-2024.3.0/PKG-INFO

@@ -0,0 +1,351 @@
+Metadata-Version: 2.1
+Name: liminal-sdk-python
+Version: 2024.3.0
+Summary: The Liminal SDK for Python
+Home-page: https://github.com/liminal-ai-security/liminal-sdk-python
+License: Apache-2.0
+Author: Aaron Bach
+Author-email: ab@liminal.ai
+Requires-Python: ==3.11.8
+Classifier: License :: OSI Approved :: Apache Software License
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Programming Language :: Python
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: Implementation :: CPython
+Classifier: Programming Language :: Python :: Implementation :: PyPy
+Requires-Dist: httpx (==0.27.0)
+Requires-Dist: mashumaro (==3.12)
+Requires-Dist: msal (==1.27.0)
+Project-URL: Bug Tracker, https://github.com/liminal-ai-security/liminal-sdk-python/issues
+Project-URL: Changelog, https://github.com/liminal-ai-security/liminal-sdk-python/releases
+Project-URL: Repository, https://github.com/liminal-ai-security/liminal-sdk-python
+Description-Content-Type: text/markdown
+
+# Liminal Python SDK
+
+[![PyPI][pypi-badge]][pypi]
+[![Version][version-badge]][version]
+[![License][license-badge]][license]
+
+The Liminal SDK for Python provides a clean, straightforward, `asyncio`-based interface
+for interacting with the Liminal API.
+
+- [Installation](#installation)
+- [Python Versions](#python-versions)
+- [Usage](#usage)
+- [Contributing](#contributing)
+
+# Installation
+
+TBD
+
+# Python Versions
+
+`liminal` is currently supported on:
+
+- Python 3.11
+- Python 3.12
+
+# Quickstart
+
+Presuming the use of Microsoft Entra ID as your auth provider, instantiating a Liminal
+API object is easy:
+
+```python
+import asyncio
+
+from liminal import Client
+from liminal.endpoints.auth import MicrosoftAuthProvider
+
+
+async def main() -> None:
+    """Create the aiohttp session and run the example."""
+    logging.basicConfig(level=logging.DEBUG)
+
+    # Create an auth provider to authenticate the user:
+    microsoft_auth_provider = MicrosoftAuthProvider("<TENANT_ID>", "<CLIENT_ID>")
+
+    # Create the liminal SDK instance:
+    liminal = Client(microsoft_auth_provider, "<LIMINAL_API_SERVER_URL>")
+
+
+asyncio.run(main())
+```
+
+You can see several examples of how to use this API object via the [`examples`][examples]
+folder in this repo.
+
+# Initial Authentication
+
+Liminal supports the concept of authenticating via various auth providers. Currently,
+the following auth providers are supported:
+
+- Microsoft Entra ID
+
+## Microsoft Entra ID
+
+Liminal authenticates with Microsoft Entra ID via an
+[OAuth 2.0 Device Authorization Grant][oauth-device-auth-grant]. This flow requires you
+to start your app, retrieve a device code from the logs produced by this SDK, and
+provide that code to Microsoft via a web browser. Once you complete the login process,
+the SDK will be authenticated for use with your Liminal instance.
+
+### Finding your Entra ID Tenant and Client IDs
+
+- Log into your [Azure portal][azure-portal].
+- Navigate to `Microsoft Entra ID`.
+- Click on `App registrations`.
+- Either create a new app registration or select an existing one.
+- In the `Overview` of the registration, look for the `Application (client) ID` and
+  `Directory (tenant) ID` values.
+
+### Authenticating Against Entra ID
+
+With a client ID and tenant ID, you can create a Liminal client object and authenticate
+it:
+
+```python
+import asyncio
+
+from liminal import Client
+from liminal.endpoints.auth import MicrosoftAuthProvider
+
+
+async def main() -> None:
+    """Create the aiohttp session and run the example."""
+    logging.basicConfig(level=logging.DEBUG)
+
+    # Create an auth provider to authenticate the user:
+    microsoft_auth_provider = MicrosoftAuthProvider("<TENANT_ID>", "<CLIENT_ID>")
+
+    # Create the liminal SDK instance and authenticate it:
+    liminal = Client(microsoft_auth_provider, "<LIMINAL_API_SERVER_URL>")
+    await liminal.authenticate_from_auth_provider()
+
+
+asyncio.run(main())
+```
+
+In your application logs, you will see a message that looks like this:
+
+```
+INFO:liminal:To sign in, use a web browser to open the page
+https://microsoft.com/devicelogin and enter the code XXXXXXXXX to authenticate.
+```
+
+Leaving your application running, open a browser at that URL and input the code as
+instructed. Once you successfully complete authentication via Entra ID, your Liminal
+client object will automatically authenticate with your Liminal API server.
+
+# Ongoing Authentication
+
+After the initial authentication with your auth provider, the Liminal client object will
+internally store access and refresh tokens to ensure the ongoing ability to communicate
+with your Liminal API server. The client object will automatically handle using the
+stored refresh token to request new access tokens as appropriate.
+
+## Manually Interacting with the Refresh Token
+
+The Liminal client object provides a `add_refresh_token_callback` method to manually
+interact with refresh tokens as they are generated. This is useful in situations where
+you want to retrieve that token and do something else with (store it in a database, for
+example). Every time a new refresh token is generated by the client object, the
+registered callbacks will be called.
+
+Refresh token callbacks are methods that take a single `str` parameter (denoting the
+refresh token). These callbacks are not expected to return any value. Lastly, when
+calling `add_refresh_token_callback`, the returned method allows you to cancel the
+callback at any time.
+
+```python
+import asyncio
+
+from liminal import Client
+from liminal.endpoints.auth import MicrosoftAuthProvider
+
+
+async def main() -> None:
+    """Create the aiohttp session and run the example."""
+    logging.basicConfig(level=logging.DEBUG)
+
+    # Create an auth provider to authenticate the user:
+    microsoft_auth_provider = MicrosoftAuthProvider("<TENANT_ID>", "<CLIENT_ID>")
+
+    # Create the liminal SDK instance and authenticate it:
+    liminal = Client(microsoft_auth_provider, "<LIMINAL_API_SERVER_URL>")
+    await liminal.authenticate_from_auth_provider()
+
+    def do_something_with_refresh_token(refresh_token: str) -> None:
+        """Do something with the refresh token."""
+        pass
+
+    # Register the refresh token callback:
+    remove_callback = liminal.add_refresh_token_callback(
+        do_something_with_refresh_token
+    )
+
+    # Later, if you want to remove the callback:
+    remove_callback()
+
+
+asyncio.run(main())
+```
+
+# Getting Model Instances
+
+Every LLM instance connected in the Liminal admin dashboard is referred to as a "model
+instance." The SDK provides several methods to interact with model instances:
+
+```python
+import asyncio
+
+from liminal import Client
+from liminal.endpoints.auth import MicrosoftAuthProvider
+
+
+async def main() -> None:
+    # Assuming you have an authenticated `liminal` object:
+
+    # Get all available model instances:
+    model_instances = await liminal.llm.get_available_model_instances()
+    # >>> [ModelInstance(...), ModelInstance(...)]
+
+    # Get a specific model instance (if it exists):
+    model_instance = await liminal.llm.get_model_instance("My Model")
+    # >>> ModelInstance(...)
+
+
+asyncio.run(main())
+```
+
+# Managing Threads
+
+Threads are conversations with an LLM instance:
+
+```python
+import asyncio
+
+from liminal import Client
+from liminal.endpoints.auth import MicrosoftAuthProvider
+
+
+async def main() -> None:
+    # Assuming you have an authenticated `liminal` object:
+
+    # Get all available threads:
+    threads = await liminal.thread.get_available()
+    # >>> [Thread(...), Thread(...)]
+
+    # Get a specific thread by ID:
+    thread = await liminal.thread.get_by_id(123)
+    # >>> Thread(...)
+
+    # Some operations require a model instance:
+    model_instance = await liminal.llm.get_model_instance("My Model")
+
+    # Create a new thread:
+    thread = await liminal.thread.create(model_instance.id, "New Thread")
+    # >>> Thread(...)
+
+    # Get the "de-identified" (containing sensitive data) context history for a thread:
+    thread = await liminal.thread.get_deidentified_context_history(model_instance.id)
+    # >>> [DeidentifiedToken(...), DeidentifiedToken(...), DeidentifiedToken(...)]
+
+
+asyncio.run(main())
+```
+
+# Submitting Prompts
+
+Submitting prompts is easy:
+
+```python
+import asyncio
+
+from liminal import Client
+from liminal.endpoints.auth import MicrosoftAuthProvider
+
+
+async def main() -> None:
+    # Assuming you have an authenticated `liminal` object:
+
+    # Prompt operations require a thread:
+    thread = await liminal.thread.get_by_id(123)
+    # >>> Thread(...)
+
+    # Analayze a prompt for sensitive info:
+    findings = await liminal.prompt.analyze(thread.id)
+    # >>> AnalyzeResponse(...)
+
+    # Cleanse input text by applying the policies defined in the Liminal admin
+    # dashboard. You can optionally provide existing analysis finidings; if not
+    # provided, analyze is # called automatically):
+    cleansed = await liminal.prompt.cleanse(
+        thread.id, "Here is a sensitive prompt", findings=findings
+    )
+    # >>> CleanseResponse(...)
+
+    # Submit a prompt to an LLM, cleansing it in the process (once again, providing optional
+    # findings):
+    response = await liminal.prompt.submit(
+        thread.id, "Here is a sensitive prompt", findings=findings
+    )
+    # >>> ProcessResponse(...)
+
+    # Rehydrate a response with sensitive data:
+    hydrated = await liminal.prompt.hydrate(
+        thread.id, "Here is a response to rehdyrate"
+    )
+    # >>> HydrateResponse(...)
+
+
+asyncio.run(main())
+```
+
+# Running Examples
+
+You can see examples of how to use this SDK via the [`examples`][examples] folder in
+this repo. Each example follows a similar "call" format by asking for inputs via
+environment variables; for example:
+
+```sh
+LIMINAL_API_SERVER_URL=https://api.DOMAIN.liminal.ai \
+CLIENT_ID=xxxxxxxxxxxxxxxx \
+TENANT_ID=xxxxxxxxxxxxxxxx \
+MODEL_INSTANCE_NAME=model-instance-name \
+python3 examples/quickstart_with_microsoft.py
+```
+
+# Contributing
+
+Thanks to all of [our contributors][contributors] so far!
+
+1. [Check for open features/bugs][issues] or [initiate a discussion on one][new-issue].
+2. [Fork the repository][fork].
+3. (_optional, but highly recommended_) Create a virtual environment: `python3 -m venv .venv`
+4. (_optional, but highly recommended_) Enter the virtual environment: `source ./.venv/bin/activate`
+5. Install the dev environment: `script/setup`
+6. Code your new feature or bug fix on a new branch.
+7. Write tests that cover your new functionality.
+8. Run tests and ensure 100% code coverage: `poetry run pytest --cov liminal tests`
+9. Update `README.md` with any new documentation.
+10. Submit a pull request!
+
+[azure-portal]: https://portal.azure.com
+[ci]: https://github.com/liminal-ai-security/liminal-sdk-python/actions
+[contributors]: https://github.com/liminal-ai-security/liminal-sdk-python/graphs/contributors
+[examples]: https://github.com/liminal-ai-security/liminal-sdk-python/tree/development/examples
+[fork]: https://github.com/liminal-ai-security/liminal-sdk-python/fork
+[issues]: https://github.com/liminal-ai-security/liminal-sdk-python/issues
+[license-badge]: https://img.shields.io/pypi/l/aionotion.svg
+[license]: https://github.com/liminal-ai-security/liminal-sdk-python/blob/main/LICENSE
+[new-issue]: https://github.com/liminal-ai-security/liminal-sdk-python/issues/new
+[notion]: https://getnotion.com
+[oauth-device-auth-grant]: https://oauth.net/2/grant-types/device-code/
+[pypi-badge]: https://img.shields.io/pypi/v/aionotion.svg
+[pypi]: https://pypi.python.org/pypi/aionotion
+[version-badge]: https://img.shields.io/pypi/pyversions/aionotion.svg
+[version]: https://pypi.python.org/pypi/aionotion
+