models

type AdditionalProperties map[string]interface{}

type BM25Config struct {

	// calibrates term-weight scaling based on the document length
	B float32 `json:"b,omitempty"`

	// calibrates term-weight scaling based on the term frequency within a document
	K1 float32 `json:"k1,omitempty"`
}

type BackupConfig struct {

	// Desired CPU core utilization ranging from 1%-80%
	// Maximum: 80
	// Minimum: 1
	CPUPercentage int64 `json:"CPUPercentage,omitempty"`

	// Weaviate will attempt to come close the specified size, with a minimum of 2MB, default of 128MB, and a maximum of 512MB
	// Maximum: 512
	// Minimum: 2
	ChunkSize int64 `json:"ChunkSize,omitempty"`

	// compression level used by compression algorithm
	// Enum: [DefaultCompression BestSpeed BestCompression]
	CompressionLevel string `json:"CompressionLevel,omitempty"`
}

type BackupCreateRequest struct {

	// Custom configuration for the backup creation process
	Config *BackupConfig `json:"config,omitempty"`

	// List of classes to exclude from the backup creation process
	Exclude []string `json:"exclude"`

	// The ID of the backup. Must be URL-safe and work as a filesystem path, only lowercase, numbers, underscore, minus characters allowed.
	ID string `json:"id,omitempty"`

	// List of classes to include in the backup creation process
	Include []string `json:"include"`
}

type BackupCreateResponse struct {

	// Backup backend name e.g. filesystem, gcs, s3.
	Backend string `json:"backend,omitempty"`

	// The list of classes for which the backup creation process was started
	Classes []string `json:"classes"`

	// error message if creation failed
	Error string `json:"error,omitempty"`

	// The ID of the backup. Must be URL-safe and work as a filesystem path, only lowercase, numbers, underscore, minus characters allowed.
	ID string `json:"id,omitempty"`

	// destination path of backup files proper to selected backend
	Path string `json:"path,omitempty"`

	// phase of backup creation process
	// Enum: [STARTED TRANSFERRING TRANSFERRED SUCCESS FAILED]
	Status *string `json:"status,omitempty"`
}

type BackupCreateStatusResponse struct {

	// Backup backend name e.g. filesystem, gcs, s3.
	Backend string `json:"backend,omitempty"`

	// error message if creation failed
	Error string `json:"error,omitempty"`

	// The ID of the backup. Must be URL-safe and work as a filesystem path, only lowercase, numbers, underscore, minus characters allowed.
	ID string `json:"id,omitempty"`

	// destination path of backup files proper to selected backend
	Path string `json:"path,omitempty"`

	// phase of backup creation process
	// Enum: [STARTED TRANSFERRING TRANSFERRED SUCCESS FAILED]
	Status *string `json:"status,omitempty"`
}

type BackupRestoreRequest struct {

	// Custom configuration for the backup restoration process
	Config *RestoreConfig `json:"config,omitempty"`

	// List of classes to exclude from the backup restoration process
	Exclude []string `json:"exclude"`

	// List of classes to include in the backup restoration process
	Include []string `json:"include"`

	// Allows overriding the node names stored in the backup with different ones. Useful when restoring backups to a different environment.
	NodeMapping map[string]string `json:"node_mapping,omitempty"`
}

type BackupRestoreResponse struct {

	// Backup backend name e.g. filesystem, gcs, s3.
	Backend string `json:"backend,omitempty"`

	// The list of classes for which the backup restoration process was started
	Classes []string `json:"classes"`

	// error message if restoration failed
	Error string `json:"error,omitempty"`

	// The ID of the backup. Must be URL-safe and work as a filesystem path, only lowercase, numbers, underscore, minus characters allowed.
	ID string `json:"id,omitempty"`

	// destination path of backup files proper to selected backend
	Path string `json:"path,omitempty"`

	// phase of backup restoration process
	// Enum: [STARTED TRANSFERRING TRANSFERRED SUCCESS FAILED]
	Status *string `json:"status,omitempty"`
}

type BackupRestoreStatusResponse struct {

	// Backup backend name e.g. filesystem, gcs, s3.
	Backend string `json:"backend,omitempty"`

	// error message if restoration failed
	Error string `json:"error,omitempty"`

	// The ID of the backup. Must be URL-safe and work as a filesystem path, only lowercase, numbers, underscore, minus characters allowed.
	ID string `json:"id,omitempty"`

	// destination path of backup files proper to selected backup backend
	Path string `json:"path,omitempty"`

	// phase of backup restoration process
	// Enum: [STARTED TRANSFERRING TRANSFERRED SUCCESS FAILED]
	Status *string `json:"status,omitempty"`
}

