openai

package

v0.5.1 Latest Latest Go to latest Published: Sep 2, 2025 License: Apache-2.0 Imports: 12 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 ¶

type Client
- func NewClient(ctx context.Context, cfg *latest.ModelConfig, env environment.Provider, ...) (*Client, error)
type StreamAdapter
- func (a *StreamAdapter) Close()
- func (a *StreamAdapter) Recv() (chat.MessageStreamResponse, error)

Constants ¶

This section is empty.

Variables ¶

This section is empty.

Functions ¶

This section is empty.

Types ¶

type Client ¶

type Client struct {
	// 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) CreateChatCompletion ¶

func (c *Client) CreateChatCompletion(
	ctx context.Context,
	messages []chat.Message,
) (string, error)

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) ID ¶

func (c *Client) ID() string

type StreamAdapter ¶

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

StreamAdapter adapts the OpenAI stream to our interface

func (*StreamAdapter) Close ¶

func (a *StreamAdapter) Close()

Close closes the stream

func (*StreamAdapter) Recv ¶

func (a *StreamAdapter) 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