components

Documentation

Overview

components are the basic components supported by eino.

Index

• func GetType(component any) (string, bool)
• func IsCallbacksEnabled(i any) bool
• type Checker
• type Component
• type Typer

Functions

func GetType

func GetType(component any) (string, bool)

func IsCallbacksEnabled

func IsCallbacksEnabled(i any) bool

Types

type Checker

type Checker interface {
	IsCallbacksEnabled() bool
}

Checker tells callback aspect status of component's implementation When the Checker interface is implemented and returns true, the framework will not start the default aspect. Instead, the component will decide the callback execution location and the information to be injected.

type Component

type Component string

Component the name of different kinds of components

const (
	ComponentOfPrompt      Component = "ChatTemplate"
	ComponentOfChatModel   Component = "ChatModel"
	ComponentOfEmbedding   Component = "Embedding"
	ComponentOfIndexer     Component = "Indexer"
	ComponentOfRetriever   Component = "Retriever"
	ComponentOfLoader      Component = "Loader"
	ComponentOfTransformer Component = "DocumentTransformer"
	ComponentOfTool        Component = "Tool"
)

type Typer

type Typer interface {
	GetType() string
}

Typer get the type name of one component's implementation if Typer exists, the full name of the component instance will be {Typer}{Component} by default recommend using Camel Case Naming Style for Typer