joytoken

package module

Go to main page

Versions in this module

v0

v0.2.1

Sep 2, 2026

Changes in this version

type Client

+ func (c *Client) EditImage(ctx context.Context, request ImageEditRequest) (*ImageGenerationResponse, error)

+ type ImageEditRequest struct

+ Image any

+ Model string

+ N *int

+ Prompt string

+ ResponseFormat string

+ Size string

+ User string

v0.2.0

Sep 2, 2026

Changes in this version

type MessageContentBlock

+ ThoughtSignature string

v0.1.6

Sep 2, 2026

v0.1.5

Aug 31, 2026

Changes in this version

+ const OrchestrationFinalTaskID

+ const OrchestrationPhasePlanning

+ const OrchestrationPlannerTaskID

type ChatCompletionChunk

+ Error map[string]any

+ MetadataList []OrchestrationTaskMeta

+ Orchestration *ChunkOrchestration

+ func (c *ChatCompletionChunk) UnmarshalJSON(data []byte) error

type ChatCompletionResponse

+ Error map[string]any

+ MetadataList []OrchestrationTaskMeta

+ Plan []PlanEntry

+ func (r *ChatCompletionResponse) IsOrchestrated() bool

+ func (r *ChatCompletionResponse) UnmarshalJSON(data []byte) error

+ type ChunkOrchestration struct

+ Phase string

+ Plan []PlanEntry

+ TaskID string

+ TaskSeq int

+ TaskStatus string

+ Title string

+ func (o *ChunkOrchestration) IsPlanning() bool

+ type OrchestrationBilling struct

+ CachedInputTokens int

+ CachedOutputTokens int

+ CreditsUsed string

+ InputTokens int

+ OutputTokens int

+ type OrchestrationLatency struct

+ RoutingMS int

+ type OrchestrationTaskMeta struct

+ Billing *OrchestrationBilling

+ Extra map[string]any

+ Latency *OrchestrationLatency

+ Model string

+ RequestID string

+ Tag []string

+ TaskID string

+ TaskSeq int

+ TaskStatus string

+ Tier string

+ type PlanEntry struct

+ Seq int

+ TaskID string

+ Title string

type RunChatStreamOptions

+ OnOrchestration func(event *ChunkOrchestration)

+ OnPlan func(plan []PlanEntry)

v0.1.4

Aug 28, 2026

v0.1.3

Aug 28, 2026

Changes in this version

type MessageContentBlock

+ ExtraContent map[string]any

type ResponseInputItem

+ ExtraContent map[string]any

type ResponseOutputItem

+ ExtraContent map[string]any

v0.1.2

Aug 28, 2026

Changes in this version

+ func RequestIDFromMetadata(metadata map[string]any) string

type ChatCompletionChunk

+ func (c *ChatCompletionChunk) RequestID() string

type ChatCompletionResponse

+ func (r *ChatCompletionResponse) RequestID() string

type ImageGenerationResponse

+ func (r *ImageGenerationResponse) RequestID() string

type MessageResponse

+ func (r *MessageResponse) RequestID() string

type MessageStreamEvent

+ func (e *MessageStreamEvent) RequestID() string

type Response

+ func (r *Response) RequestID() string

type ResponseStreamEvent

+ func (e *ResponseStreamEvent) RequestID() string

v0.1.1

Aug 28, 2026

Changes in this version

type APIError

+ Code ErrorCode

type ChatCompletionChunk

+ Metadata map[string]any

type ChatCompletionResponse

+ Metadata map[string]any

type Client

+ func (c *Client) RunChatCompletion(ctx context.Context, request ChatCompletionRequest, opts RunChatOptions) (*RunChatResult, error)

+ func (c *Client) RunChatCompletionStream(ctx context.Context, request ChatCompletionRequest, opts RunChatStreamOptions) (*RunChatResult, error)

+ func (c *Client) RunMessage(ctx context.Context, request MessageRequest, opts RunMessageOptions) (*RunMessageResult, error)

+ func (c *Client) RunMessageStream(ctx context.Context, request MessageRequest, opts RunMessageStreamOptions) (*RunMessageResult, error)

+ func (c *Client) RunResponse(ctx context.Context, request ResponseRequest, opts RunResponseOptions) (*RunResponseResult, error)

+ func (c *Client) RunResponseStream(ctx context.Context, request ResponseRequest, opts RunResponseStreamOptions) (*RunResponseResult, error)

+ type ErrorCode string

+ const ErrorCodeAuthentication

+ const ErrorCodeInvalidRequest

+ const ErrorCodeNetwork

+ const ErrorCodeNotFound

+ const ErrorCodePermission

