openai

type Assistant struct {
	ID           string           `json:"id"`
	Object       string           `json:"object"`
	Created      int              `json:"created"`
	Name         string           `json:"name"`
	Description  string           `json:"description"`
	Model        string           `json:"model"`
	Instructions string           `json:"instructions"`
	Tools        []map[string]any `json:"tools"`
	FileIDs      []string         `json:"file_ids"`
	Metadata     map[string]any   `json:"metadata"`
}

type AssistantFile struct {
	ID          string `json:"id"`
	Object      string `json:"object"`
	Created     int    `json:"created"`
	AssistantID string `json:"assistant_id"`
}

type AssistantToolOutput struct {
	CallID string `json:"tool_call_id,omitempty"`
	Output string `json:"output,omitempty"`
}

type AudioTranscriptableFile interface {
	io.ReadCloser
	Name() string
}

type AudioTranscriptionFile struct {
	ReadCloser *AudioTranscriptionFileReadCloser

	File *os.File
}

type AudioTranscriptionFileReadCloser struct {
	io.ReadCloser
	// contains filtered or unexported fields
}

type CancelFineTuneRequest struct {
	ID string `json:"id"`
}

type CancelFineTuneResponse struct {
	ID              string `json:"id"`
	Object          string `json:"object"`
	Model           string `json:"model"`
	CreatedAt       int    `json:"created_at"`
	Events          []any  `json:"events"`
	FineTunedModel  any    `json:"fine_tuned_model"`
	Hyperparams     any    `json:"hyperparams"`
	OrganizationID  string `json:"organization_id"`
	ResultFiles     []any  `json:"result_files"`
	Status          string `json:"status"`
	ValidationFiles []any  `json:"validation_files"`
	TrainingFiles   []struct {
		ID        string `json:"id"`
		Object    string `json:"object"`
		Bytes     int    `json:"bytes"`
		CreatedAt int    `json:"created_at"`
		Filename  string `json:"filename"`
		Purpose   string `json:"purpose"`
	} `json:"training_files"`
	UpdatedAt int `json:"updated_at"`
}

type CancelRunRequest struct {
	// https://platform.openai.com/docs/api-reference/runs/cancelRun#runs-cancelrun-thread_id
	//
	// Required.
	ThreadID string

	// https://platform.openai.com/docs/api-reference/runs/cancelRun#runs-cancelrun-run_id
	//
	// Required.
	RunID string
}

type ChatMessage struct {
	// Role is the role of the message, e.g. "user" or "bot".
	//
	// https://platform.openai.com/docs/api-reference/chat/create#chat/create-role
	//
	// Required.
	Role string `json:"role"`

	// Content is the text of the message.
	//
	// https://platform.openai.com/docs/api-reference/chat/create#chat/create-content
	//
	// Optional.
	Content string `json:"content"`

	// Name is the author of this message. It is required if role is function,
	// and it should be the name of the function whose response is in the content.
	//
	// May contain a-z, A-Z, 0-9, and underscores, with a maximum length of 64 characters.
	//
	// https://platform.openai.com/docs/api-reference/chat/create#chat/create-name
	//
	// Optional.
	Name string `json:"name,omitempty"`

	// FunctionCall the name and arguments of a function that should be called,
	// as generated by the model.
	//
	// https://platform.openai.com/docs/api-reference/chat/create#chat/create-function_call
	//
	// Optional.
	FunctionCall *FunctionCall `json:"function_call,omitempty"`
}

type ChatMessageStreamChunk struct {
	ID      string `json:"id"`
	Object  string `json:"object"`
	Created int    `json:"created"`
	Model   string `json:"model"`
	Choices []struct {
		// Delta is either for role or content.
		Delta struct {
			Role    *string `json:"role"`
			Content *string `json:"content"`
		} `json:"delta"`
		Index        int `json:"index"`
		FinishReason any `json:"finish_reason"`
	} `json:"choices"`
}

type ChatRole = string

type Client struct {
	// APIKey is the API key to use for requests.
	APIKey string

	// HTTPClient is the HTTP client to use for requests.
	HTTPClient *http.Client

	// Organization is the organization to use for requests.
	Organization string
}

type ClientOption func(*Client)

type CreateAssistantFileRequest struct {
	// https://platform.openai.com/docs/api-reference/assistants/createAssistantFile#assistants-createassistantfile-assistant_id
	//
	// Required.
	AssistantID string `json:"assistant_id"`

	// https://platform.openai.com/docs/api-reference/assistants/createAssistantFile#assistants-createassistantfile-file
	//
	// Required.
	FileID string `json:"file_id"`
}

type CreateAssistantFileResponse = AssistantFile

type CreateAssistantRequest struct {
	// https://platform.openai.com/docs/api-reference/assistants/createAssistant#assistants-createassistant-model
	//
	// Required.
	Model string `json:"model"`

	// https://platform.openai.com/docs/api-reference/assistants/createAssistant#assistants-createassistant-instructions
	//
	// Optional.
	Instructions string `json:"instructions,omitempty"`

	// https://platform.openai.com/docs/api-reference/assistants/createAssistant#assistants-createassistant-name
	//
	// Optional.
	Name string `json:"name,omitempty"`

	// https://platform.openai.com/docs/api-reference/assistants/createAssistant#assistants-createassistant-description
	//
	// Optional.
	Description string `json:"description,omitempty"`

	// https://platform.openai.com/docs/api-reference/assistants/createAssistant#assistants-createassistant-tools
	//
	// Optional.
	Tools []map[string]any `json:"tools,omitempty"`

	// https://platform.openai.com/docs/api-reference/assistants/createAssistant#assistants-createassistant-file_ids
	//
	// Optional.
	FileIDs []string `json:"file_ids,omitempty"`

	// https://platform.openai.com/docs/api-reference/assistants/createAssistant#assistants-createassistant-metadata
	//
	// Optional.
	Metadata map[string]any `json:"metadata,omitempty"`
}

type CreateAssistantResponse = Assistant

type CreateAudioTranscriptionRequest struct {
	// https://platform.openai.com/docs/api-reference/audio/create#audio/create-file
	//
	// Required.
	File AudioTranscriptableFile

	// https://platform.openai.com/docs/api-reference/audio/create#audio/create-model
	//
	// Required.
	Model string

	// https://platform.openai.com/docs/api-reference/audio/create#audio/create-prompt
	//
	// Optional.
	Prompt string

	// The format of the transcript output, in one of these options: json, text, srt, verbose_json, or vtt.
	//
	// https://platform.openai.com/docs/api-reference/audio/create#audio/create-response_format
	//
	// Optional. Defaults to "json".
	ResponseFormat string

	// https://platform.openai.com/docs/api-reference/audio/create#audio/create-temperature
	//
	// Optional.
	Temperature float64

	// https://platform.openai.com/docs/api-reference/audio/create#audio/create-language
	//
	// Optional.
	Language string
}

type CreateAudioTranscriptionResponse interface {
	Text() string
}

type CreateAudioTranscriptionResponseJSON struct {
	RawText string `json:"text"`
}

