mistral

README

Mistral API Client

This package provides a client for Mistral API, which is used to interact with the Mistral LLM models.

References:

• API https://docs.mistral.ai/api/
• Package https://pkg.go.dev/github.com/mutablelogic/go-client/pkg/mistral

Documentation

Overview

mistral implements an API client for mistral (https://docs.mistral.ai/api/)

Index

• type Callback
• type Client
  • func New(ApiKey string, opts ...client.ClientOpt) (*Client, error)
  • func (c *Client) Chat(ctx context.Context, messages []*schema.Message, opts ...Opt) ([]*schema.Content, error)
  • func (c *Client) CreateEmbedding(content any, opts ...Opt) (schema.Embeddings, error)
  • func (c *Client) ListModels() ([]Model, error)
• type Opt
  • func OptEncodingFormat(v string) Opt
  • func OptMaxTokens(v int) Opt
  • func OptModel(v string) Opt
  • func OptSafePrompt() Opt
  • func OptSeed(v int) Opt
  • func OptStream(fn Callback) Opt
  • func OptTemperature(v float32) Opt
  • func OptTool(value ...*schema.Tool) Opt

Types

type Callback

type Callback func(schema.MessageChoice)

Callback when new stream data is received

type Client

type Client struct {
	*client.Client
}

func New

func New(ApiKey string, opts ...client.ClientOpt) (*Client, error)

Create a new client

func (*Client) Chat

func (c *Client) Chat(ctx context.Context, messages []*schema.Message, opts ...Opt) ([]*schema.Content, error)

Chat creates a model response for the given chat conversation.

func (*Client) CreateEmbedding

func (c *Client) CreateEmbedding(content any, opts ...Opt) (schema.Embeddings, error)

CreateEmbedding creates an embedding from a string or array of strings

func (*Client) ListModels

func (c *Client) ListModels() ([]Model, error)

ListModels returns all the models

type Opt

type Opt func(*options) error

Opt is a function which can be used to set options on a request

func OptEncodingFormat

func OptEncodingFormat(v string) Opt

Set the embedding encoding format

func OptMaxTokens

func OptMaxTokens(v int) Opt

Set the maximum number of tokens

func OptModel

func OptModel(v string) Opt

Set the model

func OptSafePrompt

func OptSafePrompt() Opt

Inject a safety prompt before all conversations.

func OptSeed

func OptSeed(v int) Opt

The seed to use for random sampling. If set, different calls will generate deterministic results.

func OptStream

func OptStream(fn Callback) Opt

Set streaming response

func OptTemperature

func OptTemperature(v float32) Opt

Amount of randomness injected into the response.

func OptTool

func OptTool(value ...*schema.Tool) Opt

A list of tools the model may call.