unifyapps-guardrails 0.2.0__tar.gz

unifyapps_guardrails-0.2.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.

unifyapps_guardrails-0.2.0/PKG-INFO

@@ -0,0 +1,151 @@
+Metadata-Version: 2.4
+Name: unifyapps-guardrails
+Version: 0.2.0
+Summary: Thin client for UnifyApps platform guardrails (config-driven controls/policies), traced to UnifyApps observability.
+Author: UnifyApps
+License-Expression: Apache-2.0
+Project-URL: Homepage, https://github.com/unify-apps/unifyapps-guardrails
+Project-URL: Repository, https://github.com/unify-apps/unifyapps-guardrails
+Keywords: unifyapps,guardrails,ai,governance,opentelemetry,llm
+Classifier: Development Status :: 4 - Beta
+Classifier: Intended Audience :: Developers
+Classifier: Programming Language :: Python :: 3
+Classifier: Topic :: Scientific/Engineering :: Artificial Intelligence
+Requires-Python: >=3.9
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: opentelemetry-api>=1.20.0
+Dynamic: license-file
+
+# unifyapps-guardrails
+
+A thin client for **UnifyApps platform guardrails**. Checks are *not* run in this
+process — they are config-driven `controls` (Denied Topics, Content Filter, PII,
+Prompt Injection, Custom terms, Regex, Credentials, Blocked Tools, Custom LLM)
+grouped into `policies` applied to an agent. This client calls the exported
+`Governance | Inline Evaluate` endpoint, which resolves the agent's controls for a
+given surface, runs only those, writes incidents itself, and returns one decision.
+
+Add or remove a control in the UI and the same code enforces it — nothing about the
+checks is hardcoded here. Every call emits an OpenTelemetry span so it nests inside
+your existing UnifyApps trace.
+
+## Install
+
+```bash
+pip install unifyapps-guardrails
+```
+
+Or, from a clone (editable):
+
+```bash
+pip install -e .
+```
+
+Stdlib + `opentelemetry-api` only — no models to download, no heavy deps.
+
+## Configure
+
+| Env var | Purpose |
+|---|---|
+| `UNIFYAPPS_GUARDRAILS_URL` | URL of the exported inline-evaluate callable, with the **agent id as its last path segment** (like the OTLP endpoint) |
+| `UNIFYAPPS_GUARDRAILS_API_KEY` | optional; sent as `Authorization: Bearer <key>` |
+
+## Usage
+
+```python
+from unifyapps.guardrails import GovernanceGuard
+
+# agent id comes from UNIFYAPPS_GUARDRAILS_URL's path — nothing to pass here
+guard = GovernanceGuard()
+
+# Before the LLM sees the user's message
+d = guard.check_user_input(user_text)
+if d.block:
+    return d.content          # refusal message — don't call the LLM
+user_text = d.content         # masked/clean text to send to the LLM
+
+# After the LLM answers, before the user sees it
+d = guard.check_agent_output(reply)
+return d.content              # block -> refusal; else masked/clean text
+
+# Before a tool runs (Blocked Tools matches the name; PII/Regex/... mask the arguments)
+d = guard.check_tool_input("charge_card", {"amount": 10, "card": "4111111111111111"})
+if d.block:
+    result = d.content        # tool refusal — don't call the tool
+else:
+    result = charge_card(**d.tool_value)   # masked arguments
+
+# After the tool returns, before the LLM sees its result
+d = guard.check_tool_output("charge_card", result)
+result = d.content if d.block else d.tool_value
+```
+
+### The decision
+
+`evaluate` / `check_user_input` / `check_agent_output` / `check_tool_input` / `check_tool_output` return a `GovernanceDecision`:
+
+| Field | Meaning |
+|---|---|
+| `block` | `True` if the content must be withheld |
+| `content` | the text to **use**: masked/clean when `block=False`, the refusal message when `block=True` |
+| `raw` | the full endpoint payload |
+| `tool_value` | tool checks only: the tool arguments / result to **use** when `block=False` (masked, or your original object when nothing was masked); `None` when `block=True` |
+
+Surfaces (see `Surface`): `user_input`, `agent_output`, `tool_input`, `tool_output`. A
+tool check runs even with empty arguments, since Blocked Tools matches on the name. Tool
+values are sent as JSON (dates, decimals and other objects as text); a value JSON cannot
+hold (a circular reference, non-string keys) is checked as its text. When the platform
+masks a value, `tool_value` is its JSON form: dates, decimals and objects come back as
+strings and dict keys as strings; when nothing was masked it is your own object. A message
+that is not text (a list of content parts) is checked as its JSON text. The guard **fails
+open** — on timeout or endpoint error it returns the original text (and tool value) with
+`block=False`, so a guardrail outage never drops a turn.
+
+### Observability
+
+Each call is a `guardrail.evaluate` span. Inside a LangChain run (OpenInference
+instrumentation) it is parented under the active run, so it travels in the agent's own
+trace. A **blocked tool input** check outside the tool — the tool never runs — is recorded
+as an OpenInference TOOL span (tool name, arguments, refusal), so the trace shows the
+blocked call as a failed tool call. When the guard runs inside the tool, the framework's
+own tool span records the call: raise on a block (see the LangGraph / OpenAI Agents
+examples) so it shows as failed.
+
+Mode is the agent's, not the code's: for an agent in **observe** mode the endpoint never
+blocks or masks (every check returns the original value) and records nothing inline —
+findings are flagged from the agent's traces instead. Running these guards against an
+observe agent is safe but only adds latency.
+
+## Endpoint contract
+
+```
+POST <UNIFYAPPS_GUARDRAILS_URL>          # .../<agent-id>  (id is the last path segment)
+body  -> { content, inputType, caseId }
+200   -> { block: bool, content: str }
+
+# tool checks
+body  -> { content, inputType, caseId, toolName, tool_input | tool_output }
+200   -> { block: bool, content: str, toolInput, toolOutput }
+```
+
+The **agent id is the last path segment of the URL**, not a body field — same shape as
+the OTLP collector endpoint, so it is never passed twice. It is both the policy lookup
+key and the incident scope; the exported callable maps that path segment to its
+`agentId` input. `inputType` is the surface (`user_input` / `agent_output` / `tool_input` / `tool_output`); for a tool check `content` is the tool value as JSON text. `caseId`
+is any stable per-conversation id (the client defaults to a random uuid) so the
+resolver takes the chat branch.
+
+## Examples
+
+Full input + output turns, one per framework, in [`examples/`](examples/):
+
+| Framework | File |
+|---|---|
+| LangChain | [`examples/langchain_unify_guardrails.py`](examples/langchain_unify_guardrails.py) |
+| LangGraph | [`examples/langgraph_unify_guardrails.py`](examples/langgraph_unify_guardrails.py) |
+| OpenAI Agents SDK | [`examples/openai_agents_unify_guardrails.py`](examples/openai_agents_unify_guardrails.py) |
+
+## License
+
+[Apache 2.0](LICENSE).