type CreateChatRequest struct {
	// The model to use for the chat (e.g. "gpt3.5-turbo" or "gpt4").
	//
	// https://platform.openai.com/docs/api-reference/chat/create#chat/create-model
	//
	// Required.
	Model string `json:"model,omitempty"`

	// The context window of the conversation, which is a list of messages.
	//
	// https://platform.openai.com/docs/api-reference/chat/create#chat/create-messages
	//
	// Required.
	Messages []ChatMessage `json:"messages,omitempty"`

	// https://platform.openai.com/docs/api-reference/chat/create#chat/create-temperature
	//
	// Optional.
	Temperature float64 `json:"temperature,omitempty"`

	// https://platform.openai.com/docs/api-reference/chat/create#chat/create-top_p
	//
	// Optional.
	TopP float64 `json:"top_p,omitempty"`

	// The number of responses to return, which is typically 1 (the default).
	//
	// https://platform.openai.com/docs/api-reference/chat/create#chat/create-n
	//
	// Optional.
	N int `json:"n,omitempty"`

	// Enable streaming mode, which will return a stream instead of a list of
	// responses. This is useful for longer messages, where the caller can
	// process the response incrementally, instead of waiting for the entire
	// response to be returned.
	//
	// You can use this to enable a fun "typing" effect while the chat bot
	// is generating the response, or start transmitting the response as
	// soon as the first few tokens are available.
	//
	// https://platform.openai.com/docs/api-reference/chat/create#chat/create-stream
	//
	// Optional.
	Stream bool `json:"stream,omitempty"`

	// Up to 4 sequences where the API will stop generating further tokens.
	//
	// https://platform.openai.com/docs/api-reference/chat/create#chat/create-stop
	//
	// Optional.
	Stop []string `json:"stop,omitempty"`

	// The maximum number of tokens to generate in the chat completion.
	//
	// The total length of input tokens and generated tokens is limited
	// by the model's context length.
	//
	// https://platform.openai.com/docs/api-reference/chat/create#chat/create-max_tokens
	//
	// Optional.
	MaxTokens int `json:"max_tokens,omitempty"`

	// 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.
	//
	// https://platform.openai.com/docs/api-reference/chat/create#chat/create-presence_penalty
	//
	// Optional.
	PresencePenalty float64 `json:"presence_penalty,omitempty"`

	// 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.
	//
	// https://platform.openai.com/docs/api-reference/chat/create#chat/create-frequency_penalty
	//
	// Optional.
	FrequencyPenalty float64 `json:"frequency_penalty,omitempty"`

	// Modify the likelihood of specified tokens appearing in the completion.
	//
	// This is a json object 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.
	//
	//
	// https://platform.openai.com/docs/api-reference/chat/create#chat/create-logit_bias
	//
	// Optional.
	LogitBias map[string]float64 `json:"logit_bias,omitempty"`

	// A unique identifier representing your end-user, which can help OpenAI to monitor and detect abuse.
	//
	// https://platform.openai.com/docs/guides/safety-best-practices/end-user-ids
	//
	// https://platform.openai.com/docs/api-reference/chat/create#chat/create-user
	//
	// Optional.
	User string `json:"user,omitempty"`

	// Functions are the functions that can be called by the model.
	//
	// https://platform.openai.com/docs/api-reference/chat/create#chat/create-functions
	//
	// Optional.
	Functions []*Function `json:"functions,omitempty"`

	// Controls how the model responds to function calls. "none" means the model does not
	// call a function, and responds to the end-user. "auto" means the model can pick
	// between an end-user or calling a function. Specifying a particular function
	// via {"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.
	//
	// https://platform.openai.com/docs/api-reference/chat/create#chat/create-function_call
	//
	// Optional.
	FunctionCall FunctionCallControl `json:"function_call,omitempty"`
}

type CreateChatResponse struct {
	ID      string `json:"id"`
	Object  string `json:"object"`
	Created int    `json:"created"`
	Model   string `json:"model"`
	Usage   struct {
		PromptTokens     int `json:"prompt_tokens"`
		CompletionTokens int `json:"completion_tokens"`
		TotalTokens      int `json:"total_tokens"`
	} `json:"usage"`
	Choices []struct {
		Message      ChatMessage `json:"message"`
		FinishReason string      `json:"finish_reason"`
		Index        int         `json:"index"`
	} `json:"choices"`

	// https://platform.openai.com/docs/api-reference/chat/create#chat/create-stream
	Stream io.ReadCloser `json:"-"`
}

type CreateCompletionRequest struct {
	// 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.
	//
	// https://platform.openai.com/docs/api-reference/completions/create#completions/create-model
	Model string `json:"model"`

	// The prompt(s) to generate completions for, encoded as a string, array of strings, array of tokens, or array of token arrays.
	//
	// Note that <|endoftext|> is the document separator that the model sees during training, so if a prompt is not specified the model
	// will generate as if from the beginning of a new document.
	//
	// https://platform.openai.com/docs/api-reference/completions/create#completions/create-prompt
	Prompt []string `json:"prompt"`

	// https://platform.openai.com/docs/api-reference/completions/create#completions/create-suffix
	Suffix string `json:"suffix,omitempty"`

	// The maximum number of tokens to generate in the completion.
	//
	// The token count of your prompt plus max_tokens cannot exceed the model's context length. Most models have a context
	// length of 2048 tokens (except for the newest models, which support 4096).
	//
	// Defaults to 16 if not specified.
	//
	// https://platform.openai.com/docs/api-reference/completions/create#completions/create-max_tokens
	MaxTokens int `json:"max_tokens,omitempty"`

	// https://platform.openai.com/docs/api-reference/completions/create#completions/create-temperature
	//
	// Defaults to 1 if not specified.
	Temperature float64 `json:"temperature,omitempty"`

	// https://platform.openai.com/docs/api-reference/completions/create#completions/create-top_p
	//
	// Defaults to 1 if not specified.
	TopP float64 `json:"top_p,omitempty"`

	// https://platform.openai.com/docs/api-reference/completions/create#completions/create-n
	//
	// Defaults to 1 if not specified.
	N int `json:"n,omitempty"`

	// https://platform.openai.com/docs/api-reference/completions/create#completions/create-stream
	//
	// Defaults to false if not specified.
	Stream bool `json:"stream,omitempty"`

	// https://platform.openai.com/docs/api-reference/completions/create#completions/create-logprobs
	//
	// Defaults to nil.
	LogProbs *int `json:"logprobs,omitempty"`

	// https://platform.openai.com/docs/api-reference/completions/create#completions/create-echo
	//
	// Defaults to false if not specified.
	Echo bool `json:"echo,omitempty"`

	// https://platform.openai.com/docs/api-reference/completions/create#completions/create-stop
	Stop []string `json:"stop,omitempty"`

	// https://platform.openai.com/docs/api-reference/completions/create#completions/create-presence_penalty
	//
	// Defaults to 0 if not specified.
	PresencePenalty int `json:"presence_penalty,omitempty"`

	// https://platform.openai.com/docs/api-reference/completions/create#completions/create-frequency_penalty
	//
	// Defaults to 0 if not specified.
	FrequencyPenalty int `json:"frequency_penalty,omitempty"`

	// https://platform.openai.com/docs/api-reference/completions/create#completions/create-best_of
	//
	// Defaults to 1 if not specified.
	//
	// WARNING: 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.
	BestOf int `json:"best_of,omitempty"`

	// https://platform.openai.com/docs/api-reference/completions/create#completions/create-logit_bias
	//
	// Defaults to nil.
	LogitBias map[string]float64 `json:"logit_bias,omitempty"`

	// https://platform.openai.com/docs/api-reference/completions/create#completions/create-user
	//
	// Defaults to nil.
	User string `json:"user,omitempty"`
}

