classifications

package
v1.1.2 Latest Latest
Warning

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

Go to latest
Published: Oct 31, 2022 License: BSD-3-Clause Imports: 8 Imported by: 0

Documentation

Index

Constants

View Source
const Contextual = "text2vec-contextionary"

Contextual classification labels a data object with the closest label based on their vector position (which describes the context)

View Source
const KNN = "knn"

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

Variables

This section is empty.

Functions

This section is empty.

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

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

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 added in v1.1.1

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

WithSettings sets the classification settings

func (*Scheduler) WithSourceWhereFilter

func (s *Scheduler) WithSourceWhereFilter(whereFilter *models.WhereFilter) *Scheduler

WithSourceWhereFilter filter the data objects to be labeled

func (*Scheduler) WithTargetWhereFilter

func (s *Scheduler) WithTargetWhereFilter(whereFilter *models.WhereFilter) *Scheduler

WithTargetWhereFilter filter the label objects

func (*Scheduler) WithTrainingSetWhereFilter

func (s *Scheduler) WithTrainingSetWhereFilter(whereFilter *models.WhereFilter) *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)

Jump to

Keyboard shortcuts

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