modify_assistant: Modify Assistant - Beta

View source: R/functions.R

modify_assistantR Documentation

Modify Assistant - Beta

Description

Modifies an assistant.

Usage

modify_assistant(
  assistant_id,
  description = NULL,
  file_ids = NULL,
  instructions = NULL,
  metadata = NULL,
  model = NULL,
  name = NULL,
  tools = NULL,
  return_response = F
)

Arguments

assistant_id

(string) The ID of the assistant to modify. Required

description

(string or null) The description of the assistant. The maximum length is 512 characters.

file_ids

(array) 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. If a file was previosuly attached to the list but does not show up in the list, it will be deleted from the assistant.

instructions

(string or null) The system instructions that the assistant uses. The maximum length is 32768 characters.

metadata

(map) 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.

model

() 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.

name

(string or null) The name of the assistant. The maximum length is 256 characters.

tools

(array) 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.

return_response

(boolean) Whether to return the API response or parse the contents of the response. Defaults to FALSE (parse the response).

See Also

Open AI Documentation


samterfa/openai documentation built on Oct. 9, 2024, 5:18 p.m.