type CreateCompletionResponse struct {
	ID      string `json:"id"`
	Object  string `json:"object"`
	Created int    `json:"created"`
	Model   string `json:"model"`
	Choices []struct {
		Text         string      `json:"text"`
		Index        int         `json:"index"`
		Logprobs     interface{} `json:"logprobs"`
		FinishReason string      `json:"finish_reason"`
	} `json:"choices"`
	Usage struct {
		PromptTokens     int `json:"prompt_tokens"`
		CompletionTokens int `json:"completion_tokens"`
		TotalTokens      int `json:"total_tokens"`
	} `json:"usage"`
}

type CreateEditRequest struct {
	// https://platform.openai.com/docs/api-reference/edits/create#edits/create-model
	//
	// Required.
	Model string `json:"model"`

	// https://platform.openai.com/docs/api-reference/edits/create#edits/create-instruction
	//
	// Required.
	Instruction string `json:"instruction"`

	// https://platform.openai.com/docs/api-reference/edits/create#edits/create-input
	Input string `json:"input"`

	// https://platform.openai.com/docs/api-reference/edits/create#edits/create-n
	N int `json:"n,omitempty"`

	// https://platform.openai.com/docs/api-reference/edits/create#edits/create-temperature
	Temperature float64 `json:"temperature,omitempty"`

	// https://platform.openai.com/docs/api-reference/edits/create#edits/create-top-p
	TopP float64 `json:"top_p,omitempty"`
}

type CreateEditResponse struct {
	Object  string `json:"object"`
	Created int    `json:"created"`
	Choices []struct {
		Text  string `json:"text"`
		Index int    `json:"index"`
	} `json:"choices"`
	Usage struct {
		PromptTokens     int `json:"prompt_tokens"`
		CompletionTokens int `json:"completion_tokens"`
		TotalTokens      int `json:"total_tokens"`
	} `json:"usage"`
}

type CreateEmbeddingRequest struct {
	// https://platform.openai.com/docs/api-reference/embeddings/create#embeddings/create-model
	//
	// Required. The text to embed.
	Model string `json:"model"`

	// https://platform.openai.com/docs/api-reference/embeddings/create#embeddings/create-input
	//
	// Required. The text to embed.
	Input string `json:"input"`

	// https://platform.openai.com/docs/api-reference/embeddings/create#embeddings/create-user
	User string `json:"user,omitempty"`
}

type CreateEmbeddingResponse struct {
	Object string `json:"object"`
	Data   []struct {
		Object    string    `json:"object"`
		Embedding []float64 `json:"embedding"`
		Index     int       `json:"index"`
	} `json:"data"`
	Model string `json:"model"`
	Usage struct {
		PromptTokens int `json:"prompt_tokens"`
		TotalTokens  int `json:"total_tokens"`
	} `json:"usage"`
}

type CreateFineTuneRequest struct {
	// https://platform.openai.com/docs/api-reference/fine-tunes/create#fine-tunes/create-training_file
	//
	// Required.
	TrainingFile string `json:"training_file"`

	// https://platform.openai.com/docs/api-reference/fine-tunes/create#fine-tunes/create-validation_file
	//
	// Optional.
	ValidationFile string `json:"validation_file,omitempty"`

	// https://platform.openai.com/docs/api-reference/fine-tunes/create#fine-tunes/create-model
	//
	// Optional. Defaults to "curie".
	Model string `json:"model,omitempty"`

	// https://platform.openai.com/docs/api-reference/fine-tunes/create#fine-tunes/create-epochs
	//
	// Optional. Defaults to 4.
	Epochs int `json:"n_epochs,omitempty"`

	// https://platform.openai.com/docs/api-reference/fine-tunes/create#fine-tunes/create-batch_size
	//
	// Optional. Defaults to 32.
	BatchSize int `json:"batch_size,omitempty"`

	// https://platform.openai.com/docs/api-reference/fine-tunes/create#fine-tunes/create-learning_rate_multiplier
	//
	// Optional. Default depends on the batch size.
	LearningRateMultiplier float64 `json:"learning_rate_multiplier,omitempty"`

	// https://platform.openai.com/docs/api-reference/fine-tunes/create#fine-tunes/create-prompt_loss_weight
	//
	// Optional. Defaults to 0.01
	PromptLossWeight float64 `json:"prompt_loss_weight,omitempty"`

	// https://platform.openai.com/docs/api-reference/fine-tunes/create#fine-tunes/create-compute_classification_metrics
	//
	// Optional. Defaults to false.
	ComputeClassificationMetrics bool `json:"compute_classification_metrics,omitempty"`

	// https://platform.openai.com/docs/api-reference/fine-tunes/create#fine-tunes/create-classification_n_classes
	//
	// Optional, but required for multi-class classification.
	ClassificationNClasses int `json:"classification_n_classes,omitempty"`

	// https://platform.openai.com/docs/api-reference/fine-tunes/create#fine-tunes/create-classification_positive_class
	//
	// Optional, but required for binary classification.
	ClassificationPositiveClass string `json:"classification_positive_class,omitempty"`

	// https://platform.openai.com/docs/api-reference/fine-tunes/create#fine-tunes/create-classification_betas
	//
	// Optional, only used for binary classification.
	ClassificationBetas []float64 `json:"classification_betas,omitempty"`

	// https://platform.openai.com/docs/api-reference/fine-tunes/create#fine-tunes/create-suffix
	//
	// A string of up to 40 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
	// `ada:ft-your-org:custom-model-name-2022-02-15-04-21-04`.
	//
	// Optional.
	Suffix string `json:"suffix,omitempty"`
}

type CreateFineTuneResponse struct {
	ID        string `json:"id"`
	Object    string `json:"object"`
	Model     string `json:"model"`
	CreatedAt int    `json:"created_at"`
	Events    []struct {
		Object    string `json:"object"`
		CreatedAt int    `json:"created_at"`
		Level     string `json:"level"`
		Message   string `json:"message"`
	} `json:"events"`
	FineTunedModel interface{} `json:"fine_tuned_model"`
	Hyperparams    struct {
		BatchSize              int     `json:"batch_size"`
		LearningRateMultiplier float64 `json:"learning_rate_multiplier"`
		NEpochs                int     `json:"n_epochs"`
		PromptLossWeight       float64 `json:"prompt_loss_weight"`
	} `json:"hyperparams"`
	OrganizationID  string        `json:"organization_id"`
	ResultFiles     []interface{} `json:"result_files"`
	Status          string        `json:"status"`
	ValidationFiles []interface{} `json:"validation_files"`
	TrainingFiles   []struct {
		ID        string `json:"id"`
		Object    string `json:"object"`
		Bytes     int    `json:"bytes"`
		CreatedAt int    `json:"created_at"`
		Filename  string `json:"filename"`
		Purpose   string `json:"purpose"`
	} `json:"training_files"`
	UpdatedAt int `json:"updated_at"`
}

