openai

type IncludeType string

type LanguageModelExtraContentFunc = func(choice openai.ChatCompletionChoice) []fantasy.Content

type LanguageModelMapFinishReasonFunc = func(finishReason string) fantasy.FinishReason

type LanguageModelOption = func(*languageModel)

type LanguageModelPrepareCallFunc = func(model fantasy.LanguageModel, params *openai.ChatCompletionNewParams, call fantasy.Call) ([]fantasy.CallWarning, error)

type LanguageModelStreamExtraFunc = func(chunk openai.ChatCompletionChunk, yield func(fantasy.StreamPart) bool, ctx map[string]any) (map[string]any, bool)

type LanguageModelStreamProviderMetadataFunc = func(choice openai.ChatCompletionChoice, metadata fantasy.ProviderMetadata) fantasy.ProviderMetadata

type LanguageModelStreamUsageFunc = func(chunk openai.ChatCompletionChunk, ctx map[string]any, metadata fantasy.ProviderMetadata) (fantasy.Usage, fantasy.ProviderMetadata)

type LanguageModelToPromptFunc = func(prompt fantasy.Prompt, provider, model string) ([]openai.ChatCompletionMessageParamUnion, []fantasy.CallWarning)

type LanguageModelUsageFunc = func(choice openai.ChatCompletion) (fantasy.Usage, fantasy.ProviderOptionsData)

type Option = func(*options)

type ProviderFileOptions struct {
	ImageDetail string `json:"image_detail"`
}

type ProviderMetadata struct {
	Logprobs                 []openai.ChatCompletionTokenLogprob `json:"logprobs"`
	AcceptedPredictionTokens int64                               `json:"accepted_prediction_tokens"`
	RejectedPredictionTokens int64                               `json:"rejected_prediction_tokens"`
}

type ProviderOptions struct {
	LogitBias           map[string]int64 `json:"logit_bias"`
	LogProbs            *bool            `json:"log_probs"`
	TopLogProbs         *int64           `json:"top_log_probs"`
	ParallelToolCalls   *bool            `json:"parallel_tool_calls"`
	User                *string          `json:"user"`
	ReasoningEffort     *ReasoningEffort `json:"reasoning_effort"`
	MaxCompletionTokens *int64           `json:"max_completion_tokens"`
	TextVerbosity       *string          `json:"text_verbosity"`
	Prediction          map[string]any   `json:"prediction"`
	Store               *bool            `json:"store"`
	Metadata            map[string]any   `json:"metadata"`
	PromptCacheKey      *string          `json:"prompt_cache_key"`
	SafetyIdentifier    *string          `json:"safety_identifier"`
	ServiceTier         *string          `json:"service_tier"`
	StructuredOutputs   *bool            `json:"structured_outputs"`
}

type ReasoningEffort string

type ResponsesProviderMetadata struct {
	ResponseID string `json:"response_id"`
}

type ResponsesProviderOptions struct {
	Include           []IncludeType  `json:"include"`
	Instructions      *string        `json:"instructions"`
	Logprobs          any            `json:"logprobs"`
	MaxToolCalls      *int64         `json:"max_tool_calls"`
	Metadata          map[string]any `json:"metadata"`
	ParallelToolCalls *bool          `json:"parallel_tool_calls"`
	// PreviousResponseID chains this request to a prior stored response, enabling
	// server-side conversation state. When set, the prompt should contain only the
	// new incremental turn—not replayed assistant history.
	PreviousResponseID *string          `json:"previous_response_id"`
	PromptCacheKey     *string          `json:"prompt_cache_key"`
	ReasoningEffort    *ReasoningEffort `json:"reasoning_effort"`
	ReasoningSummary   *string          `json:"reasoning_summary"`
	SafetyIdentifier   *string          `json:"safety_identifier"`
	ServiceTier        *ServiceTier     `json:"service_tier"`
	// Store indicates whether OpenAI should persist this response for future
	// retrieval and chaining via PreviousResponseID. Defaults to false to prevent
	// unintended storage of potentially sensitive conversations.
	Store            *bool          `json:"store"`
	StrictJSONSchema *bool          `json:"strict_json_schema"`
	TextVerbosity    *TextVerbosity `json:"text_verbosity"`
	User             *string        `json:"user"`
}

type ResponsesReasoningMetadata struct {
	ItemID           string   `json:"item_id"`
	EncryptedContent *string  `json:"encrypted_content"`
	Summary          []string `json:"summary"`
}

type SearchContextSize string

type ServiceTier string

type TextVerbosity string

type WebSearchAction struct {
	// Type is the kind of action: "search", "open_page", or "find".
	Type string `json:"type"`
	// Query is the search query (present when Type is "search").
	Query string `json:"query,omitempty"`
	// Sources are the results returned by the search.
	Sources []WebSearchSource `json:"sources,omitempty"`
}

type WebSearchCallMetadata struct {
	// ItemID is the server-side ID of the web_search_call output item.
	ItemID string `json:"item_id"`
	// Action contains the structured action data from the search.
	Action *WebSearchAction `json:"action,omitempty"`
}

type WebSearchSource struct {
	Type string `json:"type"`
	URL  string `json:"url"`
}

type WebSearchToolOptions struct {
	// SearchContextSize controls the amount of context window
	// space used for search results. Defaults to medium.
	SearchContextSize SearchContextSize
	// AllowedDomains restricts search results to these domains.
	// Subdomains are included automatically.
	AllowedDomains []string
	// UserLocation provides geographic context for more
	// relevant search results.
	UserLocation *WebSearchUserLocation
}

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