Rainy SDK

https://docs.rs/rainy-sdk/latest/rainy_sdk/
Admin
Official Rust SDK for Rainy API by Enosis Labs, providing an enhanced unified interface for multiple...
Tokens:51,087
Snippets:756
Trust Score:9.7
Update:1 month ago
Show doc for...
Tokens:
Raw
### Example Search Queries

Source: https://docs.rs/rainy-sdk/latest/rainy_sdk/models/common/struct.Usage.html?search=

Common search patterns for finding types and trait implementations.

```text
std::vec
```

```text
u32 -> bool
```

```text
Option<T>, (T -> U) -> Option<U>
```

--------------------------------

### GET /api/v1/keys

Source: https://docs.rs/rainy-sdk/latest/rainy_sdk/session/index.html?search=std%3A%3Avec

Lists API keys for the current session.

```APIDOC
## GET /api/v1/keys

### Description
Retrieves a list of API keys associated with the current session.

### Method
GET

### Endpoint
/api/v1/keys
```

--------------------------------

### GET /api/v1/usage/stats

Source: https://docs.rs/rainy-sdk/latest/rainy_sdk/session/index.html?search=std%3A%3Avec

Retrieves usage statistics.

```APIDOC
## GET /api/v1/usage/stats

### Description
Returns usage statistics for the account.

### Method
GET

### Endpoint
/api/v1/usage/stats
```

--------------------------------

### GET /api/v1/usage/credits

Source: https://docs.rs/rainy-sdk/latest/rainy_sdk/session/index.html?search=Option%3CT%3E%2C+%28T+-%3E+U%29+-%3E+Option%3CU%3E

Retrieves the current usage credits balance.

```APIDOC
## GET /api/v1/usage/credits

### Description
Returns the current balance of usage credits for the account.

### Method
GET

### Endpoint
/api/v1/usage/credits
```

--------------------------------

### GET /api/v1/usage/credits

Source: https://docs.rs/rainy-sdk/latest/rainy_sdk/session/index.html?search=std%3A%3Avec

Retrieves current usage credits balance.

```APIDOC
## GET /api/v1/usage/credits

### Description
Returns the current credit balance for the account.

### Method
GET

### Endpoint
/api/v1/usage/credits
```

--------------------------------

### Initialize and use RainyClient

Source: https://docs.rs/rainy-sdk/latest/rainy_sdk/index.html?search=

Demonstrates creating a client with an API key and performing a simple chat request.

```rust
use rainy_sdk::RainyClient;

#[tokio::main]
async fn main() -> Result<(), Box<dyn std::error::Error>> {
    // Create a client with an API key. No discovery call is made here.
    let client = RainyClient::with_api_key("your-api-key")?;

    let response = client
        .simple_chat("compatible/chat-model", "Say hello")
        .await?;
    println!("{response}");

    Ok(())
}
```

--------------------------------

### get_usage_stats

Source: https://docs.rs/rainy-sdk/latest/rainy_sdk/client/struct.RainyClient.html

Get usage statistics (Deprecated).

```APIDOC
## pub async fn get_usage_stats(&self, days: Option<u32>) -> Result<UsageStats>

### Description
Get usage statistics. Legacy v2-style usage helper. Rainy API v3 usage endpoints require JWT/session auth and return different shapes.

### Parameters
- **days** (Option<u32>) - Optional - Number of days to look back (default: 30).
```

--------------------------------

### get_credit_stats

Source: https://docs.rs/rainy-sdk/latest/rainy_sdk/client/struct.RainyClient.html

Get credit statistics (Deprecated).

```APIDOC
## pub async fn get_credit_stats(&self, days: Option<u32>) -> Result<CreditInfo>

### Description
Get credit statistics. Legacy v2-style usage helper. Rainy API v3 usage endpoints require JWT/session auth and return different shapes.

### Parameters
- **days** (Option<u32>) - Optional - Number of days to look back (default: 30).
```

--------------------------------

### ProviderOptions Implementation Methods

Source: https://docs.rs/rainy-sdk/latest/rainy_sdk/models/chat/struct.ProviderOptions.html?search=Option%3CT%3E%2C+%28T+-%3E+U%29+-%3E+Option%3CU%3E

Methods for creating and configuring ProviderOptions instances.

```rust
pub fn preferred(provider: impl Into<String>) -> Self
```

```rust
pub fn with_order<I, S>(self, providers: I) -> Self
where I: IntoIterator<Item = S>, S: Into<String>,
```

```rust
pub fn with_allow_fallbacks(self, allow: bool) -> Self
```

--------------------------------

### Create ReasoningPreference instances

Source: https://docs.rs/rainy-sdk/latest/rainy_sdk/models/catalog/struct.ReasoningPreference.html

Helper methods to initialize a ReasoningPreference using either an effort level or a numeric budget.

```rust
pub fn effort(effort: impl Into<ReasoningEffort>) -> Self
```

```rust
pub fn budget(budget: u32) -> Self
```

--------------------------------

### GET /api/v1/orgs/me

Source: https://docs.rs/rainy-sdk/latest/rainy_sdk/session/index.html?search=Option%3CT%3E%2C+%28T+-%3E+U%29+-%3E+Option%3CU%3E

Retrieves the profile of the current organization.

```APIDOC
## GET /api/v1/orgs/me

### Description
Returns the organization profile associated with the current session.

### Method
GET

### Endpoint
/api/v1/orgs/me
```

--------------------------------

### GET /api/v1/orgs/me

Source: https://docs.rs/rainy-sdk/latest/rainy_sdk/session/index.html?search=std%3A%3Avec

Retrieves the profile of the current organization.

```APIDOC
## GET /api/v1/orgs/me

### Description
Returns the organization profile for the authenticated user.

### Method
GET

### Endpoint
/api/v1/orgs/me
```

--------------------------------

### RateLimiter Implementation Methods

Source: https://docs.rs/rainy-sdk/latest/rainy_sdk/auth/struct.RateLimiter.html?search=Option%3CT%3E%2C+%28T+-%3E+U%29+-%3E+Option%3CU%3E

Methods for initializing the limiter and waiting for request clearance.

```rust
pub fn new(requests_per_minute: u32) -> Self
```

```rust
pub async fn wait_if_needed(&mut self) -> Result<()>
```

--------------------------------

### RainyClient::with_api_key

Source: https://docs.rs/rainy-sdk/latest/rainy_sdk/index.html?search=Option%3CT%3E%2C+%28T+-%3E+U%29+-%3E+Option%3CU%3E

Initializes a new RainyClient instance using the provided API key for authentication.

```APIDOC
## RainyClient::with_api_key

### Description
Creates a new client instance configured with an API key. This client is used to perform inference requests against compatible services.

### Signature
`pub fn with_api_key(api_key: &str) -> Result<Self>`

### Parameters
- **api_key** (&str) - Required - The API key string used for authentication.

### Returns
- **Result<Self>** - Returns a new RainyClient instance or an error if initialization fails.
```

--------------------------------

### RainyClient Initialization

Source: https://docs.rs/rainy-sdk/latest/rainy_sdk/client/struct.RainyClient.html?search=std%3A%3Avec

Methods for creating and configuring a new RainyClient instance.