type CreateImageRequest struct {
	// https://platform.openai.com/docs/api-reference/images/create#images/create-prompt
	//
	// Required. Max of 1,000 characters.
	Prompt string `json:"prompt"`

	// https://platform.openai.com/docs/api-reference/images/create#images-create-model
	//
	// Optional. Defaults to "dall-e-2".
	Model string `json:"model,omitempty"`

	// https://platform.openai.com/docs/api-reference/completions/create#completions/create-n
	//
	// Number of images to generate. Defaults to 1 if not specified. Most be between 1 and 10.
	N int `json:"n,omitempty"`

	// https://platform.openai.com/docs/api-reference/images/create#images/create-size
	//
	// Size of the image to generate. Must be one of 256x256, 512x512, or 1024x1024.
	Size string `json:"size,omitempty"`

	// https://platform.openai.com/docs/api-reference/images/create#images/create-response_format
	//
	// Defaults to "url". The format in which the generated images are returned. Must be one of "url" or "b64_json".
	ResponseFormat string `json:"response_format,omitempty"`

	// https://platform.openai.com/docs/api-reference/images/create#images/create-user
	User string `json:"user,omitempty"`

	// https://platform.openai.com/docs/api-reference/images/create#images-create-quality
	//
	// Optional. Either "standard" or "hd", defaults to "standard".
	Quality string `json:"quality,omitempty"`

	// https://platform.openai.com/docs/api-reference/images/create#images-create-style
	//
	// Optional. Either "vivid" or "natural", defaults to "vivid". Only valid for "dall-e-3" model.
	Style string `json:"style,omitempty"`
}

type CreateImageResponse struct {
	Created int `json:"created"`
	Data    []struct {
		// One of the following: "url" or "b64_json"
		URL     *string `json:"url"`
		B64JSON *string `json:"b64_json"`

		// If there were any prompt revisions made by the API.
		// Use this to refine further.
		RevisedPrompt *string `json:"revised_prompt"`
	} `json:"data"`
}

type CreateMessageRequest struct {
	// https://platform.openai.com/docs/api-reference/messages/createMessage#messages-createmessage-thread_id
	//
	// Required.
	ThreadID string `json:"-"`

	// https://platform.openai.com/docs/api-reference/messages/createMessage#messages-createmessage-role
	//
	// Required.
	Role string `json:"role"`

	// https://platform.openai.com/docs/api-reference/messages/createMessage#messages-createmessage-content
	//
	// Required.
	Content string `json:"content"`

	// https://platform.openai.com/docs/api-reference/messages/createMessage#messages-createmessage-file_ids
	//
	// Optional.
	FileIDs []string `json:"file_ids,omitempty"`

	// https://platform.openai.com/docs/api-reference/messages/createMessage#messages-createmessage-metadata
	//
	// Optional.
	Metadata map[string]any `json:"metadata,omitempty"`
}

type CreateMessageResponse = ThreadMessage

type CreateModerationRequest struct {
	// https://platform.openai.com/docs/api-reference/moderations/create#moderations/create-model
	//
	// Optional. The model to use for moderation. Defaults to "text-moderation-latest".
	Model string `json:"model"`

	// https://platform.openai.com/docs/api-reference/moderations/create#moderations/create-input
	//
	// Required. The text to moderate.
	Input string `json:"input"`
}

type CreateModerationResponse struct {
	ID      string `json:"id"`
	Model   string `json:"model"`
	Results []struct {
		Categories struct {
			Hate            bool `json:"hate"`
			HateThreatening bool `json:"hate/threatening"`
			SelfHarm        bool `json:"self-harm"`
			Sexual          bool `json:"sexual"`
			SexualMinors    bool `json:"sexual/minors"`
			Violence        bool `json:"violence"`
			ViolenceGraphic bool `json:"violence/graphic"`
		} `json:"categories"`
		CategoryScores struct {
			Hate            float64 `json:"hate"`
			HateThreatening float64 `json:"hate/threatening"`
			SelfHarm        float64 `json:"self-harm"`
			Sexual          float64 `json:"sexual"`
			SexualMinors    float64 `json:"sexual/minors"`
			Violence        float64 `json:"violence"`
			ViolenceGraphic float64 `json:"violence/graphic"`
		} `json:"category_scores"`
		Flagged bool `json:"flagged"`
	} `json:"results"`
}

type CreateRunRequest struct {
	// https://platform.openai.com/docs/api-reference/runs/createRun#runs-createrun-thread_id
	//
	// Required.
	ThreadID string `json:"-"`

	// https://platform.openai.com/docs/api-reference/runs/createRun#runs-createrun-assistant_id
	//
	// Required.
	AssistantID string `json:"assistant_id"`

	// https://platform.openai.com/docs/api-reference/runs/createRun#runs-createrun-model
	//
	// Optional. Defaults to the model associated with the assistant.
	Model string `json:"model,omitempty"`

	// https://platform.openai.com/docs/api-reference/runs/createRun#runs-createrun-instructions
	//
	// Optional. Defaults to the instructions associated with the assistant.
	Instructions string `json:"instructions,omitempty"`

	// https://platform.openai.com/docs/api-reference/runs/createRun#runs-createrun-tools
	//
	// Optional. Defaults to the tools associated with the assistant.
	Tools []map[string]any `json:"tools,omitempty"`

	// https://platform.openai.com/docs/api-reference/runs/createRun#runs-createrun-metadata
	//
	// Optional.
	Metadata map[string]any `json:"metadata,omitempty"`
}

type CreateRunResponse = Run

type CreateSpeechRequest struct {
	// https://platform.openai.com/docs/api-reference/audio/createSpeech#audio-createspeech-model
	//
	// Required.
	Model string `json:"model"`

	// https://platform.openai.com/docs/api-reference/audio/createSpeech#audio-createspeech-input
	//
	// Required.
	Input string `json:"input"`

	// https://platform.openai.com/docs/api-reference/audio/createSpeech#audio-createspeech-voice
	//
	// Required.
	Voice string `json:"voice,omitempty"`

	// https://platform.openai.com/docs/api-reference/audio/createSpeech#audio-createspeech-response_format
	//
	// Optional. Defaults to "mp3".
	ResponseFormat string `json:"response_format,omitempty"`

	// https://platform.openai.com/docs/api-reference/audio/createSpeech#audio-createspeech-speed
	//
	// Optional. Defaults to 1.
	Speed float64 `json:"speed,omitempty"`
}

type CreateThreadAndRunRequest struct {
	// https://platform.openai.com/docs/api-reference/runs/createThreadAndRun#runs-createthreadandrun-assistant_id
	//
	// Required.
	AssistantID string `json:"assistant_id"`

	// https://platform.openai.com/docs/api-reference/runs/createThreadAndRun#runs-createthreadandrun-thread
	//
	// Optional.
	Thread *CreateThreadAndRunRequestInitialThread `json:"thread,omitempty"`

	// https://platform.openai.com/docs/api-reference/runs/createThreadAndRun#runs-createthreadandrun-model
	//
	// Optional. Defaults to the model associated with the assistant.
	Model string `json:"model,omitempty"`

	// https://platform.openai.com/docs/api-reference/runs/createThreadAndRun#runs-createthreadandrun-instructions
	//
	// Optional. Defaults to the instructions associated with the assistant.
	Instructions string `json:"instructions,omitempty"`

	// https://platform.openai.com/docs/api-reference/runs/createThreadAndRun#runs-createthreadandrun-tools
	//
	// Optional. Defaults to the tools associated with the assistant.
	Tools []map[string]any `json:"tools,omitempty"`

	// https://platform.openai.com/docs/api-reference/runs/createThreadAndRun#runs-createthreadandrun-metadata
	//
	// Optional.
	Metadata map[string]any `json:"metadata,omitempty"`
}