type BatchDelete struct {

	// If true, objects will not be deleted yet, but merely listed. Defaults to false.
	DryRun *bool `json:"dryRun,omitempty"`

	// match
	Match *BatchDeleteMatch `json:"match,omitempty"`

	// Controls the verbosity of the output, possible values are: "minimal", "verbose". Defaults to "minimal".
	Output *string `json:"output,omitempty"`
}

type BatchDeleteMatch struct {

	// Class (name) which objects will be deleted.
	// Example: City
	Class string `json:"class,omitempty"`

	// Filter to limit the objects to be deleted.
	Where *WhereFilter `json:"where,omitempty"`
}

type BatchDeleteResponse struct {

	// If true, objects will not be deleted yet, but merely listed. Defaults to false.
	DryRun *bool `json:"dryRun,omitempty"`

	// match
	Match *BatchDeleteResponseMatch `json:"match,omitempty"`

	// Controls the verbosity of the output, possible values are: "minimal", "verbose". Defaults to "minimal".
	Output *string `json:"output,omitempty"`

	// results
	Results *BatchDeleteResponseResults `json:"results,omitempty"`
}

type BatchDeleteResponseMatch struct {

	// Class (name) which objects will be deleted.
	// Example: City
	Class string `json:"class,omitempty"`

	// Filter to limit the objects to be deleted.
	Where *WhereFilter `json:"where,omitempty"`
}

type BatchDeleteResponseResults struct {

	// How many objects should have been deleted but could not be deleted.
	Failed int64 `json:"failed"`

	// The most amount of objects that can be deleted in a single query, equals QUERY_MAXIMUM_RESULTS.
	Limit int64 `json:"limit"`

	// How many objects were matched by the filter.
	Matches int64 `json:"matches"`

	// With output set to "minimal" only objects with error occurred will the be described. Successfully deleted objects would be omitted. Output set to "verbose" will list all of the objets with their respective statuses.
	Objects []*BatchDeleteResponseResultsObjectsItems0 `json:"objects"`

	// How many objects were successfully deleted in this round.
	Successful int64 `json:"successful"`
}

type BatchDeleteResponseResultsObjectsItems0 struct {

	// errors
	Errors *ErrorResponse `json:"errors,omitempty"`

	// ID of the Object.
	// Format: uuid
	ID strfmt.UUID `json:"id,omitempty"`

	// status
	// Enum: [SUCCESS DRYRUN FAILED]
	Status *string `json:"status,omitempty"`
}

type BatchReference struct {

	// Long-form beacon-style URI to identify the source of the cross-ref including the property name. Should be in the form of weaviate://localhost/<kinds>/<uuid>/<className>/<propertyName>, where <kinds> must be one of 'objects', 'objects' and <className> and <propertyName> must represent the cross-ref property of source class to be used.
	// Example: weaviate://localhost/Zoo/a5d09582-4239-4702-81c9-92a6e0122bb4/hasAnimals
	// Format: uri
	From strfmt.URI `json:"from,omitempty"`

	// Name of the reference tenant.
	Tenant string `json:"tenant,omitempty"`

	// Short-form URI to point to the cross-ref. Should be in the form of weaviate://localhost/<uuid> for the example of a local cross-ref to an object
	// Example: weaviate://localhost/97525810-a9a5-4eb0-858a-71449aeb007f
	// Format: uri
	To strfmt.URI `json:"to,omitempty"`
}

type BatchReferenceResponse struct {
	BatchReference

	// result
	Result *BatchReferenceResponseAO1Result `json:"result,omitempty"`
}

type BatchReferenceResponseAO1Result struct {

	// errors
	Errors *ErrorResponse `json:"errors,omitempty"`

	// status
	// Enum: [SUCCESS PENDING FAILED]
	Status *string `json:"status,omitempty"`
}

type BatchStats struct {

	// How many objects are currently in the batch queue.
	QueueLength *int64 `json:"queueLength,omitempty"`

	// How many objects are approximately processed from the batch queue per second.
	RatePerSecond int64 `json:"ratePerSecond"`
}

type C11yExtension struct {

	// The new concept you want to extend. Must be an all-lowercase single word, or a space delimited compound word. Examples: 'foobarium', 'my custom concept'
	// Example: foobarium
	Concept string `json:"concept,omitempty"`

	// A list of space-delimited words or a sentence describing what the custom concept is about. Avoid using the custom concept itself. An Example definition for the custom concept 'foobarium': would be 'a naturally occurring element which can only be seen by programmers'
	Definition string `json:"definition,omitempty"`

	// Weight of the definition of the new concept where 1='override existing definition entirely' and 0='ignore custom definition'. Note that if the custom concept is not present in the contextionary yet, the weight cannot be less than 1.
	Weight float32 `json:"weight,omitempty"`
}