```APIDOC
## pub fn with_api_key(api_key: impl Into<String>) -> Result<Self>
Creates a client using a protocol-neutral API key.

## pub fn with_config(auth_config: AuthConfig) -> Result<Self>
Creates a client from explicit configuration.

## pub fn with_retry_config(self, retry_config: RetryConfig) -> Self
Replaces the retry configuration used for safe operations.

## pub fn with_anthropic_version(self, version: impl Into<String>) -> Result<Self>
Sets the anthropic-version header used by native Messages requests.
```

--------------------------------

### RainyClient Initialization

Source: https://docs.rs/rainy-sdk/latest/rainy_sdk/client/struct.RainyClient.html?search=u32+-%3E+bool

Methods for creating and configuring a new RainyClient instance.

```APIDOC
## RainyClient Initialization

### with_api_key(api_key: impl Into<String>) -> Result<Self>
Creates a client using a protocol-neutral API key.

### with_config(auth_config: AuthConfig) -> Result<Self>
Creates a client from explicit configuration.

### with_retry_config(self, retry_config: RetryConfig) -> Self
Replaces the retry configuration used for safe operations.

### with_anthropic_version(self, version: impl Into<String>) -> Result<Self>
Sets the anthropic-version header used by native Messages requests.
```

--------------------------------

### get_user_account

Source: https://docs.rs/rainy-sdk/latest/rainy_sdk/client/struct.RainyClient.html

Get current user account information (Deprecated).

```APIDOC
## pub async fn get_user_account(&self) -> Result<User>

### Description
Get current user account information. Legacy v2 user account endpoint. Rainy API v3 uses JWT session endpoints such as /api/v1/auth/me and /api/v1/orgs/me.
```

--------------------------------

### SessionConfig::new

Source: https://docs.rs/rainy-sdk/latest/rainy_sdk/session/struct.SessionConfig.html?search=u32+-%3E+bool

Creates a new instance of SessionConfig with default settings.

```APIDOC
## pub fn new() -> Self

### Description
Creates a session configuration with sane defaults for Rainy API v3.
```

--------------------------------

### GET /api/v1/search/extract

Source: https://docs.rs/rainy-sdk/latest/rainy_sdk/search/index.html?search=

Extracts content from search results via the Rainy API v3.

```APIDOC
## GET /api/v1/search/extract

### Description
Retrieves extracted content from a search operation.

### Method
GET

### Endpoint
/api/v1/search/extract

### Response
#### Success Response (200)
- **SearchExtractResponse** (object) - The native response payload containing extracted data.
```

--------------------------------

### Authenticate with API Key

Source: https://docs.rs/rainy-sdk/latest/rainy_sdk/index.html?search=

Shows the simplest method for initializing a RainyClient instance using an API key.

```rust
// Simplest way to create a client
let client = RainyClient::with_api_key("your-api-key")?;
```

--------------------------------

### GET /api/v1/search

Source: https://docs.rs/rainy-sdk/latest/rainy_sdk/search/index.html?search=

Performs a web search operation using the Rainy API v3.

```APIDOC
## GET /api/v1/search

### Description
Executes a web search request and returns a structured response containing search results.

### Method
GET

### Endpoint
/api/v1/search

### Response
#### Success Response (200)
- **SearchResponse** (object) - The native response payload containing search results.
```

--------------------------------

### AuthConfig SDK Methods

Source: https://docs.rs/rainy-sdk/latest/rainy_sdk/auth/struct.AuthConfig.html?search=std%3A%3Avec

Methods available for initializing and configuring the AuthConfig struct.

```APIDOC
## AuthConfig::new(api_key: impl Into<String>) -> Self

### Description
Creates a new configuration instance with the Rainy service as the default backend.

## AuthConfig::with_base_url(self, base_url: impl Into<String>) -> Self

### Description
Sets the root base URL for the client.

## AuthConfig::with_api_base_url(self, api_base_url: impl Into<String>) -> Self

### Description
Sets the exact base URL for versioned protocol routes.

## AuthConfig::with_timeout(self, seconds: u64) -> Self

### Description
Sets the request timeout in seconds.

## AuthConfig::with_max_retries(self, retries: u32) -> Self

### Description
Sets the maximum retry count for safe operations.

## AuthConfig::with_retry(self, enable: bool) -> Self

### Description
Enables or disables retries for safe operations.

## AuthConfig::with_user_agent(self, user_agent: impl Into<String>) -> Self

### Description
Sets the User-Agent header for requests.

## AuthConfig::validate(&self) -> Result<()>

### Description
Validates credentials, URLs, and header-safe configuration.

## AuthConfig::build_headers(&self) -> Result<HeaderMap>

### Description
Builds Bearer headers for OpenAI-compatible requests.

## AuthConfig::build_anthropic_headers(&self, version: &str) -> Result<HeaderMap>

### Description
Builds native Anthropic headers for Messages requests.
```

--------------------------------

### FunctionDefinition Builder Methods

Source: https://docs.rs/rainy-sdk/latest/rainy_sdk/models/tools/struct.FunctionDefinition.html?search=

Methods for initializing and configuring a FunctionDefinition instance.

```rust
pub fn new(name: impl Into<String>) -> Self
```

```rust
pub fn with_description(self, description: impl Into<String>) -> Self
```

```rust
pub fn with_parameters(self, parameters: Value) -> Self
```

--------------------------------

### AnthropicImageSource Constructor Methods

Source: https://docs.rs/rainy-sdk/latest/rainy_sdk/models/messages/struct.AnthropicImageSource.html?search=std%3A%3Avec

Factory methods for creating instances of AnthropicImageSource for either base64 encoded images or remote URLs.

```rust
pub fn base64(media_type: impl Into<String>, data: impl Into<String>) -> Self
```

```rust
pub fn url(url: impl Into<String>) -> Self
```

--------------------------------

### From and Into Conversions

Source: https://docs.rs/rainy-sdk/latest/rainy_sdk/models/catalog/struct.ModelPricing.html?search=std%3A%3Avec

Standard library conversions between types.

```rust
impl<T> From<T> for T
```

```rust
fn from(t: T) -> T
```

```rust
impl<T, U> Into<U> for T
where U: From<T>,
```

```rust
fn into(self) -> U
```

--------------------------------

### POST /api/v1/keys

Source: https://docs.rs/rainy-sdk/latest/rainy_sdk/session/index.html?search=std%3A%3Avec

Creates a new API key.

```APIDOC
## POST /api/v1/keys

### Description
Generates a new API key for the authenticated user.

### Method
POST

### Endpoint
/api/v1/keys
```

--------------------------------

### POST /api/v1/keys

Source: https://docs.rs/rainy-sdk/latest/rainy_sdk/session/index.html?search=Option%3CT%3E%2C+%28T+-%3E+U%29+-%3E+Option%3CU%3E

Creates a new API key.

```APIDOC
## POST /api/v1/keys

### Description
Creates a new API key for the authenticated user.

### Method
POST

### Endpoint
/api/v1/keys
```

--------------------------------

### CloneToUninit Experimental API

Source: https://docs.rs/rainy-sdk/latest/rainy_sdk/error/enum.RainyError.html?search=u32+-%3E+bool

Performs copy-assignment from self to a destination pointer. This is a nightly-only experimental API.