type CreateThreadAndRunRequestInitialThread struct {
	Messages []*CreateThreadAndRunRequestInitialThreadMessage `json:"messages,omitempty"`
	Metadata map[string]any                                   `json:"metadata,omitempty"`
}

type CreateThreadAndRunRequestInitialThreadMessage struct {
	Role     string         `json:"role"`
	Content  string         `json:"content"`
	FilesIDs []string       `json:"file_ids,omitempty"`
	Metadata map[string]any `json:"metadata,omitempty"`
}

type CreateThreadAndRunResponse = Run

type CreateThreadRequest struct {
	// https://platform.openai.com/docs/api-reference/threads/createThread#threads-createthread-messages
	//
	// Optional.
	Messages []*ChatMessage `json:"messages,omitempty"`

	// https://platform.openai.com/docs/api-reference/threads/createThread#threads-createthread-metadata
	//
	// Optional.
	Metadata map[string]any `json:"metadata,omitempty"`
}

type CreateThreadResponse = Thread

type DeleteAssistantFileRequest struct {
	// https://platform.openai.com/docs/api-reference/assistants/deleteAssistantFile#assistants-deleteassistantfile-assistant_id
	//
	// Required.
	AssistantID string `json:"assistant_id"`

	// https://platform.openai.com/docs/api-reference/assistants/deleteAssistantFile#assistants-deleteassistantfile-file_id
	//
	// Required.
	FileID string `json:"file_id"`
}

type DeleteAssistantRequest struct {
	// https://platform.openai.com/docs/api-reference/assistants/delete#assistants/delete-id
	//
	// Required.
	ID string `json:"assistant_id"`
}

type DeleteFileRequest struct {
	// ID of the file to delete.
	//
	// Required.
	ID string `json:"id"`
}

type DeleteFileResponse struct {
	ID      string `json:"id"`
	Object  string `json:"object"`
	Deleted bool   `json:"deleted"`
}

type DeleteFineTuneModelRequest struct {
	// https://platform.openai.com/docs/api-reference/fine-tunes/delete-model#fine-tunes/delete-model-model
	//
	// Required.
	ID string `json:"model"`
}

type DeleteFineTuneModelResponse struct {
	ID      string `json:"id"`
	Object  string `json:"object"`
	Deleted bool   `json:"deleted"`
}

type DeleteThreadRequest struct {
	// https://platform.openai.com/docs/api-reference/threads/deleteThread#threads-deletethread-id
	//
	// Required.
	ID string `json:"thread_id"`
}

type Function struct {
	// Name is the name of the function.
	//
	// https://platform.openai.com/docs/api-reference/chat/create#chat/create-name
	//
	// Required.
	Name string `json:"name"`

	// Description is a description of the function.
	//
	// https://platform.openai.com/docs/api-reference/chat/create#chat/create-description
	//
	// Optional.
	Description string `json:"description,omitempty"`

	// Parameters are the arguments to the function.
	//
	// 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.
	//
	// https://json-schema.org/understanding-json-schema/
	//
	// https://platform.openai.com/docs/guides/gpt/function-calling
	//
	// https://platform.openai.com/docs/api-reference/chat/create#chat/create-parameters
	//
	// Required.
	Parameters *JSONSchema `json:"parameters,omitempty"`
}

type FunctionCall struct {
	Name      string                `json:"name"`
	Arguments FunctionCallArguments `json:"arguments"`
}

type FunctionCallArguments map[string]any

type FunctionCallControl interface {
	// contains filtered or unexported methods
}

type FunctionCallControlAuto struct{}

type FunctionCallControlName string

type FunctionCallControlNone struct{}

type GetAssistantFileRequest struct {
	// https://platform.openai.com/docs/api-reference/assistants/getAssistantFile#assistants-getassistantfile-assistant_id
	//
	// Required.
	AssistantID string `json:"assistant_id"`

	// https://platform.openai.com/docs/api-reference/assistants/getAssistantFile#assistants-getassistantfile-file_id
	//
	// Required.
	FileID string `json:"file_id"`
}

type GetAssistantFileResponse = AssistantFile

type GetAssistantRequest struct {
	// https://platform.openai.com/docs/api-reference/assistants/get#assistants/get-id
	//
	// Required.
	ID string `json:"assistant_id"`
}

type GetAssistantResponse = Assistant

type GetFileContentRequest struct {
	// ID of the file to retrieve.
	//
	// Required.
	ID string `json:"id"`
}

type GetFileContentResponse struct {
	// Body is the file content returned by the OpenAI API.
	//
	// The caller is responsible for closing the body, and should do so as soon as possible.
	Body io.ReadCloser
}

type GetFileInfoRequest struct {
	// ID of the file to retrieve.
	//
	// Required.
	ID string `json:"id"`
}

type GetFileInfoResponse struct {
	ID        string `json:"id"`
	Object    string `json:"object"`
	Bytes     int    `json:"bytes"`
	CreatedAt int    `json:"created_at"`
	Filename  string `json:"filename"`
	Purpose   string `json:"purpose"`
}

type GetFineTuneRequest struct {
	ID string `json:"id"`
}

type GetFineTuneResponse struct {
	ID        string `json:"id"`
	Object    string `json:"object"`
	Model     string `json:"model"`
	CreatedAt int    `json:"created_at"`
	Events    []struct {
		Object    string `json:"object"`
		CreatedAt int    `json:"created_at"`
		Level     string `json:"level"`
		Message   string `json:"message"`
	} `json:"events"`
	FineTunedModel string `json:"fine_tuned_model"`
	Hyperparams    struct {
		BatchSize              int     `json:"batch_size"`
		LearningRateMultiplier float64 `json:"learning_rate_multiplier"`
		NEpochs                int     `json:"n_epochs"`
		PromptLossWeight       float64 `json:"prompt_loss_weight"`
	} `json:"hyperparams"`
	OrganizationID string `json:"organization_id"`
	ResultFiles    []struct {
		ID        string `json:"id"`
		Object    string `json:"object"`
		Bytes     int    `json:"bytes"`
		CreatedAt int    `json:"created_at"`
		Filename  string `json:"filename"`
		Purpose   string `json:"purpose"`
	} `json:"result_files"`
	Status          string `json:"status"`
	ValidationFiles []any  `json:"validation_files"`
	TrainingFiles   []struct {
		ID        string `json:"id"`
		Object    string `json:"object"`
		Bytes     int    `json:"bytes"`
		CreatedAt int    `json:"created_at"`
		Filename  string `json:"filename"`
		Purpose   string `json:"purpose"`
	} `json:"training_files"`
	UpdatedAt int `json:"updated_at"`
}

