redis-intent-router 0.1.0a1__tar.gz

redis_intent_router-0.1.0a1/PKG-INFO

@@ -0,0 +1,559 @@
+Metadata-Version: 2.4
+Name: redis-intent-router
+Version: 0.1.0a1
+Summary: Python Client SDK for Redis Intent Router
+License: MIT
+Author: Redis AI Services Team
+Requires-Python: >=3.10
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Programming Language :: Python :: 3.14
+Requires-Dist: httpcore (>=1.0.9)
+Requires-Dist: httpx (>=0.28.1)
+Requires-Dist: pydantic (>=2.11.2)
+Project-URL: Documentation, https://pypi.org/project/redis-intent-router/
+Project-URL: Homepage, https://redis.io/docs/latest/develop/ai/
+Description-Content-Type: text/markdown
+
+# redis-intent-router
+
+Developer-friendly & type-safe Python SDK specifically catered to leverage *redis-intent-router* API.
+
+[![Built by Speakeasy](https://img.shields.io/badge/Built_by-SPEAKEASY-374151?style=for-the-badge&labelColor=f3f4f6)](https://www.speakeasy.com/?utm_source=redis-intent-router&utm_campaign=python)
+[![License: MIT](https://img.shields.io/badge/LICENSE_//_MIT-3b5bdb?style=for-the-badge&labelColor=eff6ff)](https://opensource.org/licenses/MIT)
+
+
+<br /><br />
+> [!IMPORTANT]
+> This SDK is not yet ready for production use. To complete setup please follow the steps outlined in your [workspace](https://app.speakeasy.com/org/redis/ai-services). Delete this section before > publishing to a package manager.
+
+<!-- Start Summary [summary] -->
+## Summary
+
+Redis Intent Router: Intent authoring and matching API for one Router. An intent is a named classification with example phrasings and an optional dispatch target; matching returns the intents closest to a query. Intents and examples are ordered lists: they are returned in the order they were created.
+
+For more information about the API: [Redis AI documentation](https://redis.io/docs/latest/develop/ai/)
+<!-- End Summary [summary] -->
+
+<!-- Start Table of Contents [toc] -->
+## Table of Contents
+<!-- $toc-max-depth=2 -->
+* [redis-intent-router](#redis-intent-router)
+  * [SDK Installation](#sdk-installation)
+  * [IDE Support](#ide-support)
+  * [SDK Example Usage](#sdk-example-usage)
+  * [Authentication](#authentication)
+  * [Available Resources and Operations](#available-resources-and-operations)
+  * [Global Parameters](#global-parameters)
+  * [Retries](#retries)
+  * [Error Handling](#error-handling)
+  * [Custom HTTP Client](#custom-http-client)
+  * [Resource Management](#resource-management)
+  * [Debugging](#debugging)
+* [Development](#development)
+  * [Maturity](#maturity)
+  * [Contributions](#contributions)
+
+<!-- End Table of Contents [toc] -->
+
+<!-- Start SDK Installation [installation] -->
+## SDK Installation
+
+> [!NOTE]
+> **Python version upgrade policy**
+>
+> Once a Python version reaches its [official end of life date](https://devguide.python.org/versions/), a 3-month grace period is provided for users to upgrade. Following this grace period, the minimum python version supported in the SDK will be updated.
+
+The SDK can be installed with *uv*, *pip*, or *poetry* package managers.
+
+### uv
+
+*uv* is a fast Python package installer and resolver, designed as a drop-in replacement for pip and pip-tools. It's recommended for its speed and modern Python tooling capabilities.
+
+```bash
+uv add redis-intent-router
+```
+
+### PIP
+
+*PIP* is the default package installer for Python, enabling easy installation and management of packages from PyPI via the command line.
+
+```bash
+pip install redis-intent-router
+```
+
+### Poetry
+
+*Poetry* is a modern tool that simplifies dependency management and package publishing by using a single `pyproject.toml` file to handle project metadata and dependencies.
+
+```bash
+poetry add redis-intent-router
+```
+
+### Shell and script usage with `uv`
+
+You can use this SDK in a Python shell with [uv](https://docs.astral.sh/uv/) and the `uvx` command that comes with it like so:
+
+```shell
+uvx --from redis-intent-router python
+```
+
+It's also possible to write a standalone Python script without needing to set up a whole project like so:
+
+```python
+#!/usr/bin/env -S uv run --script
+# /// script
+# requires-python = ">=3.10"
+# dependencies = [
+#     "redis-intent-router",
+# ]
+# ///
+
+from redis_intent_router import IntentRouter
+
+sdk = IntentRouter(
+  # SDK arguments
+)
+
+# Rest of script here...
+```
+
+Once that is saved to a file, you can run it with `uv run script.py` where
+`script.py` can be replaced with the actual file name.
+<!-- End SDK Installation [installation] -->
+
+<!-- Start IDE Support [idesupport] -->
+## IDE Support
+
+### PyCharm
+
+Generally, the SDK will work well with most IDEs out of the box. However, when using PyCharm, you can enjoy much better integration with Pydantic by installing an additional plugin.
+
+- [PyCharm Pydantic Plugin](https://docs.pydantic.dev/latest/integrations/pycharm/)
+<!-- End IDE Support [idesupport] -->
+
+<!-- Start SDK Example Usage [usage] -->
+## SDK Example Usage
+
+### Example
+
+```python
+# Synchronous Example
+from redis_intent_router import IntentRouter, models
+
+
+with IntentRouter(
+    "https://api.example.com",
+    router_id="<id>",
+    api_key="<INTENT_ROUTER_API_KEY>",
+) as intent_router:
+
+    intent_router.clear(scope=models.ClearScope.INTENTS)
+
+    # Use the SDK ...
+```
+
+</br>
+
+The same SDK client can also be used to make asynchronous requests by importing asyncio.
+
+```python
+# Asynchronous Example
+import asyncio
+from redis_intent_router import IntentRouter, models
+
+async def main():
+
+    async with IntentRouter(
+        "https://api.example.com",
+        router_id="<id>",
+        api_key="<INTENT_ROUTER_API_KEY>",
+    ) as intent_router:
+
+        await intent_router.clear_async(scope=models.ClearScope.INTENTS)
+
+        # Use the SDK ...
+
+asyncio.run(main())
+```
+<!-- End SDK Example Usage [usage] -->
+
+<!-- Start Authentication [security] -->
+## Authentication
+
+### Per-Client Security Schemes
+
+This SDK supports the following security scheme globally:
+
+| Name      | Type | Scheme      | Environment Variable    |
+| --------- | ---- | ----------- | ----------------------- |
+| `api_key` | http | HTTP Bearer | `INTENT_ROUTER_API_KEY` |
+
+To authenticate with the API the `api_key` parameter must be set when initializing the SDK client instance. For example:
+```python
+from redis_intent_router import IntentRouter, models
+
+
+with IntentRouter(
+    "https://api.example.com",
+    api_key="<INTENT_ROUTER_API_KEY>",
+    router_id="<id>",
+) as intent_router:
+
+    intent_router.clear(scope=models.ClearScope.INTENTS)
+
+    # Use the SDK ...
+
+```
+<!-- End Authentication [security] -->
+
+<!-- Start Available Resources and Operations [operations] -->
+## Available Resources and Operations
+
+<details open>
+<summary>Available methods</summary>
+
+### IntentRouter SDK
+
+* clear - Removes everything the scope names. With INTENTS every intent and example of the Router is deleted and the Router itself stays. The scope is required: there is no default.
+* get_router_health - Reports why a Router can or cannot serve: its state, the generation the data plane has applied and the stores it depends on.
+* list_intents - Lists intents with their configuration and example counts, in the order they were created.
+* add_intents - Adds several intents in the order given, after the ones the Router already has. An intent whose name already exists is replaced in its place; every other intent is left alone. Nothing is written if any intent is invalid.
+* delete_intent - Deletes one intent and its examples. Deleting a missing intent succeeds.
+* get_intent - Returns one intent. Its examples are listed from the examples sub-resource.
+* update_intent - Changes an intent's description, target, minScore or metadata as a merge patch, without touching or re-embedding its examples. An omitted member is unchanged and a null member is cleared; a given metadata map replaces the whole map.
+* upsert_intent - Creates or replaces one intent. Idempotent: the same request twice yields the same state. 201 when the intent is new, 200 when it replaced one, which keeps its place in the list. Existing phrasings absent from the request are removed after the new ones are written, so a concurrent match never sees an empty intent.
+* list_examples - Lists an intent's examples in the order they were written.
+* add_examples - Adds example phrasings to an existing intent, after the ones it already has. Repeating a phrasing is harmless: it keeps its place and is not embedded again.
+* delete_example - Deletes one example. Deleting a missing example succeeds.
+* get_example - Returns one example. An identifier from another intent is not found.
+* match - Returns the intents closest to the query, best first. No match is a 200 with an empty list.
+
+</details>
+<!-- End Available Resources and Operations [operations] -->
+
+<!-- Start Global Parameters [global-parameters] -->
+## Global Parameters
+
+A parameter is configured globally. This parameter may be set on the SDK client instance itself during initialization. When configured as an option during SDK initialization, This global value will be used as the default on the operations that use it. When such operations are called, there is a place in each to override the global value, if needed.
+
+For example, you can set `routerId` to `"<id>"` at SDK initialization and then you do not have to pass the same value on calls to operations like `clear`. But if you want to do so you may, which will locally override the global setting. See the example code below for a demonstration.
+
+
+### Available Globals
+
+The following global parameter is available.
+Global parameters can also be set via environment variable.
+
+| Name      | Type | Description              | Environment             |
+| --------- | ---- | ------------------------ | ----------------------- |
+| router_id | str  | The router_id parameter. | INTENT_ROUTER_ROUTER_ID |
+
+### Example
+
+```python
+from redis_intent_router import IntentRouter, models
+
+
+with IntentRouter(
+    "https://api.example.com",
+    router_id="<id>",
+    api_key="<INTENT_ROUTER_API_KEY>",
+) as intent_router:
+
+    intent_router.clear(scope=models.ClearScope.INTENTS)
+
+    # Use the SDK ...
+
+```
+<!-- End Global Parameters [global-parameters] -->
+
+<!-- Start Retries [retries] -->
+## Retries
+
+Some of the endpoints in this SDK support retries. If you use the SDK without any configuration, it will fall back to the default retry strategy provided by the API. However, the default retry strategy can be overridden on a per-operation basis, or across the entire SDK.
+
+To change the default retry strategy for a single API call, simply provide a `RetryConfig` object to the call:
+```python
+from redis_intent_router import IntentRouter, models
+from redis_intent_router.utils import BackoffStrategy, RetryConfig
+
+
+with IntentRouter(
+    "https://api.example.com",
+    router_id="<id>",
+    api_key="<INTENT_ROUTER_API_KEY>",
+) as intent_router:
+
+    intent_router.clear(scope=models.ClearScope.INTENTS,
+        RetryConfig("backoff", BackoffStrategy(1, 50, 1.1, 100), False))
+
+    # Use the SDK ...
+
+```
+
+If you'd like to override the default retry strategy for all operations that support retries, you can use the `retry_config` optional parameter when initializing the SDK:
+```python
+from redis_intent_router import IntentRouter, models
+from redis_intent_router.utils import BackoffStrategy, RetryConfig
+
+
+with IntentRouter(
+    "https://api.example.com",
+    retry_config=RetryConfig("backoff", BackoffStrategy(1, 50, 1.1, 100), False),
+    router_id="<id>",
+    api_key="<INTENT_ROUTER_API_KEY>",
+) as intent_router:
+
+    intent_router.clear(scope=models.ClearScope.INTENTS)
+
+    # Use the SDK ...
+
+```
+<!-- End Retries [retries] -->
+
+<!-- Start Error Handling [errors] -->
+## Error Handling
+
+`IntentRouterError` is the base class for all HTTP error responses. It has the following properties:
+
+| Property           | Type             | Description                                                                             |
+| ------------------ | ---------------- | --------------------------------------------------------------------------------------- |
+| `err.message`      | `str`            | Error message                                                                           |
+| `err.status_code`  | `int`            | HTTP response status code eg `404`                                                      |
+| `err.headers`      | `httpx.Headers`  | HTTP response headers                                                                   |
+| `err.body`         | `str`            | HTTP body. Can be empty string if no body is returned.                                  |
+| `err.raw_response` | `httpx.Response` | Raw HTTP response                                                                       |
+| `err.data`         |                  | Optional. Some errors may contain structured data. [See Error Classes](#error-classes). |
+
+### Example
+```python
+from redis_intent_router import IntentRouter, errors, models
+
+
+with IntentRouter(
+    "https://api.example.com",
+    router_id="<id>",
+    api_key="<INTENT_ROUTER_API_KEY>",
+) as intent_router:
+
+    try:
+
+        intent_router.clear(scope=models.ClearScope.INTENTS)
+
+        # Use the SDK ...
+
+
+    except errors.IntentRouterError as e:
+        # The base class for HTTP error responses
+        print(e.message)
+        print(e.status_code)
+        print(e.body)
+        print(e.headers)
+        print(e.raw_response)
+
+        # Depending on the method different errors may be thrown
+        if isinstance(e, errors.BadRequestErrorResponseContent):
+            print(e.data.title)  # str
+            print(e.data.status)  # Optional[int]
+            print(e.data.detail)  # Optional[str]
+            print(e.data.instance)  # Optional[str]
+            print(e.data.type)  # models.BadRequestErrorType
+```
+
+### Error Classes
+**Primary errors:**
+* `IntentRouterError`: The base class for HTTP error responses.
+  * `BadRequestErrorResponseContent`: Request validation or input decoding failed. Status code `400`.
+  * `AuthenticationErrorResponseContent`: Authentication credentials are missing, malformed, or invalid. Status code `401`.
+  * `NotFoundErrorResponseContent`: The requested resource does not exist. Status code `404`.
+  * `TimeoutErrorResponseContent`: The request timed out before the service could complete it. Status code `408`.
+  * `ConflictErrorResponseContent`: The request conflicts with the current state of the resource. Status code `409`.
+  * `ResourceSuspendedErrorResponseContent`: The requested resource exists but is suspended by an administrator. Status code `423`.
+  * `FailedDependencyErrorResponseContent`: A dependent resource required to process the request is unavailable or unhealthy. Status code `424`.
+  * `UnexpectedErrorResponseContent`: The service failed with an unexpected internal error. Status code `500`.
+  * `ServiceUnavailableErrorResponseContent`: ServiceUnavailableError 503 response. Status code `503`.
+
+<details><summary>Less common errors (6)</summary>
+
+<br />
+
+**Network errors:**
+* [`httpx.RequestError`](https://www.python-httpx.org/exceptions/#httpx.RequestError): Base class for request errors.
+    * [`httpx.ConnectError`](https://www.python-httpx.org/exceptions/#httpx.ConnectError): HTTP client was unable to make a request to a server.
+    * [`httpx.TimeoutException`](https://www.python-httpx.org/exceptions/#httpx.TimeoutException): HTTP request timed out.
+
+
+**Inherit from `IntentRouterError`**:
+* `PreconditionFailedErrorResponseContent`: The write named an expected revision (expectedRevision or If-Match) that is no longer current. Read the resource again and retry. Status code `412`. Applicable to 2 of 13 methods.*
+* `ResponseValidationError`: Type mismatch between the response data and the expected Pydantic model. Provides access to the Pydantic validation error via the `cause` attribute.
+
+</details>
+
+\* Check [the method documentation](#available-resources-and-operations) to see if the error is applicable.
+<!-- End Error Handling [errors] -->
+
+<!-- Start Custom HTTP Client [http-client] -->
+## Custom HTTP Client
+
+The Python SDK makes API calls using the [httpx](https://www.python-httpx.org/) HTTP library.  In order to provide a convenient way to configure timeouts, cookies, proxies, custom headers, and other low-level configuration, you can initialize the SDK client with your own HTTP client instance.
+Depending on whether you are using the sync or async version of the SDK, you can pass an instance of `HttpClient` or `AsyncHttpClient` respectively, which are Protocol's ensuring that the client has the necessary methods to make API calls.
+This allows you to wrap the client with your own custom logic, such as adding custom headers, logging, or error handling, or you can just pass an instance of `httpx.Client` or `httpx.AsyncClient` directly.
+
+For example, you could specify a header for every request that this sdk makes as follows:
+```python
+from redis_intent_router import IntentRouter
+import httpx
+
+http_client = httpx.Client(headers={"x-custom-header": "someValue"})
+s = IntentRouter(client=http_client)
+```
+
+or you could wrap the client with your own custom logic:
+```python
+from redis_intent_router import IntentRouter
+from redis_intent_router.httpclient import AsyncHttpClient
+import httpx
+
+class CustomClient(AsyncHttpClient):
+    client: AsyncHttpClient
+
+    def __init__(self, client: AsyncHttpClient):
+        self.client = client
+
+    async def send(
+        self,
+        request: httpx.Request,
+        *,
+        stream: bool = False,
+        auth: Union[
+            httpx._types.AuthTypes, httpx._client.UseClientDefault, None
+        ] = httpx.USE_CLIENT_DEFAULT,
+        follow_redirects: Union[
+            bool, httpx._client.UseClientDefault
+        ] = httpx.USE_CLIENT_DEFAULT,
+    ) -> httpx.Response:
+        request.headers["Client-Level-Header"] = "added by client"
+
+        return await self.client.send(
+            request, stream=stream, auth=auth, follow_redirects=follow_redirects
+        )
+
+    def build_request(
+        self,
+        method: str,
+        url: httpx._types.URLTypes,
+        *,
+        content: Optional[httpx._types.RequestContent] = None,
+        data: Optional[httpx._types.RequestData] = None,
+        files: Optional[httpx._types.RequestFiles] = None,
+        json: Optional[Any] = None,
+        params: Optional[httpx._types.QueryParamTypes] = None,
+        headers: Optional[httpx._types.HeaderTypes] = None,
+        cookies: Optional[httpx._types.CookieTypes] = None,
+        timeout: Union[
+            httpx._types.TimeoutTypes, httpx._client.UseClientDefault
+        ] = httpx.USE_CLIENT_DEFAULT,
+        extensions: Optional[httpx._types.RequestExtensions] = None,
+    ) -> httpx.Request:
+        return self.client.build_request(
+            method,
+            url,
+            content=content,
+            data=data,
+            files=files,
+            json=json,
+            params=params,
+            headers=headers,
+            cookies=cookies,
+            timeout=timeout,
+            extensions=extensions,
+        )
+
+s = IntentRouter(async_client=CustomClient(httpx.AsyncClient()))
+```
+### httpx2 (Pydantic's httpx fork)
+
+[httpx2](https://httpx2.pydantic.dev/) is Pydantic's maintained fork of `httpx`. To run this SDK on httpx2, call `alias_httpx()` at your program's entry point, before importing the SDK, so every `import httpx` — including the ones inside the SDK — resolves to `httpx2`:
+```python
+import httpx2
+
+httpx2.alias_httpx()
+
+from redis_intent_router import IntentRouter
+
+s = IntentRouter()
+```
+
+An SDK can also be generated against httpx2 directly, so it depends on the fork instead of `httpx`, by setting `python.httpClientLibrary: httpx2` in `gen.yaml`.
+<!-- End Custom HTTP Client [http-client] -->
+
+<!-- Start Resource Management [resource-management] -->
+## Resource Management
+
+The `IntentRouter` class implements the context manager protocol and registers a finalizer function to close the underlying sync and async HTTPX clients it uses under the hood. This will close HTTP connections, release memory and free up other resources held by the SDK. In short-lived Python programs and notebooks that make a few SDK method calls, resource management may not be a concern. However, in longer-lived programs, it is beneficial to create a single SDK instance via a [context manager][context-manager] and reuse it across the application.
+
+[context-manager]: https://docs.python.org/3/reference/datamodel.html#context-managers
+
+```python
+from redis_intent_router import IntentRouter
+def main():
+
+    with IntentRouter(
+        "https://api.example.com",
+        router_id="<id>",
+        api_key="<INTENT_ROUTER_API_KEY>",
+    ) as intent_router:
+        # Rest of application here...
+
+
+# Or when using async:
+async def amain():
+
+    async with IntentRouter(
+        "https://api.example.com",
+        router_id="<id>",
+        api_key="<INTENT_ROUTER_API_KEY>",
+    ) as intent_router:
+        # Rest of application here...
+```
+<!-- End Resource Management [resource-management] -->
+
+<!-- Start Debugging [debug] -->
+## Debugging
+
+You can setup your SDK to emit debug logs for SDK requests and responses.
+
+You can pass your own logger class directly into your SDK.
+```python
+from redis_intent_router import IntentRouter
+import logging
+
+logging.basicConfig(level=logging.DEBUG)
+s = IntentRouter(server_url="https://example.com", debug_logger=logging.getLogger("redis_intent_router"))
+```
+
+You can also enable a default debug logger by setting an environment variable `INTENT_ROUTER_DEBUG` to true.
+<!-- End Debugging [debug] -->
+
+<!-- Placeholder for Future Speakeasy SDK Sections -->
+
+# Development
+
+## Maturity
+
+This SDK is in beta, and there may be breaking changes between versions without a major version update. Therefore, we recommend pinning usage
+to a specific package version. This way, you can install the same version each time without breaking changes unless you are intentionally
+looking for the latest version.
+
+## Contributions
+
+While we value open-source contributions to this SDK, this library is generated programmatically. Any manual changes added to internal files will be overwritten on the next generation.
+We look forward to hearing your feedback. Feel free to open a PR or an issue with a proof of concept and we'll do our best to include it in a future release.
+
+### SDK Created by [Speakeasy](https://www.speakeasy.com/?utm_source=redis-intent-router&utm_campaign=python)
+