```rust
unsafe fn clone_to_uninit(&self, dest: *mut u8)
```

--------------------------------

### into_ok

Source: https://docs.rs/rainy-sdk/latest/rainy_sdk/error/type.Result.html?search=u32+-%3E+bool

Returns the contained Ok value without panicking.

```APIDOC
## pub const fn into_ok(self) -> T

### Description
Returns the contained `Ok` value, but never panics. This is a maintainability safeguard that will fail to compile if the error type of the `Result` is later changed to an error that can actually occur.
```

--------------------------------

### Into Ok

Source: https://docs.rs/rainy-sdk/latest/rainy_sdk/error/type.Result.html?search=Option%3CT%3E%2C+%28T+-%3E+U%29+-%3E+Option%3CU%3E

Returns the Ok value without panicking, intended for infallible results.

```rust
fn only_good_news() -> Result<String, !> {
    Ok("this is fine".into())
}

let s: String = only_good_news().into_ok();
println!("{s}");
```

--------------------------------

### Create an API key with RainyClient

Source: https://docs.rs/rainy-sdk/latest/rainy_sdk/client/struct.RainyClient.html?search=u32+-%3E+bool

Demonstrates creating a new API key using a master API key for authentication. Note that this method is deprecated in favor of JWT/session-based authentication.

```rust
let client = RainyClient::with_api_key("master-api-key")?;

let api_key = client.create_api_key(
    "Production API key",
    Some(365)
).await?;

println!("Created API key: {}", api_key.key);
```

--------------------------------

### Implement ReasoningBudget Methods

Source: https://docs.rs/rainy-sdk/latest/rainy_sdk/models/reasoning/enum.ReasoningBudget.html

Methods for creating and retrieving concrete token counts from the ReasoningBudget enum.

```rust
pub const fn tokens(value: u32) -> Self

pub const fn as_tokens(self) -> Option<u32>
```

--------------------------------

### create_openai_chat_completion

Source: https://docs.rs/rainy-sdk/latest/rainy_sdk/client/struct.RainyClient.html?search=u32+-%3E+bool

Creates a Chat completion using full OpenAI-compatible messages.

```APIDOC
## create_openai_chat_completion

### Description
Creates a Chat completion using full OpenAI-compatible messages.

### Signature
`pub async fn create_openai_chat_completion(&self, request: OpenAIChatCompletionRequest) -> Result<OpenAIChatCompletionResponse>`
```

--------------------------------

### create_openai_chat_completion

Source: https://docs.rs/rainy-sdk/latest/rainy_sdk/client/struct.RainyClient.html?search=std%3A%3Avec

Creates a Chat completion using full OpenAI-compatible messages.

```APIDOC
## create_openai_chat_completion(request: OpenAIChatCompletionRequest)

### Description
Creates a Chat completion using full OpenAI-compatible messages.

### Parameters
- **request** (OpenAIChatCompletionRequest) - Required - The request object containing chat messages and configuration.
```

--------------------------------

### POST /api/v1/auth/register

Source: https://docs.rs/rainy-sdk/latest/rainy_sdk/session/index.html?search=std%3A%3Avec

Registers a new user account.

```APIDOC
## POST /api/v1/auth/register

### Description
Registers a new user account in the system.

### Method
POST

### Endpoint
/api/v1/auth/register

### Request Body
- **RegisterRequest** (object) - Required - Contains registration details.
```

--------------------------------

### POST /api/v1/auth/register

Source: https://docs.rs/rainy-sdk/latest/rainy_sdk/session/index.html?search=Option%3CT%3E%2C+%28T+-%3E+U%29+-%3E+Option%3CU%3E

Registers a new user account.

```APIDOC
## POST /api/v1/auth/register

### Description
Registers a new user account with the provided details.

### Method
POST

### Endpoint
/api/v1/auth/register
```

--------------------------------

### RateLimiter::new

Source: https://docs.rs/rainy-sdk/latest/rainy_sdk/auth/struct.RateLimiter.html?search=Option%3CT%3E%2C+%28T+-%3E+U%29+-%3E+Option%3CU%3E

Creates a new instance of RateLimiter with a specified request limit per minute.

```APIDOC
### pub fn new(requests_per_minute: u32) -> Self

Creates a new RateLimiter instance.

#### Parameters
- **requests_per_minute** (u32) - The number of requests allowed per minute.
```

--------------------------------

### Accessing the VERSION constant

Source: https://docs.rs/rainy-sdk/latest/rainy_sdk/constant.VERSION.html?search=Option%3CT%3E%2C+%28T+-%3E+U%29+-%3E+Option%3CU%3E

Retrieves the current SDK version string defined at compile time.

```rust
pub const VERSION: &str = "0.6.50";
```

--------------------------------

### SessionConfig::new

Source: https://docs.rs/rainy-sdk/latest/rainy_sdk/session/struct.SessionConfig.html

Creates a new instance of SessionConfig with default settings for the Rainy API v3.

```APIDOC
## pub fn new() -> Self

### Description
Creates a session configuration with sane defaults for Rainy API v3.

### Returns
- **Self** - A new SessionConfig instance.
```

--------------------------------

### AnthropicTool Implementation Methods

Source: https://docs.rs/rainy-sdk/latest/rainy_sdk/models/messages/struct.AnthropicTool.html?search=

Methods for creating and configuring an AnthropicTool instance.

```rust
pub fn new(name: impl Into<String>, input_schema: Value) -> Self
```

```rust
pub fn with_description(self, description: impl Into<String>) -> Self
```

--------------------------------

### create_openai_chat_completion_stream

Source: https://docs.rs/rainy-sdk/latest/rainy_sdk/client/struct.RainyClient.html?search=u32+-%3E+bool

Creates a full-message streaming Chat completion and returns chunks.

```APIDOC
## create_openai_chat_completion_stream

### Description
Creates a full-message streaming Chat completion and returns chunks.

### Signature
`pub async fn create_openai_chat_completion_stream(&self, request: OpenAIChatCompletionRequest) -> Result<Pin<Box<dyn Stream<Item = Result<ChatCompletionStreamResponse>> + Send>>>`
```

--------------------------------

### AnthropicMessage Creation Methods

Source: https://docs.rs/rainy-sdk/latest/rainy_sdk/models/messages/struct.AnthropicMessage.html?search=

Helper methods to instantiate user or assistant messages.

```rust
pub fn user(content: impl Into<AnthropicContent>) -> Self
```

```rust
pub fn assistant(content: impl Into<AnthropicContent>) -> Self
```

--------------------------------

### Define ReasoningConfig struct

Source: https://docs.rs/rainy-sdk/latest/rainy_sdk/models/reasoning/struct.ReasoningConfig.html

The structure definition for reasoning configuration parameters.

```rust
pub struct ReasoningConfig {
    pub enabled: Option<bool>,
    pub effort: Option<ReasoningEffort>,
    pub max_tokens: Option<u32>,
    pub exclude: Option<bool>,
    pub extra: BTreeMap<String, Value>,
}
```

--------------------------------

### create_openai_chat_completion_stream_events

Source: https://docs.rs/rainy-sdk/latest/rainy_sdk/client/struct.RainyClient.html?search=u32+-%3E+bool

Creates a full-message streaming Chat completion with typed events.

