gigachat

README

go-gigachat

GigaChat REST API

Go client for Gigachat API: (https://developers.sber.ru)

Documentation

Index

• Constants
• type ChatRequest
• type ChatResponse
• type Choice
• type Client
  • func NewClient(clientId string, clientSecret string) (*Client, error)
  • func NewClientWithConfig(config *Config) (*Client, error)
  • func NewInsecureClient(clientId string, clientSecret string) (*Client, error)
  • func (c *Client) Auth() error
  • func (c *Client) AuthWithContext(ctx context.Context) error
  • func (c *Client) Chat(in *ChatRequest) (*ChatResponse, error)
  • func (c *Client) ChatWithContext(ctx context.Context, in *ChatRequest) (*ChatResponse, error)
  • func (c *Client) Model(model string) (*Model, error)
  • func (c *Client) ModelWithContext(ctx context.Context, model string) (*Model, error)
  • func (c *Client) Models() (*ModelListResponse, error)
  • func (c *Client) ModelsWithContext(ctx context.Context) (*ModelListResponse, error)
• type Config
• type Message
• type Model
• type ModelListResponse
• type OAuthResponse
• type Token
  • func (t *Token) Active() bool
  • func (t *Token) Get() string
  • func (t *Token) Set(value string, expiresAt time.Time)
• type Usage

Constants

const (
	AuthUrl    = "https://ngw.devices.sberbank.ru:9443/api/"
	BaseUrl    = "https://gigachat.devices.sberbank.ru/api/"
	OAuthPath  = "v2/oauth"
	ModelsPath = "v1/models"
	ChatPath   = "v1/chat/completions"
)

const (
	ScopeApiIndividual = "GIGACHAT_API_PERS"
	ScopeApiBusiness   = "GIGACHAT_API_CORP"
)

const (
	UserRole      = "user"
	AssistantRole = "assistant"
	SystemRole    = "system"
)

const (
	ModelLatest = "GigaChat:latest"
)

Types

type ChatRequest

type ChatRequest struct {
	Model             string    `json:"model"`
	Messages          []Message `json:"messages"`
	Temperature       *float64  `json:"temperature"`
	TopP              *float64  `json:"top_p"`
	N                 *int64    `json:"n"`
	Stream            *bool     `json:"stream"`
	MaxTokens         *int64    `json:"max_tokens"`
	RepetitionPenalty *float64  `json:"repetition_penalty"`
	UpdateInterval    *int64    `json:"update_interval"`
}

type ChatResponse

type ChatResponse struct {
	Model   string   `json:"model"`
	Created int64    `json:"created"`
	Method  string   `json:"object"`
	Choices []Choice `json:"choices"`
	Usage   Usage    `json:"usage"`
}

type Choice

type Choice struct {
	Index        int64  `json:"index"`
	FinishReason string `json:"finish_reason"`
	Message      Message
}

type Client

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

func NewClient

func NewClient(clientId string, clientSecret string) (*Client, error)

func NewClientWithConfig

func NewClientWithConfig(config *Config) (*Client, error)

NewClientWithConfig creates a new GigaChat client with the specified configuration.

func NewInsecureClient

func NewInsecureClient(clientId string, clientSecret string) (*Client, error)

NewInsecureClient creates a new GigaChat client with InsecureSkipVerify because GigaChat uses a weird certificate authority.

func (*Client) Auth

func (c *Client) Auth() error

func (*Client) AuthWithContext

func (c *Client) AuthWithContext(ctx context.Context) error

func (*Client) Chat

func (c *Client) Chat(in *ChatRequest) (*ChatResponse, error)

func (*Client) ChatWithContext

func (c *Client) ChatWithContext(ctx context.Context, in *ChatRequest) (*ChatResponse, error)

func (*Client) Model

func (c *Client) Model(model string) (*Model, error)

func (*Client) ModelWithContext

func (c *Client) ModelWithContext(ctx context.Context, model string) (*Model, error)

func (*Client) Models

func (c *Client) Models() (*ModelListResponse, error)

func (*Client) ModelsWithContext

func (c *Client) ModelsWithContext(ctx context.Context) (*ModelListResponse, error)

type Config

type Config struct {
	AuthUrl      string
	BaseUrl      string
	ClientId     string
	ClientSecret string
	Scope        string
	Insecure     bool
}

type Message

type Message struct {
	Role    string `json:"role"`
	Content string `json:"content"`
}

type Model

type Model struct {
	Id      string `json:"id"`
	Type    string `json:"object"`
	OwnedBy string `json:"owned_by"`
}

type ModelListResponse

type ModelListResponse struct {
	Models []Model `json:"data"`
	Type   string  `json:"object"`
}

type OAuthResponse

type OAuthResponse struct {
	AccessToken string `json:"access_token"`
	ExpiresAt   int64  `json:"expires_at"`
}

type Token

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

func (*Token) Active

func (t *Token) Active() bool

func (*Token) Get

func (t *Token) Get() string

func (*Token) Set

func (t *Token) Set(value string, expiresAt time.Time)

type Usage

type Usage struct {
	PromptTokens     int64 `json:"prompt_tokens"`
	CompletionTokens int64 `json:"completion_tokens"`
	TotalTokens      int64 `json:"total_tokens"`
}