unifyapps_guardrails-0.2.0/README.md

@@ -0,0 +1,132 @@
+# unifyapps-guardrails
+
+A thin client for **UnifyApps platform guardrails**. Checks are *not* run in this
+process — they are config-driven `controls` (Denied Topics, Content Filter, PII,
+Prompt Injection, Custom terms, Regex, Credentials, Blocked Tools, Custom LLM)
+grouped into `policies` applied to an agent. This client calls the exported
+`Governance | Inline Evaluate` endpoint, which resolves the agent's controls for a
+given surface, runs only those, writes incidents itself, and returns one decision.
+
+Add or remove a control in the UI and the same code enforces it — nothing about the
+checks is hardcoded here. Every call emits an OpenTelemetry span so it nests inside
+your existing UnifyApps trace.
+
+## Install
+
+```bash
+pip install unifyapps-guardrails
+```
+
+Or, from a clone (editable):
+
+```bash
+pip install -e .
+```
+
+Stdlib + `opentelemetry-api` only — no models to download, no heavy deps.
+
+## Configure
+
+| Env var | Purpose |
+|---|---|
+| `UNIFYAPPS_GUARDRAILS_URL` | URL of the exported inline-evaluate callable, with the **agent id as its last path segment** (like the OTLP endpoint) |
+| `UNIFYAPPS_GUARDRAILS_API_KEY` | optional; sent as `Authorization: Bearer <key>` |
+
+## Usage
+
+```python
+from unifyapps.guardrails import GovernanceGuard
+
+# agent id comes from UNIFYAPPS_GUARDRAILS_URL's path — nothing to pass here
+guard = GovernanceGuard()
+
+# Before the LLM sees the user's message
+d = guard.check_user_input(user_text)
+if d.block:
+    return d.content          # refusal message — don't call the LLM
+user_text = d.content         # masked/clean text to send to the LLM
+
+# After the LLM answers, before the user sees it
+d = guard.check_agent_output(reply)
+return d.content              # block -> refusal; else masked/clean text
+
+# Before a tool runs (Blocked Tools matches the name; PII/Regex/... mask the arguments)
+d = guard.check_tool_input("charge_card", {"amount": 10, "card": "4111111111111111"})
+if d.block:
+    result = d.content        # tool refusal — don't call the tool
+else:
+    result = charge_card(**d.tool_value)   # masked arguments
+
+# After the tool returns, before the LLM sees its result
+d = guard.check_tool_output("charge_card", result)
+result = d.content if d.block else d.tool_value
+```
+
+### The decision
+
+`evaluate` / `check_user_input` / `check_agent_output` / `check_tool_input` / `check_tool_output` return a `GovernanceDecision`:
+
+| Field | Meaning |
+|---|---|
+| `block` | `True` if the content must be withheld |
+| `content` | the text to **use**: masked/clean when `block=False`, the refusal message when `block=True` |
+| `raw` | the full endpoint payload |
+| `tool_value` | tool checks only: the tool arguments / result to **use** when `block=False` (masked, or your original object when nothing was masked); `None` when `block=True` |
+
+Surfaces (see `Surface`): `user_input`, `agent_output`, `tool_input`, `tool_output`. A
+tool check runs even with empty arguments, since Blocked Tools matches on the name. Tool
+values are sent as JSON (dates, decimals and other objects as text); a value JSON cannot
+hold (a circular reference, non-string keys) is checked as its text. When the platform
+masks a value, `tool_value` is its JSON form: dates, decimals and objects come back as
+strings and dict keys as strings; when nothing was masked it is your own object. A message
+that is not text (a list of content parts) is checked as its JSON text. The guard **fails
+open** — on timeout or endpoint error it returns the original text (and tool value) with
+`block=False`, so a guardrail outage never drops a turn.
+
+### Observability
+
+Each call is a `guardrail.evaluate` span. Inside a LangChain run (OpenInference
+instrumentation) it is parented under the active run, so it travels in the agent's own
+trace. A **blocked tool input** check outside the tool — the tool never runs — is recorded
+as an OpenInference TOOL span (tool name, arguments, refusal), so the trace shows the
+blocked call as a failed tool call. When the guard runs inside the tool, the framework's
+own tool span records the call: raise on a block (see the LangGraph / OpenAI Agents
+examples) so it shows as failed.
+
+Mode is the agent's, not the code's: for an agent in **observe** mode the endpoint never
+blocks or masks (every check returns the original value) and records nothing inline —
+findings are flagged from the agent's traces instead. Running these guards against an
+observe agent is safe but only adds latency.
+
+## Endpoint contract
+
+```
+POST <UNIFYAPPS_GUARDRAILS_URL>          # .../<agent-id>  (id is the last path segment)
+body  -> { content, inputType, caseId }
+200   -> { block: bool, content: str }
+
+# tool checks
+body  -> { content, inputType, caseId, toolName, tool_input | tool_output }
+200   -> { block: bool, content: str, toolInput, toolOutput }
+```
+
+The **agent id is the last path segment of the URL**, not a body field — same shape as
+the OTLP collector endpoint, so it is never passed twice. It is both the policy lookup
+key and the incident scope; the exported callable maps that path segment to its
+`agentId` input. `inputType` is the surface (`user_input` / `agent_output` / `tool_input` / `tool_output`); for a tool check `content` is the tool value as JSON text. `caseId`
+is any stable per-conversation id (the client defaults to a random uuid) so the
+resolver takes the chat branch.
+
+## Examples
+
+Full input + output turns, one per framework, in [`examples/`](examples/):
+
+| Framework | File |
+|---|---|
+| LangChain | [`examples/langchain_unify_guardrails.py`](examples/langchain_unify_guardrails.py) |
+| LangGraph | [`examples/langgraph_unify_guardrails.py`](examples/langgraph_unify_guardrails.py) |
+| OpenAI Agents SDK | [`examples/openai_agents_unify_guardrails.py`](examples/openai_agents_unify_guardrails.py) |
+
+## License
+
+[Apache 2.0](LICENSE).