type C11yNearestNeighbors []*C11yNearestNeighborsItems0

type C11yNearestNeighborsItems0 struct {

	// distance
	Distance float32 `json:"distance,omitempty"`

	// word
	Word string `json:"word,omitempty"`
}

type C11yVector []float32

type C11yVectorBasedQuestion []*C11yVectorBasedQuestionItems0

type C11yVectorBasedQuestionItems0 struct {

	// Vectorized properties.
	// Max Items: 300
	// Min Items: 300
	ClassProps []*C11yVectorBasedQuestionItems0ClassPropsItems0 `json:"classProps"`

	// Vectorized classname.
	// Max Items: 300
	// Min Items: 300
	ClassVectors []float32 `json:"classVectors"`
}

type C11yVectorBasedQuestionItems0ClassPropsItems0 struct {

	// props vectors
	PropsVectors []float32 `json:"propsVectors"`

	// String with valuename.
	Value string `json:"value,omitempty"`
}

type C11yWordsResponse struct {

	// concatenated word
	ConcatenatedWord *C11yWordsResponseConcatenatedWord `json:"concatenatedWord,omitempty"`

	// Weighted results for per individual word
	IndividualWords []*C11yWordsResponseIndividualWordsItems0 `json:"individualWords"`
}

type C11yWordsResponseConcatenatedWord struct {

	// concatenated nearest neighbors
	ConcatenatedNearestNeighbors C11yNearestNeighbors `json:"concatenatedNearestNeighbors,omitempty"`

	// concatenated vector
	ConcatenatedVector C11yVector `json:"concatenatedVector,omitempty"`

	// concatenated word
	ConcatenatedWord string `json:"concatenatedWord,omitempty"`

	// single words
	SingleWords []string `json:"singleWords"`
}

type C11yWordsResponseIndividualWordsItems0 struct {

	// info
	Info *C11yWordsResponseIndividualWordsItems0Info `json:"info,omitempty"`

	// present
	Present bool `json:"present,omitempty"`

	// word
	Word string `json:"word,omitempty"`
}

type C11yWordsResponseIndividualWordsItems0Info struct {

	// nearest neighbors
	NearestNeighbors C11yNearestNeighbors `json:"nearestNeighbors,omitempty"`

	// vector
	Vector C11yVector `json:"vector,omitempty"`
}

type Class struct {

	// Name of the class as URI relative to the schema URL.
	Class string `json:"class,omitempty"`

	// Description of the class.
	Description string `json:"description,omitempty"`

	// inverted index config
	InvertedIndexConfig *InvertedIndexConfig `json:"invertedIndexConfig,omitempty"`

	// Configuration specific to modules this Weaviate instance has installed
	ModuleConfig interface{} `json:"moduleConfig,omitempty"`

	// multi tenancy config
	MultiTenancyConfig *MultiTenancyConfig `json:"multiTenancyConfig,omitempty"`

	// The properties of the class.
	Properties []*Property `json:"properties"`

	// replication config
	ReplicationConfig *ReplicationConfig `json:"replicationConfig,omitempty"`

	// Manage how the index should be sharded and distributed in the cluster
	ShardingConfig interface{} `json:"shardingConfig,omitempty"`

	// vector config
	VectorConfig map[string]VectorConfig `json:"vectorConfig,omitempty"`

	// Vector-index config, that is specific to the type of index selected in vectorIndexType
	VectorIndexConfig interface{} `json:"vectorIndexConfig,omitempty"`

	// Name of the vector index to use, eg. (HNSW)
	VectorIndexType string `json:"vectorIndexType,omitempty"`

	// Specify how the vectors for this class should be determined. The options are either 'none' - this means you have to import a vector with each object yourself - or the name of a module that provides vectorization capabilities, such as 'text2vec-contextionary'. If left empty, it will use the globally configured default which can itself either be 'none' or a specific module.
	Vectorizer string `json:"vectorizer,omitempty"`
}

