anthropic

Documentation

Overview

anthropic implements an API client for anthropic (https://docs.anthropic.com/en/api/getting-started)

Index

• type Callback
• type Client
  • func New(ApiKey string, opts ...client.ClientOpt) (*Client, error)
  • func (c *Client) Messages(ctx context.Context, messages []*schema.Message, opt ...Opt) ([]schema.Content, error)
• type Delta
• type Opt
  • func OptMaxTokens(v int) Opt
  • func OptModel(v string) Opt
  • func OptStopSequence(v string) Opt
  • func OptStream(fn Callback) Opt
  • func OptSystem(prompt string) Opt
  • func OptTemperature(v float64) Opt
  • func OptTool(tool *schema.Tool) Opt
  • func OptUser(v string) Opt
• type Usage

Types

type Callback

type Callback func(*Delta)

Stream response, which is called with each delta in the conversation or nil if the conversation is complete

type Client

type Client struct {
	*client.Client
}

func New

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

Create a new client

func (*Client) Messages

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

Send a structured list of input messages with text and/or image content, and the model will generate the next message in the conversation. Use a context to cancel the request, instead of the client-related timeout.

type Delta

type Delta struct {
	Type string `json:"type"`
	Text string `json:"text,omitempty"`
}

Delta for a message response which is streamed

type Opt

type Opt func(*reqMessage) error

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

func OptMaxTokens

func OptMaxTokens(v int) Opt

Set the maximum number of tokens

func OptModel

func OptModel(v string) Opt

Set the model

func OptStopSequence

func OptStopSequence(v string) Opt

Custom text sequence that will cause the model to stop generating.

func OptStream

func OptStream(fn Callback) Opt

Set streaming response

func OptSystem

func OptSystem(prompt string) Opt

Set system prompt

func OptTemperature

func OptTemperature(v float64) Opt

Amount of randomness injected into the response.

func OptTool

func OptTool(tool *schema.Tool) Opt

Add a tool

func OptUser

func OptUser(v string) Opt

An external identifier for the user who is associated with the request.

type Usage

type Usage struct {
	InputTokens  int `json:"input_tokens"`
	OutputTokens int `json:"output_tokens"`
}

Token usage for messages