unifyapps_guardrails-0.2.0/pyproject.toml

@@ -0,0 +1,32 @@
+[project]
+name = "unifyapps-guardrails"
+version = "0.2.0"
+description = "Thin client for UnifyApps platform guardrails (config-driven controls/policies), traced to UnifyApps observability."
+readme = "README.md"
+requires-python = ">=3.9"
+license = "Apache-2.0"
+authors = [{ name = "UnifyApps" }]
+keywords = ["unifyapps", "guardrails", "ai", "governance", "opentelemetry", "llm"]
+classifiers = [
+    "Development Status :: 4 - Beta",
+    "Intended Audience :: Developers",
+    "Programming Language :: Python :: 3",
+    "Topic :: Scientific/Engineering :: Artificial Intelligence",
+]
+# Checks run on the platform, not here. The client is stdlib + OpenTelemetry only.
+dependencies = [
+    "opentelemetry-api>=1.20.0",
+]
+
+[project.urls]
+Homepage = "https://github.com/unify-apps/unifyapps-guardrails"
+Repository = "https://github.com/unify-apps/unifyapps-guardrails"
+
+[build-system]
+requires = ["setuptools>=68"]
+build-backend = "setuptools.build_meta"
+
+# PEP 420 namespace package: ships unifyapps/guardrails/ and coexists with
+# the pip-installed unifyapps-otel (which owns unifyapps/otel/).
+[tool.setuptools.packages.find]
+where = ["src"]

unifyapps_guardrails-0.2.0/setup.cfg

@@ -0,0 +1,4 @@
+[egg_info]
+tag_build = 
+tag_date = 0
+

unifyapps_guardrails-0.2.0/src/unifyapps/guardrails/__init__.py

@@ -0,0 +1,15 @@
+"""UnifyApps guardrails.
+
+Detection lives on the platform (config-driven `controls`/`policies`), not here.
+Use `GovernanceGuard` to call the exported inline-evaluate endpoint; it resolves the
+agent's controls for a surface, runs only those, writes incidents itself, and returns
+one decision (block / mask).
+"""
+
+from .client import GovernanceDecision, GovernanceGuard, Surface
+
+__all__ = [
+    "GovernanceGuard",
+    "GovernanceDecision",
+    "Surface",
+]