Metadata-Version: 2.4
Name: capo-lex-runtime-service
Version: 0.1.0
Summary: Python SDK for Lex Runtime Service.
Classifier: Development Status :: 4 - Beta
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
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
Classifier: Topic :: Software Development :: Code Generators
Classifier: Typing :: Typed
Requires-Python: >=3.10
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: zapros>=0.13.0
Provides-Extra: sso
Requires-Dist: capo-sso>=0.2.0; extra == "sso"
Requires-Dist: capo-sso-oidc>=0.2.0; extra == "sso"
Requires-Dist: capo-sts>=0.3.0; extra == "sso"
Dynamic: license-file

# Getting Started

## Installation

```
pip install capo-lex-runtime-service
```

## Usage

```python
from capo_lex_runtime_service import AsyncLexRuntimeServiceClient


async def main():
    async with AsyncLexRuntimeServiceClient() as lex_runtime_service:
        # Example: call the delete_session operation
        response = await lex_runtime_service.delete_session()
        print(response["bot_name"])
```

## Streaming Request

Some operations accept a streaming request body. Pass an async iterator of `bytes` chunks, or the whole body as `bytes`, for the streaming parameter.

```python
from capo_lex_runtime_service import AsyncLexRuntimeServiceClient


async def main():
    async with AsyncLexRuntimeServiceClient() as lex_runtime_service:
        # Example: call post_content with a streaming request body
        async def chunks():
            yield b'Hello, World!'

        response = await lex_runtime_service.post_content(input_stream=chunks())
        print(response)

        # Or pass the whole body as bytes
        response = await lex_runtime_service.post_content(input_stream=b'Hello, World!')
        print(response)
```

## Streaming Response

Some operations return a streaming response body. Use the operation as an async context manager and iterate over the response field to read chunks.

```python
from capo_lex_runtime_service import AsyncLexRuntimeServiceClient


async def main():
    async with AsyncLexRuntimeServiceClient() as lex_runtime_service:
        # Example: call post_content and read the streaming response
        async with lex_runtime_service.post_content() as response:
            async for chunk in response["audio_stream"]:
                print(chunk)
```

## Error Handling

The SDK raises exceptions for errors returned by the API. Catch them to handle failures gracefully.

```python
from capo_lex_runtime_service import AsyncLexRuntimeServiceClient
from capo_lex_runtime_service.error import BadRequestException


async def main():
    async with AsyncLexRuntimeServiceClient() as lex_runtime_service:
        try:
            await lex_runtime_service.delete_session()
        except BadRequestException as e:
            print(f"Error: {e}")
            print(e.data)  # additional error data
```

## Retrying

The SDK retries failed operations automatically. Retry behaviour follows the Smithy specification: errors are retried based on their `is_retryable` and `is_throttling_error` attributes. Throttling errors use a longer base delay. Network-level failures (connection errors and timeouts) are also retried. Non-retryable errors, such as client errors without the `@retryable` trait, are raised immediately without further attempts.

The number of attempts defaults to 3 and can be changed at the client level via `retry_max_attempts`, or per call via `config_overrides`.

```python
from capo_lex_runtime_service import AsyncLexRuntimeServiceClient


async def main():
    async with AsyncLexRuntimeServiceClient() as lex_runtime_service:
        # Default: 3 attempts for every operation
        response = await lex_runtime_service.delete_session()

        # Override per operation
        response = await lex_runtime_service.delete_session(config_overrides={"retry_max_attempts": 5})

        # Disable retries for this call
        response = await lex_runtime_service.delete_session(config_overrides={"retry_max_attempts": 1})
```