```APIDOC
## create_openai_chat_completion_stream_events

### Description
Creates a full-message streaming Chat completion with typed events.

### Signature
`pub async fn create_openai_chat_completion_stream_events(&self, request: OpenAIChatCompletionRequest) -> Result<Pin<Box<dyn Stream<Item = Result<ChatStreamEvent>> + Send>>>`
```

--------------------------------

### build_reasoning_config

Source: https://docs.rs/rainy-sdk/latest/rainy_sdk/models/catalog/fn.build_reasoning_config.html?search=std%3A%3Avec

Builds a literal reasoning object from declared public parameter names. An effort preference becomes { "effort": "..." } only when the catalog declares reasoning_effort or reasoning.effort. A budget preference is emitted as { "max_tokens": N } only when the catalog declares a numeric reasoning control.

```APIDOC
## fn build_reasoning_config

### Signature
`pub fn build_reasoning_config(model: &ModelCatalogItem, preference: &ReasoningPreference) -> Option<Value>`

### Description
Builds a literal reasoning object from declared public parameter names. An effort preference becomes { "effort": "..." } only when the catalog declares `reasoning_effort` or `reasoning.effort`. A budget preference is emitted as { "max_tokens": N } only when the catalog declares a numeric reasoning control. No effort-to-budget conversion is performed.
```

--------------------------------

### Tool Struct Definition

Source: https://docs.rs/rainy-sdk/latest/rainy_sdk/models/tools/struct.Tool.html

The primary structure for defining an OpenAI-compatible tool.

```rust
pub struct Tool {
    pub type: ToolType,
    pub function: FunctionDefinition,
}
```

--------------------------------

### AnthropicContentBlock Implementation Methods

Source: https://docs.rs/rainy-sdk/latest/rainy_sdk/models/messages/enum.AnthropicContentBlock.html?search=Option%3CT%3E%2C+%28T+-%3E+U%29+-%3E+Option%3CU%3E

Constructor methods for creating instances of AnthropicContentBlock variants.

```rust
pub fn text(text: impl Into<String>) -> Self
```

```rust
pub fn image(source: AnthropicImageSource) -> Self
```

```rust
pub fn tool_use( id: impl Into<String>, name: impl Into<String>, input: Value, ) -> Self
```

```rust
pub fn tool_result( tool_use_id: impl Into<String>, content: Value, is_error: Option<bool>, ) -> Self
```

--------------------------------

### OpenAIMessageContent::text

Source: https://docs.rs/rainy-sdk/latest/rainy_sdk/models/chat/enum.OpenAIMessageContent.html?search=Option%3CT%3E%2C+%28T+-%3E+U%29+-%3E+Option%3CU%3E

Creates a new OpenAIMessageContent instance containing plain text.

```APIDOC
## pub fn text(content: impl Into<String>) -> Self

### Description
Creates a new OpenAIMessageContent instance initialized with plain text content.

### Parameters
- **content** (impl Into<String>) - Required - The text content to be stored in the message.
```

--------------------------------

### Calculate Product of Result Iterator

Source: https://docs.rs/rainy-sdk/latest/rainy_sdk/error/type.Result.html

Demonstrates using the product method on an iterator of Results, which short-circuits on the first Err encountered.

```rust
let nums = vec!["5", "10", "1", "2"];
let total: Result<usize, _> = nums.iter().map(|w| w.parse::<usize>()).product();
assert_eq!(total, Ok(100));
let nums = vec!["5", "10", "one", "2"];
let total: Result<usize, _> = nums.iter().map(|w| w.parse::<usize>()).product();
assert!(total.is_err());
```

--------------------------------

### ChatMessage::system

Source: https://docs.rs/rainy-sdk/latest/rainy_sdk/models/chat/struct.ChatMessage.html?search=std%3A%3Avec

Creates a new system message.

```APIDOC
## fn system(content: impl Into<String>) -> Self

### Description
Creates a new system message with the provided content.

### Parameters
- **content** (impl Into<String>) - Required - The text content of the system message.
```

--------------------------------

### OpenAIMessageContent::parts

Source: https://docs.rs/rainy-sdk/latest/rainy_sdk/models/chat/enum.OpenAIMessageContent.html?search=Option%3CT%3E%2C+%28T+-%3E+U%29+-%3E+Option%3CU%3E

Creates a new OpenAIMessageContent instance containing multimodal content parts.

```APIDOC
## pub fn parts(parts: Vec<OpenAIContentPart>) -> Self

### Description
Creates a new OpenAIMessageContent instance initialized with a collection of multimodal content parts.

### Parameters
- **parts** (Vec<OpenAIContentPart>) - Required - A vector of OpenAIContentPart objects representing the multimodal content.
```

--------------------------------

### Borrow and BorrowMut Implementations

Source: https://docs.rs/rainy-sdk/latest/rainy_sdk/models/catalog/struct.ModelPricing.html?search=std%3A%3Avec

Standard library blanket implementations for immutable and mutable borrowing.

```rust
impl<T> Borrow<T> for T
where T: ?Sized,
```

```rust
fn borrow(&self) -> &T
```

```rust
impl<T> BorrowMut<T> for T
where T: ?Sized,
```

```rust
fn borrow_mut(&mut self) -> &mut T
```

--------------------------------

### POST /api/v1/auth/login

Source: https://docs.rs/rainy-sdk/latest/rainy_sdk/session/index.html?search=std%3A%3Avec

Authenticates a user and returns session tokens.

```APIDOC
## POST /api/v1/auth/login

### Description
Authenticates a user with provided credentials and returns session tokens.

### Method
POST

### Endpoint
/api/v1/auth/login

### Request Body
- **LoginRequest** (object) - Required - Contains user credentials for login.
```

--------------------------------

### POST /api/v1/auth/login

Source: https://docs.rs/rainy-sdk/latest/rainy_sdk/session/index.html?search=Option%3CT%3E%2C+%28T+-%3E+U%29+-%3E+Option%3CU%3E

Authenticates a user and returns session tokens.

```APIDOC
## POST /api/v1/auth/login

### Description
Authenticates a user using credentials provided in the request body.

### Method
POST

### Endpoint
/api/v1/auth/login
```

--------------------------------

### ResponsesEvent Implementation Methods

Source: https://docs.rs/rainy-sdk/latest/rainy_sdk/models/responses/struct.ResponsesEvent.html

Methods for creating a new event instance and extracting text deltas from the payload.

```rust
pub fn new(event: Option<String>, data: Value) -> Self
```

```rust
pub fn text_delta(&self) -> Option<&str>
```

--------------------------------

### expect

Source: https://docs.rs/rainy-sdk/latest/rainy_sdk/error/type.Result.html?search=std%3A%3Avec

Returns the contained Ok value, or panics if the value is an Err.

```APIDOC
## pub fn expect(self, msg: &str) -> T

### Description
Returns the contained `Ok` value, consuming the `self` value. Panics if the value is an `Err`, with a panic message including the passed message, and the content of the `Err`.
```

--------------------------------

### Perform deep web research with RainyClient

Source: https://docs.rs/rainy-sdk/latest/rainy_sdk/client/struct.RainyClient.html?search=u32+-%3E+bool

Demonstrates basic and advanced research queries using the research method with optional configuration.

