openresponses

package
v0.3.2 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Oct 16, 2026 License: Apache-2.0 Imports: 5 Imported by: 0

README

OpenResponses

openresponses.New provides language models for a Responses-compatible endpoint. BaseURL is required and includes the API prefix, for example https://example.com/v1. Requests use POST {BaseURL}/responses. Model, LanguageModel, and Responses select the same protocol implementation.

p := openresponses.New(openresponses.Options{
    Name:    "local",
    BaseURL: "http://localhost:1234/v1",
    APIKey:  "optional-key",
})
m := p.Model("my-model")

The implementation is shared with OpenAI Responses through openai.NewResponsesModel and openai.ResponsesConfig. It supports message and function-tool input, structured output, streamed text and reasoning, tool calls, usage, and typed stream errors. Generic endpoints do not infer OpenAI reasoning capabilities from model names. Provider options use the flat openresponses.ResponsesOptions shape; the endpoint must support any requested extensions. Responses item metadata uses the openai namespace for round trips through the shared message converter.

Per-call headers override configured headers. A configured API key is applied last as bearer authentication. HTTPClient allows a custom transport. Non-language model factories return nil.

Azure's Model and LanguageModel use Responses; Chat selects its deployment Chat Completions API. Azure refreshes TokenProvider on every request. Its Responses API version defaults to v1; explicit deployment APIs keep their own version default.

Hugging Face's Model and LanguageModel use https://router.huggingface.co/v1/responses. ResponsesBaseURL configures this endpoint independently of BaseURL, which serves inference modalities. TextGeneration selects prompt-based inference. Image generation and embeddings remain available through their inference model factories.

Documentation

Overview

Package openresponses provides a configurable Responses API provider.

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

Types

type Options

type Options struct {
	Name       string
	BaseURL    string
	APIKey     string
	Headers    map[string]string
	HTTPClient *http.Client
}

Options configures a Responses-compatible endpoint. BaseURL is required.

type Provider

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

func New

func New(opts Options) *Provider

func (*Provider) EmbeddingModel

func (p *Provider) EmbeddingModel(string) model.EmbeddingModel

func (*Provider) ID

func (p *Provider) ID() string

func (*Provider) ImageModel

func (p *Provider) ImageModel(string) model.ImageModel

func (*Provider) LanguageModel

func (p *Provider) LanguageModel(id string) model.LanguageModel

func (*Provider) Model

func (p *Provider) Model(id string) stream.Model

func (*Provider) RerankingModel

func (p *Provider) RerankingModel(string) model.RerankingModel

func (*Provider) Responses

func (p *Provider) Responses(id string) *openai.ResponsesModel

func (*Provider) SpeechModel

func (p *Provider) SpeechModel(string) model.SpeechModel

func (*Provider) TranscriptionModel

func (p *Provider) TranscriptionModel(string) model.TranscriptionModel

type ResponsesOptions

type ResponsesOptions = openai.ResponsesOptions

ResponsesOptions configures Responses requests.

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL