groqerr

Documentation

Overview

Package groqerr provides error types for the groq-go library.

Index

• type APIError
  • func (e *APIError) Error() string
  • func (e *APIError) UnmarshalJSON(data []byte) (err error)
• type ErrContentFieldsMisused
  • func (e ErrContentFieldsMisused) Error() string
• type ErrRequest
  • func (e *ErrRequest) Error() string
  • func (e *ErrRequest) Unwrap() error
• type ErrTooManyEmptyStreamMessages
  • func (e ErrTooManyEmptyStreamMessages) Error() string
• type ErrToolNotFound
  • func (e ErrToolNotFound) Error() string
• type ErrorBuffer
• type ErrorResponse

Types

type APIError

type APIError struct {
	// Code is the code of the error.
	Code any `json:"code,omitempty"`
	// Message is the message of the error.
	Message string `json:"message"`
	// Param is the param of the error.
	Param *string `json:"param,omitempty"`
	// Type is the type of the error.
	Type string `json:"type"`
	// HTTPStatusCode is the status code of the error.
	HTTPStatusCode int `json:"-"`
}

APIError provides error information returned by the Groq API.

func (*APIError) Error

func (e *APIError) Error() string

Error method implements the error interface on APIError.

func (*APIError) UnmarshalJSON

func (e *APIError) UnmarshalJSON(data []byte) (err error)

UnmarshalJSON implements the json.Unmarshaler interface.

type ErrContentFieldsMisused

type ErrContentFieldsMisused struct{}

ErrContentFieldsMisused is an error that occurs when both Content and MultiContent properties are set.

func (ErrContentFieldsMisused) Error

func (e ErrContentFieldsMisused) Error() string

Error implements the error interface.

type ErrRequest

type ErrRequest struct {
	HTTPStatusCode int
	Err            error
}

ErrRequest is a request error.

func (*ErrRequest) Error

func (e *ErrRequest) Error() string

Error implements the error interface.

func (*ErrRequest) Unwrap

func (e *ErrRequest) Unwrap() error

Unwrap unwraps the error.

type ErrTooManyEmptyStreamMessages

type ErrTooManyEmptyStreamMessages struct{}

ErrTooManyEmptyStreamMessages is returned when the stream has sent too many empty messages.

func (ErrTooManyEmptyStreamMessages) Error

func (e ErrTooManyEmptyStreamMessages) Error() string

Error returns the error message.

type ErrToolNotFound

type ErrToolNotFound struct {
	ToolName string
}

ErrToolNotFound is returned when a tool is not found.

func (ErrToolNotFound) Error

func (e ErrToolNotFound) Error() string

Error implements the error interface.

type ErrorBuffer

type ErrorBuffer interface {
	io.Writer
	Len() int
	Bytes() []byte
}

ErrorBuffer is a buffer that allows for appending errors.

type ErrorResponse

type ErrorResponse struct {
	Error *APIError `json:"error,omitempty"`
}

ErrorResponse is the response returned by the Groq API.