openai

type ChatModel struct {
	// contains filtered or unexported fields
}

type ChatOptions struct {
	// Logprobs returns the log probabilities of the tokens.
	// Can be true (return logprobs) or a number 1-20 (return top N logprobs).
	Logprobs any `json:"logprobs,omitempty"`

	// LogitBias modifies the likelihood of specified tokens appearing in the completion.
	// Maps token IDs to bias values from -100 to 100.
	LogitBias map[string]int `json:"logitBias,omitempty"`

	// ParallelToolCalls controls whether to use parallel tool calls.
	// Defaults to true.
	ParallelToolCalls *bool `json:"parallelToolCalls,omitempty"`

	// PresencePenalty penalizes new tokens based on whether they appear in the text so far.
	// Range: -2.0 to 2.0. Positive values increase likelihood to talk about new topics.
	PresencePenalty *float64 `json:"presencePenalty,omitempty"`

	// FrequencyPenalty penalizes new tokens based on their frequency in the text so far.
	// Range: -2.0 to 2.0. Positive values decrease likelihood to repeat the same line.
	FrequencyPenalty *float64 `json:"frequencyPenalty,omitempty"`

	// ReasoningEffort controls reasoning effort for reasoning models.
	// Values: "low", "medium", "high"
	ReasoningEffort string `json:"reasoningEffort,omitempty"`

	// Store controls whether to store the generation.
	Store *bool `json:"store,omitempty"`

	// StrictJsonSchema controls whether to use strict JSON schema validation.
	StrictJsonSchema *bool `json:"strictJsonSchema,omitempty"`

	// StructuredOutputs controls whether to use structured outputs.
	StructuredOutputs *bool `json:"structuredOutputs,omitempty"`

	// User is a unique identifier representing your end-user for abuse monitoring.
	User string `json:"user,omitempty"`
}

type ConversionResult struct {
	Input    []responsesInputItem
	Warnings []ConversionWarning
}

type ConversionWarning struct {
	Type    string `json:"type"`    // "other"
	Message string `json:"message"` // Warning message
}

type CustomFormat struct {
	Type       string `json:"type"`
	Syntax     string `json:"syntax,omitempty"`
	Definition string `json:"definition,omitempty"`
}

type CustomOptions struct {
	Name        string        `json:"name"`
	Description string        `json:"description,omitempty"`
	Format      *CustomFormat `json:"format,omitempty"`
}

type LanguageModelCapabilities struct {
	// IsReasoningModel indicates if the model is a reasoning model (o1, o3, o4-mini, gpt-5, etc.)
	IsReasoningModel bool

	// SystemMessageMode determines how system messages should be handled.
	// "system" - use standard system role
	// "developer" - convert to developer role (for reasoning models)
	// "remove" - remove system messages entirely
	SystemMessageMode string

	// SupportsFlexProcessing indicates if the model supports flex processing tier.
	SupportsFlexProcessing bool

	// SupportsPriorityProcessing indicates if the model supports priority processing tier.
	SupportsPriorityProcessing bool

	// SupportsNonReasoningParameters indicates if the model allows temperature, topP, logProbs
	// when reasoningEffort is none. Only true for gpt-5.1+ models.
	SupportsNonReasoningParameters bool
}

type OpenAIEmbeddingModel struct {
	// contains filtered or unexported fields
}

type OpenAIErrorData struct {
	Error OpenAIErrorInfo `json:"error"`
}

type OpenAIErrorInfo struct {
	// Message is the error message. For nested errors from providers like
	// OpenRouter, this may contain JSON-encoded error details.
	Message string `json:"message"`

	// Type is the error type (e.g., "invalid_request_error").
	// Optional - may be nil for some providers.
	Type *string `json:"type,omitempty"`

	// Param is the parameter that caused the error.
	// Optional - type is any to handle different provider formats.
	Param any `json:"param,omitempty"`

	// Code is the error code. Can be either a string or number depending
	// on the provider. For example, OpenAI uses strings like "invalid_api_key",
	// while OpenRouter may use numeric codes like 429.
	Code any `json:"code,omitempty"`
}

type OpenAIImageModel struct {
	// contains filtered or unexported fields
}

type OpenAISpeechModel struct {
	// contains filtered or unexported fields
}

type OpenAITranscriptionModel struct {
	// contains filtered or unexported fields
}

type Provider struct {
	// contains filtered or unexported fields
}

type ResponsesModel struct {
	// contains filtered or unexported fields
}

