classifications

Documentation

Index

• Constants
• type API
  • func New(con *connection.Connection) *API
  • func (api *API) Getter() *Getter
  • func (api *API) Scheduler() *Scheduler
• type Getter
  • func (g *Getter) Do(ctx context.Context) (*models.Classification, error)
  • func (g *Getter) WithID(uuid string) *Getter
• type Scheduler
  • func (s *Scheduler) Do(ctx context.Context) (*models.Classification, error)
  • func (s *Scheduler) WithBasedOnProperties(basedOnProperties []string) *Scheduler
  • func (s *Scheduler) WithClassName(name string) *Scheduler
  • func (s *Scheduler) WithClassifyProperties(classifyProperties []string) *Scheduler
  • func (s *Scheduler) WithSettings(settings interface{}) *Scheduler
  • func (s *Scheduler) WithSourceWhereFilter(whereFilter *filters.WhereBuilder) *Scheduler
  • func (s *Scheduler) WithTargetWhereFilter(whereFilter *filters.WhereBuilder) *Scheduler
  • func (s *Scheduler) WithTrainingSetWhereFilter(whereFilter *filters.WhereBuilder) *Scheduler
  • func (s *Scheduler) WithType(classificationType string) *Scheduler
  • func (s *Scheduler) WithWaitForCompletion() *Scheduler

Constants

const Contextual = "text2vec-contextionary"

Contextual classification labels a data object with the closest label based on their vector position (which describes the context). It can only be used with the text2vec-contextionary vectorizer.

const KNN = "knn"

KNN (k nearest neighbours) a non parametric classification based on training data

const ZeroShot = "zeroshot"

ZeroShot classification labels a data object with the closest label based on their vector position (which describes the context) It can be used with any vectorizer or custom vectors.

Types

type API

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

API classifications API

func New

func New(con *connection.Connection) *API

New Classification api group from connection

func (*API) Getter

func (api *API) Getter() *Getter

Getter get a builder to retrieve a classification

func (*API) Scheduler

func (api *API) Scheduler() *Scheduler

Scheduler get a builder to schedule a classification

type Getter

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

Getter builder to retrieve a classification status object

func (*Getter) Do

func (g *Getter) Do(ctx context.Context) (*models.Classification, error)

Do get the classification

func (*Getter) WithID

func (g *Getter) WithID(uuid string) *Getter

WithID of the classification

type Scheduler

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

Scheduler builder to schedule a classification

func (*Scheduler) Do

func (s *Scheduler) Do(ctx context.Context) (*models.Classification, error)

Do schedule the classification in weaviate

func (*Scheduler) WithBasedOnProperties

func (s *Scheduler) WithBasedOnProperties(basedOnProperties []string) *Scheduler

WithBasedOnProperties defines the properties that will be considered for the classification

func (*Scheduler) WithClassName

func (s *Scheduler) WithClassName(name string) *Scheduler

WithClassName that should be classified

func (*Scheduler) WithClassifyProperties

func (s *Scheduler) WithClassifyProperties(classifyProperties []string) *Scheduler

WithClassifyProperties defines the properties that will be labeled through the classification

func (*Scheduler) WithSettings

func (s *Scheduler) WithSettings(settings interface{}) *Scheduler

WithSettings sets the classification settings

func (*Scheduler) WithSourceWhereFilter

func (s *Scheduler) WithSourceWhereFilter(whereFilter *filters.WhereBuilder) *Scheduler

WithSourceWhereFilter filter the data objects to be labeled

func (*Scheduler) WithTargetWhereFilter

func (s *Scheduler) WithTargetWhereFilter(whereFilter *filters.WhereBuilder) *Scheduler

WithTargetWhereFilter filter the label objects

func (*Scheduler) WithTrainingSetWhereFilter

func (s *Scheduler) WithTrainingSetWhereFilter(whereFilter *filters.WhereBuilder) *Scheduler

WithTrainingSetWhereFilter filter the objects that are used as training data. E.g. in a knn classification

func (*Scheduler) WithType

func (s *Scheduler) WithType(classificationType string) *Scheduler

WithType of classification e.g. knn or contextual

func (*Scheduler) WithWaitForCompletion

func (s *Scheduler) WithWaitForCompletion() *Scheduler

WithWaitForCompletion block while classification is running (until classification succeeded or failed)