openai

package

v1.9.19 Latest Latest Go to latest Published: Nov 21, 2025 License: Apache-2.0 Imports: 23 Imported by: 0

Details

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

Repository

github.com/docker/cagent

Links

Documentation ¶

Index ¶

func ConvertParametersToSchema(params any) (map[string]any, error)
type Client
- func NewClient(ctx context.Context, cfg *latest.ModelConfig, env environment.Provider, ...) (*Client, error)
type ResponseStreamAdapter
- func (a *ResponseStreamAdapter) Close()
- func (a *ResponseStreamAdapter) Recv() (chat.MessageStreamResponse, error)

Constants ¶

This section is empty.

Variables ¶

This section is empty.

Functions ¶

func ConvertParametersToSchema ¶ added in v1.7.0

func ConvertParametersToSchema(params any) (map[string]any, error)

ConvertParametersToSchema converts parameters to OpenAI Schema format

Types ¶

type Client ¶

type Client struct {
	base.Config
	// contains filtered or unexported fields
}

Client represents an OpenAI client wrapper It implements the provider.Provider interface

func NewClient ¶

func NewClient(ctx context.Context, cfg *latest.ModelConfig, env environment.Provider, opts ...options.Opt) (*Client, error)

NewClient creates a new OpenAI client from the provided configuration

func (*Client) CreateBatchEmbedding ¶ added in v1.9.16

func (c *Client) CreateBatchEmbedding(ctx context.Context, texts []string) (*base.BatchEmbeddingResult, error)

CreateBatchEmbedding generates embedding vectors for multiple texts.

OpenAI supports up to 2048 inputs per request

func (*Client) CreateChatCompletionStream ¶

func (c *Client) CreateChatCompletionStream(
	ctx context.Context,
	messages []chat.Message,
	requestTools []tools.Tool,
) (chat.MessageStream, error)

CreateChatCompletionStream creates a streaming chat completion request It returns a stream that can be iterated over to get completion chunks

func (*Client) CreateEmbedding ¶ added in v1.9.16

func (c *Client) CreateEmbedding(ctx context.Context, text string) (*base.EmbeddingResult, error)

CreateEmbedding generates an embedding vector for the given text

func (*Client) CreateResponseStream ¶ added in v1.9.18

func (c *Client) CreateResponseStream(
	ctx context.Context,
	messages []chat.Message,
	requestTools []tools.Tool,
) (chat.MessageStream, error)

type ResponseStreamAdapter ¶ added in v1.9.18

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

ResponseStreamAdapter adapts the OpenAI responses stream to our interface

func (*ResponseStreamAdapter) Close ¶ added in v1.9.18

func (a *ResponseStreamAdapter) Close()

Close closes the stream

func (*ResponseStreamAdapter) Recv ¶ added in v1.9.18

func (a *ResponseStreamAdapter) Recv() (chat.MessageStreamResponse, error)

Recv gets the next completion chunk

Source Files ¶

View all Source files

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