```rust
let client = RainyClient::with_api_key("your-api-key")?;

// Basic research
let response = client.research("Latest Rust features", None).await?;
if let Some(content) = response.result {
    println!("Report: {}", content);
}

// Advanced deep research with a selected search provider
let config = ResearchConfig::new()
    .with_provider(ResearchProvider::Exa)
    .with_depth(ResearchDepth::Advanced);

let response = client.research("Quantum Computing advances", Some(config)).await?;
```

--------------------------------

### Attach a subscriber to a type

Source: https://docs.rs/rainy-sdk/latest/rainy_sdk/models/chat/enum.StopSequences.html?search=std%3A%3Avec

Attaches a specific subscriber to the type, returning a WithDispatch wrapper.

```rust
fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,
```

--------------------------------

### Define ProviderOptions struct

Source: https://docs.rs/rainy-sdk/latest/rainy_sdk/models/chat/struct.ProviderOptions.html

The structure definition for provider-routing options used as a Chat extension.

```rust
pub struct ProviderOptions {
    pub order: Option<Vec<String>>,
    pub allow_fallbacks: Option<bool>,
    pub require_parameters: Option<bool>,
    pub sort: Option<String>,
    pub extra: BTreeMap<String, Value>,
}
```

--------------------------------

### SessionConfig::with_base_url

Source: https://docs.rs/rainy-sdk/latest/rainy_sdk/session/struct.SessionConfig.html?search=u32+-%3E+bool

Sets the base URL for the API service.

```APIDOC
## pub fn with_base_url(self, base_url: impl Into<String>) -> Self

### Description
Sets a custom base URL for the Rainy API service.
```

--------------------------------

### Function Signature for build_reasoning_config

Source: https://docs.rs/rainy-sdk/latest/rainy_sdk/models/catalog/fn.build_reasoning_config.html

The function signature for building a reasoning configuration from a model catalog item and reasoning preference.

```rust
pub fn build_reasoning_config(
    model: &ModelCatalogItem,
    preference: &ReasoningPreference,
) -> Option<Value>
```

--------------------------------

### Define ReasoningPreference struct

Source: https://docs.rs/rainy-sdk/latest/rainy_sdk/models/catalog/struct.ReasoningPreference.html

The core structure definition for ReasoningPreference, containing the mode, effort, and budget fields.

```rust
pub struct ReasoningPreference {
    pub mode: ReasoningMode,
    pub effort: Option<ReasoningEffort>,
    pub budget: Option<u32>,
}
```

--------------------------------

### CloneToUninit Trait Implementation

Source: https://docs.rs/rainy-sdk/latest/rainy_sdk/auth/struct.AuthConfig.html?search=std%3A%3Avec

Experimental nightly-only API for performing copy-assignment to uninitialized memory.

```rust
impl<T> CloneToUninit for T
where T: Clone,
```

```rust
unsafe fn clone_to_uninit(&self, dest: *mut u8)
```

--------------------------------

### Fallback to alternative Result with or

Source: https://docs.rs/rainy-sdk/latest/rainy_sdk/error/type.Result.html

Returns the current Result if it is Ok, otherwise returns the provided alternative Result.

```rust
let x: Result<u32, &str> = Ok(2);
let y: Result<u32, &str> = Err("late error");
assert_eq!(x.or(y), Ok(2));

let x: Result<u32, &str> = Err("early error");
let y: Result<u32, &str> = Ok(2);
assert_eq!(x.or(y), Ok(2));

let x: Result<u32, &str> = Err("not a 2");
let y: Result<u32, &str> = Err("late error");
assert_eq!(x.or(y), Err("late error"));

let x: Result<u32, &str> = Ok(2);
let y: Result<u32, &str> = Ok(100);
assert_eq!(x.or(y), Ok(2));
```

--------------------------------

### RetryConfig::new

Source: https://docs.rs/rainy-sdk/latest/rainy_sdk/retry/struct.RetryConfig.html?search=Option%3CT%3E%2C+%28T+-%3E+U%29+-%3E+Option%3CU%3E

Creates a new RetryConfig instance with a specified maximum number of retries and default values for other settings.

```APIDOC
## pub fn new(max_retries: u32) -> Self

### Description
Creates a new `RetryConfig` with a specified maximum number of retries and default values for other settings.

### Arguments
- **max_retries** (u32) - The maximum number of times to retry an operation.
```

--------------------------------

### RetryConfig Constructor

Source: https://docs.rs/rainy-sdk/latest/rainy_sdk/retry/struct.RetryConfig.html?search=

Creates a new instance with a specified maximum retry count and default settings.

```rust
pub fn new(max_retries: u32) -> Self
```

--------------------------------

### SessionConfig::with_base_url

Source: https://docs.rs/rainy-sdk/latest/rainy_sdk/session/struct.SessionConfig.html

Sets a custom base URL for the Rainy API service.

```APIDOC
## pub fn with_base_url(self, base_url: impl Into<String>) -> Self

### Description
Sets a custom base URL for the Rainy API service.

### Parameters
- **base_url** (impl Into<String>) - The base URL of the Rainy API v3 service (host only).
```

--------------------------------

### Default RetryConfig

Source: https://docs.rs/rainy-sdk/latest/rainy_sdk/retry/struct.RetryConfig.html?search=

Creates a new RetryConfig instance with default settings.

```APIDOC
## fn default() -> Self

### Description
Creates a default `RetryConfig` instance with the following predefined settings:
- `max_retries`: 3
- `base_delay_ms`: 1000 (1 second)
- `max_delay_ms`: 30000 (30 seconds)
- `backoff_multiplier`: 2.0
- `jitter`: true
```

--------------------------------

### create_api_key

Source: https://docs.rs/rainy-sdk/latest/rainy_sdk/client/struct.RainyClient.html?search=u32+-%3E+bool

Create a new API key. Note: This method is deprecated.

```APIDOC
## create_api_key

### Description
Create a new API key. This endpoint requires user authentication with a master API key.

### Arguments
- **description** (&str) - Description of what this API key will be used for
- **expires_in_days** (Option<u32>) - Optional expiration time in days

### Signature
`pub async fn create_api_key(&self, description: &str, expires_in_days: Option<u32>) -> Result<ApiKey>`
```

--------------------------------

### ChatMessage::assistant

Source: https://docs.rs/rainy-sdk/latest/rainy_sdk/models/chat/struct.ChatMessage.html?search=std%3A%3Avec

Creates a new assistant message.

```APIDOC
## fn assistant(content: impl Into<String>) -> Self

### Description
Creates a new assistant message with the provided content.

### Parameters
- **content** (impl Into<String>) - Required - The text content of the assistant message.
```

--------------------------------

### Unwrap Result or Default

Source: https://docs.rs/rainy-sdk/latest/rainy_sdk/error/type.Result.html

Returns the Ok value or the default value for the type if the result is an Err.

```rust
let good_year_from_input = "1909";
let bad_year_from_input = "190blarg";
let good_year = good_year_from_input.parse().unwrap_or_default();
let bad_year = bad_year_from_input.parse().unwrap_or_default();

assert_eq!(1909, good_year);
assert_eq!(0, bad_year);
```

--------------------------------

### SessionConfig API

Source: https://docs.rs/rainy-sdk/latest/rainy_sdk/session/struct.SessionConfig.html?search=

