rboto-lex-runtime-v2

rboto is an independent project maintained by 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 Lex Runtime V2, powered by Rust. This package contains LexRuntimeV2Client and 6 operations.

Installation

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

python -m pip install "rboto[lex-runtime-v2]"

You can also install rboto-lex-runtime-v2 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.

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.

import asyncio

from rboto import LexRuntimeV2Client


async def main() -> None:
    client = LexRuntimeV2Client(region="us-east-1")
    response = await client.recognize_text(
        bot_id="YOUR_BOT_ID",
        bot_alias_id="YOUR_ALIAS_ID",
        locale_id="en_US",
        session_id="example-session",
        text="I need help with my order",
    )
    print(response.messages)


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 LexRuntimeV2Client.

• 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_lex_runtime_v2.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_lex_runtime_v2.exceptions. Their error_code, message, and operation_name identify service failures.

Clients also accept profile, endpoint_url, or shared Session settings. See configuration, errors, and 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_lex_runtime_v2.types; native response definitions are in the package's _native.pyi.

Complete signatures

delete_session

async def delete_session(
    *,
    bot_id: str,
    bot_alias_id: str,
    locale_id: str,
    session_id: str,
) -> DeleteSessionOutput: ...

get_session

async def get_session(
    *,
    bot_id: str,
    bot_alias_id: str,
    locale_id: str,
    session_id: str,
) -> GetSessionOutput: ...

put_session

async def put_session(
    *,
    bot_id: str,
    bot_alias_id: str,
    locale_id: str,
    session_id: str,
    session_state: SessionState,
    messages: Sequence[Message] | None = None,
    request_attributes: dict[str, str] | None = None,
    response_content_type: str | None = None,
) -> PutSessionOutput: ...

recognize_text

async def recognize_text(
    *,
    bot_id: str,
    bot_alias_id: str,
    locale_id: str,
    session_id: str,
    text: str,
    session_state: SessionState | None = None,
    request_attributes: dict[str, str] | None = None,
) -> RecognizeTextOutput: ...

recognize_utterance

async def recognize_utterance(
    *,
    bot_id: str,
    bot_alias_id: str,
    locale_id: str,
    session_id: str,
    request_content_type: str,
    session_state: str | None = None,
    request_attributes: str | None = None,
    response_content_type: str | None = None,
    input_stream: bytes | None = None,
) -> RecognizeUtteranceOutput: ...

start_conversation

async def start_conversation(
    *,
    bot_id: str,
    bot_alias_id: str,
    locale_id: str,
    session_id: str,
    request_event_stream: AsyncIterator[StartConversationRequestEventStream],
    conversation_mode: ConversationMode | None = None,
) -> StartConversationOutput: ...

Links

• Service guide
• Repository
• Issues
• Releases

Licensed under Apache-2.0.