type GetMessageFileRequest struct {
	// https://platform.openai.com/docs/api-reference/messages/getMessageFile#messages-getmessagefile-thread_id
	//
	// Required.
	ThreadID string `json:"thread_id"`

	// https://platform.openai.com/docs/api-reference/messages/getMessageFile#messages-getmessagefile-message_id
	//
	// Required.
	MessageID string `json:"message_id"`

	// https://platform.openai.com/docs/api-reference/messages/getMessageFile#messages-getmessagefile-file_id
	//
	// Required.
	FileID string `json:"file_id"`
}

type GetMessageFileResponse = MessageFile

type GetMessageRequest struct {
	// https://platform.openai.com/docs/api-reference/messages/getMessage#messages-getmessage-thread_id
	//
	// Required.
	ThreadID string `json:"thread_id"`

	// https://platform.openai.com/docs/api-reference/messages/getMessage#messages-getmessage-message_id
	//
	// Required.
	MessageID string `json:"message_id"`
}

type GetMessageResponse = ThreadMessage

type GetRunRequest struct {
	// https://platform.openai.com/docs/api-reference/runs/getRun#runs-getrun-thread_id
	//
	// Required.
	ThreadID string

	// https://platform.openai.com/docs/api-reference/runs/getRun#runs-getrun-run_id
	//
	// Required.
	RunID string
}

type GetRunResponse = Run

type GetRunStepRequest struct {
	// https://platform.openai.com/docs/api-reference/runs/getRunStep#runs-getrunstep-thread_id
	//
	// Required.
	ThreadID string

	// https://platform.openai.com/docs/api-reference/runs/getRunStep#runs-getrunstep-run_id
	//
	// Required.
	RunID string

	// https://platform.openai.com/docs/api-reference/runs/getRunStep#runs-getrunstep-step_id
	//
	// Required.
	StepID string
}

type GetRunStepResponse = RunStep

type GetThreadRequest struct {
	// https://platform.openai.com/docs/api-reference/threads/getThread#threads-getthread-id
	//
	// Required.
	ID string `json:"thread_id"`
}

type GetThreadResponse = Thread

type JSONSchema struct {
	// Type is the type of the schema.
	Type string `json:"type,omitempty"`

	// Description is the description of the schema.
	Description string `json:"description,omitempty"`

	// Properties is the properties of the schema.
	Properties map[string]*JSONSchema `json:"properties,omitempty"`

	// Required is the required properties of the schema.
	Required []string `json:"required,omitempty"`

	// Enum is the enum of the schema.
	Enum []string `json:"enum,omitempty"`

	// Items is the items of the schema.
	Items *JSONSchema `json:"items,omitempty"`

	// AdditionalProperties is the additional properties of the schema.
	AdditionalProperties *JSONSchema `json:"additionalProperties,omitempty"`

	// Ref is the ref of the schema.
	Ref string `json:"$ref,omitempty"`

	// AnyOf is the anyOf of the schema.
	AnyOf []*JSONSchema `json:"anyOf,omitempty"`

	// AllOf is the allOf of the schema.
	AllOf []*JSONSchema `json:"allOf,omitempty"`

	// OneOf is the oneOf of the schema.
	OneOf []*JSONSchema `json:"oneOf,omitempty"`

	// Default is the default of the schema.
	Default any `json:"default,omitempty"`

	// Pattern is the pattern of the schema.
	Pattern string `json:"pattern,omitempty"`

	// MinItems is the minItems of the schema.
	MinItems int `json:"minItems,omitempty"`

	// MaxItems is the maxItems of the schema.
	MaxItems int `json:"maxItems,omitempty"`

	// UniqueItems is the uniqueItems of the schema.
	UniqueItems bool `json:"uniqueItems,omitempty"`

	// MultipleOf is the multipleOf of the schema.
	MultipleOf int `json:"multipleOf,omitempty"`

	// Min is the minimum of the schema.
	Min int `json:"min,omitempty"`

	// Max is the maximum of the schema.
	Max int `json:"max,omitempty"`

	// ExclusiveMin is the exclusiveMinimum of the schema.
	ExclusiveMin bool `json:"exclusiveMinimum,omitempty"`

	// ExclusiveMax is the exclusiveMaximum of the schema.
	ExclusiveMax bool `json:"exclusiveMaximum,omitempty"`
}

type ListAssistantFilesRequest struct {
	// https://platform.openai.com/docs/api-reference/assistants/listAssistantFiles#assistants-listassistantfiles-assistant_id
	//
	// Required.
	AssistantID string `json:"-"`

	// https://platform.openai.com/docs/api-reference/assistants/listAssistantFiles#assistants-listassistantfiles-limit
	//
	// Optional. Defaults to 20.
	Limit int `json:"limit,omitempty"`

	// https://platform.openai.com/docs/api-reference/assistants/listAssistantFiles#assistants-listassistantfiles-order
	//
	// Optional. Defaults to "desc".
	Order string `json:"order,omitempty"`

	// https://platform.openai.com/docs/api-reference/assistants/listAssistantFiles#assistants-listassistantfiles-after
	//
	// Optional.
	After string `json:"after,omitempty"`

	// https://platform.openai.com/docs/api-reference/assistants/listAssistantFiles#assistants-listassistantfiles-before
	//
	// Optional.
	Before string `json:"before,omitempty"`
}

type ListAssistantFilesResponse struct {
	Data []AssistantFile `json:"data"`
}

type ListAssistantsRequest struct {
	// https://platform.openai.com/docs/api-reference/assistants/listAssistants#assistants-listassistants-limit
	//
	// Optional. Defaults to 20.
	Limit int `json:"limit,omitempty"`

	// https://platform.openai.com/docs/api-reference/assistants/listAssistants#assistants-listassistants-order
	//
	// Optional. Defaults to "desc".
	Order string `json:"order,omitempty"`

	// https://platform.openai.com/docs/api-reference/assistants/listAssistants#assistants-listassistants-after
	//
	// Optional.
	After string `json:"after,omitempty"`

	// https://platform.openai.com/docs/api-reference/assistants/listAssistants#assistants-listassistants-before
	//
	// Optional.
	Before string `json:"before,omitempty"`
}

type ListAssistantsResponse struct {
	Data []Assistant `json:"data"`
}

type ListFilesRequest struct {
	// https://platform.openai.com/docs/api-reference/files/list#files-list-purpose
	//
	// Optional. Filter to only list files with the specified purpose (assistants, fine-tune, etc).
	Purpose string `json:"purpose,omitempty"`
}

type ListFilesResponse struct {
	Data []struct {
		ID        string `json:"id"`
		Object    string `json:"object"`
		Bytes     int    `json:"bytes"`
		CreatedAt int    `json:"created_at"`
		Filename  string `json:"filename"`
		Purpose   string `json:"purpose"`
	} `json:"data"`
	Object string `json:"object"`
}

type ListFineTuneEventsRequest struct {
	// https://platform.openai.com/docs/api-reference/fine-tunes/events#fine-tunes/events-fine_tune_id
	//
	// Required.
	ID string `json:"id"`

	// https://platform.openai.com/docs/api-reference/fine-tunes/events#fine-tunes/events-stream
	//
	// Optional.
	Stream bool `json:"stream"`
}