Methods for initializing and configuring the SessionConfig object.

```APIDOC
## SessionConfig

### Description
Configuration structure for `RainySessionClient` to manage API connection settings.

### Methods

#### new()
Creates a new `SessionConfig` instance with default values for the Rainy API v3.

#### with_base_url(base_url: impl Into<String>) -> Self
Sets a custom base URL for the Rainy API service.

#### with_timeout(timeout_seconds: u64) -> Self
Sets a custom HTTP request timeout in seconds.

#### with_user_agent(user_agent: impl Into<String>) -> Self
Sets a custom User-Agent header value for session requests.
```

--------------------------------

### Chain Result with And

Source: https://docs.rs/rainy-sdk/latest/rainy_sdk/error/type.Result.html

Returns the provided result if the current result is Ok, otherwise returns the Err.

```rust
let x: Result<u32, &str> = Ok(2);
let y: Result<&str, &str> = Err("late error");
assert_eq!(x.and(y), Err("late error"));

let x: Result<u32, &str> = Err("early error");
let y: Result<&str, &str> = Ok("foo");
assert_eq!(x.and(y), Err("early error"));

let x: Result<u32, &str> = Err("not a 2");
let y: Result<&str, &str> = Err("late error");
assert_eq!(x.and(y), Err("not a 2"));

let x: Result<u32, &str> = Ok(2);
let y: Result<&str, &str> = Ok("different result type");
assert_eq!(x.and(y), Ok("different result type"));
```

--------------------------------

### DailyUsage Struct Definition

Source: https://docs.rs/rainy-sdk/latest/rainy_sdk/models/struct.DailyUsage.html?search=

Defines the data structure for legacy daily usage tracking.

```rust
pub struct DailyUsage {
    pub date: String,
    pub credits_used: f64,
    pub requests: u64,
    pub tokens: u64,
}
```

--------------------------------

### unwrap

Source: https://docs.rs/rainy-sdk/latest/rainy_sdk/error/type.Result.html?search=u32+-%3E+bool

Returns the contained Ok value, consuming the self value. Panics if the value is an Err.

```APIDOC
## pub fn unwrap(self) -> T

### Description
Returns the contained `Ok` value, consuming the `self` value. Because this function may panic, its use is generally discouraged.

### Panics
Panics if the value is an `Err`, with a panic message provided by the `Err`’s value.
```

--------------------------------

### ResearchConfig Methods

Source: https://docs.rs/rainy-sdk/latest/rainy_sdk/search/struct.ResearchConfig.html?search=Option%3CT%3E%2C+%28T+-%3E+U%29+-%3E+Option%3CU%3E

Methods available for initializing and configuring a ResearchConfig instance.

```APIDOC
## ResearchConfig

### Description
Configuration object for web research requests. Provides methods to set search provider, depth, source limits, and model preferences.

### Methods
- **new() -> Self**: Create a new configuration with default settings.
- **with_provider(provider: ResearchProvider) -> Self**: Set the search provider.
- **with_depth(depth: ResearchDepth) -> Self**: Set the search depth.
- **with_max_sources(max: u32) -> Self**: Set maximum sources.
- **with_async(async_mode: bool) -> Self**: Set the request to be processed asynchronously.
- **with_model(model: impl Into<String>) -> Self**: Set the specific AI model.
```

--------------------------------

### ChatMessage::user

Source: https://docs.rs/rainy-sdk/latest/rainy_sdk/models/chat/struct.ChatMessage.html?search=std%3A%3Avec

Creates a new user message.

```APIDOC
## fn user(content: impl Into<String>) -> Self

### Description
Creates a new user message with the provided content.

### Parameters
- **content** (impl Into<String>) - Required - The text content of the user message.
```

--------------------------------

### Result FromIterator Implementation

Source: https://docs.rs/rainy-sdk/latest/rainy_sdk/error/type.Result.html

Demonstrates collecting an iterator of Results into a single Result, which short-circuits on the first Err encountered.

```rust
let v = vec![1, 2];
let res: Result<Vec<u32>, &'static str> = v.iter().map(|x: &u32|
    x.checked_add(1).ok_or("Overflow!")
).collect();
assert_eq!(res, Ok(vec![2, 3]));
```

```rust
let v = vec![1, 2, 0];
let res: Result<Vec<u32>, &'static str> = v.iter().map(|x: &u32|
    x.checked_sub(1).ok_or("Underflow!")
).collect();
assert_eq!(res, Err("Underflow!"));
```

```rust
let v = vec![3, 2, 1, 10];
let mut shared = 0;
let res: Result<Vec<u32>, &'static str> = v.iter().map(|x: &u32| {
    shared += x;
    x.checked_sub(2).ok_or("Underflow!")
}).collect();
assert_eq!(res, Err("Underflow!"));
assert_eq!(shared, 6);
```

--------------------------------

### list_api_keys

Source: https://docs.rs/rainy-sdk/latest/rainy_sdk/client/struct.RainyClient.html?search=u32+-%3E+bool

List all API keys for the current user. Note: This method is deprecated.

```APIDOC
## list_api_keys

### Description
List all API keys for the current user. This endpoint requires user authentication.

### Signature
`pub async fn list_api_keys(&self) -> Result<Vec<ApiKey>>`
```

--------------------------------

### Provide default value with unwrap_or

Source: https://docs.rs/rainy-sdk/latest/rainy_sdk/error/type.Result.html

Returns the contained Ok value or a provided default value if the Result is Err.

```rust
let default = 2;
let x: Result<u32, &str> = Ok(9);
assert_eq!(x.unwrap_or(default), 9);

let x: Result<u32, &str> = Err("error");
assert_eq!(x.unwrap_or(default), default);
```

--------------------------------

### AnthropicThinking::enabled

Source: https://docs.rs/rainy-sdk/latest/rainy_sdk/models/messages/struct.AnthropicThinking.html?search=u32+-%3E+bool

Creates an enabled thinking configuration with an explicit budget.

```APIDOC
## pub fn enabled(budget_tokens: u32) -> Self

### Description
Creates an enabled thinking configuration with an explicit budget for the native Anthropic extended-thinking protocol.

### Parameters
- **budget_tokens** (u32) - Required - The explicit token budget required by the native protocol.

### Returns
- **Self** - An instance of AnthropicThinking with the thinking mode enabled.
```

--------------------------------

### From Trait Implementation

Source: https://docs.rs/rainy-sdk/latest/rainy_sdk/auth/struct.AuthConfig.html?search=std%3A%3Avec

Returns the argument unchanged.

```rust
impl<T> From<T> for T
```

```rust
fn from(t: T) -> T
```

--------------------------------

### Usage Struct Definition

Source: https://docs.rs/rainy-sdk/latest/rainy_sdk/models/common/struct.Usage.html?search=Option%3CT%3E%2C+%28T+-%3E+U%29+-%3E+Option%3CU%3E

The core data structure for tracking token usage in chat completions.

```rust
pub struct Usage {
    pub prompt_tokens: u32,
    pub completion_tokens: u32,
    pub total_tokens: u32,
}
```

--------------------------------

### unwrap_or_default

Source: https://docs.rs/rainy-sdk/latest/rainy_sdk/error/type.Result.html?search=u32+-%3E+bool

