Enum ApiProtocol 

#[non_exhaustive]
pub enum ApiProtocol {
    OpenAiChat,
    Anthropic,
}

The wire protocol an endpoint exposes.

Selects the request path, the authentication header, the request body shape and the streaming event vocabulary. Defaults to ApiProtocol::OpenAiChat, which is what every endpoint the SDK supported before 0.9.0 speaks.

Examples

use open_agent::ApiProtocol;

assert_eq!(ApiProtocol::default(), ApiProtocol::OpenAiChat);
assert_eq!(ApiProtocol::Anthropic.path(), "/messages");

Variants (Non-exhaustive)

Non-exhaustive enums could have additional variants added in future. Therefore, when matching against variants of non-exhaustive enums, an extra wildcard arm must be added to account for any future variants.

OpenAiChat

OpenAI chat completions: POST {base_url}/chat/completions, bearer auth.

Anthropic

Anthropic messages: POST {base_url}/messages, x-api-key auth.

Implementations

impl ApiProtocol

pub fn path(&self) -> &'static str

The path appended to base_url to reach the completion endpoint.

Includes the leading slash, because base_url is documented as carrying no trailing one.

pub fn as_str(&self) -> &'static str

The lowercase name used in configuration files and diagnostics.

pub fn from_wire(raw: &str) -> Option<Self>

Parses a protocol name, ASCII-case-insensitively.

Returns None for anything unrecognised, so a caller reading a config file can name the offending value in its own error rather than silently falling back to a default the user did not ask for.

openai is accepted alongside openai-chat and openai_chat: configuration files in the wild write it every way, and rejecting the short form would be a trap with no upside.

Examples

use open_agent::ApiProtocol;

assert_eq!(ApiProtocol::from_wire("Anthropic"), Some(ApiProtocol::Anthropic));
assert_eq!(ApiProtocol::from_wire("openai_chat"), Some(ApiProtocol::OpenAiChat));
assert_eq!(ApiProtocol::from_wire("cohere"), None);

Trait Implementations

impl Clone for ApiProtocol

fn clone(&self) -> ApiProtocol

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Copy for ApiProtocol

impl Debug for ApiProtocol

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for ApiProtocol

fn default() -> ApiProtocol

Returns the “default value” for a type.

impl Display for ApiProtocol

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Eq for ApiProtocol

impl PartialEq for ApiProtocol

fn eq(&self, other: &ApiProtocol) -> bool

Equality operator ==.

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=.

impl StructuralPartialEq for ApiProtocol