type ListFineTuneEventsResponse struct {
	Object string `json:"object"`
	Data   []struct {
		Object    string `json:"object"`
		CreatedAt int    `json:"created_at"`
		Level     string `json:"level"`
		Message   string `json:"message"`
	} `json:"data"`

	// https://platform.openai.com/docs/api-reference/fine-tunes/events#fine-tunes/events-stream
	//
	// Only present if stream=true. Up to the caller to close the stream, e.g.: defer res.Stream.Close()
	Stream io.ReadCloser `json:"-"`
}

type ListFineTunesRequest struct {
}

type ListFineTunesResponse struct {
	Object string `json:"object"`
	Data   []struct {
		ID              string         `json:"id"`
		Object          string         `json:"object"`
		Model           string         `json:"model"`
		CreatedAt       int            `json:"created_at"`
		FineTunedModel  any            `json:"fine_tuned_model"`
		Hyperparams     map[string]any `json:"hyperparams"`
		OrganizationID  string         `json:"organization_id"`
		ResultFiles     []any          `json:"result_files"`
		Status          string         `json:"status"`
		ValidationFiles []any          `json:"validation_files"`
		TrainingFiles   []any          `json:"training_files"`
		UpdatedAt       int            `json:"updated_at"`
	} `json:"data"`
}

type ListMessageFilesRequest struct {
	// https://platform.openai.com/docs/api-reference/messages/listMessageFiles#messages-listmessagefiles-thread_id
	//
	// Required.
	ThreadID string `json:"thread_id"`

	// https://platform.openai.com/docs/api-reference/messages/listMessageFiles#messages-listmessagefiles-message_id
	//
	// Required.
	MessageID string `json:"message_id"`

	// https://platform.openai.com/docs/api-reference/messages/listMessageFiles#messages-listmessagefiles-limit
	//
	// Optional. Defaults to 20.
	Limit int `json:"limit,omitempty"`

	// https://platform.openai.com/docs/api-reference/messages/listMessageFiles#messages-listmessagefiles-order
	//
	// Optional. Defaults to "desc".
	Order string `json:"order,omitempty"`

	// https://platform.openai.com/docs/api-reference/messages/listMessageFiles#messages-listmessagefiles-after
	//
	// Optional.
	After string `json:"after,omitempty"`

	// https://platform.openai.com/docs/api-reference/messages/listMessageFiles#messages-listmessagefiles-before
	//
	// Optional.
	Before string `json:"before,omitempty"`
}

type ListMessageFilesResponse struct {
	Data []MessageFile `json:"data"`
}

type ListMessagesRequest struct {
	// https://platform.openai.com/docs/api-reference/messages/listMessages#messages-listmessages-thread_id
	//
	// Required.
	ThreadID string `json:"thread_id"`

	// https://platform.openai.com/docs/api-reference/messages/listMessages#messages-listmessages-limit
	//
	// Optional. Defaults to 20.
	Limit int `json:"limit,omitempty"`

	// https://platform.openai.com/docs/api-reference/messages/listMessages#messages-listmessages-order
	//
	// Optional. Defaults to "desc".
	Order string `json:"order,omitempty"`

	// https://platform.openai.com/docs/api-reference/messages/listMessages#messages-listmessages-after
	//
	// Optional.
	After string `json:"after,omitempty"`

	// https://platform.openai.com/docs/api-reference/messages/listMessages#messages-listmessages-before
	//
	// Optional.
	Before string `json:"before,omitempty"`
}

type ListMessagesResponse struct {
	Data []ThreadMessage `json:"data"`
}

type ListRunStepsRequest struct {
	// https://platform.openai.com/docs/api-reference/runs/listRunSteps#runs-listrunsteps-thread_id
	//
	// Required.
	ThreadID string

	// https://platform.openai.com/docs/api-reference/runs/listRunSteps#runs-listrunsteps-run_id
	//
	// Required.
	RunID string

	// https://platform.openai.com/docs/api-reference/runs/listRunSteps#runs-listrunsteps-limit
	//
	// Optional. Defaults to 20.
	Limit int

	// https://platform.openai.com/docs/api-reference/runs/listRunSteps#runs-listrunsteps-order
	//
	// Optional. Defaults to "desc".
	Order string

	// https://platform.openai.com/docs/api-reference/runs/listRunSteps#runs-listrunsteps-after
	//
	// Optional.
	After string

	// https://platform.openai.com/docs/api-reference/runs/listRunSteps#runs-listrunsteps-before
	//
	// Optional.
	Before string
}

type ListRunStepsResponse struct {
	Data []RunStep `json:"data"`
}

type ListRunsRequest struct {
	// https://platform.openai.com/docs/api-reference/runs/listRuns#runs-listruns-thread_id
	//
	// Required.
	ThreadID string `json:"thread_id"`

	// https://platform.openai.com/docs/api-reference/runs/listRuns#runs-listruns-limit
	//
	// Optional. Defaults to 20.
	Limit int `json:"limit,omitempty"`

	// https://platform.openai.com/docs/api-reference/runs/listRuns#runs-listruns-order
	//
	// Optional. Defaults to "desc".
	Order string `json:"order,omitempty"`

	// https://platform.openai.com/docs/api-reference/runs/listRuns#runs-listruns-after
	//
	// Optional.
	After string `json:"after,omitempty"`

	// https://platform.openai.com/docs/api-reference/runs/listRuns#runs-listruns-before
	//
	// Optional.
	Before string `json:"before,omitempty"`
}

type ListRunsResponse struct {
	Data []Run `json:"data"`
}

type MessageFile struct {
	ID        string `json:"id"`
	Object    string `json:"object"`
	Created   int    `json:"created"`
	MessageID string `json:"message_id"`
}

type Model = string

type Models struct {
	Object string `json:"object"`
	Data   []struct {
		ID         string `json:"id"`
		Object     string `json:"object"`
		Created    int    `json:"created"`
		OwnedBy    string `json:"owned_by"`
		Permission []struct {
			ID                 string      `json:"id"`
			Object             string      `json:"object"`
			Created            int         `json:"created"`
			AllowCreateEngine  bool        `json:"allow_create_engine"`
			AllowSampling      bool        `json:"allow_sampling"`
			AllowLogprobs      bool        `json:"allow_logprobs"`
			AllowSearchIndices bool        `json:"allow_search_indices"`
			AllowView          bool        `json:"allow_view"`
			AllowFineTuning    bool        `json:"allow_fine_tuning"`
			Organization       string      `json:"organization"`
			Group              interface{} `json:"group"`
			IsBlocking         bool        `json:"is_blocking"`
		} `json:"permission"`
		Root   string      `json:"root"`
		Parent interface{} `json:"parent"`
	} `json:"data"`
}

type RateLimiters struct {
	Chat struct {
		Requests *rate.Limiter
		Tokens   *rate.Limiter
	}
	Text struct {
		Requests *rate.Limiter
		Tokens   *rate.Limiter
	}
	Embedding struct {
		Requests *rate.Limiter
		Tokens   *rate.Limiter
	}
	Images struct {
		Requests *rate.Limiter
	}
	Audio struct {
		Requests *rate.Limiter
	}
}

type Role = string

