Struct FunctionObjectArgs 

pub struct FunctionObjectArgs { /* private fields */ }

Available on crate feature chat-completion-types only.

Builder for FunctionObject.

Implementations

impl FunctionObjectArgs

pub fn name<VALUE: Into<String>>(&mut self, value: VALUE) -> &mut Self

Available on (crate features response-types or video-types or vectorstore-types or chat-completion-types or assistant-types or batch-types or audio-types or realtime-types or image-types) and (crate features chat-completion-types or assistant-types) only.

The name of the function to be called. Must be a-z, A-Z, 0-9, or contain underscores and dashes, with a maximum length of 64.

pub fn description<VALUE: Into<String>>(&mut self, value: VALUE) -> &mut Self

Available on (crate features response-types or video-types or vectorstore-types or chat-completion-types or assistant-types or batch-types or audio-types or realtime-types or image-types) and (crate features chat-completion-types or assistant-types) only.

A description of what the function does, used by the model to choose when and how to call the function.

pub fn parameters<VALUE: Into<Value>>(&mut self, value: VALUE) -> &mut Self

Available on (crate features response-types or video-types or vectorstore-types or chat-completion-types or assistant-types or batch-types or audio-types or realtime-types or image-types) and (crate features chat-completion-types or assistant-types) only.

The parameters the functions accepts, described as a JSON Schema object. See the guide for examples, and the JSON Schema reference for documentation about the format.

Omitting parameters defines a function with an empty parameter list.

pub fn strict<VALUE: Into<bool>>(&mut self, value: VALUE) -> &mut Self

Available on (crate features response-types or video-types or vectorstore-types or chat-completion-types or assistant-types or batch-types or audio-types or realtime-types or image-types) and (crate features chat-completion-types or assistant-types) only.

Whether to enable strict schema adherence when generating the function call. If set to true, the model will follow the exact schema defined in the parameters field. Only a subset of JSON Schema is supported when strict is true. Learn more about Structured Outputs in the function calling guide.

pub fn build(&self) -> Result<FunctionObject, OpenAIError>

Available on (crate features response-types or video-types or vectorstore-types or chat-completion-types or assistant-types or batch-types or audio-types or realtime-types or image-types) and (crate features chat-completion-types or assistant-types) only.

Builds a new FunctionObject.

Errors

If a required field has not been initialized.

Trait Implementations

impl Clone for FunctionObjectArgs

Available on (crate features chat-completion-types or assistant-types) and (crate features response-types or video-types or vectorstore-types or chat-completion-types or assistant-types or batch-types or audio-types or realtime-types or image-types) only.

fn clone(&self) -> FunctionObjectArgs

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for FunctionObjectArgs

Available on (crate features chat-completion-types or assistant-types) and (crate features response-types or video-types or vectorstore-types or chat-completion-types or assistant-types or batch-types or audio-types or realtime-types or image-types) only.

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

Formats the value using the given formatter.

impl Default for FunctionObjectArgs

Available on (crate features chat-completion-types or assistant-types) and (crate features response-types or video-types or vectorstore-types or chat-completion-types or assistant-types or batch-types or audio-types or realtime-types or image-types) only.

fn default() -> Self

Returns the “default value” for a type.