type ResponsesOptions struct {
	// Conversation is the ID of the OpenAI Conversation to continue.
	// You must create a conversation first via the OpenAI API.
	// Cannot be used in conjunction with PreviousResponseID.
	Conversation string `json:"conversation,omitempty"`

	// Include specifies extra fields to include in the response.
	// Example values: "reasoning.encrypted_content", "file_search_call.results", "message.output_text.logprobs"
	Include []string `json:"include,omitempty"`

	// Instructions for the model.
	// They can be used to change the system or developer message when continuing
	// a conversation using the PreviousResponseID option.
	Instructions string `json:"instructions,omitempty"`

	// Logprobs returns the log probabilities of the tokens.
	// Can be true (return logprobs) or a number 1-20 (return top N logprobs).
	// Including logprobs increases response size and can slow down response times.
	Logprobs any `json:"logprobs,omitempty"`

	// MaxToolCalls is the maximum number of total calls to built-in tools
	// that can be processed in a response. This applies across all built-in
	// tool calls, not per individual tool.
	MaxToolCalls *int `json:"maxToolCalls,omitempty"`

	// Metadata is additional metadata to store with the generation.
	Metadata any `json:"metadata,omitempty"`

	// ParallelToolCalls controls whether to use parallel tool calls.
	// Defaults to true.
	ParallelToolCalls *bool `json:"parallelToolCalls,omitempty"`

	// PreviousResponseID is the ID of the previous response for conversation continuation.
	PreviousResponseID string `json:"previousResponseId,omitempty"`

	// PromptCacheKey sets a cache key to tie this prompt to cached prefixes
	// for better caching performance.
	PromptCacheKey string `json:"promptCacheKey,omitempty"`

	// PromptCacheRetention is the retention policy for the prompt cache.
	// Values: "in_memory" (default), "24h" (extended, only for 5.1 series models)
	PromptCacheRetention string `json:"promptCacheRetention,omitempty"`

	// ReasoningEffort controls reasoning effort for reasoning models.
	// Values: "none", "minimal", "low", "medium", "high", "xhigh"
	// Note: "none" is only for GPT-5.1 models, "xhigh" only for GPT-5.1-Codex-Max.
	ReasoningEffort string `json:"reasoningEffort,omitempty"`

	// ReasoningSummary controls reasoning summary output from the model.
	// Values: "auto" (automatically receive richest level), "detailed" (comprehensive summaries)
	ReasoningSummary string `json:"reasoningSummary,omitempty"`

	// SafetyIdentifier is the identifier for safety monitoring and tracking.
	SafetyIdentifier string `json:"safetyIdentifier,omitempty"`

	// ServiceTier is the service tier for the request.
	// Values: "auto" (default), "flex" (50% cheaper, higher latency), "priority" (faster, Enterprise), "default"
	ServiceTier string `json:"serviceTier,omitempty"`

	// Store controls whether to store the generation. Defaults to true.
	Store *bool `json:"store,omitempty"`

	// StrictJsonSchema controls whether to use strict JSON schema validation.
	// Defaults to true.
	StrictJsonSchema *bool `json:"strictJsonSchema,omitempty"`

	// TextVerbosity controls the verbosity of the model's responses.
	// Values: "low" (concise), "medium", "high" (verbose)
	TextVerbosity string `json:"textVerbosity,omitempty"`

	// Truncation controls output truncation.
	// Values: "auto" (default, truncates automatically), "disabled" (no truncation)
	Truncation string `json:"truncation,omitempty"`

	// User is a unique identifier representing your end-user for abuse monitoring.
	User string `json:"user,omitempty"`

	// SystemMessageMode overrides how system messages are handled.
	// Values: "system" (default for most models), "developer" (for reasoning models), "remove"
	SystemMessageMode string `json:"systemMessageMode,omitempty"`

	// ForceReasoning forces treating this model as a reasoning model.
	// Useful for "stealth" reasoning models via custom baseURL where the model ID
	// is not recognized by the SDK's allowlist.
	ForceReasoning bool `json:"forceReasoning,omitempty"`
}

type SystemMessageMode string

type ToolSearchOptions struct {
	Execution   string         `json:"execution,omitempty"`
	Description string         `json:"description,omitempty"`
	Parameters  map[string]any `json:"parameters,omitempty"`
}

type WebSearchFilters struct {
	AllowedDomains []string `json:"allowedDomains,omitempty"`
}

type WebSearchOptions struct {
	ExternalWebAccess *bool                  `json:"externalWebAccess,omitempty"`
	Filters           *WebSearchFilters      `json:"filters,omitempty"`
	SearchContextSize string                 `json:"searchContextSize,omitempty"`
	UserLocation      *WebSearchUserLocation `json:"userLocation,omitempty"`
}

type WebSearchUserLocation struct {
	Type     string `json:"type"`
	Country  string `json:"country,omitempty"`
	City     string `json:"city,omitempty"`
	Region   string `json:"region,omitempty"`
	Timezone string `json:"timezone,omitempty"`
}