aidial-interceptors-sdk 0.1.0__tar.gz

aidial_interceptors_sdk-0.1.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 2023 EPAM Systems, Inc.
+
+   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.

aidial_interceptors_sdk-0.1.0/PKG-INFO

@@ -0,0 +1,247 @@
+Metadata-Version: 2.1
+Name: aidial-interceptors-sdk
+Version: 0.1.0
+Summary: Framework for creating interceptors for AI DIAL
+Home-page: https://epam-rail.com
+License: Apache-2.0
+Keywords: ai
+Author: EPAM RAIL
+Author-email: SpecialEPM-DIALDevTeam@epam.com
+Requires-Python: >=3.11,<4.0
+Classifier: License :: OSI Approved :: Apache Software License
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Topic :: Software Development :: Libraries :: Python Modules
+Provides-Extra: examples
+Requires-Dist: aidial-sdk[telemetry] (>=0.13.0,<0.14.0)
+Requires-Dist: aiohttp (>=3.8.3,<4.0.0)
+Requires-Dist: aiostream (>=0.6.2,<0.7.0)
+Requires-Dist: fastapi (>=0.51,<1.0)
+Requires-Dist: httpx (>=0.25.0,<1.0)
+Requires-Dist: numpy (>=1.26.1,<2.0.0) ; extra == "examples"
+Requires-Dist: openai (>=1.32.0,<2.0.0)
+Requires-Dist: pillow (>=10.4.0,<11.0.0) ; extra == "examples"
+Requires-Dist: spacy (>=3.7.5,<4.0.0) ; extra == "examples"
+Project-URL: Documentation, https://epam-rail.com/dial_api
+Project-URL: Repository, https://github.com/epam/ai-dial-interceptors-sdk
+Description-Content-Type: text/markdown
+
+# AI DIAL Interceptors Python SDK
+
+> [!IMPORTANT]
+> This package is in early development and subject to rapid changes. Breaking changes between versions are likely as the project evolves.
+
+## Overview
+
+The framework provides useful classes and helpers for creating DIAL Interceptors in Python for chat completion and embedding models.
+
+An interceptor could be thought of as a middleware that
+
+1. modifies an incoming DIAL request received from the client *(or it may leave it as is)*
+2. calls upstream DIAL application *(**the upstream** for short)* with the modified request
+3. modifies the response from the upstream *(or it may leave it as is)*
+4. returns the modified response to the client
+
+The upstream is encapsulated behind a special deployment id `interceptor`. This deployment id is resolved by the DIAL Core into an appropriate deployment id.
+
+Interceptors could be classified into the following categories:
+
+1. **Pre-interceptors** that only modify the incoming request from the client *(e.g. rejecting requests following certain criteria)*
+2. **Post-interceptors** that only modify the response received from the upstream *(e.g. censoring the response)*
+3. **Generic interceptors** that modify both the incoming request and the response from the upstream *(e.g. caching the responses)*
+
+To create chat completion interceptor one needs to implement instance of the class [ChatCompletionInterceptor](aidial_interceptors_sdk/chat_completion/base.py) and for embedding interceptor - [EmbeddingsInterceptor](aidial_interceptors_sdk/embeddings/base.py).
+
+See [example](aidial_interceptors_sdk/examples/interceptor/registry.py) interceptor implementations for more details.
+
+## Environment Variables
+
+Copy `.env.example` to `.env` and customize it for your environment:
+
+|Variable|Default|Description|
+|---|---|---|
+|LOG_LEVEL|INFO|Log level. Use DEBUG for dev purposes and INFO in prod|
+|WEB_CONCURRENCY|1|Number of workers for the server|
+|DIAL_URL||The URL of the DIAL Core server|
+
+## Development
+
+This project uses [Python>=3.11](https://www.python.org/downloads/) and [Poetry>=1.6.1](https://python-poetry.org/) as a dependency manager.
+
+Check out Poetry's [documentation on how to install it](https://python-poetry.org/docs/#installation) on your system before proceeding.
+
+To install requirements:
+
+```sh
+poetry install
+```
+
+This will install all requirements for running the package, linting, formatting and tests.
+
+### IDE configuration
+
+The recommended IDE is [VSCode](https://code.visualstudio.com/).
+Open the project in VSCode and install the recommended extensions.
+
+The VSCode is configured to use PEP-8 compatible formatter [Black](https://black.readthedocs.io/en/stable/index.html).
+
+Alternatively you can use [PyCharm](https://www.jetbrains.com/pycharm/).
+
+Set-up the Black formatter for PyCharm [manually](https://black.readthedocs.io/en/stable/integrations/editors.html#pycharm-intellij-idea) or
+install PyCharm>=2023.2 with [built-in Black support](https://blog.jetbrains.com/pycharm/2023/07/2023-2/#black).
+
+### Make on Windows
+
+As of now, Windows distributions do not include the make tool. To run make commands, the tool can be installed using
+the following command (since [Windows 10](https://learn.microsoft.com/en-us/windows/package-manager/winget/)):
+
+```sh
+winget install GnuWin32.Make
+```
+
+For convenience, the tool folder can be added to the PATH environment variable as `C:\Program Files (x86)\GnuWin32\bin`.
+The command definitions inside Makefile should be cross-platform to keep the development environment setup simple.
+
+### Lint
+
+To run the linting before committing:
+
+```sh
+make lint
+```
+
+To auto-fix formatting issues run:
+
+```sh
+make format
+```
+
+### Test
+
+To run unit tests:
+
+```sh
+make test
+```
+
+### Clean
+
+To remove the virtual environment and build artifacts:
+
+```sh
+make clean
+```
+
+## Examples
+
+The repository also provides examples of various DIAL Interceptors all packed into a DIAL service.
+
+Keep in mind, that the following example interceptors aren't ready for a production use.
+They are provided solely as examples to demonstrate basic use cases of interceptors. Use at your discretion.
+
+### Chat completion interceptors
+
+|Interceptor name|Category|Description|
+|---|---|---|
+|reply-as-pirate|Pre|Injects systems prompt `Reply as a pirate` to the request|
+|reject-external-links|Pre|Rejects any URL in DIAL attachments which do not point to DIAL Core storage|
+|reject-blacklisted-words|Generic|Rejects the request if it contains any blacklisted words|
+|image-watermark|Post|Stamps "EPAM DIAL" watermark on all image attachments in the response. Demonstrates how to work with files stored on DIAL File Storage.|
+|statistics-reporter|Post|Collects statistics on the response stream *(tokens/sec, finish reason, completion tokens etc)* and reports it in a new stage when response is finished|
+|pii-anonymizer|Generic|Anonymizes any PII in the request, calls the upstream, deanonymizes the response|
+|replicator:N|Generic|Calls the upstream N times and combines the N response into a single response. Could be useful for stabilization of model's output, since certain models aren't deterministic.|
+|cache|Generic|Caches incoming chat completion requests. **Not ready for production use. Use at your discretion**|
+|no-op|Generic|No-op interceptor - does not modify the request or the response, simply proxies the upstream|
+
+### Embeddings interceptors
+
+|Interceptor name|Category|Description|
+|---|---|---|
+|reject-blacklisted-words|Pre|Rejects the request if it contains any blacklisted words|
+|normalize-vector|Post|Normalizes the vector in the response|
+|project-vector:N|Post|Changes the dimensionality of the vectors in the response to N, where N is an integer path parameter.|
+|no-op|Generic|No-op interceptor - does not modify the request or the response, simply proxies the upstream|
+
+### Environment variables
+
+Copy `.env.example` to `.env` and customize it for your environment:
+
+|Variable|Default|Description|
+|---|---|---|
+|PII_ANONYMIZER_LABELS_TO_REDACT|PERSON,ORG,GPE,PRODUCT|Comma-separated list of spaCy entity types to redact. Find the full list of entities [here](https://github.com/explosion/spacy-models/blob/e46017f5c8241096c1b30fae080f0e0709c8038c/meta/en_core_web_sm-3.7.0.json#L121-L140).|
+
+### Running interceptor as a DIAL service
+
+To run dev application locally run:
+
+```sh
+make examples_serve
+```
+
+To run from Docker container:
+
+```sh
+make examples_docker_serve
+```
+
+Either of the commands will start the server on `http://localhost:5000` exposing endpoints for each of the interceptors like these:
+
+- `http://localhost:5000/openai/deployments/pii-anonymizer/chat/completions`
+- `http://localhost:5000/openai/deployments/normalize-vector/embeddings`
+
+### DIAL Core configuration
+
+The interceptor endpoints are defined in the `interceptors` section of the DIAL Core configuration like this:
+
+```json
+{
+    "interceptors": {
+        "chat-reply-as-pirate": {
+            "endpoint": "${INTERCEPTOR_SERVICE_URL}/openai/deployments/reply-as-pirate/chat/completions"
+        },
+        "chat-statistics-reporter": {
+            "endpoint": "${INTERCEPTOR_SERVICE_URL}/openai/deployments/statistics-reporter/chat/completions"
+        }
+    }
+}
+```
+
+where `INTERCEPTOR_SERVICE_URL` is the URL of the interceptor service, which is `http://localhost:5000` when run locally, or the interceptor service URL when deployed within Kubernetes.
+
+The declared interceptors could be then attached to particular models and applications:
+
+```json
+{
+    "models": {
+        "anthropic.claude-v3-haiku": {
+            "type": "chat",
+            "iconUrl": "anthropic.svg",
+            "endpoint": "${BEDROCK_ADAPTER_SERVICE_URL}/openai/deployments/anthropic.claude-3-haiku-20240307-v1:0/chat/completions",
+            "interceptors": [
+                "chat-statistics-reporter",
+                "chat-reply-as-pirate"
+            ]
+        }
+    }
+}
+```
+
+Make sure that
+
+1. chat completion interceptors are only used in chat models or application,
+2. embeddings interceptors are only used in embeddings models.
+
+The stack of interceptors in DIAL works similarly to a stack of middlewares in Express.js or Django:
+
+```txt
+Client -> (original request) ->
+  Interceptor 1 -> (modified request #1) ->
+    Interceptor 2 -> (modified request #2) ->
+      Upstream -> (original response) ->
+    Interceptor 2 -> (modified response #1) ->
+  Interceptor 1 -> (modified response #2) ->
+Client
+```
+
+**Every** request/response in the diagram above goes through the DIAL Core. This is hidden from the diagram for brevity.

aidial_interceptors_sdk-0.1.0/README.md

@@ -0,0 +1,218 @@
+# AI DIAL Interceptors Python SDK
+
+> [!IMPORTANT]
+> This package is in early development and subject to rapid changes. Breaking changes between versions are likely as the project evolves.
+
+## Overview
+
+The framework provides useful classes and helpers for creating DIAL Interceptors in Python for chat completion and embedding models.
+
+An interceptor could be thought of as a middleware that
+
+1. modifies an incoming DIAL request received from the client *(or it may leave it as is)*
+2. calls upstream DIAL application *(**the upstream** for short)* with the modified request
+3. modifies the response from the upstream *(or it may leave it as is)*
+4. returns the modified response to the client
+
+The upstream is encapsulated behind a special deployment id `interceptor`. This deployment id is resolved by the DIAL Core into an appropriate deployment id.
+
+Interceptors could be classified into the following categories:
+
+1. **Pre-interceptors** that only modify the incoming request from the client *(e.g. rejecting requests following certain criteria)*
+2. **Post-interceptors** that only modify the response received from the upstream *(e.g. censoring the response)*
+3. **Generic interceptors** that modify both the incoming request and the response from the upstream *(e.g. caching the responses)*
+
+To create chat completion interceptor one needs to implement instance of the class [ChatCompletionInterceptor](aidial_interceptors_sdk/chat_completion/base.py) and for embedding interceptor - [EmbeddingsInterceptor](aidial_interceptors_sdk/embeddings/base.py).
+
+See [example](aidial_interceptors_sdk/examples/interceptor/registry.py) interceptor implementations for more details.
+
+## Environment Variables
+
+Copy `.env.example` to `.env` and customize it for your environment:
+
+|Variable|Default|Description|
+|---|---|---|
+|LOG_LEVEL|INFO|Log level. Use DEBUG for dev purposes and INFO in prod|
+|WEB_CONCURRENCY|1|Number of workers for the server|
+|DIAL_URL||The URL of the DIAL Core server|
+
+## Development
+
+This project uses [Python>=3.11](https://www.python.org/downloads/) and [Poetry>=1.6.1](https://python-poetry.org/) as a dependency manager.
+
+Check out Poetry's [documentation on how to install it](https://python-poetry.org/docs/#installation) on your system before proceeding.
+
+To install requirements:
+
+```sh
+poetry install
+```
+
+This will install all requirements for running the package, linting, formatting and tests.
+
+### IDE configuration
+
+The recommended IDE is [VSCode](https://code.visualstudio.com/).
+Open the project in VSCode and install the recommended extensions.
+
+The VSCode is configured to use PEP-8 compatible formatter [Black](https://black.readthedocs.io/en/stable/index.html).
+
+Alternatively you can use [PyCharm](https://www.jetbrains.com/pycharm/).
+
+Set-up the Black formatter for PyCharm [manually](https://black.readthedocs.io/en/stable/integrations/editors.html#pycharm-intellij-idea) or
+install PyCharm>=2023.2 with [built-in Black support](https://blog.jetbrains.com/pycharm/2023/07/2023-2/#black).
+
+### Make on Windows
+
+As of now, Windows distributions do not include the make tool. To run make commands, the tool can be installed using
+the following command (since [Windows 10](https://learn.microsoft.com/en-us/windows/package-manager/winget/)):
+
+```sh
+winget install GnuWin32.Make
+```
+
+For convenience, the tool folder can be added to the PATH environment variable as `C:\Program Files (x86)\GnuWin32\bin`.
+The command definitions inside Makefile should be cross-platform to keep the development environment setup simple.
+
+### Lint
+
+To run the linting before committing:
+
+```sh
+make lint
+```
+
+To auto-fix formatting issues run:
+
+```sh
+make format
+```
+
+### Test
+
+To run unit tests:
+
+```sh
+make test
+```
+
+### Clean
+
+To remove the virtual environment and build artifacts:
+
+```sh
+make clean
+```
+
+## Examples
+
+The repository also provides examples of various DIAL Interceptors all packed into a DIAL service.
+
+Keep in mind, that the following example interceptors aren't ready for a production use.
+They are provided solely as examples to demonstrate basic use cases of interceptors. Use at your discretion.
+
+### Chat completion interceptors
+
+|Interceptor name|Category|Description|
+|---|---|---|
+|reply-as-pirate|Pre|Injects systems prompt `Reply as a pirate` to the request|
+|reject-external-links|Pre|Rejects any URL in DIAL attachments which do not point to DIAL Core storage|
+|reject-blacklisted-words|Generic|Rejects the request if it contains any blacklisted words|
+|image-watermark|Post|Stamps "EPAM DIAL" watermark on all image attachments in the response. Demonstrates how to work with files stored on DIAL File Storage.|
+|statistics-reporter|Post|Collects statistics on the response stream *(tokens/sec, finish reason, completion tokens etc)* and reports it in a new stage when response is finished|
+|pii-anonymizer|Generic|Anonymizes any PII in the request, calls the upstream, deanonymizes the response|
+|replicator:N|Generic|Calls the upstream N times and combines the N response into a single response. Could be useful for stabilization of model's output, since certain models aren't deterministic.|
+|cache|Generic|Caches incoming chat completion requests. **Not ready for production use. Use at your discretion**|
+|no-op|Generic|No-op interceptor - does not modify the request or the response, simply proxies the upstream|
+
+### Embeddings interceptors
+
+|Interceptor name|Category|Description|
+|---|---|---|
+|reject-blacklisted-words|Pre|Rejects the request if it contains any blacklisted words|
+|normalize-vector|Post|Normalizes the vector in the response|
+|project-vector:N|Post|Changes the dimensionality of the vectors in the response to N, where N is an integer path parameter.|
+|no-op|Generic|No-op interceptor - does not modify the request or the response, simply proxies the upstream|
+
+### Environment variables
+
+Copy `.env.example` to `.env` and customize it for your environment:
+
+|Variable|Default|Description|
+|---|---|---|
+|PII_ANONYMIZER_LABELS_TO_REDACT|PERSON,ORG,GPE,PRODUCT|Comma-separated list of spaCy entity types to redact. Find the full list of entities [here](https://github.com/explosion/spacy-models/blob/e46017f5c8241096c1b30fae080f0e0709c8038c/meta/en_core_web_sm-3.7.0.json#L121-L140).|
+
+### Running interceptor as a DIAL service
+
+To run dev application locally run:
+
+```sh
+make examples_serve
+```
+
+To run from Docker container:
+
+```sh
+make examples_docker_serve
+```
+
+Either of the commands will start the server on `http://localhost:5000` exposing endpoints for each of the interceptors like these:
+
+- `http://localhost:5000/openai/deployments/pii-anonymizer/chat/completions`
+- `http://localhost:5000/openai/deployments/normalize-vector/embeddings`
+
+### DIAL Core configuration
+
+The interceptor endpoints are defined in the `interceptors` section of the DIAL Core configuration like this:
+
+```json
+{
+    "interceptors": {
+        "chat-reply-as-pirate": {
+            "endpoint": "${INTERCEPTOR_SERVICE_URL}/openai/deployments/reply-as-pirate/chat/completions"
+        },
+        "chat-statistics-reporter": {
+            "endpoint": "${INTERCEPTOR_SERVICE_URL}/openai/deployments/statistics-reporter/chat/completions"
+        }
+    }
+}
+```
+
+where `INTERCEPTOR_SERVICE_URL` is the URL of the interceptor service, which is `http://localhost:5000` when run locally, or the interceptor service URL when deployed within Kubernetes.
+
+The declared interceptors could be then attached to particular models and applications:
+
+```json
+{
+    "models": {
+        "anthropic.claude-v3-haiku": {
+            "type": "chat",
+            "iconUrl": "anthropic.svg",
+            "endpoint": "${BEDROCK_ADAPTER_SERVICE_URL}/openai/deployments/anthropic.claude-3-haiku-20240307-v1:0/chat/completions",
+            "interceptors": [
+                "chat-statistics-reporter",
+                "chat-reply-as-pirate"
+            ]
+        }
+    }
+}
+```
+
+Make sure that
+
+1. chat completion interceptors are only used in chat models or application,
+2. embeddings interceptors are only used in embeddings models.
+
+The stack of interceptors in DIAL works similarly to a stack of middlewares in Express.js or Django:
+
+```txt
+Client -> (original request) ->
+  Interceptor 1 -> (modified request #1) ->
+    Interceptor 2 -> (modified request #2) ->
+      Upstream -> (original response) ->
+    Interceptor 2 -> (modified response #1) ->
+  Interceptor 1 -> (modified response #2) ->
+Client
+```
+
+**Every** request/response in the diagram above goes through the DIAL Core. This is hidden from the diagram for brevity.

aidial_interceptors_sdk-0.1.0/aidial_interceptors_sdk/chat_completion/__init__.py

@@ -0,0 +1,3 @@
+from .adapter import interceptor_to_chat_completion
+from .base import ChatCompletionInterceptor, ChatCompletionNoOpInterceptor
+from .element_path import ElementPath