Metadata-Version: 2.4
Name: rboto-sagemaker-runtime-http2
Version: 0.1.0
Classifier: Development Status :: 3 - Alpha
Classifier: Intended Audience :: Developers
Classifier: Framework :: AsyncIO
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.12
Classifier: Programming Language :: Python :: 3.13
Classifier: Programming Language :: Python :: 3.14
Classifier: Programming Language :: Python :: 3.15
Classifier: Programming Language :: Rust
Classifier: Topic :: Software Development :: Libraries :: Python Modules
Classifier: Typing :: Typed
Requires-Dist: rboto==0.1.0
License-File: LICENSE
Summary: rboto: async-only, typed Python client for Amazon SageMaker Runtime HTTP/2, powered by Rust. Alpha preview.
Keywords: rboto,aws,sagemaker-runtime-http2,asyncio,typing,rust
Home-Page: https://github.com/ferrumio/rboto
Author-email: Leandro Cavalcante Damascena <leandro.damascena@gmail.com>
License-Expression: Apache-2.0
Requires-Python: >=3.12
Description-Content-Type: text/markdown; charset=UTF-8; variant=GFM
Project-URL: Changelog, https://github.com/ferrumio/rboto/releases
Project-URL: Documentation, https://ferrumio.github.io/rboto/clients/
Project-URL: Homepage, https://ferrumio.github.io/rboto/
Project-URL: Issues, https://github.com/ferrumio/rboto/issues
Project-URL: Repository, https://github.com/ferrumio/rboto

<!-- Generated by rboto-codegen. Edit the descriptor, template, or example source. -->
# rboto-sagemaker-runtime-http2

rboto is an independent project maintained by [Ferrumio](https://github.com/ferrumio).
It is not affiliated with, sponsored by, or endorsed by Amazon Web Services (AWS).

**Preview (Alpha).** rboto is under active development. APIs may change between releases.

rboto provides an **async-only, typed Python client for Amazon SageMaker Runtime HTTP/2**,
powered by Rust. This package contains `SageMakerRuntimeHTTP2Client` and
**1 operations**.

## Installation

Requires Python 3.12 or newer and a native wheel for your Python version and platform.

```bash
python -m pip install "rboto[sagemaker-runtime-http2]"
```

You can also install `rboto-sagemaker-runtime-http2` directly; it installs the matching
`rboto` package. Only the selected service is installed.

These are the package names to use when a release is available on your package index.
If your index has no release yet, follow the
[source installation instructions](https://ferrumio.github.io/rboto/getting-started/).

## Usage

Configure credentials through your environment, shared profile, or workload role.
The example uses `us-east-1`; select a region where your service and resources are available.
Resource names, identifiers, input files, and model IDs in the example are placeholders
to replace with your own.

```python
import asyncio
from collections.abc import AsyncIterator
from pathlib import Path

from rboto import SageMakerRuntimeHTTP2Client
from rboto_sagemaker_runtime_http2.types import RequestStreamEvent


async def request_events() -> AsyncIterator[RequestStreamEvent]:
    # Use an endpoint whose model accepts this JSON request format.
    # Models may require several payload parts or a different content format.
    payload = await asyncio.to_thread(Path("request.json").read_bytes)
    yield {
        "payload_part": {
            "bytes": payload,
            "data_type": "UTF8",
            "completion_state": "COMPLETE",
        },
    }


async def main() -> None:
    client = SageMakerRuntimeHTTP2Client(region="us-east-1")
    response = await client.invoke_endpoint_with_bidirectional_stream(
        endpoint_name="my-streaming-endpoint",
        body=request_events(),
    )
    async for event in response["body"]:
        print(event)


if __name__ == "__main__":
    asyncio.run(main())
```

In an application with an event loop, call `await main()` instead of `asyncio.run(main())`.
Reuse the client across calls. Constructing a client does not send a request.

## API conventions

- Import the client with `from rboto import SageMakerRuntimeHTTP2Client`.
- Every operation is asynchronous: use `await client.method(...)`.
- Operation arguments are keyword-only and use the Python names listed below.
- Structured inputs use typed dictionaries and tagged unions from `rboto_sagemaker_runtime_http2.types`.
- Regular responses expose typed attributes; `response.to_dict()` converts them to a dictionary.
- Event-stream responses may be typed dictionaries containing async iterators. Follow the
  declared return type; consume event streams with `async for`.
- Byte streams are consumed asynchronously. `await stream.read()` buffers the complete body;
  iterate the stream when processing a large response.
- Direct operation calls return one page.

- Catch modeled exceptions from `rboto_sagemaker_runtime_http2.exceptions`. Their `error_code`,
  `message`, and `operation_name` identify service failures.

Clients also accept `profile`, `endpoint_url`, or shared `Session` settings.
See [configuration](https://ferrumio.github.io/rboto/guides/configuration/),
[errors](https://ferrumio.github.io/rboto/guides/errors/), and
[streaming](https://ferrumio.github.io/rboto/guides/streaming/).

## Operations

This is the complete operation catalog for this generated package. “Required arguments”
lists arguments without defaults in the Python signature. Service-side conditions may
require additional arguments. Each method links to its complete signature, including
optional arguments. Nested input definitions are in `rboto_sagemaker_runtime_http2.types`;
native response definitions are in the package's `_native.pyi`.

| Method | Required arguments | Return type |
|---|---|---|
| [`invoke_endpoint_with_bidirectional_stream`](#invoke_endpoint_with_bidirectional_stream) | <code>endpoint_name: str</code>, <code>body: AsyncIterator[RequestStreamEvent]</code> | <code>InvokeEndpointWithBidirectionalStreamOutput</code> |

## Complete signatures

### invoke_endpoint_with_bidirectional_stream

```python
async def invoke_endpoint_with_bidirectional_stream(
    *,
    endpoint_name: str,
    body: AsyncIterator[RequestStreamEvent],
    target_variant: str | None = None,
    model_invocation_path: str | None = None,
    model_query_string: str | None = None,
) -> InvokeEndpointWithBidirectionalStreamOutput: ...
```


## Links

- [Service guide](https://ferrumio.github.io/rboto/clients/)
- [Repository](https://github.com/ferrumio/rboto)
- [Issues](https://github.com/ferrumio/rboto/issues)
- [Releases](https://github.com/ferrumio/rboto/releases)

Licensed under Apache-2.0.