type Run struct {
	ID             string           `json:"id"`
	Object         string           `json:"object"`
	CreatedAt      int              `json:"created_at"`
	ThreadID       string           `json:"thread_id"`
	AssistantID    string           `json:"assistant_id"`
	Status         string           `json:"status"`
	RequiredAction string           `json:"required_action,omitempty"`
	LastError      map[string]any   `json:"last_error,omitempty"`
	ExpiresAt      int              `json:"expires_at"`
	StartedAt      int              `json:"started_at,omitempty"`
	CancelledAt    int              `json:"cancelled_at,omitempty"`
	FailedAt       int              `json:"failed_at,omitempty"`
	CompletedAt    int              `json:"completed_at,omitempty"`
	Model          string           `json:"model"`
	Instructions   string           `json:"instructions"`
	Tools          []map[string]any `json:"tools"`
	FileIDs        []string         `json:"file_ids"`
	Metadata       map[string]any   `json:"metadata"`
}

type RunStatus = string

type RunStep struct {
	ID          string         `json:"id"`
	Object      string         `json:"object"`
	Created     int            `json:"created"`
	AssistantID string         `json:"assistant_id"`
	ThreadID    string         `json:"thread_id"`
	RunID       string         `json:"run_id"`
	Type        string         `json:"type"`
	Status      string         `json:"status"`
	StepDetails map[string]any `json:"step_details"`
	LastError   map[string]any `json:"last_error,omitempty"`
	ExpiredAt   int            `json:"expired_at,omitempty"`
	CanceledAt  int            `json:"canceled_at,omitempty"`
	FailedAt    int            `json:"failed_at,omitempty"`
	CompletedAt int            `json:"completed_at,omitempty"`
	Metadata    map[string]any `json:"metadata,omitempty"`
}

type SubmitToolOutputsRequest struct {
	// https://platform.openai.com/docs/api-reference/runs/submitToolOutputs#runs-submittooloutputs-thread_id
	//
	// Required.
	ThreadID string `json:"-"`

	// https://platform.openai.com/docs/api-reference/runs/submitToolOutputs#runs-submittooloutputs-run_id
	//
	// Required.
	RunID string `json:"-"`

	// https://platform.openai.com/docs/api-reference/runs/submitToolOutputs#runs-submittooloutputs-tool_id
	//
	// Required.
	ToolOuputs []*AssistantToolOutput `json:"tool_outputs"`
}

type SubmitToolOutputsResponse = Run

type Thread struct {
	ID       string         `json:"id"`
	Object   string         `json:"object"`
	Created  int            `json:"created"`
	Metadata map[string]any `json:"metadata"`
}

type ThreadMessage struct {
	ID          string                 `json:"id"`
	Object      string                 `json:"object"`
	CreatedAt   int                    `json:"created_at"`
	ThreadID    string                 `json:"thread_id"`
	Role        string                 `json:"role"`
	Content     []ThreadMessageContent `json:"content"`
	AssistantID string                 `json:"assistant_id,omitempty"`
	RunID       string                 `json:"run_id,omitempty"`
	FileIDs     []string               `json:"file_ids,omitempty"`
	Metadata    map[string]any         `json:"metadata,omitempty"`
}

type ThreadMessageContent map[string]any

type UpdateAssistantRequest struct {
	// https://platform.openai.com/docs/api-reference/assistants/update#assistants/update-id
	//
	// Required.
	ID string `json:"-"`

	// https://platform.openai.com/docs/api-reference/assistants/modifyAssistant#assistants-modifyassistant-model
	//
	// Optional.
	Model string `json:"model,omitempty"`

	// https://platform.openai.com/docs/api-reference/assistants/modifyAssistant#assistants-modifyassistant-name
	//
	// Optional.
	Name string `json:"name,omitempty"`

	// https://platform.openai.com/docs/api-reference/assistants/modifyAssistant#assistants-modifyassistant-description
	//
	// Optional.
	Description string `json:"description,omitempty"`

	// https://platform.openai.com/docs/api-reference/assistants/modifyAssistant#assistants-modifyassistant-instructions
	//
	// Optional.
	Instructions string `json:"instructions,omitempty"`

	// https://platform.openai.com/docs/api-reference/assistants/modifyAssistant#assistants-modifyassistant-tools
	//
	// Optional.
	Tools []map[string]any `json:"tools,omitempty"`

	// https://platform.openai.com/docs/api-reference/assistants/modifyAssistant#assistants-modifyassistant-file_ids
	//
	// Optional.
	FileIDs []string `json:"file_ids,omitempty"`

	// https://platform.openai.com/docs/api-reference/assistants/modifyAssistant#assistants-modifyassistant-metadata
	//
	// Optional.
	Metadata map[string]any `json:"metadata,omitempty"`
}

type UpdateMessageRequest struct {
	// https://platform.openai.com/docs/api-reference/messages/getMessage#messages-getmessage-thread_id
	//
	// Required.
	ThreadID string `json:"thread_id"`

	// https://platform.openai.com/docs/api-reference/messages/getMessage#messages-getmessage-message_id
	//
	// Required.
	MessageID string `json:"message_id"`

	// https://platform.openai.com/docs/api-reference/messages/modifyMessage#messages-modifymessage-metadata
	//
	// Optional.
	Metadata map[string]any `json:"metadata,omitempty"`
}

type UpdateMessageResponse = ThreadMessage

type UpdateRunRequest struct {
	// https://platform.openai.com/docs/api-reference/runs/modifyRun#runs-modifyrun-thread_id
	//
	// Required.
	ThreadID string `json:"-"`

	// https://platform.openai.com/docs/api-reference/runs/modifyRun#runs-modifyrun-run_id
	//
	// Required.
	RunID string `json:"-"`

	// https://platform.openai.com/docs/api-reference/runs/modifyRun#runs-modifyrun-metadata
	//
	// Optional.
	Metadata map[string]any `json:"metadata,omitempty"`
}

type UpdateRunResponse = Run

type UpdateThreadRequest struct {
	// https://platform.openai.com/docs/api-reference/threads/modifyThread#threads-modifythread-id
	//
	// Required.
	ID string `json:"thread_id"`

	// https://platform.openai.com/docs/api-reference/threads/modifyThread#threads-modifythread-metadata
	//
	// Optional.
	Metadata map[string]any `json:"metadata,omitempty"`
}

type UpdateThreadResponse = Thread

type UploadFileRequest struct {
	// Name of the JSON Lines file to be uploaded.
	//
	// If the purpose is set to "fine-tune", each line is a JSON
	// record with "prompt" and "completion" fields representing
	// your training examples.
	//
	// Required.
	Name string `json:"name"`

	// Purpose of the uploaded documents.
	//
	// Use "fine-tune" for Fine-tuning. This allows us to validate t
	// the format of the uploaded file.
	//
	// Required.
	Purpose string `json:"purpose"`

	// Body of the file to upload.
	//
	// Required.
	Body io.Reader `json:"file"` // TODO: how to handle this?
}

type UploadFileResponse struct {
	ID        string `json:"id"`
	Object    string `json:"object"`
	Bytes     int    `json:"bytes"`
	CreatedAt int    `json:"created_at"`
	Filename  string `json:"filename"`
	Purpose   string `json:"purpose"`
}