Documentation ¶
Index ¶
- type API
- func (data *API) Checker() *Checker
- func (data *API) Creator() *Creator
- func (data *API) Deleter() *Deleter
- func (data *API) ObjectsGetter() *ObjectsGetter
- func (data *API) ReferenceCreator() *ReferenceCreator
- func (data *API) ReferenceDeleter() *ReferenceDeleter
- func (data *API) ReferencePayloadBuilder() *ReferencePayloadBuilder
- func (data *API) ReferenceReplacer() *ReferenceReplacer
- func (data *API) Updater() *Updater
- func (data *API) Validator() *Validator
- type Checker
- type Creator
- func (creator *Creator) Do(ctx context.Context) (*ObjectWrapper, error)
- func (creator *Creator) PayloadObject() (*models.Object, error)
- func (creator *Creator) WithClassName(name string) *Creator
- func (creator *Creator) WithID(uuid string) *Creator
- func (creator *Creator) WithProperties(propertySchema models.PropertySchema) *Creator
- func (creator *Creator) WithVector(vector []float32) *Creator
- type Deleter
- type ObjectWrapper
- type ObjectsGetter
- func (getter *ObjectsGetter) Do(ctx context.Context) ([]*models.Object, error)
- func (getter *ObjectsGetter) WithAdditional(additional string) *ObjectsGetter
- func (getter *ObjectsGetter) WithID(id string) *ObjectsGetter
- func (getter *ObjectsGetter) WithLimit(limit int) *ObjectsGetter
- func (getter *ObjectsGetter) WithVector() *ObjectsGetter
- type ReferenceCreator
- func (rc *ReferenceCreator) Do(ctx context.Context) error
- func (rc *ReferenceCreator) WithID(uuid string) *ReferenceCreator
- func (rc *ReferenceCreator) WithReference(referencePayload *models.SingleRef) *ReferenceCreator
- func (rc *ReferenceCreator) WithReferenceProperty(propertyName string) *ReferenceCreator
- type ReferenceDeleter
- func (rr *ReferenceDeleter) Do(ctx context.Context) error
- func (rr *ReferenceDeleter) WithID(uuid string) *ReferenceDeleter
- func (rr *ReferenceDeleter) WithReference(referencePayload *models.SingleRef) *ReferenceDeleter
- func (rr *ReferenceDeleter) WithReferenceProperty(propertyName string) *ReferenceDeleter
- type ReferencePayloadBuilder
- type ReferenceReplacer
- func (rr *ReferenceReplacer) Do(ctx context.Context) error
- func (rr *ReferenceReplacer) WithID(uuid string) *ReferenceReplacer
- func (rr *ReferenceReplacer) WithReferenceProperty(propertyName string) *ReferenceReplacer
- func (rr *ReferenceReplacer) WithReferences(referencePayload *models.MultipleRef) *ReferenceReplacer
- type Updater
- func (updater *Updater) Do(ctx context.Context) error
- func (updater *Updater) WithClassName(className string) *Updater
- func (updater *Updater) WithID(uuid string) *Updater
- func (updater *Updater) WithMerge() *Updater
- func (updater *Updater) WithProperties(propertySchema models.PropertySchema) *Updater
- type Validator
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type API ¶
type API struct {
// contains filtered or unexported fields
}
API Contains all the builders required to access the weaviate data API
func (*API) ObjectsGetter ¶
func (data *API) ObjectsGetter() *ObjectsGetter
ObjectsGetter get a builder to get an Action
func (*API) ReferenceCreator ¶
func (data *API) ReferenceCreator() *ReferenceCreator
ReferenceCreator get a builder to add references to data objects
func (*API) ReferenceDeleter ¶
func (data *API) ReferenceDeleter() *ReferenceDeleter
ReferenceDeleter get a builder to delete references on a data object
func (*API) ReferencePayloadBuilder ¶
func (data *API) ReferencePayloadBuilder() *ReferencePayloadBuilder
ReferencePayloadBuilder get a builder to create the payloads that reference an object
func (*API) ReferenceReplacer ¶
func (data *API) ReferenceReplacer() *ReferenceReplacer
ReferenceReplacer get a builder to replace references on a data object
type Checker ¶
type Checker struct {
// contains filtered or unexported fields
}
Checker builder to check data object's existence
type Creator ¶
type Creator struct {
// contains filtered or unexported fields
}
Creator builder to create a data object in weaviate
func (*Creator) Do ¶
func (creator *Creator) Do(ctx context.Context) (*ObjectWrapper, error)
Do create the data object as specified in the builder
func (*Creator) PayloadObject ¶
PayloadObject returns the data object payload which may be used in a batch request
func (*Creator) WithClassName ¶
WithClassName indicates what class the data object is associated with
func (*Creator) WithID ¶
WithID if specified the object will be created under this uuid weaviate will generate a uuid if this was not called or an empty string is specified.
func (*Creator) WithProperties ¶
func (creator *Creator) WithProperties(propertySchema models.PropertySchema) *Creator
WithProperties property values of the data object
func (*Creator) WithVector ¶
type Deleter ¶
type Deleter struct {
// contains filtered or unexported fields
}
Deleter builder to delete a data object
type ObjectWrapper ¶
ObjectWrapper wrapping the result of a creation for both actions and things
type ObjectsGetter ¶
type ObjectsGetter struct {
// contains filtered or unexported fields
}
ObjectsGetter Builder to retrieve Things from weaviate
func (*ObjectsGetter) WithAdditional ¶
func (getter *ObjectsGetter) WithAdditional(additional string) *ObjectsGetter
WithAdditional parameters such as for example: classification, featureProjection
func (*ObjectsGetter) WithID ¶
func (getter *ObjectsGetter) WithID(id string) *ObjectsGetter
WithID specifies the uuid of the Thing that should be retrieved
if omitted a set of objects matching the builder specifications will be retrieved
func (*ObjectsGetter) WithLimit ¶
func (getter *ObjectsGetter) WithLimit(limit int) *ObjectsGetter
WithLimit of results
func (*ObjectsGetter) WithVector ¶
func (getter *ObjectsGetter) WithVector() *ObjectsGetter
WithVector include the raw vector of the data object
type ReferenceCreator ¶
type ReferenceCreator struct {
// contains filtered or unexported fields
}
ReferenceCreator builder to add a reference to the property of a data object
func (*ReferenceCreator) Do ¶
func (rc *ReferenceCreator) Do(ctx context.Context) error
Do add the reference specified by the set payload to the object and property specified in the builder.
func (*ReferenceCreator) WithID ¶
func (rc *ReferenceCreator) WithID(uuid string) *ReferenceCreator
WithID specifies the uuid of the object on which to add the reference
func (*ReferenceCreator) WithReference ¶
func (rc *ReferenceCreator) WithReference(referencePayload *models.SingleRef) *ReferenceCreator
WithReference specifies the data object that should be referenced by the in this object specified reference property The payload may be created using the ReferencePayloadBuilder
func (*ReferenceCreator) WithReferenceProperty ¶
func (rc *ReferenceCreator) WithReferenceProperty(propertyName string) *ReferenceCreator
WithReferenceProperty specifies the property that should hold the reference
type ReferenceDeleter ¶
type ReferenceDeleter struct {
// contains filtered or unexported fields
}
ReferenceDeleter builder to remove a reference from a data object
func (*ReferenceDeleter) Do ¶
func (rr *ReferenceDeleter) Do(ctx context.Context) error
Do remove the reference defined by the payload set in this builder to the property and object defined in this builder
func (*ReferenceDeleter) WithID ¶
func (rr *ReferenceDeleter) WithID(uuid string) *ReferenceDeleter
WithID specifies the uuid of the object on which the reference will be deleted
func (*ReferenceDeleter) WithReference ¶
func (rr *ReferenceDeleter) WithReference(referencePayload *models.SingleRef) *ReferenceDeleter
WithReference specifies reference payload of the reference about to be deleted
func (*ReferenceDeleter) WithReferenceProperty ¶
func (rr *ReferenceDeleter) WithReferenceProperty(propertyName string) *ReferenceDeleter
WithReferenceProperty specifies the property on which the reference should be deleted
type ReferencePayloadBuilder ¶
type ReferencePayloadBuilder struct {
// contains filtered or unexported fields
}
ReferencePayloadBuilder to create a payload that references a data object. The payload may be added to a reference property in another data object.
func (*ReferencePayloadBuilder) Payload ¶
func (rpb *ReferencePayloadBuilder) Payload() *models.SingleRef
Payload to reference the in the builder specified data object
func (*ReferencePayloadBuilder) WithID ¶
func (rpb *ReferencePayloadBuilder) WithID(uuid string) *ReferencePayloadBuilder
WithID specifies the uuid of the object to be referenced
type ReferenceReplacer ¶
type ReferenceReplacer struct {
// contains filtered or unexported fields
}
ReferenceReplacer builder to replace reference(s) with new one(s)
func (*ReferenceReplacer) Do ¶
func (rr *ReferenceReplacer) Do(ctx context.Context) error
Do replace the references of the in this builder specified data object
func (*ReferenceReplacer) WithID ¶
func (rr *ReferenceReplacer) WithID(uuid string) *ReferenceReplacer
WithID specifies the uuid of the object about to get its reference replaced
func (*ReferenceReplacer) WithReferenceProperty ¶
func (rr *ReferenceReplacer) WithReferenceProperty(propertyName string) *ReferenceReplacer
WithReferenceProperty specifies the property that should replace
func (*ReferenceReplacer) WithReferences ¶
func (rr *ReferenceReplacer) WithReferences(referencePayload *models.MultipleRef) *ReferenceReplacer
WithReferences the set of references that should replace the currently existing references
type Updater ¶
type Updater struct {
// contains filtered or unexported fields
}
Updater builder to update property values in a data object
func (*Updater) WithClassName ¶
WithClassName specifies the class of the object about to be updated
func (*Updater) WithMerge ¶
WithMerge indicates that the object should be merged with the existing object instead of replacing it
func (*Updater) WithProperties ¶
func (updater *Updater) WithProperties(propertySchema models.PropertySchema) *Updater
WithProperties specifies the property schema of the class about to be updated
type Validator ¶
type Validator struct {
// contains filtered or unexported fields
}
Validator builder object to validate a class
func (*Validator) Do ¶
Do validate the data object specified in the builder Will return an error if the object is not valid or if there is a different error
func (*Validator) WithClassName ¶
WithClassName specifies the class of the object about to be validated
func (*Validator) WithSchema ¶
func (validator *Validator) WithSchema(propertySchema models.PropertySchema) *Validator
WithSchema specifies the property schema of the class about to be validated