type Classification struct {

	// base the text-based classification on these fields (of type text)
	// Example: ["description"]
	BasedOnProperties []string `json:"basedOnProperties"`

	// class (name) which is used in this classification
	// Example: City
	Class string `json:"class,omitempty"`

	// which ref-property to set as part of the classification
	// Example: ["inCountry"]
	ClassifyProperties []string `json:"classifyProperties"`

	// error message if status == failed
	// Example: classify xzy: something went wrong
	Error string `json:"error,omitempty"`

	// filters
	Filters *ClassificationFilters `json:"filters,omitempty"`

	// ID to uniquely identify this classification run
	// Example: ee722219-b8ec-4db1-8f8d-5150bb1a9e0c
	// Format: uuid
	ID strfmt.UUID `json:"id,omitempty"`

	// additional meta information about the classification
	Meta *ClassificationMeta `json:"meta,omitempty"`

	// classification-type specific settings
	Settings interface{} `json:"settings,omitempty"`

	// status of this classification
	// Example: running
	// Enum: [running completed failed]
	Status string `json:"status,omitempty"`

	// which algorithm to use for classifications
	Type string `json:"type,omitempty"`
}

type ClassificationFilters struct {

	// limit the objects to be classified
	SourceWhere *WhereFilter `json:"sourceWhere,omitempty"`

	// Limit the possible sources when using an algorithm which doesn't really on training data, e.g. 'contextual'. When using an algorithm with a training set, such as 'knn', limit the training set instead
	TargetWhere *WhereFilter `json:"targetWhere,omitempty"`

	// Limit the training objects to be considered during the classification. Can only be used on types with explicit training sets, such as 'knn'
	TrainingSetWhere *WhereFilter `json:"trainingSetWhere,omitempty"`
}

type ClassificationMeta struct {

	// time when this classification finished
	// Example: 2017-07-21T17:32:28Z
	// Format: date-time
	Completed strfmt.DateTime `json:"completed,omitempty"`

	// number of objects which were taken into consideration for classification
	// Example: 147
	Count int64 `json:"count,omitempty"`

	// number of objects which could not be classified - see error message for details
	// Example: 7
	CountFailed int64 `json:"countFailed,omitempty"`

	// number of objects successfully classified
	// Example: 140
	CountSucceeded int64 `json:"countSucceeded,omitempty"`

	// time when this classification was started
	// Example: 2017-07-21T17:32:28Z
	// Format: date-time
	Started strfmt.DateTime `json:"started,omitempty"`
}

type Deprecation struct {

	// Describes which API is effected, usually one of: REST, GraphQL
	APIType string `json:"apiType,omitempty"`

	// The id that uniquely identifies this particular deprecations (mostly used internally)
	ID string `json:"id,omitempty"`

	// The locations within the specified API affected by this deprecation
	Locations []string `json:"locations"`

	// User-required object to not be affected by the (planned) removal
	Mitigation string `json:"mitigation,omitempty"`

	// What this deprecation is about
	Msg string `json:"msg,omitempty"`

	// A best-effort guess of which upcoming version will remove the feature entirely
	PlannedRemovalVersion string `json:"plannedRemovalVersion,omitempty"`

	// If the feature has already been removed, it was removed in this version
	RemovedIn *string `json:"removedIn,omitempty"`

	// If the feature has already been removed, it was removed at this timestamp
	// Format: date-time
	RemovedTime *strfmt.DateTime `json:"removedTime,omitempty"`

	// The deprecation was introduced in this version
	// Format: date-time
	SinceTime strfmt.DateTime `json:"sinceTime,omitempty"`

	// The deprecation was introduced in this version
	SinceVersion string `json:"sinceVersion,omitempty"`

	// Whether the problematic API functionality is deprecated (planned to be removed) or already removed
	Status string `json:"status,omitempty"`
}

type ErrorResponse struct {

	// error
	Error []*ErrorResponseErrorItems0 `json:"error"`
}

type ErrorResponseErrorItems0 struct {

	// message
	Message string `json:"message,omitempty"`
}

type GeoCoordinates struct {

	// The latitude of the point on earth in decimal form
	Latitude *float32 `json:"latitude,omitempty"`

	// The longitude of the point on earth in decimal form
	Longitude *float32 `json:"longitude,omitempty"`
}

type GraphQLError struct {

	// locations
	Locations []*GraphQLErrorLocationsItems0 `json:"locations"`

	// message
	Message string `json:"message,omitempty"`

	// path
	Path []string `json:"path"`
}

type GraphQLErrorLocationsItems0 struct {

	// column
	Column int64 `json:"column,omitempty"`

	// line
	Line int64 `json:"line,omitempty"`
}

type GraphQLQueries []*GraphQLQuery

type GraphQLQuery struct {

	// The name of the operation if multiple exist in the query.
	OperationName string `json:"operationName,omitempty"`

	// Query based on GraphQL syntax.
	Query string `json:"query,omitempty"`

	// Additional variables for the query.
	Variables interface{} `json:"variables,omitempty"`
}

type GraphQLResponse struct {

	// GraphQL data object.
	Data map[string]JSONObject `json:"data,omitempty"`

	// Array with errors.
	Errors []*GraphQLError `json:"errors,omitempty"`
}

