Skip to main content

Operation

Enum Operation 

Source
#[non_exhaustive]
pub enum Operation {
Show 37 variants ListModels, GetModel, CountTokens, GenerateContent, StreamGenerateContent, CreateModeration, CreateDecision, CompactContent, SummarizeMemory, CreateConversation, CreateEmbedding, BatchCreateEmbedding, Rerank, WebSearch, CreateImage, EditImage, CreateSpeech, CreateTranscription, CreateTranslation, CreateFile, ListFiles, RetrieveFile, RetrieveFileContent, DeleteFile, CreateVideo, RetrieveVideo, ListVideos, DeleteVideo, DownloadVideoContent, CreateVoice, CreateRealtimeClientSecret, HangupRealtimeCall, CreateLiveSession, HangupLiveSession, ConnectLive, CreateRealtimeCall, ConnectRealtime,
}
Expand description

What the caller wants done.

The operation and Dialect together identify the wire shape.

Variants (Non-exhaustive)§

This enum is marked as 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.
§

ListModels

§

GetModel

§

CountTokens

§

GenerateContent

§

StreamGenerateContent

§

CreateModeration

Standard OpenAI moderation JSON, distinct from Codex Guardian’s SSE.

§

CreateDecision

Typed predicate, choice and score answers from the OpenAI Decisions API.

§

CompactContent

§

SummarizeMemory

§

CreateConversation

§

CreateEmbedding

§

BatchCreateEmbedding

§

Rerank

§

WebSearch

§

CreateImage

§

EditImage

§

CreateSpeech

§

CreateTranscription

§

CreateTranslation

§

CreateFile

§

ListFiles

§

RetrieveFile

§

RetrieveFileContent

§

DeleteFile

§

CreateVideo

§

RetrieveVideo

§

ListVideos

§

DeleteVideo

§

DownloadVideoContent

Download video bytes, e.g. OpenAI’s GET /videos/{video_id}/content. Some vendors instead expose a download URL in a job response; their channel implementation resolves that URL as part of this operation.

§

CreateVoice

Create a custom voice from a description or a consented audio sample.

§

CreateRealtimeClientSecret

Mint an upstream Realtime client credential.

§

HangupRealtimeCall

Explicitly end a bound Realtime call.

§

CreateLiveSession

Create a GPT-Live media session; distinct from legacy /live SDP setup.

§

HangupLiveSession

Explicitly end a bound GPT-Live session.

§

ConnectLive

Native GPT-Live primary or sideband WebSocket.

§

CreateRealtimeCall

SDP handshake creating a WebRTC realtime call.

§

ConnectRealtime

Duplex websocket session. Never transformed — only same-protocol passthrough, because a client that can keep talking mid-response has no equivalent in a half-duplex dialect.

Implementations§

Source§

impl Operation

Source

pub const fn produces_usage(self) -> bool

Whether this operation performs inference or a metered tool action. Catalog, token-counting, resource management and signaling-only calls belong in request logs, not request-level usage statistics.

Source

pub fn usage_operations() -> impl Iterator<Item = Self>

Shared by persistence and historical usage queries.

Source

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

Stable persistence id.

Source

pub fn from_id(value: &str) -> Option<Self>

Trait Implementations§

Source§

impl Clone for Operation

Source§

fn clone(&self) -> Self

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Copy for Operation

Source§

impl Debug for Operation

Source§

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

Formats the value using the given formatter. Read more
Source§

impl<'de> Deserialize<'de> for Operation

Source§

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>
where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer. Read more
Source§

impl Eq for Operation

Source§

impl<'_derivative_strum> From<&'_derivative_strum Operation> for &'static str

Source§

fn from(x: &'_derivative_strum Operation) -> &'static str

Converts to this type from the input type.
Source§

impl From<Operation> for &'static str

Source§

fn from(x: Operation) -> &'static str

Converts to this type from the input type.
Source§

impl FromStr for Operation

Source§

type Err = ParseError

The associated error which can be returned from parsing.
Source§

fn from_str(s: &str) -> Result<Operation, <Self as FromStr>::Err>

Parses a string s to return a value of this type. Read more
Source§

impl Hash for Operation

Source§

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher. Read more
1.3.0 · Source§

fn hash_slice<H>(data: &[Self], state: &mut H)
where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher. Read more
Source§

impl IntoEnumIterator for Operation

Source§

impl Ord for Operation

Source§

fn cmp(&self, other: &Self) -> Ordering

This method returns an Ordering between self and other. Read more
1.21.0 (const: unstable) · Source§

fn max(self, other: Self) -> Self
where Self: Sized,

Compares and returns the maximum of two values. Read more
1.21.0 (const: unstable) · Source§

fn min(self, other: Self) -> Self
where Self: Sized,

Compares and returns the minimum of two values. Read more
1.50.0 (const: unstable) · Source§

fn clamp(self, min: Self, max: Self) -> Self
where Self: Sized,

Restrict a value to a certain interval. Read more
Source§

fn clamp_to<R>(self, range: R) -> Self
where Self: Sized, R: ClampBounds<Self>,

🔬This is a nightly-only experimental API. (clamp_to)
Restrict a value to a certain range. Read more
Source§

impl PartialEq for Operation

Source§

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

Equality operator ==. Read more
1.0.0 (const: unstable) · Source§

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

Inequality operator !=. Read more
Source§

impl PartialOrd for Operation

Source§

fn partial_cmp(&self, other: &Self) -> Option<Ordering>

This method returns an ordering between self and other values if one exists. Read more
1.0.0 (const: unstable) · Source§

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

Tests less than (for self and other) and is used by the < operator. Read more
1.0.0 (const: unstable) · Source§

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

Tests less than or equal to (for self and other) and is used by the <= operator. Read more
1.0.0 (const: unstable) · Source§

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

Tests greater than (for self and other) and is used by the > operator. Read more
1.0.0 (const: unstable) · Source§

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

Tests greater than or equal to (for self and other) and is used by the >= operator. Read more
Source§

impl Serialize for Operation

Source§

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>
where __S: Serializer,

Serialize this value into the given Serde serializer. Read more
Source§

impl StructuralPartialEq for Operation

Source§

impl TryFrom<&str> for Operation

Source§

type Error = ParseError

The type returned in the event of a conversion error.
Source§

fn try_from(s: &str) -> Result<Operation, <Self as TryFrom<&str>>::Error>

Performs the conversion.

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

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

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

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

Source§

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

Mutably borrows from an owned value. Read more
Source§

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

Source§

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

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> DeserializeOwned for T
where T: for<'de> Deserialize<'de>,

Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

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

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> ResourceSend for T
where T: Send + ?Sized,

Source§

impl<T> ResourceSync for T
where T: Sync + ?Sized,

Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = !

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, !>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.