+ const ErrorCodeRateLimited

+ const ErrorCodeServerError

+ const ErrorCodeTimeout

+ const ErrorCodeUnknown

+ type FilePermissionFunc func(ctx context.Context, request FilePermissionRequest) (allow bool, err error)

+ type FilePermissionRequest struct

+ Input any

+ Root string

+ Step int

+ ToolName string

+ type FinishReasonKind int

+ const FinishContentFilter

+ const FinishLength

+ const FinishMalformedToolCall

+ const FinishStop

+ const FinishToolCalls

+ const FinishUnknown

+ func (k FinishReasonKind) String() string

type MessageRequest

+ ToolChoice any

+ type MessageToolChoice struct

+ Name string

+ Type string

+ type MessageToolStep struct

+ Index int

+ Response *MessageResponse

+ ToolResults []ToolCallResult

+ Usage *MessageUsage

type Option

+ func WithDefaultBuiltinTools(enabled bool) Option

+ func WithDefaultLocalTools(enabled bool) Option

+ func WithFilePermission(ask FilePermissionFunc) Option

+ func WithFileWorkspace(root string) Option

+ func WithMaxRetries(maxRetries int) Option

+ func WithShellPermission(ask ShellPermissionFunc) Option

+ func WithShellWorkspace(dir string) Option

+ func WithToolHandler(name, description string, parameters map[string]any, execute ToolExecuteFunc) Option

+ func WithTools(tools ...Tool) Option

+ func WithoutDefaultTools(names ...string) Option

type Response

+ CreatedAt int64

+ Error map[string]any

+ IncompleteDetails map[string]any

type ResponseInputItem

+ Arguments string

+ CallID string

+ EncryptedContent string

+ ID string

+ Name string

+ Output string

+ Status string

+ Summary []any

type ResponseOutputItem

+ Action map[string]any

+ Arguments string

+ CallID string

+ EncryptedContent string

+ Name string

+ Results []any

+ Summary []any

type ResponseRequest

+ Include []string

+ Metadata map[string]any

+ ParallelToolCalls *bool

+ PreviousResponseID string

+ Store *bool

+ Tier string

+ ToolChoice any

type ResponseStreamEvent

+ Arguments string

+ Error map[string]any

type ResponseTool

+ Filters map[string]any

+ MaxNumResults *int

+ RankingOptions *ResponseToolRankingOptions

+ SearchContextSize string

+ Strict *bool

+ UserLocation *ResponseToolUserLocation

+ VectorStoreIDs []string

+ type ResponseToolRankingOptions struct

+ Ranker string

+ ScoreThreshold *float64

+ type ResponseToolStep struct

+ Index int

+ Response *Response

+ ToolResults []ToolCallResult

+ Usage *ResponseUsage

+ type ResponseToolUserLocation struct

+ City string

+ Country string

+ Region string

+ Timezone string

+ Type string

+ type RunChatOptions struct

+ MaxSteps int

+ type RunChatResult struct

+ FinalText string

+ FinishReason string

+ Messages []ChatMessage

+ Steps []ToolStep

+ StoppedBy string

+ type RunChatStreamOptions struct

+ MaxSteps int

+ OnTextDelta func(delta string)

+ OnToolResult func(result ToolCallResult)

+ type RunMessageOptions struct

+ MaxSteps int

+ type RunMessageResult struct

+ FinalText string

+ Messages []MessageParam

+ Steps []MessageToolStep

+ StoppedBy string

+ type RunMessageStreamOptions struct

+ MaxSteps int

+ OnTextDelta func(delta string)

+ OnToolResult func(result ToolCallResult)

+ type RunResponseOptions struct

+ MaxSteps int

+ type RunResponseResult struct

+ FinalText string

+ Input []ResponseInputItem

+ Steps []ResponseToolStep

+ StoppedBy string

+ type RunResponseStreamOptions struct

+ MaxSteps int

+ OnTextDelta func(delta string)

+ OnToolResult func(result ToolCallResult)

+ type ShellPermissionFunc func(ctx context.Context, request ShellPermissionRequest) (allow bool, err error)

+ type ShellPermissionRequest struct

+ Command string

+ Input any

+ Step int

+ ToolName string

+ WorkingDir string

+ type Tool = tooldef.Tool

+ func DefineTool(t Tool) Tool

+ type ToolCallResult struct

+ Content string

+ IsError bool

+ ToolCallID string

+ ToolName string

+ type ToolExecuteFunc = tooldef.ToolExecuteFunc

+ type ToolExecutionContext = tooldef.ToolExecutionContext

+ type ToolStep struct