type GraphQLResponses []*GraphQLResponse

type InvertedIndexConfig struct {

	// bm25
	Bm25 *BM25Config `json:"bm25,omitempty"`

	// Asynchronous index clean up happens every n seconds
	CleanupIntervalSeconds int64 `json:"cleanupIntervalSeconds,omitempty"`

	// Index each object with the null state
	IndexNullState bool `json:"indexNullState,omitempty"`

	// Index length of properties
	IndexPropertyLength bool `json:"indexPropertyLength,omitempty"`

	// Index each object by its internal timestamps
	IndexTimestamps bool `json:"indexTimestamps,omitempty"`

	// stopwords
	Stopwords *StopwordConfig `json:"stopwords,omitempty"`
}

type JSONObject interface{}

type Link struct {

	// weaviate documentation about this resource group
	DocumentationHref string `json:"documentationHref,omitempty"`

	// target of the link
	Href string `json:"href,omitempty"`

	// human readable name of the resource group
	Name string `json:"name,omitempty"`

	// relationship if both resources are related, e.g. 'next', 'previous', 'parent', etc.
	Rel string `json:"rel,omitempty"`
}

type Meta struct {

	// The url of the host.
	Hostname string `json:"hostname,omitempty"`

	// Module-specific meta information
	Modules interface{} `json:"modules,omitempty"`

	// Version of weaviate you are currently running
	Version string `json:"version,omitempty"`
}

type MultiTenancyConfig struct {

	// Whether or not multi-tenancy is enabled for this class
	Enabled bool `json:"enabled"`
}

type MultipleRef []*SingleRef

type NestedProperty struct {

	// data type
	DataType []string `json:"dataType"`

	// description
	Description string `json:"description,omitempty"`

	// index filterable
	IndexFilterable *bool `json:"indexFilterable,omitempty"`

	// index searchable
	IndexSearchable *bool `json:"indexSearchable,omitempty"`

	// name
	Name string `json:"name,omitempty"`

	// nested properties
	NestedProperties []*NestedProperty `json:"nestedProperties,omitempty"`

	// tokenization
	// Enum: [word lowercase whitespace field]
	Tokenization string `json:"tokenization,omitempty"`
}

type NodeShardStatus struct {

	// The name of shard's class.
	Class string `json:"class"`

	// The status of vector compression/quantization.
	Compressed bool `json:"compressed"`

	// The load status of the shard.
	Loaded bool `json:"loaded"`

	// The name of the shard.
	Name string `json:"name"`

	// The number of objects in shard.
	ObjectCount int64 `json:"objectCount"`

	// The status of the vector indexing process.
	VectorIndexingStatus string `json:"vectorIndexingStatus"`

	// The length of the vector indexing queue.
	VectorQueueLength int64 `json:"vectorQueueLength"`
}

type NodeStats struct {

	// The total number of objects in DB.
	ObjectCount int64 `json:"objectCount"`

	// The count of Weaviate's shards.
	ShardCount int64 `json:"shardCount"`
}

type NodeStatus struct {

	// Weaviate batch statistics.
	BatchStats *BatchStats `json:"batchStats,omitempty"`

	// The gitHash of Weaviate.
	GitHash string `json:"gitHash,omitempty"`

	// The name of the node.
	Name string `json:"name,omitempty"`

	// The list of the shards with it's statistics.
	Shards []*NodeShardStatus `json:"shards"`

	// Weaviate overall statistics.
	Stats *NodeStats `json:"stats,omitempty"`

	// Node's status.
	// Enum: [HEALTHY UNHEALTHY UNAVAILABLE TIMEOUT]
	Status *string `json:"status,omitempty"`

	// The version of Weaviate.
	Version string `json:"version,omitempty"`
}

type NodesStatusResponse struct {

	// nodes
	Nodes []*NodeStatus `json:"nodes"`
}

type Object struct {

	// additional
	Additional AdditionalProperties `json:"additional,omitempty"`

	// Class of the Object, defined in the schema.
	Class string `json:"class,omitempty"`

	// Timestamp of creation of this Object in milliseconds since epoch UTC.
	CreationTimeUnix int64 `json:"creationTimeUnix,omitempty"`

	// ID of the Object.
	// Format: uuid
	ID strfmt.UUID `json:"id,omitempty"`

	// Timestamp of the last Object update in milliseconds since epoch UTC.
	LastUpdateTimeUnix int64 `json:"lastUpdateTimeUnix,omitempty"`

	// properties
	Properties PropertySchema `json:"properties,omitempty"`

	// Name of the Objects tenant.
	Tenant string `json:"tenant,omitempty"`

	// This field returns vectors associated with the Object. C11yVector, Vector or Vectors values are possible.
	Vector C11yVector `json:"vector,omitempty"`

	// vector weights
	VectorWeights VectorWeights `json:"vectorWeights,omitempty"`

	// This field returns vectors associated with the Object.
	Vectors Vectors `json:"vectors,omitempty"`
}

type ObjectsGetResponse struct {
	Object

	// deprecations
	Deprecations []*Deprecation `json:"deprecations"`

	// result
	Result *ObjectsGetResponseAO2Result `json:"result,omitempty"`
}

type ObjectsGetResponseAO2Result struct {

	// errors
	Errors *ErrorResponse `json:"errors,omitempty"`

	// status
	// Enum: [SUCCESS PENDING FAILED]
	Status *string `json:"status,omitempty"`
}

type ObjectsListResponse struct {

	// deprecations
	Deprecations []*Deprecation `json:"deprecations"`

	// The actual list of Objects.
	Objects []*Object `json:"objects"`

	// The total number of Objects for the query. The number of items in a response may be smaller due to paging.
	TotalResults int64 `json:"totalResults,omitempty"`
}

type PatchDocumentAction struct {

	// A string containing a JSON Pointer value.
	From string `json:"from,omitempty"`

	// merge
	Merge *Object `json:"merge,omitempty"`

	// The operation to be performed.
	// Required: true
	// Enum: [add remove replace move copy test]
	Op *string `json:"op"`

	// A JSON-Pointer.
	// Required: true
	Path *string `json:"path"`

	// The value to be used within the operations.
	Value interface{} `json:"value,omitempty"`
}

type PatchDocumentObject struct {

	// A string containing a JSON Pointer value.
	From string `json:"from,omitempty"`

	// merge
	Merge *Object `json:"merge,omitempty"`

	// The operation to be performed.
	// Required: true
	// Enum: [add remove replace move copy test]
	Op *string `json:"op"`

	// A JSON-Pointer.
	// Required: true
	Path *string `json:"path"`

	// The value to be used within the operations.
	Value interface{} `json:"value,omitempty"`
}

type PeerUpdate struct {

	// The session ID of the peer.
	// Format: uuid
	ID strfmt.UUID `json:"id,omitempty"`

	// Human readable name.
	Name string `json:"name,omitempty"`

	// The latest known hash of the peer's schema.
	SchemaHash string `json:"schemaHash,omitempty"`

	// The location where the peer is exposed to the internet.
	// Format: uri
	URI strfmt.URI `json:"uri,omitempty"`
}

type PeerUpdateList []*PeerUpdate

type PhoneNumber struct {

	// Read-only. The numerical country code (e.g. 49)
	CountryCode uint64 `json:"countryCode,omitempty"`

	// Optional. The ISO 3166-1 alpha-2 country code. This is used to figure out the correct countryCode and international format if only a national number (e.g. 0123 4567) is provided
	DefaultCountry string `json:"defaultCountry,omitempty"`

	// The raw input as the phone number is present in your raw data set. It will be parsed into the standardized formats if valid.
	Input string `json:"input,omitempty"`

	// Read-only. Parsed result in the international format (e.g. +49 123 ...)
	InternationalFormatted string `json:"internationalFormatted,omitempty"`

	// Read-only. The numerical representation of the national part
	National uint64 `json:"national,omitempty"`

	// Read-only. Parsed result in the national format (e.g. 0123 456789)
	NationalFormatted string `json:"nationalFormatted,omitempty"`

	// Read-only. Indicates whether the parsed number is a valid phone number
	Valid bool `json:"valid,omitempty"`
}

type Principal struct {

	// groups
	Groups []string `json:"groups"`

	// The username that was extracted either from the authentication information
	Username string `json:"username,omitempty"`
}

type Property struct {

	// Can be a reference to another type when it starts with a capital (for example Person), otherwise "string" or "int".
	DataType []string `json:"dataType"`

	// Description of the property.
	Description string `json:"description,omitempty"`

	// Optional. Should this property be indexed in the inverted index. Defaults to true. If you choose false, you will not be able to use this property in where filters. This property has no affect on vectorization decisions done by modules
	IndexFilterable *bool `json:"indexFilterable,omitempty"`

	// Optional. Should this property be indexed in the inverted index. Defaults to true. If you choose false, you will not be able to use this property in where filters, bm25 or hybrid search. This property has no affect on vectorization decisions done by modules (deprecated as of v1.19; use indexFilterable or/and indexSearchable instead)
	IndexInverted *bool `json:"indexInverted,omitempty"`

	// Optional. Should this property be indexed in the inverted index. Defaults to true. Applicable only to properties of data type text and text[]. If you choose false, you will not be able to use this property in bm25 or hybrid search. This property has no affect on vectorization decisions done by modules
	IndexSearchable *bool `json:"indexSearchable,omitempty"`

	// Configuration specific to modules this Weaviate instance has installed
	ModuleConfig interface{} `json:"moduleConfig,omitempty"`

	// Name of the property as URI relative to the schema URL.
	Name string `json:"name,omitempty"`

	// The properties of the nested object(s). Applies to object and object[] data types.
	NestedProperties []*NestedProperty `json:"nestedProperties,omitempty"`

	// Determines tokenization of the property as separate words or whole field. Optional. Applies to text and text[] data types. Allowed values are `word` (default; splits on any non-alphanumerical, lowercases), `lowercase` (splits on white spaces, lowercases), `whitespace` (splits on white spaces), `field` (trims). Not supported for remaining data types
	// Enum: [word lowercase whitespace field trigram gse]
	Tokenization string `json:"tokenization,omitempty"`
}

type PropertySchema interface{}

type ReferenceMetaClassification struct {

	// The lowest distance of a neighbor in the losing group. Optional. If k equals the size of the winning group, there is no losing group
	ClosestLosingDistance *float64 `json:"closestLosingDistance,omitempty"`

	// The lowest distance of any neighbor, regardless of whether they were in the winning or losing group
	ClosestOverallDistance float64 `json:"closestOverallDistance,omitempty"`

	// Closest distance of a neighbor from the winning group
	ClosestWinningDistance float64 `json:"closestWinningDistance,omitempty"`

	// size of the losing group, can be 0 if the winning group size equals k
	LosingCount int64 `json:"losingCount,omitempty"`

	// deprecated - do not use, to be removed in 0.23.0
	LosingDistance *float64 `json:"losingDistance,omitempty"`

	// Mean distance of all neighbors from the losing group. Optional. If k equals the size of the winning group, there is no losing group.
	MeanLosingDistance *float64 `json:"meanLosingDistance,omitempty"`

	// Mean distance of all neighbors from the winning group
	MeanWinningDistance float64 `json:"meanWinningDistance,omitempty"`

	// overall neighbors checked as part of the classification. In most cases this will equal k, but could be lower than k - for example if not enough data was present
	OverallCount int64 `json:"overallCount,omitempty"`

	// size of the winning group, a number between 1..k
	WinningCount int64 `json:"winningCount,omitempty"`

	// deprecated - do not use, to be removed in 0.23.0
	WinningDistance float64 `json:"winningDistance,omitempty"`
}

type ReplicationConfig struct {

	// Number of times a class is replicated
	Factor int64 `json:"factor,omitempty"`
}

type RestoreConfig struct {

	// Desired CPU core utilization ranging from 1%-80%
	// Maximum: 80
	// Minimum: 1
	CPUPercentage int64 `json:"CPUPercentage,omitempty"`
}

type Schema struct {

	// Semantic classes that are available.
	Classes []*Class `json:"classes"`

	// Email of the maintainer.
	// Format: email
	Maintainer strfmt.Email `json:"maintainer,omitempty"`

	// Name of the schema.
	Name string `json:"name,omitempty"`
}

type SchemaClusterStatus struct {

	// Contains the sync check error if one occurred
	Error string `json:"error,omitempty"`

	// True if the cluster is in sync, false if there is an issue (see error).
	Healthy bool `json:"healthy"`

	// Hostname of the coordinating node, i.e. the one that received the cluster. This can be useful information if the error message contains phrases such as 'other nodes agree, but local does not', etc.
	Hostname string `json:"hostname,omitempty"`

	// The cluster check at startup can be ignored (to recover from an out-of-sync situation).
	IgnoreSchemaSync bool `json:"ignoreSchemaSync"`

	// Number of nodes that participated in the sync check
	NodeCount int64 `json:"nodeCount,omitempty"`
}

type SchemaHistory interface{}

type ShardStatus struct {

	// Status of the shard
	Status string `json:"status,omitempty"`
}

type ShardStatusGetResponse struct {

	// Name of the shard
	Name string `json:"name,omitempty"`

	// Status of the shard
	Status string `json:"status,omitempty"`

	// Size of the vector queue of the shard
	VectorQueueSize int64 `json:"vectorQueueSize"`
}

type ShardStatusList []*ShardStatusGetResponse

type SingleRef struct {

	// If using a direct reference, specify the URI to point to the cross-ref here. Should be in the form of weaviate://localhost/<uuid> for the example of a local cross-ref to an object
	// Format: uri
	Beacon strfmt.URI `json:"beacon,omitempty"`

	// If using a concept reference (rather than a direct reference), specify the desired class name here
	// Format: uri
	Class strfmt.URI `json:"class,omitempty"`

	// Additional Meta information about classifications if the item was part of one
	Classification *ReferenceMetaClassification `json:"classification,omitempty"`

	// If using a direct reference, this read-only fields provides a link to the referenced resource. If 'origin' is globally configured, an absolute URI is shown - a relative URI otherwise.
	// Format: uri
	Href strfmt.URI `json:"href,omitempty"`

	// If using a concept reference (rather than a direct reference), specify the desired properties here
	Schema PropertySchema `json:"schema,omitempty"`
}

type StopwordConfig struct {

	// stopwords to be considered additionally
	Additions []string `json:"additions"`

	// pre-existing list of common words by language
	Preset string `json:"preset,omitempty"`

	// stopwords to be removed from consideration
	Removals []string `json:"removals"`
}

type Tenant struct {

	// activity status of the tenant's shard. Optional for creating tenant (implicit `HOT`) and required for updating tenant. Allowed values are `HOT` - tenant is fully active, `WARM` - tenant is active, some restrictions are imposed (TBD; not supported yet), `COLD` - tenant is inactive; no actions can be performed on tenant, tenant's files are stored locally, `FROZEN` - as COLD, but files are stored on cloud storage (not supported yet)
	// Enum: [HOT WARM COLD FROZEN]
	ActivityStatus string `json:"activityStatus,omitempty"`

	// name of the tenant
	Name string `json:"name,omitempty"`
}

type Vector []float32

type VectorConfig struct {

	// Vector-index config, that is specific to the type of index selected in vectorIndexType
	VectorIndexConfig interface{} `json:"vectorIndexConfig,omitempty"`

	// Name of the vector index to use, eg. (HNSW)
	VectorIndexType string `json:"vectorIndexType,omitempty"`

	// Configuration of a specific vectorizer used by this vector
	Vectorizer interface{} `json:"vectorizer,omitempty"`
}

type VectorWeights interface{}

type Vectors map[string]Vector

type WhereFilter struct {

	// combine multiple where filters, requires 'And' or 'Or' operator
	Operands []*WhereFilter `json:"operands"`

	// operator to use
	// Example: GreaterThanEqual
	// Enum: [And Or Equal Like NotEqual GreaterThan GreaterThanEqual LessThan LessThanEqual WithinGeoRange IsNull ContainsAny ContainsAll]
	Operator string `json:"operator,omitempty"`

	// path to the property currently being filtered
	// Example: ["inCity","City","name"]
	Path []string `json:"path"`

	// value as boolean
	// Example: false
	ValueBoolean *bool `json:"valueBoolean,omitempty"`

	// value as boolean
	// Example: [true,false]
	ValueBooleanArray []bool `json:"valueBooleanArray,omitempty"`

	// value as date (as string)
	// Example: TODO
	ValueDate *string `json:"valueDate,omitempty"`

	// value as date (as string)
	// Example: TODO
	ValueDateArray []string `json:"valueDateArray,omitempty"`

	// value as geo coordinates and distance
	ValueGeoRange *WhereFilterGeoRange `json:"valueGeoRange,omitempty"`

	// value as integer
	// Example: 2000
	ValueInt *int64 `json:"valueInt,omitempty"`

	// value as integer
	// Example: [100, 200]
	ValueIntArray []int64 `json:"valueIntArray,omitempty"`

	// value as number/float
	// Example: 3.14
	ValueNumber *float64 `json:"valueNumber,omitempty"`

	// value as number/float
	// Example: [3.14]
	ValueNumberArray []float64 `json:"valueNumberArray,omitempty"`

	// value as text (deprecated as of v1.19; alias for valueText)
	// Example: my search term
	ValueString *string `json:"valueString,omitempty"`

	// value as text (deprecated as of v1.19; alias for valueText)
	// Example: ["my search term"]
	ValueStringArray []string `json:"valueStringArray,omitempty"`

	// value as text
	// Example: my search term
	ValueText *string `json:"valueText,omitempty"`

	// value as text
	// Example: ["my search term"]
	ValueTextArray []string `json:"valueTextArray,omitempty"`
}

type WhereFilterGeoRange struct {

	// distance
	Distance *WhereFilterGeoRangeDistance `json:"distance,omitempty"`

	// geo coordinates
	GeoCoordinates *GeoCoordinates `json:"geoCoordinates,omitempty"`
}

type WhereFilterGeoRangeDistance struct {

	// max
	Max float64 `json:"max,omitempty"`
}