Struct ModifyAssistantRequestArgs

pub struct ModifyAssistantRequestArgs { /* private fields */ }

Builder for ModifyAssistantRequest.

Implementations

impl ModifyAssistantRequestArgs

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

ID of the model to use. You can use the List models API to see all of your available models, or see our Model overview for descriptions of them.

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

The name of the assistant. The maximum length is 256 characters.

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

The description of the assistant. The maximum length is 512 characters.

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

The system instructions that the assistant uses. The maximum length is 256,000 characters.

pub fn tools<VALUE: Into<Vec<AssistantTools>>>( &mut self, value: VALUE, ) -> &mut Self

A list of tool enabled on the assistant. There can be a maximum of 128 tools per assistant. Tools can be of types code_interpreter, file_search, or function.

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

A set of resources that are used by the assistant’s tools. The resources are specific to the type of tool. For example, the code_interpreter tool requires a list of file IDs, while the file_search tool requires a list of vector store IDs.

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

Set of 16 key-value pairs that can be attached to an object. This can be useful for storing additional information about the object in a structured format. Keys can be a maximum of 64 characters long and values can be a maxium of 512 characters long.

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

What sampling temperature to use, between 0 and 2. Higher values like 0.8 will make the output more random, while lower values like 0.2 will make it more focused and deterministic.

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

An alternative to sampling with temperature, called nucleus sampling, where the model considers the results of the tokens with top_p probability mass. So 0.1 means only the tokens comprising the top 10% probability mass are considered.

We generally recommend altering this or temperature but not both.

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

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

Builds a new ModifyAssistantRequest.

Errors

If a required field has not been initialized.

Trait Implementations

impl Clone for ModifyAssistantRequestArgs

fn clone(&self) -> ModifyAssistantRequestArgs

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for ModifyAssistantRequestArgs

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

Formats the value using the given formatter.

impl Default for ModifyAssistantRequestArgs

fn default() -> Self

Returns the “default value” for a type.