+ AssistantMessage ChatMessage

+ FinishReason string

+ Index int

+ ToolResults []ToolCallResult

+ Usage *Usage

v0.1.0

Aug 10, 2026

Changes in this version

+ const ModelAuto

+ var ErrMissingAPIKey = errors.New("joytoken API key is required; pass WithAPIKey or set JOY_TOKEN_API_KEY")

+ func IsAPIError(err error) bool

+ type APIError struct

+ Body any

+ RequestID string

+ ResponseHeaders http.Header

+ StatusCode int

+ func (e *APIError) Error() string

+ type CatalogOption struct

+ Label string

+ Value string

+ type ChatCompletionChoice struct

+ FinishReason string

+ Index int

+ Logprobs any

+ Message ChatMessage

+ type ChatCompletionChunk struct

+ Choices []ChatCompletionChunkChoice

+ Created int64

+ ID string

+ Model string

+ Object string

+ Usage *Usage

+ type ChatCompletionChunkChoice struct

+ Delta map[string]any

+ FinishReason string

+ Index int

+ Logprobs any

+ type ChatCompletionRequest struct

+ MaxTokens *int

+ Messages []ChatMessage

+ Metadata map[string]any

+ Model string

+ Stop any

+ Stream bool

+ Temperature *float64

+ Tier string

+ ToolChoice any

+ Tools []ChatTool

+ TopP *float64

+ type ChatCompletionResponse struct

+ Choices []ChatCompletionChoice

+ Created int64

+ ID string

+ Model string

+ Object string

+ Usage *Usage

+ type ChatCompletionStream struct

+ func (s *ChatCompletionStream) Close() error

+ func (s *ChatCompletionStream) Recv() (*ChatCompletionChunk, error)

+ type ChatMessage struct

+ Content any

+ Name string

+ Role string

+ ToolCallID string

+ ToolCalls []ToolCall

+ type ChatTool struct

+ Function ChatToolFunction

+ Type string

+ type ChatToolFunction struct

+ Description string

+ Name string

+ Parameters map[string]any

+ type Client struct

+ func NewClient(opts ...Option) *Client

+ func (c *Client) CreateChatCompletion(ctx context.Context, request ChatCompletionRequest) (*ChatCompletionResponse, error)

+ func (c *Client) CreateMessage(ctx context.Context, request MessageRequest) (*MessageResponse, error)

+ func (c *Client) CreateResponse(ctx context.Context, request ResponseRequest) (*Response, error)

+ func (c *Client) GenerateImage(ctx context.Context, request ImageGenerationRequest) (*ImageGenerationResponse, error)

+ func (c *Client) GetModelMeta(ctx context.Context) (*ModelMetadataResponse, error)

+ func (c *Client) GetPricing(ctx context.Context) (*PricingResponse, error)

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

+ func (c *Client) ListModelsWithOptions(ctx context.Context, options ListModelsOptions) (*ModelListResponse, error)

+ func (c *Client) StreamChatCompletion(ctx context.Context, request ChatCompletionRequest) (*ChatCompletionStream, error)

+ func (c *Client) StreamMessage(ctx context.Context, request MessageRequest) (*MessageStream, error)

+ func (c *Client) StreamResponse(ctx context.Context, request ResponseRequest) (*ResponseStream, error)

+ type GeneratedImage struct

+ B64JSON string

+ RevisedPrompt string

+ URL string

+ type HTTPClient interface

+ Do func(req *http.Request) (*http.Response, error)

+ type ImageGenerationRequest struct

+ Background string

+ Model string

+ Moderation string

+ N *int

+ OutputCompression *int

+ OutputFormat string

+ Prompt string

+ Quality string

+ ResponseFormat string

+ Size string

+ Style string

+ User string

+ type ImageGenerationResponse struct

+ Created int64

+ Data []GeneratedImage

+ Metadata map[string]any

+ type ListModelsOptions struct

+ Locale ModelLocale

+ type MessageContentBlock struct

+ Content any

+ ID string

+ Input map[string]any

+ Name string

+ Text string

+ ToolUseID string

+ Type string

+ type MessageParam struct

+ Content any

+ Role string

+ type MessageRequest struct

+ MaxTokens int

+ Messages []MessageParam

+ Metadata map[string]any

+ Model string

+ Stream bool

+ System any

+ Temperature *float64

+ Tier string

+ Tools []MessageTool

+ type MessageResponse struct

+ Content []MessageContentBlock

+ ID string

+ Metadata map[string]any

+ Model string

+ Role string

+ StopReason *string

+ StopSequence *string

+ Type string

+ Usage MessageUsage

+ type MessageStream struct

