Skip to main content

OpenAIProvider

Struct OpenAIProvider 

Source
pub struct OpenAIProvider { /* private fields */ }
Expand description

OpenAI GPT API provider.

Supports GPT-4o, GPT-4, GPT-3.5, and other OpenAI models. Also works with Azure OpenAI and compatible APIs.

Implementations§

Source§

impl OpenAIProvider

Source

pub fn instance_of<V: NapiRaw>(env: Env, value: V) -> Result<bool>

Source§

impl OpenAIProvider

Source§

impl OpenAIProvider

Source

pub fn new(api_key: String) -> Self

Create a new OpenAI provider with API key.

§Arguments
  • api_key - Your OpenAI API key (starts with “sk-”)
Source

pub fn with_base_url(api_key: String, base_url: String) -> Self

Create a provider with custom base URL.

Useful for Azure OpenAI, LocalAI, or other compatible APIs.

Source

pub fn with_org(api_key: String, org_id: String) -> Self

Create a provider with organization ID.

Source

pub fn name(&self) -> String

Provider name (“openai”).

Source

pub async fn list_models(&self) -> Result<Vec<String>>

List available models.

Returns an array of model IDs like “gpt-4o”, “gpt-4-turbo”.

Source

pub async fn complete( &self, request: JsCompletionRequest, ) -> Result<JsCompletionResponse>

Create a completion (non-streaming).

§Arguments
  • request - The completion request with model, messages, etc.
§Returns

The completion response with content, tool calls, and usage.

Source

pub fn complete_stream( &self, request: JsCompletionRequest, callback: JsFunction, ) -> Result<()>

Create a streaming completion.

The callback is called for each chunk received. Chunks have:

  • chunk_type: “content_block_delta”, “message_stop”, etc.
  • delta: Text content (for delta chunks)
  • stop_reason: Why generation stopped (for final chunk)
§Arguments
  • request - The completion request
  • callback - Function called with (error, chunk) for each chunk

Trait Implementations§

Source§

impl FromNapiMutRef for OpenAIProvider

Source§

unsafe fn from_napi_mut_ref( env: napi_env, napi_val: napi_value, ) -> Result<&'static mut Self>

Safety Read more
Source§

impl FromNapiRef for OpenAIProvider

Source§

unsafe fn from_napi_ref( env: napi_env, napi_val: napi_value, ) -> Result<&'static Self>

Safety Read more
Source§

impl FromNapiValue for &OpenAIProvider

Source§

unsafe fn from_napi_value(env: napi_env, napi_val: napi_value) -> Result<Self>

Safety Read more
Source§

fn from_unknown(value: JsUnknown) -> Result<Self, Error>

Source§

impl FromNapiValue for &mut OpenAIProvider

Source§

unsafe fn from_napi_value(env: napi_env, napi_val: napi_value) -> Result<Self>

Safety Read more
Source§

fn from_unknown(value: JsUnknown) -> Result<Self, Error>

Source§

impl ObjectFinalize for OpenAIProvider

Source§

fn finalize(self, env: Env) -> Result<(), Error>

Source§

impl ToNapiValue for OpenAIProvider

Source§

impl TypeName for &OpenAIProvider

Source§

impl TypeName for &mut OpenAIProvider

Source§

impl TypeName for OpenAIProvider

Source§

impl ValidateNapiValue for &OpenAIProvider

Source§

unsafe fn validate(env: napi_env, napi_val: napi_value) -> Result<napi_value>

Safety Read more
Source§

impl ValidateNapiValue for &mut OpenAIProvider

Source§

unsafe fn validate(env: napi_env, napi_val: napi_value) -> Result<napi_value>

Safety Read more

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> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
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> JsValuesTupleIntoVec for T
where T: ToNapiValue,

Source§

impl<T> Pointable for T

Source§

const ALIGN: usize

The alignment of pointer.
Source§

type Init = T

The type for initializers.
Source§

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more
Source§

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more
Source§

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more
Source§

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more
Source§

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

Source§

fn and<P, B, E>(self, other: P) -> And<T, P>
where T: Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow only if self and other return Action::Follow. Read more
Source§

fn or<P, B, E>(self, other: P) -> Or<T, P>
where T: Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow if either self or other returns Action::Follow. Read more
Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

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

Source§

type Error = Infallible

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

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

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.
Source§

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

Source§

fn vzip(self) -> V

Source§

impl<T> WithSubscriber for T

Source§

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

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more