entity

Documentation

Index

• Variables
• type Data
• type Entity
  • func (e *Entity) NodeID() string
  • func (e *Entity) String() string
  • func (e *Entity) Type() string
• type EntityExtractor
  • func NewEntityExtractor(llm llm.LLM, opts ...Option) *EntityExtractor
  • func (ee *EntityExtractor) Extract(ctx context.Context, text string) ([]Record, error)
• type Option
  • func WithEntityTypes(types []string) Option
• type Record
• type Relationship
  • func (e *Relationship) NodeID() string
  • func (r *Relationship) String() string
  • func (r *Relationship) Type() string

Variables

var DefaultEntityTypes = []string{"organization", "person", "policy", "bill", "geo", "event", "role", "electorate"}

Types

type Data

type Data struct {
	prompts.PromptData
	EntityTypes []string
	InputText   string
}

type Entity

type Entity struct {
	Name        string
	Description string
	Embedding   []float32
	// contains filtered or unexported fields
}

func (*Entity) NodeID

func (e *Entity) NodeID() string

func (*Entity) String

func (e *Entity) String() string

func (*Entity) Type

func (e *Entity) Type() string

type EntityExtractor

type EntityExtractor struct {
	ExtractionPrompt string
	EntityTypes      []string
	MaxGleanings     int
	// contains filtered or unexported fields
}

func NewEntityExtractor

func NewEntityExtractor(llm llm.LLM, opts ...Option) *EntityExtractor

func (*EntityExtractor) Extract

func (ee *EntityExtractor) Extract(ctx context.Context, text string) ([]Record, error)

type Option

type Option func(*EntityExtractor)

func WithEntityTypes

func WithEntityTypes(types []string) Option

type Record

type Record interface {
	NodeID() string
	Type() string
	// contains filtered or unexported methods
}

type Relationship

type Relationship struct {
	Entity1  string
	Relation string
	Entity2  string
	Keyword  string
	Weight   int
	// contains filtered or unexported fields
}

func (*Relationship) NodeID

func (e *Relationship) NodeID() string

func (*Relationship) String

func (r *Relationship) String() string

func (*Relationship) Type

func (r *Relationship) Type() string