string, OpenAI API key (see https://platform.openai.com/account/api-keys)

string/raw, content of file or path to the file

mime type of path. If not supplied, will be guess by mime::guess_type() when needed.

string, 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.

NULL/string, the name of the assistant. The maximum length is 256 characters.

NULL/string, the description of the assistant. The maximum length is 512 characters.

NULL/string, the system instructions that the assistant uses. The maximum length is 32768 characters.

NULL/list, 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, retrieval, or function.

NULL/character vector, a list of file IDs attached to this assistant. There can be a maximum of 20 files attached to the assistant. Files are ordered by their creation date in ascending order.

NULL/list, 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.

string, OpenAI API key (see https://platform.openai.com/account/api-keys)

string, the ID of the assistant for which to create a File.

string, a file ID (with purpose="assistants") that the assistant should use. Useful for tools like retrieval and code_interpreter that can access files.

string, OpenAI API key (see https://platform.openai.com/account/api-keys)

string, the ID of the assistant who the file belongs to.

string, the ID of the file to delete

string, OpenAI API key (see https://platform.openai.com/account/api-keys)

string, the ID of the assistant to delete

string, OpenAI API key (see https://platform.openai.com/account/api-keys)

string, the ID of the assistant the file belongs to.

NULL/integer, a limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 20.

NULL/string, sort order by the created_at timestamp of the objects. asc for ascending order and desc for descending order. Defaults to desc

NULL/string, a cursor for use in pagination. after is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with obj_foo, your subsequent call can include after=obj_foo in order to fetch the next page of the list.

NULL/string, a cursor for use in pagination. before is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with obj_foo, your subsequent call can include before=obj_foo in order to fetch the previous page of the list.

string, OpenAI API key (see https://platform.openai.com/account/api-keys)

string, the ID of the assistant to modify

string, 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 (https://platform.openai.com/docs/models/overview) for descriptions of them.

NULL/string, the name of the assistant. The maximum length is 256 characters.

NULL/string, the description of the assistant. The maximum length is 512 characters.

NULL/string, the system instructions that the assistant uses. The maximum length is 32768 characters.

NULL/list, 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, retrieval, or function.

NULL/character vector, a list of file IDs attached to this assistant. There can be a maximum of 20 files attached to the assistant. Files are ordered by their creation date in ascending order.

NULL/list, 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.

string, OpenAI API key (see https://platform.openai.com/account/api-keys)

string, the ID of the assistant who the file belongs to.

string, the ID of the file we're getting.

string, OpenAI API key (see https://platform.openai.com/account/api-keys)

string, the ID of the assistant to retrieve.

string, OpenAI API key (see https://platform.openai.com/account/api-keys)

string, one of the available TTS models: 'tts-1' or 'tts-1-hd'

string, the text to generate audio for. The maximum length is 4096 characters.

string, the voice to use when generating the audio. Supported voices are alloy, echo, fable, onyx, nova, and shimmer. Previews of the voices are available in the Text to speech guide - https://platform.openai.com/docs/guides/text-to-speech/voice-options

string, the format to audio in. Supported formats are mp3 (default), opus, aac, and flac

double, the speed of the generated audio. Select a value from 0.25 to 4.0, 1.0 is the default.

string, OpenAI API key (see https://platform.openai.com/account/api-keys)

string/raw, content of the audio file or path to the audio file to transcribe, in one of these formats: flac, mp3, mp4, mpeg, mpga, m4a, ogg, wav, or webm.

string, ID of the model to use. Only 'whisper-1' is currently available.

NULL/string, the language of the input audio. Supplying the input language in ISO-639-1 format will improve accuracy and latency. See https://en.wikipedia.org/wiki/List_of_ISO_639_language_codes

NULL/string, an optional text to guide the model's style or continue a previous audio segment. The prompt (https://platform.openai.com/docs/guides/speech-to-text/prompting) should match the audio language.

NULL/string, The format of the transcript output, in one of these options: json (default), text, srt, verbose_json, or vtt.

NULL/double, the sampling temperature, between 0 and 1. Higher values like 0.8 will make the output more random, while lower values like 0.2 will make it more focused and deterministic. If set to 0, the model will use log probability to automatically increase the temperature until certain thresholds are hit. 0 is default.

NULL/string mime type of file (e.g. "audio/mpeg"). If NULL (default), will be guess by mime::guess_type() when needed.

string, OpenAI API key (see https://platform.openai.com/account/api-keys)

string/raw, content of the input audio file or path to the input audio file to translate, in one of these formats: flac, mp3, mp4, mpeg, mpga, m4a, ogg, wav, or webm

string, ID of the model to use. Only 'whisper-1' is currently available.

string, An optional text to guide the model's style or continue a previous audio segment. The prompt should be in English.

string, the format of the transcript output, in one of these options: json (default), text, srt, verbose_json, or vtt.

double, the sampling temperature, between 0 and 1. Higher values like 0.8 will make the output more random, while lower values like 0.2 will make it more focused and deterministic. If set to 0, the model will use log probability to automatically increase the temperature until certain thresholds are hit. 0 is default.

string, OpenAI API key (see https://platform.openai.com/account/api-keys)

audio data

audio format

response object returned by chat_request

data.frame, data.frame with messages comprising the conversation so far

string, ID of the model to use. See the model endpoint compatibility table https://platform.openai.com/docs/models/model-endpoint-compatibility for details on which models work with the Chat API.

NULL/double, number between -2.0 and 2.0. Positive values penalize new tokens based on their existing frequency in the text so far, decreasing the model's likelihood to repeat the same line verbatim. More at https://platform.openai.com/docs/guides/text-generation/parameter-details

NULL/list, modify the likelihood of specified tokens appearing in the completion. Accepts a list that maps tokens (specified by their token ID in the tokenizer) to an associated bias value from -100 to 100. Mathematically, the bias is added to the logits generated by the model prior to sampling. The exact effect will vary per model, but values between -1 and 1 should decrease or increase likelihood of selection; values like -100 or 100 should result in a ban or exclusive selection of the relevant token. See https://platform.openai.com/tokenizer

NULL/flag, whether to return log probabilities of the output tokens or not. If true, returns the log probabilities of each output token returned in the content of message. This option is currently not available on the gpt-4-vision-preview model. Defaults to false.

NULL/int, an integer between 0 and 5 specifying the number of most likely tokens to return at each token position, each with an associated log probability. logprobs must be set to true if this parameter is used.

NULL/int, the maximum number of tokens to generate in the chat completion

NULL/int, how many chat completion choices to generate for each input message.

NULL/double, number between -2.0 and 2.0. Positive values penalize new tokens based on whether they appear in the text so far, increasing the model's likelihood to talk about new topics. See https://platform.openai.com/docs/guides/text-generation/parameter-details

NULL/list, an object specifying the format that the model must output. Compatible with gpt-4-1106-preview and gpt-3.5-turbo-1106. Setting to list(type = "json_object") enables JSON mode, which guarantees the message the model generates is valid JSON. Important: when using JSON mode, you must also instruct the model to produce JSON yourself via a system or user message. Without this, the model may generate an unending stream of whitespace until the generation reaches the token limit, resulting in a long-running and seemingly "stuck" request. Also note that the message content may be partially cut off if finish_reason="length", which indicates the generation exceeded max_tokens or the conversation exceeded the max context length. Text is default response format.

NULL/int, this feature is in Beta. If specified, our system will make a best effort to sample deterministically, such that repeated requests with the same seed and parameters should return the same result. Determinism is not guaranteed, and you should refer to the system_fingerprint response parameter to monitor changes in the backend.

NULL/character vector, up to 4 sequences where the API will stop generating further tokens.

NULL/flag, if set, partial message deltas will be sent, like in ChatGPT. Tokens will be sent as data-only server-sent events as they become available, with the stream terminated by a data: [DONE] message. Defaults to false

NULL/double, 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.

NULL/double, 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. Defaults to 1

NULL/list, a "list" of tools the model may call. Currently, only functions are supported as a tool. Use this to provide a list of functions the model may generate JSON inputs for. Example value:

list(
  # string (required), the type of the tool. Currently, only
  # 'function' is supported
  type = "function",
  
  # list (required)
  function = list(
    # string (optional)
    description = "some description",

    # string (required), 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
    name = "functionname",
    
    # list (optional), the parameters the functions accepts,
    # described as a JSON Schema object. Omitting parameters
    # defines a function with an empty parameter list.
    parameters = list()
  )
)

NULL/string/list, controls which (if any) function is called by the model. 'none' means the model will not call a function and instead generates a message. 'auto' means the model can pick between generating a message or calling a function. Specifying a particular function via list 'list(type = "function", function": list(name: "my_function"))' forces the model to call that function. 'none' is the default when no functions are present, 'auto' is the default if functions are present.

NULL/string, a unique identifier representing your end-user, which can help OpenAI to monitor and detect abuse. See https://platform.openai.com/docs/guides/safety-best-practices/end-user-ids

string, OpenAI API key (see https://platform.openai.com/account/api-keys)

response object returned by completions_request

string, dialog role (phrase owner)

flag, trim left white space character(s) from text

string, ID of the model to use. You can use the list models (https://platform.openai.com/docs/api-reference/models/list) API to see all of your available models, or see our model overview (https://platform.openai.com/docs/models/overview) for descriptions of them.

API endpoint parameter

string/NULL, the suffix that comes after a completion of inserted text.

integer, the maximum number of tokens (https://platform.openai.com/tokenizer) to generate in the completion. The token count of your prompt plus max_tokens cannot exceed the model's context length.

double, 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.

double, 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.

integer, How many completions to generate for each prompt. Note: Because this parameter generates many completions, it can quickly consume your token quota. Use carefully and ensure that you have reasonable settings for 'max_tokens' and 'stop'.

flag, Whether to stream back partial progress. If set, tokens will be sent as data-only server-sent events as they become available, with the stream terminated by a data: '[DONE]' message.

integer, Include the log probabilities on the logprobs most likely tokens, as well the chosen tokens. For example, if logprobs is 5, the API will return a list of the 5 most likely tokens. The API will always return the logprob of the sampled token, so there may be up to logprobs+1 elements in the response.

logical, echo back the prompt in addition to the completion

string or array, up to 4 sequences where the API will stop generating further tokens. The returned text will not contain the stop sequence.

double, Number between -2.0 and 2.0. Positive values penalize new tokens based on whether they appear in the text so far, increasing the model's likelihood to talk about new topics.

double, Number between -2.0 and 2.0. Positive values penalize new tokens based on their existing frequency in the text so far, decreasing the model's likelihood to repeat the same line verbatim.

integer, Generates best_of completions server-side and returns the "best" (the one with the highest log probability per token). Results cannot be streamed. When used with n, best_of controls the number of candidate completions and n specifies how many to return – best_of must be greater than n.

string, A unique identifier representing your end-user, which can help OpenAI to monitor and detect abuse

string, OpenAI API key (see https://platform.openai.com/account/api-keys)

string, csv file path

data.frame, input data.frame

character vector, column names of the df that will be modified

A character string. The default for the format methods is "%Y-%m-%d %H:%M:%S" if any element has a time component which is not midnight, and "%Y-%m-%d" otherwise. If options("digits.secs") is set, up to the specified number of digits will be printed for seconds.

A character string specifying the time zone to be used for the conversion. System-specific (see as.POSIXlt), but "" is the current time zone, and "GMT" is UTC. Invalid values are most commonly treated as UTC, on some platforms with a warning.

string, behavior for missing column(s): "warn" - log warning, "skip" - skip missing column(s), "stop" - throw error

data.frame, input data.frame

character vector, df column names containing objects

NULL/character vector, object properties (NULL means all)

flag, whether the rows of the columns contain multiple objects

string/NULL, cell header

string, how to combine objects

string/NULL, cell footer

string/NULL, object header

string, how to combine properties

string/NULL, object footer

string, sprintf fmt parameter with two '%s' fields (property

string, value for NULL object property name, value)

string, behavior for missing column(s): "warn" - log warning, "skip" - skip missing column(s), "stop" - throw error

data.frame, input data.frame

character vector, column name(s) to be deleted

string, behavior for missing column(s): "warn" - log warning, "skip" - skip missing column(s), "stop" - throw error

data.frame, input data.frame

string, replacement for NULL

data.frame, input data.frame

string, column name as sort source

flag, should the sort order be increasing or decreasing?

string, behavior for missing column(s): "warn" - log warning, "skip" - skip missing column(s), "stop" - throw error

data.frame, input data.frame

string, behavior for missing column(s): "warn" - log warning, "skip" - skip missing column(s), "stop" - throw error

string, message content

string, message role ("owner")

see https://platform.openai.com/docs/guides/gpt/chat-completions-response-format

data.frame, dialog data.frame to save in csv file

string, csv file path

character vector, input text to embed, encoded as a string or array of tokens. To embed multiple inputs in a single request, pass an array of strings or array of token arrays. The input must not exceed the max input tokens for the model (8192 tokens for text-embedding-ada-002), cannot be an empty string, and any array must be 2048 dimensions or less.

string, ID of the model to use. You can use the list models API (https://platform.openai.com/docs/api-reference/models/list) to see all of your available models, or see our model overview (https://platform.openai.com/docs/models/overview) for descriptions of them.

string, he format to return the embeddings in. Can be either float (default) or base64.

string, a unique identifier representing your end-user, which can help OpenAI to monitor and detect abuse. To learn more visit https://platform.openai.com/docs/guides/safety-best-practices/end-user-ids

string, OpenAI API key (see https://platform.openai.com/account/api-keys)

integer, The index of the embedding in the list of embeddings

double vector, the embedding vector, which is a "list of floats". The length of vector depends on the model as listed in the embedding guide.

string, the object type, which is always "embedding"

string, OpenAI API key (see https://platform.openai.com/account/api-keys)

string, question text

string, ID of the model to use. See the model endpoint compatibility table https://platform.openai.com/docs/models/model-endpoint-compatibility for details on which models work with the Chat API.

NULL/int, the maximum number of tokens to generate in the chat completion

flag, If TRUE, print the answer on the console

string, id of the uploaded file

string, OpenAI API key (see https://platform.openai.com/account/api-keys)

response object returned by files_list_request

NULL/string, only return files with the given purpose

string, OpenAI API key (see https://platform.openai.com/account/api-keys)

string, id of the uploaded file

string, OpenAI API key (see https://platform.openai.com/account/api-keys)

string, id of the uploaded file

string, OpenAI API key (see https://platform.openai.com/account/api-keys)

string, OpenAI API key (see https://platform.openai.com/account/api-keys)

string, id of the uploaded file

string/raw, path or content of the JSON Lines file to be uploaded

string, the intended purpose of the uploaded documents. Use "fine-tune" for Fine-tuning.

NULL/string, mime type of 'file'. See api_upload_file

string, OpenAI API key (see https://platform.openai.com/account/api-keys)

string, the ID of the fine-tuning job to cancel

string, OpenAI API key (see https://platform.openai.com/account/api-keys)

string, the name of the base model to fine-tune. You can select one of the supported models: gpt-3.5-turbo-1106 (recommended), gpt-3.5-turbo-0613, babbage-002, davinci-002, gpt-4-0613 (experimental)

string, the ID of an uploaded file that contains training data. See files_upload_request.

list/NULL, the hyperparameters used for the fine-tuning job. 'hyperparameters$batch_size' string/integer/NULL defaults to "auto", number of examples in each batch. A larger batch size means that model parameters are updated less frequently, but with lower variance. 'hyperparameters$learning_rate_multiplier' string/number/NULL defaults to "auto", scaling factor for the learning rate. A smaller learning rate may be useful to avoid overfitting. 'hyperparameters$n_epochs' string/integer/NULL, defaults to "auto", the number of epochs to train the model for. An epoch refers to one full cycle through the training dataset.

string/NULL, A string of up to 18 characters that will be added to your fine-tuned model name. For example, a suffix of "custom-model-name" would produce a model name like ft:gpt-3.5-turbo:openai:custom-model-name:7p4lURel

string/NULL, the ID of an uploaded file that contains validation data. If you provide this file, the data is used to generate validation metrics periodically during fine-tuning. These metrics can be viewed in the fine-tuning results file. The same data should not be present in both train and validation files. Your dataset must be formatted as a JSONL file. You must upload your file with the purpose fine-tune.

string, OpenAI API key (see https://platform.openai.com/account/api-keys)

string, the ID of the fine-tuning job to get events for

string/NULL, identifier for the last event from the previous pagination request.

integer/NULL, number of events to retrieve (defaults to 20)

string, OpenAI API key (see https://platform.openai.com/account/api-keys)

response object returned by fine_tuning_events_list_request

response object returned by fine_tuning_jobs_list_request

response object returned by fine_tuning_retrive_job_request

NULL/string, identifier for the last job from the previous pagination request

NULL/integer, number of fine-tuning jobs to retrieve (default 20)

string, OpenAI API key (see https://platform.openai.com/account/api-keys)

string, the ID of the fine-tuning job to get events for

string, OpenAI API key (see https://platform.openai.com/account/api-keys)

string/raw, the image to edit. Must be a valid PNG file, less than 4MB, and square. If mask is not provided, image must have transparency, which will be used as the mask.

string, a text description of the desired image(s). The maximum length is 1000 characters.

NULL/string/raw, an additional image whose fully transparent areas (e.g. where alpha is zero) indicate where image should be edited. Must be a valid PNG file, less than 4MB, and have the same dimensions as 'image'.

NULL/string, the model to use for image generation. Only dall-e-2 is supported at this time.

NULL/int, the number of images to generate. Must be between 1 (default) and 10.

NULL/string, the size of the generated images. Must be one of 256x256, 512x512, or 1024x1024 (default).

NULL/string, the format in which the generated images are returned. Must be one of "url" or "b64_json".

string a unique identifier representing your end-user, which can help OpenAI to monitor and detect abuse.

string, OpenAI API key (see https://platform.openai.com/account/api-keys)

response object returned by images_generator_request or images_edit_request

NULL/string additional info put into the image set object

NULL/string additional info put into the image set object

string, a text description of the desired image(s). The maximum length is 1000 characters for dall-e-2 and 4000 characters for dall-e-3.

NULL/string, the model to use for image generation. Defaults to 'dall-e-2'

NULL/int, the number of images to generate. Must be between 1 and 10. For dall-e-3, only n=1 is supported.

NULL/string, the quality of the image that will be generated. 'hd' creates images with finer details and greater consistency across the image. This param is only supported for dall-e-3. Defaults to 'standard'.

NULL/string, the format in which the generated images are returned. Must be one of "url" or "b64_json".

NULL/string, the size of the generated images. Must be one of 256x256, 512x512, or 1024x1024 for dall-e-2. Must be one of 1024x1024, 1792x1024, or 1024x1792 for dall-e-3 models. 1024x1024 is default.

NULL/string, the style of the generated images. Must be one of 'vivid' (default) or 'natural'. Vivid causes the model to lean towards generating hyper-real and dramatic images. Natural causes the model to produce more natural, less hyper-real looking images. This param is only supported for dall-e-3.

string a unique identifier representing your end-user, which can help OpenAI to monitor and detect abuse.

string, OpenAI API key (see https://platform.openai.com/account/api-keys)

images set(s), NULL also allowed

string/raw, the image to edit. Must be a valid PNG file, less than 4MB, and square

NULL/string, the model to use for image generation. Only dall-e-2 is supported at this time.

NULL/int, the number of images to generate. Must be between 1 (default) and 10.

NULL/string, the format in which the generated images are returned. Must be one of "url" or "b64_json".

NULL/string, the size of the generated images. Must be one of 256x256, 512x512, or 1024x1024 (default).

string a unique identifier representing your end-user, which can help OpenAI to monitor and detect abuse.

string, OpenAI API key (see https://platform.openai.com/account/api-keys)

R variable

R variable to test

dialog data.frame or NULL

string, the ID of the thread to create a message for.

string, the role of the entity that is creating the message. Currently only user is supported.

string, the content of the message.

NULL/character vector, a list of File IDs that the message should use. There can be a maximum of 10 files attached to a message. Useful for tools like retrieval and code_interpreter that can access and use files.

NULL/list, 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.

string, OpenAI API key (see https://platform.openai.com/account/api-keys)

string, the ID of the thread the messages belong to

string, the ID of the message that the files belongs to

NULL/integer, a limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 20.

NULL/string, sort order by the created_at timestamp of the objects. asc for ascending order and desc for descending order. Defaults to desc

NULL/string, a cursor for use in pagination. after is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with obj_foo, your subsequent call can include after=obj_foo in order to fetch the next page of the list.

NULL/string, a cursor for use in pagination. before is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with obj_foo, your subsequent call can include before=obj_foo in order to fetch the previous page of the list.

string, OpenAI API key (see https://platform.openai.com/account/api-keys)

string, the ID of the thread the messages belong to

NULL/integer, a limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 20.

NULL/string, sort order by the created_at timestamp of the objects. asc for ascending order and desc for descending order. Defaults to desc

NULL/string, a cursor for use in pagination. after is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with obj_foo, your subsequent call can include after=obj_foo in order to fetch the next page of the list.

NULL/string, a cursor for use in pagination. before is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with obj_foo, your subsequent call can include before=obj_foo in order to fetch the previous page of the list.

string, OpenAI API key (see https://platform.openai.com/account/api-keys)

string, the ID of the thread to which this message belongs

string, the ID of the message to modify

NULL/list, 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 maximum of 512 characters long.

string, OpenAI API key (see https://platform.openai.com/account/api-keys)

string, the ID of the thread the messages belong to

string, the ID of the message that the files belongs to

string, the ID of the file being retrieved

string, OpenAI API key (see https://platform.openai.com/account/api-keys)

string, the ID of the thread the messages belong to

string, the ID of the message that the files belongs to

string, OpenAI API key (see https://platform.openai.com/account/api-keys)

string, the model to delete

string, OpenAI API key (see https://platform.openai.com/account/api-keys)

response object returned by models_list_request

string, OpenAI API key (see https://platform.openai.com/account/api-keys)

string, the ID of the model to use for this request

string, OpenAI API key (see https://platform.openai.com/account/api-keys)

string, the input text to classify

string, two content moderations models are available: 'text-moderation-stable' and 'text-moderation-latest'. The default is 'text-moderation-latest' which will be automatically upgraded over time. This ensures you are always using our most accurate model. If you use 'text-moderation-stable', we will provide advanced notice before updating the model. Accuracy of 'text-moderation-stable' may be slightly lower than for 'text-moderation-latest'.

string, OpenAI API key (see https://platform.openai.com/account/api-keys)

an object used to select a method.

further arguments passed to or from other methods.

an object used to select a method.

further arguments passed to or from other methods.

an object used to select a method.

further arguments passed to or from other methods.

an object used to select a method.

further arguments passed to or from other methods.

an object used to select a method.

further arguments passed to or from other methods.

an object used to select a method.

further arguments passed to or from other methods.

an object used to select a method.

further arguments passed to or from other methods.

an object used to select a method.

further arguments passed to or from other methods.

an object used to select a method.

further arguments passed to or from other methods.

an object used to select a method.

further arguments passed to or from other methods.

an object used to select a method.

further arguments passed to or from other methods.

an object used to select a method.

further arguments passed to or from other methods.

string, API endpoint url

string, OpenAI API key (see https://platform.openai.com/account/api-keys)

One of the following:

• FALSE: No body. This is typically not used with POST, PUT, or PATCH, but can be useful if you need to send a bodyless request (like GET) with VERB().

• NULL: An empty body

• "": A length 0 body

• upload_file("path/"): The contents of a file. The mime type will be guessed from the extension, or can be supplied explicitly as the second argument to upload_file()

• A character or raw vector: sent as is in body. Use content_type() to tell the server what sort of data you are sending.

• A named list: See details for encode.

NULL/list, query string elements as list(name1 = value1, name2 = value2)

If the body is a named list, how should it be encoded? Can be one of form (application/x-www-form-urlencoded), multipart, (multipart/form-data), or json (application/json).

For "multipart", list elements can be strings or objects created by upload_file(). For "form", elements are coerced to strings and escaped, use I() to prevent double-escaping. For "json", parameters are automatically "unboxed" (i.e. length 1 vectors are converted to scalars). To preserve a length 1 vector as a vector, wrap in I(). For "raw", either a character or raw vector. You'll need to make sure to set the content_type() yourself.

string, request method

NULL/character vector, NULL or additional class name(s) (S3) appended to the response content

string, the ID of the thread (https://platform.openai.com/docs/api-reference/threads) to which this run belongs

string, the ID of the run to cancel

string, OpenAI API key (see https://platform.openai.com/account/api-keys)

string, the ID of the thread to run

string, the ID of the assistant to use to execute this run

NULL/string, the ID of the model (https://platform.openai.com/docs/api-reference/models) to be used to execute this run. If a value is provided here, it will override the model associated with the assistant. If not, the model associated with the assistant will be used.

NULL/string, overrides the instructions (https://platform.openai.com/docs/api-reference/assistants/createAssistant) of the assistant. This is useful for modifying the behavior on a per-run basis.

NULL/string, appends additional instructions at the end of the instructions for the run. This is useful for modifying the behavior on a per-run basis without overriding other instructions.

NULL/named list, override the tools the assistant can use for this run. This is useful for modifying the behavior on a per-run basis. Example:

# code interpreter tool
list(
  type = "code_interpreter"
)
# or retrieval tool
list(
  type = "retrieval"
)
# or function tool
list(
  type = "retrieval",
  function = list(
    # string (optional), a description of what the function
    # does, used by the model to choose when and how to call
    # the function.
    description = 
    # string (required), 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.
    name =
    # list (optional), the parameters the functions accepts.
    # See the guide
    # (https://platform.openai.com/docs/guides/text-generation/function-calling)
    # for examples. Omitting parameters defines a function
    # with an empty parameter list.
    parameters = list (
    )
 )
)

NULL/list, 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 maximum of 512 characters long.

string, OpenAI API key (see https://platform.openai.com/account/api-keys)

string, the ID of the assistant to use to execute this run

NULL/list,

list(
  # messages "array" (list of list(s))
  messages = list(
    list(
    # string (required), the role of the entity that is creating
    # the message. Currently only user is supported.
    role = 
    # string (required), the content of the message.
    content = 
    # character vector (optional), a list of File IDs that
    # the message should use. There can be a maximum of 10
    # files attached to a message. Useful for tools like retrieval
    # and code_interpreter that can access and use files.
    file_ids = 
    # named list (optional), 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 maximum of 512 characters long.
    metadata = list (
      meta1 = "value1"
    )
  )
 ),
 # named list (optional), 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 maximum of 512 characters long.
 metadata = list(
   metaX = "value y"
 )
)

NULL/string, the ID of the model (https://platform.openai.com/docs/api-reference/models) to be used to execute this run. If a value is provided here, it will override the model associated with the assistant. If not, the model associated with the assistant will be used.

NULL/string, overrides the instructions (https://platform.openai.com/docs/api-reference/assistants/createAssistant) of the assistant. This is useful for modifying the behavior on a per-run basis.

NULL/named list, override the tools the assistant can use for this run. This is useful for modifying the behavior on a per-run basis. Example:

# code interpreter tool
list(
  type = "code_interpreter"
)
# or retrieval tool
list(
  type = "retrieval"
)
# or function tool
list(
  type = "retrieval",
  function = list(
    # string (optional), a description of what the function does, used by the model to choose when and how to call
    # the function.
    description = 
    # string (required), 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.
    name =
    # list (optional), the parameters the functions accepts. See the guide
    # (https://platform.openai.com/docs/guides/text-generation/function-calling) for examples. Omitting parameters
    # defines a function with an empty parameter list.
    parameters = list (
    )
 )
)

NULL/list, 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 maximum of 512 characters long.

string, OpenAI API key (see https://platform.openai.com/account/api-keys)

string, the ID of the thread the run belongs to

string, the ID of the run the run steps belong to

NULL/integer, a limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 20.

NULL/string, sort order by the created_at timestamp of the objects. asc for ascending order and desc for descending order. Defaults to desc

NULL/string, a cursor for use in pagination. after is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with obj_foo, your subsequent call can include after=obj_foo in order to fetch the next page of the list.

NULL/string, a cursor for use in pagination. before is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with obj_foo, your subsequent call can include before=obj_foo in order to fetch the previous page of the list.

string, OpenAI API key (see https://platform.openai.com/account/api-keys)

string, the ID of the thread the run belongs to

NULL/integer, a limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 20.

NULL/string, sort order by the created_at timestamp of the objects. asc for ascending order and desc for descending order. Defaults to desc

NULL/string, a cursor for use in pagination. after is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with obj_foo, your subsequent call can include after=obj_foo in order to fetch the next page of the list.

NULL/string, a cursor for use in pagination. before is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with obj_foo, your subsequent call can include before=obj_foo in order to fetch the previous page of the list.

string, OpenAI API key (see https://platform.openai.com/account/api-keys)

string, the ID of the thread (https://platform.openai.com/docs/api-reference/threads) that was run

string, the ID of the run to modify

NULL/list, 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 maximum of 512 characters long.

string, OpenAI API key (see https://platform.openai.com/account/api-keys)

string, The ID of the thread (https://platform.openai.com/docs/api-reference/threads) that was run

string, the ID of the run to retrieve

string, OpenAI API key (see https://platform.openai.com/account/api-keys)

string, the ID of the thread (https://platform.openai.com/docs/api-reference/threads) to which the run and run step belongs

string, the ID of the run to which the run step belongs

string, the ID of the run step to retrieve

string, OpenAI API key (see https://platform.openai.com/account/api-keys)

string, the ID of the thread (https://platform.openai.com/docs/api-reference/threads) to which this run belongs

string, the ID of the run that requires the tool output submission

list, a list of tools for which the outputs are being submitted.

list(
  # string (optional), the ID of the tool call in the required_action
  # object within the run object the output is being submitted for.
  tool_call_id = 
  # string (optional), the output of the tool call to be
  # submitted to continue the run
  output = 
)

string, OpenAI API key (see https://platform.openai.com/account/api-keys)

parameters in form log_level = function

NULL/list, a list of messages to start the thread with. The message "object" description:

list(
  list(
    # string (required), the role of the entity that is
    # creating the message. Currently only 'user' is supported.
    role = "user",
    # string (required), the content of the message.
    content = 
    # character vector (optional), a list of File IDs that
    # the message should use. There can be a maximum of 10
    # files attached to a message. Useful for tools like
    # retrieval and code_interpreter that can access and
    # use files.
    file_ids = 
    # named list (optional), 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 maximum of 512 characters long.
    metadata = list(
      meta1 = "value 2"
    )
  )
)

NULL/list, 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 maximum of 512 characters long.

string, OpenAI API key (see https://platform.openai.com/account/api-keys)

string, the ID of the thread to delete

string, OpenAI API key (see https://platform.openai.com/account/api-keys)

string, the ID of the thread to modify. Only the 'metadata' can be modified.

NULL/list, 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 maximum of 512 characters long.

string, OpenAI API key (see https://platform.openai.com/account/api-keys)

string, the ID of the thread to retrieve.

string, OpenAI API key (see https://platform.openai.com/account/api-keys)

int, unix timestamp value

A character string. The default for the format methods is "%Y-%m-%d %H:%M:%S" if any element has a time component which is not midnight, and "%Y-%m-%d" otherwise. If options("digits.secs") is set, up to the specified number of digits will be printed for seconds.

A character string specifying the time zone to be used for the conversion. System-specific (see as.POSIXlt), but "" is the current time zone, and "GMT" is UTC. Invalid values are most commonly treated as UTC, on some platforms with a warning.

logical. Should the time zone abbreviation be appended to the output? This is used in printing times, and more reliable than using "%Z".