rest

Documentation

Overview

Package rest with all rest API functions.

Package rest Weaviate

# Introduction
 Weaviate is an open source, AI-native vector database that helps developers create intuitive and reliable AI-powered applications.
 ### Base Path
The base path for the Weaviate server is structured as `[YOUR-WEAVIATE-HOST]:[PORT]/v1`. As an example, if you wish to access the `schema` endpoint on a local instance, you would navigate to `http://localhost:8080/v1/schema`. Ensure you replace `[YOUR-WEAVIATE-HOST]` and `[PORT]` with your actual server host and port number respectively.
 ### Questions?
If you have any comments or questions, please feel free to reach out to us at the community forum [https://forum.weaviate.io/](https://forum.weaviate.io/).
### Issues?
If you find a bug or want to file a feature request, please open an issue on our GitHub repository for [Weaviate](https://github.com/weaviate/weaviate).
### Want more documentation?
For a quickstart, code examples, concepts and more, please visit our [documentation page](https://weaviate.io/developers/weaviate).
Schemes:
  https
Host: localhost
BasePath: /v1
Version: 1.28.3
Contact: Weaviate<hello@weaviate.io> https://github.com/weaviate

Consumes:
  - application/json
  - application/yaml

Produces:
  - application/json

swagger:meta

Index

• Constants
• Variables
• func MakeAppState(ctx context.Context, options *swag.CommandLineOptionsGroup) *state.State
• func NewWeaviateJSONFormatter() logrus.Formatter
• func NewWeaviateTextFormatter() logrus.Formatter
• func ParseVersionFromSwaggerSpec() string
• type MaintenanceMode
• type ModulesProvider
• type RequestStatus
  • func (s RequestStatus) String() string
• type Server
  • func NewServer(api *operations.WeaviateAPI) *Server
  • func (s *Server) ConfigureAPI()
  • func (s *Server) ConfigureFlags()
  • func (s *Server) Fatalf(f string, args ...interface{})
  • func (s *Server) GetHandler() http.Handler
  • func (s *Server) HTTPListener() (net.Listener, error)
  • func (s *Server) Listen() error
  • func (s *Server) Logf(f string, args ...interface{})
  • func (s *Server) Serve() (err error)
  • func (s *Server) SetAPI(api *operations.WeaviateAPI)
  • func (s *Server) SetHandler(handler http.Handler)
  • func (s *Server) Shutdown() error
  • func (s *Server) TLSListener() (net.Listener, error)
  • func (s *Server) UnixListener() (net.Listener, error)
• type WeaviateJSONFormatter
  • func (wf *WeaviateJSONFormatter) Format(e *logrus.Entry) ([]byte, error)
• type WeaviateTextFormatter
  • func (wf *WeaviateTextFormatter) Format(e *logrus.Entry) ([]byte, error)

Constants

const MinimumRequiredContextionaryVersion = "1.0.2"

Variables

var (
	// SwaggerJSON embedded version of the swagger document used at generation time
	SwaggerJSON json.RawMessage
	// FlatSwaggerJSON embedded flattened version of the swagger document used at generation time
	FlatSwaggerJSON json.RawMessage
)

Functions

func MakeAppState

func MakeAppState(ctx context.Context, options *swag.CommandLineOptionsGroup) *state.State

func NewWeaviateJSONFormatter

func NewWeaviateJSONFormatter() logrus.Formatter

func NewWeaviateTextFormatter

func NewWeaviateTextFormatter() logrus.Formatter

func ParseVersionFromSwaggerSpec

func ParseVersionFromSwaggerSpec() string

Types

type MaintenanceMode

type MaintenanceMode struct {
	Enabled bool `json:"enabled"`
}

type ModulesProvider

type ModulesProvider interface {
	RestApiAdditionalProperties(includeProp string, class *models.Class) map[string]interface{}
	GetMeta() (map[string]interface{}, error)
	HasMultipleVectorizers() bool
}

type RequestStatus

type RequestStatus int

const (
	Ok RequestStatus = iota
	UserError
	ServerError
)

func (RequestStatus) String

func (s RequestStatus) String() string

type Server

type Server struct {
	EnabledListeners []string         `long:"scheme" description:"the listeners to enable, this can be repeated and defaults to the schemes in the swagger spec"`
	CleanupTimeout   time.Duration    `long:"cleanup-timeout" description:"grace period for which to wait before killing idle connections" default:"10s"`
	GracefulTimeout  time.Duration    `long:"graceful-timeout" description:"grace period for which to wait before shutting down the server" default:"15s"`
	MaxHeaderSize    flagext.ByteSize `` /* 231-byte string literal not displayed */

	SocketPath flags.Filename `long:"socket-path" description:"the unix socket to listen on" default:"/var/run/weaviate.sock"`

	Host         string        `long:"host" description:"the IP to listen on" default:"localhost" env:"HOST"`
	Port         int           `long:"port" description:"the port to listen on for insecure connections, defaults to a random value" env:"PORT"`
	ListenLimit  int           `long:"listen-limit" description:"limit the number of outstanding requests"`
	KeepAlive    time.Duration `` /* 169-byte string literal not displayed */
	ReadTimeout  time.Duration `long:"read-timeout" description:"maximum duration before timing out read of the request" default:"30s"`
	WriteTimeout time.Duration `long:"write-timeout" description:"maximum duration before timing out write of the response" default:"60s"`

	TLSHost           string         `long:"tls-host" description:"the IP to listen on for tls, when not specified it's the same as --host" env:"TLS_HOST"`
	TLSPort           int            `long:"tls-port" description:"the port to listen on for secure connections, defaults to a random value" env:"TLS_PORT"`
	TLSCertificate    flags.Filename `long:"tls-certificate" description:"the certificate to use for secure connections" env:"TLS_CERTIFICATE"`
	TLSCertificateKey flags.Filename `long:"tls-key" description:"the private key to use for secure connections" env:"TLS_PRIVATE_KEY"`
	TLSCACertificate  flags.Filename `long:"tls-ca" description:"the certificate authority file to be used with mutual tls auth" env:"TLS_CA_CERTIFICATE"`
	TLSListenLimit    int            `long:"tls-listen-limit" description:"limit the number of outstanding requests"`
	TLSKeepAlive      time.Duration  `` /* 160-byte string literal not displayed */
	TLSReadTimeout    time.Duration  `long:"tls-read-timeout" description:"maximum duration before timing out read of the request"`
	TLSWriteTimeout   time.Duration  `long:"tls-write-timeout" description:"maximum duration before timing out write of the response"`
	// contains filtered or unexported fields
}

Server for the weaviate API

func NewServer

func NewServer(api *operations.WeaviateAPI) *Server

NewServer creates a new api weaviate server but does not configure it

func (*Server) ConfigureAPI

func (s *Server) ConfigureAPI()

ConfigureAPI configures the API and handlers.

func (*Server) ConfigureFlags

func (s *Server) ConfigureFlags()

ConfigureFlags configures the additional flags defined by the handlers. Needs to be called before the parser.Parse

func (*Server) Fatalf

func (s *Server) Fatalf(f string, args ...interface{})

Fatalf logs message either via defined user logger or via system one if no user logger is defined. Exits with non-zero status after printing

func (*Server) GetHandler

func (s *Server) GetHandler() http.Handler

GetHandler returns a handler useful for testing

func (*Server) HTTPListener

func (s *Server) HTTPListener() (net.Listener, error)

HTTPListener returns the http listener

func (*Server) Listen

func (s *Server) Listen() error

Listen creates the listeners for the server

func (*Server) Logf

func (s *Server) Logf(f string, args ...interface{})

Logf logs message either via defined user logger or via system one if no user logger is defined.

func (*Server) Serve

func (s *Server) Serve() (err error)

Serve the api

func (*Server) SetAPI

func (s *Server) SetAPI(api *operations.WeaviateAPI)

SetAPI configures the server with the specified API. Needs to be called before Serve

func (*Server) SetHandler

func (s *Server) SetHandler(handler http.Handler)

SetHandler allows for setting a http handler on this server

func (*Server) Shutdown

func (s *Server) Shutdown() error

Shutdown server and clean up resources

func (*Server) TLSListener

func (s *Server) TLSListener() (net.Listener, error)

TLSListener returns the https listener

func (*Server) UnixListener

func (s *Server) UnixListener() (net.Listener, error)

UnixListener returns the domain socket listener

type WeaviateJSONFormatter

type WeaviateJSONFormatter struct {
	*logrus.JSONFormatter
	// contains filtered or unexported fields
}

func (*WeaviateJSONFormatter) Format

func (wf *WeaviateJSONFormatter) Format(e *logrus.Entry) ([]byte, error)

type WeaviateTextFormatter

type WeaviateTextFormatter struct {
	*logrus.TextFormatter
	// contains filtered or unexported fields
}

func (*WeaviateTextFormatter) Format

func (wf *WeaviateTextFormatter) Format(e *logrus.Entry) ([]byte, error)