openai

package

v1.4.240 Latest Latest Go to latest Published: Jul 7, 2025 License: MIT Imports: 17 Imported by: 0

Details

Valid go.mod file
Redistributable license
Tagged version
Stable version
Learn more about best practices

Repository

github.com/danielmiessler/fabric

Links

Open Source Insights

Documentation ¶

Index ¶

Constants
Variables
type Client
type MessageConversionResult

Constants ¶

View Source

const ImageGenerationResponseType = "image_generation_call"

ImageGenerationResponseType is the type used for image generation calls in responses

View Source

const ImageGenerationToolType = "image_generation"

Variables ¶

View Source

var ImageGenerationSupportedModels = []string{
	"gpt-4o",
	"gpt-4o-mini",
	"gpt-4.1",
	"gpt-4.1-mini",
	"gpt-4.1-nano",
	"o3",
}

ImageGenerationSupportedModels lists all models that support image generation

Functions ¶

This section is empty.

Types ¶

type Client ¶

type Client struct {
	*plugins.PluginBase
	ApiKey              *plugins.SetupQuestion
	ApiBaseURL          *plugins.SetupQuestion
	ApiClient           *openai.Client
	ImplementsResponses bool // Whether this provider supports the Responses API
}

func NewClient ¶

func NewClient() (ret *Client)

func NewClientCompatible ¶

func NewClientCompatible(vendorName string, defaultBaseUrl string, configureCustom func() error) (ret *Client)

func NewClientCompatibleNoSetupQuestions ¶ added in v1.4.143

func NewClientCompatibleNoSetupQuestions(vendorName string, configureCustom func() error) (ret *Client)

func NewClientCompatibleWithResponses ¶ added in v1.4.222

func NewClientCompatibleWithResponses(vendorName string, defaultBaseUrl string, implementsResponses bool, configureCustom func() error) (ret *Client)

func (*Client) ListModels ¶

func (o *Client) ListModels() (ret []string, err error)

func (*Client) NeedsRawMode ¶ added in v1.4.192

func (o *Client) NeedsRawMode(modelName string) bool

func (*Client) Send ¶

func (o *Client) Send(ctx context.Context, msgs []*chat.ChatCompletionMessage, opts *common.ChatOptions) (ret string, err error)

func (*Client) SendStream ¶

func (o *Client) SendStream(
	msgs []*chat.ChatCompletionMessage, opts *common.ChatOptions, channel chan string,
) (err error)

type MessageConversionResult ¶ added in v1.4.222

type MessageConversionResult struct {
	Role            string
	Content         string
	MultiContent    []chat.ChatMessagePart
	HasMultiContent bool
}

MessageConversionResult holds the common conversion result

Source Files ¶

View all Source files

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