+ func (s *MessageStream) Close() error

+ func (s *MessageStream) Recv() (*MessageStreamEvent, error)

+ type MessageStreamEvent struct

+ ContentBlock *MessageContentBlock

+ Delta map[string]any

+ Error map[string]any

+ Index *int

+ Message *MessageResponse

+ Metadata map[string]any

+ Type string

+ Usage *MessageUsage

+ type MessageTool struct

+ Description string

+ InputSchema map[string]any

+ Name string

+ type MessageUsage struct

+ CacheCreationInputTokens int

+ CacheReadInputTokens int

+ InputTokens int

+ OutputTokens int

+ type ModelInfo struct

+ Alias string

+ CustomerCachereadMtok float64

+ CustomerCachewriteMtok float64

+ CustomerImageCachedInputMtok string

+ CustomerImageInputMtok string

+ CustomerImageOutputMtok string

+ CustomerInputMtok float64

+ CustomerOutputMtok float64

+ Description string

+ DisplayName string

+ FeatureTags []string

+ MCIScore float64

+ ModelID string

+ ModelKey string

+ Provider string

+ ScenarioTags []string

+ Tags []string

+ Tier string

+ type ModelListData struct

+ Models []ModelInfo

+ type ModelListResponse struct

+ Code int

+ Data ModelListData

+ Message string

+ Object string

+ type ModelLocale string

+ const ModelLocaleEN

+ const ModelLocaleZH

+ type ModelMetadata struct

+ FeatureTags []CatalogOption

+ IndustryPacks []CatalogOption

+ Providers []CatalogOption

+ SKUs []CatalogOption

+ Tiers []CatalogOption

+ UpdatedAt string

+ type ModelMetadataResponse struct

+ Code int

+ Data ModelMetadata

+ Message string

+ type Option func(*Client)

+ func WithAPIBaseURL(apiBaseURL string) Option

+ func WithAPIKey(apiKey string) Option

+ func WithAnthropicBaseURL(anthropicBaseURL string) Option

+ func WithAnthropicVersion(anthropicVersion string) Option

+ func WithHTTPClient(httpClient HTTPClient) Option

+ func WithHeader(key, value string) Option

+ func WithOpenAIBaseURL(openAIBaseURL string) Option

+ func WithTimeout(timeout time.Duration) Option

+ type Pricing struct

+ CurrentVersion string

+ SKUs []PricingSKU

+ Tiers []PricingTier

+ UpdatedAt string

+ type PricingResponse struct

+ Code int

+ Data Pricing

+ Message string

+ type PricingSKU struct

+ Code string

+ Description string

+ Name string

+ type PricingTier struct

+ Code string

+ CreditsPerUSD string

+ Description string

+ Name string

+ RateVersion string

+ SortOrder int32

+ USDPerCredit string

+ Unit string

+ UpdatedAt string

+ type Response struct

+ ID string

+ Metadata map[string]any

+ Model string

+ Object string

+ Output []ResponseOutputItem

+ Status string

+ Usage *ResponseUsage

+ func (r *Response) OutputText() string

+ type ResponseInputContentPart struct

+ Text string

+ Type string

+ type ResponseInputItem struct

+ Content any

+ Role string

+ Type string

+ type ResponseOutputContent struct

+ Annotations []any

+ Text string

+ Type string

+ type ResponseOutputItem struct

+ Content []ResponseOutputContent

+ ID string

+ Role string

+ Status string

+ Type string

+ type ResponseRequest struct

+ Input any

+ Instructions string

+ MaxOutputTokens *int

+ Model string

+ Stream bool

+ Temperature *float64

+ Tools []ResponseTool

+ TopP *float64

+ type ResponseStream struct

+ func (s *ResponseStream) Close() error

+ func (s *ResponseStream) Recv() (*ResponseStreamEvent, error)

+ type ResponseStreamEvent struct

+ ContentIndex int

+ Delta string

+ Item *ResponseOutputItem

+ ItemID string

+ OutputIndex int

+ Part *ResponseOutputContent

+ Response *Response

+ SequenceNumber int

+ Text string

+ Type string

+ type ResponseTool struct

+ Description string

+ Name string

+ Parameters map[string]any

+ Type string

+ type ResponseUsage struct

+ InputTokens int

+ OutputTokens int

+ TotalTokens int

+ type ToolCall struct

+ Function ToolFunction

+ ID string

+ Type string

+ type ToolFunction struct

+ Arguments string

+ Name string

+ type Usage struct

+ CompletionTokens int

+ Cost *float64

+ PromptTokens int

+ TotalCost *float64

+ TotalTokens int

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL