schema

package
v1.6.7 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Sep 16, 2025 License: MIT Imports: 5 Imported by: 0

Documentation

Overview

Pachage schema include BaseIOSchema etc.

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

func Stringify added in v1.0.1

func Stringify(s Schema) string

func ToMessage added in v1.6.4

func ToMessage(s Schema, dist *instructor.Message)

Types

type Attachement

type Attachement struct {
	// ImageURL attached image_url
	ImageURLs []string `json:"image_url,omitempty"`
	// Files attached file
	Files []io.Reader `json:"file,omitempty"`
	// FileIDs llm FileIDs
	FileIDs []string `json:"file_id,omitempty"`
	// VideoURLs
	VideoURLs []string `json:"video_url,omitempty"`
}

Attachement message attachement

type Base

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

Base is a base schema

func (Base) Attachement

func (r Base) Attachement() *Attachement

Attachement returns schema attachement

func (Base) Chunks added in v1.2.1

func (r Base) Chunks() []Schema

func (Base) ExtraBody added in v1.4.7

func (r Base) ExtraBody() map[string]any

func (*Base) SetAttachement added in v1.0.1

func (r *Base) SetAttachement(attach *Attachement)

Attachement returns schema attachement

func (*Base) SetExtraBody added in v1.4.7

func (r *Base) SetExtraBody(v map[string]any)

type Input

type Input struct {
	Base
	// ChatMessage is the chat message sent by the user to the assistant.
	ChatMessage string `` /* 134-byte string literal not displayed */
}

Input implements BaseAgentInputSchema This schema represents the input from the user to the AI agent.

func CreateInput added in v1.0.1

func CreateInput(chatMessage string) Input

CreateeInput returns a BaseAgentInput

func NewInput

func NewInput(chatMessage string) *Input

NewInput returns a new BaseAgentInput

func (Input) String

func (i Input) String() string

type Output

type Output struct {
	Base
	// ChatMessage is the chat message exchanged between the user and the chat agent.
	// contains the markdown-enabled response generated by the chat agent.
	ChatMessage string `` /* 218-byte string literal not displayed */
}

Output implements BaseAgentOutputSchema This schema represents the response generated by the chat agent.

func CreateOutput added in v1.0.1

func CreateOutput(chatMessage string) Output

CreateOutput returns a BaseAgentOutput

func NewOutput

func NewOutput(chatMessage string) *Output

NewOutput returns a new BaseAgentOutput

type Schema

type Schema interface {
	// Attachement() returns schema attchement
	Attachement() *Attachement
	// Chunks() returns additional schema chunks
	Chunks() []Schema
	// ExtraBody
	ExtraBody() map[string]any
}

Schema is message schema interface

type SchemaPointer added in v1.0.8

type SchemaPointer interface {
	Schema
	SetAttachement(*Attachement)
	SetExtraBody(map[string]any)
}

type String

type String struct {
	Base
	// contains filtered or unexported fields
}

func NewString added in v1.4.7

func NewString(str string) *String

func (String) Bytes added in v1.4.7

func (s String) Bytes() []byte

func (String) MarshalYAML added in v1.5.0

func (s String) MarshalYAML() (any, error)

func (String) String

func (s String) String() string

func (*String) Unmarshal added in v1.3.6

func (s *String) Unmarshal(bs []byte) error

type Stringer added in v1.3.3

type Stringer interface {
	String() string
}

Jump to

Keyboard shortcuts

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