Returns the contained Ok value or a default value if the result is Err.

```APIDOC
## pub fn unwrap_or_default(self) -> T

### Description
Consumes the `self` argument then, if `Ok`, returns the contained value, otherwise if `Err`, returns the default value for that type.
```

--------------------------------

### with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>

Source: https://docs.rs/rainy-sdk/latest/rainy_sdk/models/chat/enum.StopSequences.html?search=std%3A%3Avec

Attaches the provided Subscriber to the current type.

```APIDOC
## fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>

### Description
Attaches the provided `Subscriber` to this type, returning a `WithDispatch` wrapper.

### Parameters
- **subscriber** (S) - Required - The subscriber to attach, which must implement `Into<Dispatch>`.
```

--------------------------------

### Default RetryConfig

Source: https://docs.rs/rainy-sdk/latest/rainy_sdk/retry/struct.RetryConfig.html?search=Option%3CT%3E%2C+%28T+-%3E+U%29+-%3E+Option%3CU%3E

Creates a default instance of RetryConfig with predefined settings for retries and delays.

```APIDOC
## fn default() -> Self

### Description
Creates a default `RetryConfig` instance with the following settings:
- `max_retries`: 3
- `base_delay_ms`: 1000 (1 second)
- `max_delay_ms`: 30000 (30 seconds)
- `backoff_multiplier`: 2.0
- `jitter`: true
```

--------------------------------

### Define ChatStreamOptions struct

Source: https://docs.rs/rainy-sdk/latest/rainy_sdk/models/chat/struct.ChatStreamOptions.html

The structure definition for ChatStreamOptions, containing fields for usage reporting and extra metadata.

```rust
pub struct ChatStreamOptions {
    pub include_usage: Option<bool>,
    pub extra: BTreeMap<String, Value>,
}
```

--------------------------------

### RainySessionClient SDK Methods

Source: https://docs.rs/rainy-sdk/latest/rainy_sdk/session/struct.RainySessionClient.html

Methods available on the RainySessionClient for managing sessions and interacting with the Rainy API.

```APIDOC
## RainySessionClient

### Description
Client for Rainy API v3 JWT/session endpoints. Use this client for authentication and account operations.

### Methods
- **new() -> Result<Self>** - Creates a session client using default configuration.
- **with_config(config: SessionConfig) -> Result<Self>** - Creates a session client with custom configuration.
- **with_base_url(base_url: impl Into<String>) -> Result<Self>** - Creates a session client with a custom base URL.
- **set_access_token(access_token: impl Into<String>)** - Sets the in-memory access token.
- **clear_access_token()** - Clears the in-memory access token.
- **access_token() -> Option<&str>** - Returns the current access token.
- **base_url() -> &str** - Returns the configured API base URL.
- **login(email: &str, password: &str) -> Result<LoginResponse>** - Authenticates a user.
- **register(email: &str, password: &str, region: &str) -> Result<LoginResponse>** - Registers a new user.
- **refresh(refresh_token: &str) -> Result<RefreshResponse>** - Refreshes the session token.
- **me() -> Result<SessionUser>** - Returns the current authenticated user profile.
- **org_me() -> Result<OrgProfile>** - Returns the current organization profile.
- **list_api_keys() -> Result<Vec<SessionApiKeyListItem>>** - Lists API keys.
- **create_api_key(name: &str, key_type: Option<&str>) -> Result<CreatedApiKey>** - Creates a new API key.
- **delete_api_key(id: &str) -> Result<Value>** - Deletes an API key by ID.
- **usage_credits() -> Result<UsageCreditsResponse>** - Returns current credit balance.
- **usage_stats(days: Option<u32>) -> Result<UsageStatsResponse>** - Returns usage statistics.
```

--------------------------------

### List API keys with RainyClient

Source: https://docs.rs/rainy-sdk/latest/rainy_sdk/client/struct.RainyClient.html?search=u32+-%3E+bool

Retrieves all API keys associated with the authenticated user. This method is deprecated.

```rust
let client = RainyClient::with_api_key("user-api-key")?;

let keys = client.list_api_keys().await?;
for key in keys {
    println!("Key: {} - Active: {}", key.key, key.is_active);
}
```

--------------------------------

### Define SessionConfig Struct

Source: https://docs.rs/rainy-sdk/latest/rainy_sdk/session/struct.SessionConfig.html?search=

The core structure used to hold configuration settings for session requests.

```rust
pub struct SessionConfig {
    pub base_url: String,
    pub timeout_seconds: u64,
    pub user_agent: String,
}
```

--------------------------------

### ModelPricing Struct Definition

Source: https://docs.rs/rainy-sdk/latest/rainy_sdk/models/catalog/struct.ModelPricing.html?search=

Defines the structure for model pricing metadata containing optional prompt and completion price strings.

```rust
pub struct ModelPricing {
    pub prompt: Option<String>,
    pub completion: Option<String>,
}
```

--------------------------------

### RainySessionClient SDK Methods

Source: https://docs.rs/rainy-sdk/latest/rainy_sdk/session/struct.RainySessionClient.html?search=

Methods available on the RainySessionClient for interacting with authentication, organization, and usage endpoints.

```APIDOC
## RainySessionClient Methods

### Authentication
- **login(email: &str, password: &str) -> Result<LoginResponse>** - Authenticates a user and stores the access token.
- **register(email: &str, password: &str, region: &str) -> Result<LoginResponse>** - Registers a new user and stores the access token.
- **refresh(refresh_token: &str) -> Result<RefreshResponse>** - Refreshes the session token pair.

### User and Organization
- **me() -> Result<SessionUser>** - Retrieves the current user profile (GET /api/v1/auth/me).
- **org_me() -> Result<OrgProfile>** - Retrieves the current organization profile (GET /api/v1/orgs/me).

### API Keys
- **list_api_keys() -> Result<Vec<SessionApiKeyListItem>>** - Lists API keys for the session.
- **create_api_key(name: &str, key_type: Option<&str>) -> Result<CreatedApiKey>** - Creates a new API key.
- **delete_api_key(id: &str) -> Result<Value>** - Deletes an API key by ID.

### Usage
- **usage_credits() -> Result<UsageCreditsResponse>** - Retrieves credit balance (GET /api/v1/usage/credits).
- **usage_stats(days: Option<u32>) -> Result<UsageStatsResponse>** - Retrieves usage statistics (GET /api/v1/usage/stats).
```

--------------------------------

### Retrieve user account information

Source: https://docs.rs/rainy-sdk/latest/rainy_sdk/client/struct.RainyClient.html?search=u32+-%3E+bool

Fetches information for the authenticated user. Note that this method is deprecated.

```rust
let client = RainyClient::with_api_key("user-api-key")?;

let user = client.get_user_account().await?;
println!("Current credits: {}", user.current_credits);
```

--------------------------------

### Copying and Cloning Result Contents

Source: https://docs.rs/rainy-sdk/latest/rainy_sdk/error/type.Result.html

Methods to copy or clone the contents of an Ok variant from a Result containing a reference.

```rust
let val = 12;
let x: Result<&i32, i32> = Ok(&val);
assert_eq!(x, Ok(&12));
let copied = x.copied();
assert_eq!(copied, Ok(12));
```

```rust
let val = 12;
let x: Result<&i32, i32> = Ok(&val);
assert_eq!(x, Ok(&12));
let cloned = x.cloned();
assert_eq!(cloned, Ok(12));
```

```rust
let mut val = 12;
let x: Result<&mut i32, i32> = Ok(&mut val);
assert_eq!(x, Ok(&mut 12));
let copied = x.copied();
assert_eq!(copied, Ok(12));
```

```rust
let mut val = 12;
let x: Result<&mut i32, i32> = Ok(&mut val);
assert_eq!(x, Ok(&mut 12));
let cloned = x.cloned();
assert_eq!(cloned, Ok(12));
```

--------------------------------

### AuthConfig SDK Reference

Source: https://docs.rs/rainy-sdk/latest/rainy_sdk/auth/struct.AuthConfig.html

The AuthConfig struct allows users to initialize and configure authentication settings for the Rainy SDK. It provides methods for setting base URLs, timeouts, and generating protocol-specific headers.

```APIDOC
## AuthConfig

### Description
Configuration for API-key authenticated protocol clients. The API key is held as a `SecretString` and is never included in the configuration’s `Debug` or `Display` output.

### Methods
- **new(api_key: impl Into<String>) -> Self**: Creates a configuration with the Rainy service as the default backend.
- **with_base_url(self, base_url: impl Into<String>) -> Self**: Sets the root base URL.
- **with_api_base_url(self, api_base_url: impl Into<String>) -> Self**: Sets the exact base URL for versioned protocol routes.
- **with_timeout(self, seconds: u64) -> Self**: Sets the request timeout in seconds.
- **with_max_retries(self, retries: u32) -> Self**: Sets the retry count for safe operations.
- **with_retry(self, enable: bool) -> Self**: Enables or disables retries for safe operations.
- **with_user_agent(self, user_agent: impl Into<String>) -> Self**: Sets the User-Agent header.
- **validate(&self) -> Result<()>**: Validates credentials, URLs, and header-safe configuration.
- **build_headers(&self) -> Result<HeaderMap>**: Builds Bearer headers for OpenAI-compatible requests.
- **build_anthropic_headers(&self, version: &str) -> Result<HeaderMap>**: Builds native Anthropic headers for Messages requests.
- **timeout(&self) -> Duration**: Returns the configured timeout.
```

--------------------------------

### create_api_key

Source: https://docs.rs/rainy-sdk/latest/rainy_sdk/client/struct.RainyClient.html?search=std%3A%3Avec

Creates a new API key. Note: This method is deprecated.

```APIDOC
## create_api_key(description: &str, expires_in_days: Option<u32>)

### Description
Create a new API key. This endpoint requires user authentication with a master API key.

### Parameters
- **description** (&str) - Required - Description of what this API key will be used for.
- **expires_in_days** (Option<u32>) - Optional - Optional expiration time in days.
```

--------------------------------

### openai_chat_completion_envelope

Source: https://docs.rs/rainy-sdk/latest/rainy_sdk/client/struct.RainyClient.html?search=u32+-%3E+bool

Creates a full-message Chat completion in Rainy envelope mode.

```APIDOC
## openai_chat_completion_envelope

### Description
Creates a full-message Chat completion in Rainy envelope mode.

### Signature
`pub async fn openai_chat_completion_envelope(&self, request: OpenAIChatCompletionRequest) -> Result<RainyEnvelope<OpenAIChatCompletionResponse>>`
```

--------------------------------

### Define ReasoningMeta struct

Source: https://docs.rs/rainy-sdk/latest/rainy_sdk/models/common/struct.ReasoningMeta.html?search=Option%3CT%3E%2C+%28T+-%3E+U%29+-%3E+Option%3CU%3E

The structure used to represent reasoning summary metadata.

```rust
pub struct ReasoningMeta {
    pub present: bool,
    pub summary_present: bool,
    pub tokens: Option<u32>,
}
```

--------------------------------

### SessionConfig::with_user_agent

Source: https://docs.rs/rainy-sdk/latest/rainy_sdk/session/struct.SessionConfig.html

Sets a custom User-Agent header for session requests.

```APIDOC
## pub fn with_user_agent(self, user_agent: impl Into<String>) -> Self

### Description
Sets a custom User-Agent header value.

### Parameters
- **user_agent** (impl Into<String>) - The User-Agent string to be used for requests.
```

--------------------------------

### OpenAIInputAudio Struct Definition

Source: https://docs.rs/rainy-sdk/latest/rainy_sdk/models/chat/struct.OpenAIInputAudio.html?search=

The primary structure for defining audio input, containing the base64 data string and the format identifier.

```rust
pub struct OpenAIInputAudio {
    pub data: String,
    pub format: String,
}
```

--------------------------------

### POST /api/v1/auth/login

Source: https://docs.rs/rainy-sdk/latest/rainy_sdk/session/struct.LoginRequest.html

This endpoint is used to authenticate a user. It requires an email and password provided in the request body.

```APIDOC
## POST /api/v1/auth/login

### Description
Authenticates a user using their email and password.

### Method
POST

### Endpoint
/api/v1/auth/login

### Request Body
- **email** (string) - Required - User email address.
- **password** (string) - Required - User password.

### Request Example
{
  "email": "user@example.com",
  "password": "securepassword123"
}
```

--------------------------------

### Define ChatImageConfig struct

Source: https://docs.rs/rainy-sdk/latest/rainy_sdk/models/chat/struct.ChatImageConfig.html

The structure definition for ChatImageConfig, containing optional size and quality fields and a BTreeMap for extra data.

```rust
pub struct ChatImageConfig {
    pub size: Option<String>,
    pub quality: Option<String>,
    pub extra: BTreeMap<String, Value>,
}
```

--------------------------------

### Model Management

Source: https://docs.rs/rainy-sdk/latest/rainy_sdk/client/struct.RainyClient.html?search=u32+-%3E+bool

Methods for retrieving and selecting available models from the catalog.

```APIDOC
## Model Management

### list_models() -> Result<ModelList>
Performs a safe explicit model-list request.

### get_available_models() -> Result<AvailableModels>
Returns a compatibility summary of the public model list.

### get_model(model_id: &str) -> Result<ModelListItem>
Retrieves one public model record.

### get_models_catalog() -> Result<Vec<ModelCatalogItem>>
Retrieves the public model catalog extension.

### select_models(criteria: ModelSelectionCriteria) -> Result<Vec<ModelCatalogItem>>
Fetches the public catalog and applies local selection criteria.
```

--------------------------------

### From trait implementation

Source: https://docs.rs/rainy-sdk/latest/rainy_sdk/models/catalog/struct.ModelPricing.html

Standard implementation for identity conversion.

```rust
fn from(t: T) -> T
```

--------------------------------

### Convert Result to References with as_ref

Source: https://docs.rs/rainy-sdk/latest/rainy_sdk/error/type.Result.html?search=u32+-%3E+bool

Converts a Result into a Result containing references to the original values.

```rust
let x: Result<u32, &str> = Ok(2);
assert_eq!(x.as_ref(), Ok(&2));

let x: Result<u32, &str> = Err("Error");
assert_eq!(x.as_ref(), Err(&"Error"));
```
Tokens:
Raw