Struct OpenResponsesRequest

core/schema/openresponses.go:27–61

OpenResponsesRequest represents a request to the Open Responses API https://www.openresponses.org/specification

// OpenResponsesRequest represents a request to the Open Responses API
// https://www.openresponses.org/specification
type OpenResponsesRequest struct {
	Model              string            `json:"model"`
	Input              any               `json:"input"` // string or []ORItemParam
	Tools              []ORFunctionTool  `json:"tools,omitempty"`
	ToolChoice         any               `json:"tool_choice,omitempty"` // "auto"|"required"|"none"|{type:"function",name:"..."}
	Stream             bool              `json:"stream,omitempty"`
	MaxOutputTokens    *int              `json:"max_output_tokens,omitempty"`
	Temperature        *float64          `json:"temperature,omitempty"`
	TopP               *float64          `json:"top_p,omitempty"`
	Truncation         string            `json:"truncation,omitempty"` // "auto"|"disabled"
	Instructions       string            `json:"instructions,omitempty"`
	Reasoning          *ORReasoningParam `json:"reasoning,omitempty"`
	Metadata           map[string]string `json:"metadata,omitempty"`
	PreviousResponseID string            `json:"previous_response_id,omitempty"`

	// Additional parameters from spec
	TextFormat        any      `json:"text_format,omitempty"`         // TextResponseFormat or JsonSchemaResponseFormatParam
	ServiceTier       string   `json:"service_tier,omitempty"`        // "auto"|"default"|priority hint
	AllowedTools      []string `json:"allowed_tools,omitempty"`       // Restrict which tools can be invoked
	Store             *bool    `json:"store,omitempty"`               // Whether to store the response
	Include           []string `json:"include,omitempty"`             // What to include in response
	ParallelToolCalls *bool    `json:"parallel_tool_calls,omitempty"` // Allow parallel tool calls
	PresencePenalty   *float64 `json:"presence_penalty,omitempty"`    // Presence penalty (-2.0 to 2.0)
	FrequencyPenalty  *float64 `json:"frequency_penalty,omitempty"`   // Frequency penalty (-2.0 to 2.0)
	TopLogprobs       *int     `json:"top_logprobs,omitempty"`        // Number of top logprobs to return
	Background        *bool    `json:"background,omitempty"`          // Run request in background
	MaxToolCalls      *int     `json:"max_tool_calls,omitempty"`      // Maximum number of tool calls

	// OpenAI-compatible extensions (not in Open Responses spec)
	LogitBias map[string]float64 `json:"logit_bias,omitempty"` // Map of token IDs to bias values (-100 to 100)

	// Internal fields (like OpenAIRequest)
	Context context.Context    `json:"-"`
	Cancel  context.CancelFunc `json:"-"`
}

// ModelName implements the LocalAIRequest interface
func (r *OpenResponsesRequest) ModelName(s *string) string {