vald

package
v1.6.2 Latest Latest
Warning

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

 Go to latest Published: Oct 18, 2022 License: Apache-2.0 Imports: 9 Imported by: 6

Documentation

Overview

Package vald provides vald server interface

Index

Constants

View Source 
const (
	InsertRPCServiceName = "Insert"
	UpdateRPCServiceName = "Update"
	UpsertRPCServiceName = "Upsert"
	SearchRPCServiceName = "Search"
	RemoveRPCServiceName = "Remove"
	ObjectRPCServiceName = "Object"
	FilterRPCServiceName = "Filter"
)
View Source 
const (
	InsertRPCName             = "Insert"
	StreamInsertRPCName       = "StreamInsert"
	MultiInsertRPCName        = "MultiInsert"
	InsertObjectRPCName       = "InsertObject"
	StreamInsertObjectRPCName = "StreamInsertObject"
	MultiInsertObjectRPCName  = "MultiInsertObject"

	UpdateRPCName             = "Update"
	StreamUpdateRPCName       = "StreamUpdate"
	MultiUpdateRPCName        = "MultiUpdate"
	UpdateObjectRPCName       = "UpdateObject"
	StreamUpdateObjectRPCName = "StreamUpdateObject"
	MultiUpdateObjectRPCName  = "MultiUpdateObject"

	UpsertRPCName             = "Upsert"
	StreamUpsertRPCName       = "StreamUpsert"
	MultiUpsertRPCName        = "MultiUpsert"
	UpsertObjectRPCName       = "UpsertObject"
	StreamUpsertObjectRPCName = "StreamUpsertObject"
	MultiUpsertObjectRPCName  = "MultiUpsertObject"

	SearchRPCName                   = "Search"
	SearchByIDRPCName               = "SearchByID"
	StreamSearchRPCName             = "StreamSearch"
	StreamSearchByIDRPCName         = "StreamSearchByID"
	MultiSearchRPCName              = "MultiSearch"
	MultiSearchByIDRPCName          = "MultiSearchByID"
	LinearSearchRPCName             = "LinearSearch"
	LinearSearchByIDRPCName         = "LinearSearchByID"
	StreamLinearSearchRPCName       = "StreamLinearSearch"
	StreamLinearSearchByIDRPCName   = "StreamLinearSearchByID"
	MultiLinearSearchRPCName        = "MultiLinearSearch"
	MultiLinearSearchByIDRPCName    = "MultiLinearSearchByID"
	SearchObjectRPCName             = "SearchObject"
	MultiSearchObjectRPCName        = "MultiSearchObject"
	LinearSearchObjectRPCName       = "LinearSearchObject"
	MultiLinearSearchObjectRPCName  = "MultiLinearSearchObject"
	StreamLinearSearchObjectRPCName = "StreamLinearSearchObject"
	StreamSearchObjectRPCName       = "StreamSearchObject"

	RemoveRPCName       = "Remove"
	StreamRemoveRPCName = "StreamRemove"
	MultiRemoveRPCName  = "MultiRemove"

	ExistsRPCName          = "Exists"
	GetObjectRPCName       = "GetObject"
	StreamGetObjectRPCName = "StreamGetObject"
)
View Source 
const PackageName = "vald.v1"

Variables

View Source 
var File_apis_proto_v1_vald_filter_proto protoreflect.FileDescriptor
View Source 
var File_apis_proto_v1_vald_insert_proto protoreflect.FileDescriptor
View Source 
var File_apis_proto_v1_vald_object_proto protoreflect.FileDescriptor
View Source 
var File_apis_proto_v1_vald_remove_proto protoreflect.FileDescriptor
View Source 
var File_apis_proto_v1_vald_search_proto protoreflect.FileDescriptor
View Source 
var File_apis_proto_v1_vald_update_proto protoreflect.FileDescriptor
View Source 
var File_apis_proto_v1_vald_upsert_proto protoreflect.FileDescriptor
View Source 
var Filter_ServiceDesc = grpc.ServiceDesc{
	ServiceName: "vald.v1.Filter",
	HandlerType: (*FilterServer)(nil),
	Methods: []grpc.MethodDesc{
		{
			MethodName: "SearchObject",
			Handler:    _Filter_SearchObject_Handler,
		},
		{
			MethodName: "MultiSearchObject",
			Handler:    _Filter_MultiSearchObject_Handler,
		},
		{
			MethodName: "InsertObject",
			Handler:    _Filter_InsertObject_Handler,
		},
		{
			MethodName: "MultiInsertObject",
			Handler:    _Filter_MultiInsertObject_Handler,
		},
		{
			MethodName: "UpdateObject",
			Handler:    _Filter_UpdateObject_Handler,
		},
		{
			MethodName: "MultiUpdateObject",
			Handler:    _Filter_MultiUpdateObject_Handler,
		},
		{
			MethodName: "UpsertObject",
			Handler:    _Filter_UpsertObject_Handler,
		},
		{
			MethodName: "MultiUpsertObject",
			Handler:    _Filter_MultiUpsertObject_Handler,
		},
	},
	Streams: []grpc.StreamDesc{
		{
			StreamName:    "StreamSearchObject",
			Handler:       _Filter_StreamSearchObject_Handler,
			ServerStreams: true,
			ClientStreams: true,
		},
		{
			StreamName:    "StreamInsertObject",
			Handler:       _Filter_StreamInsertObject_Handler,
			ServerStreams: true,
			ClientStreams: true,
		},
		{
			StreamName:    "StreamUpdateObject",
			Handler:       _Filter_StreamUpdateObject_Handler,
			ServerStreams: true,
			ClientStreams: true,
		},
		{
			StreamName:    "StreamUpsertObject",
			Handler:       _Filter_StreamUpsertObject_Handler,
			ServerStreams: true,
			ClientStreams: true,
		},
	},
	Metadata: "apis/proto/v1/vald/filter.proto",
}

Filter_ServiceDesc is the grpc.ServiceDesc for Filter service. It's only intended for direct use with grpc.RegisterService, and not to be introspected or modified (even as a copy)

View Source 
var Insert_ServiceDesc = grpc.ServiceDesc{
	ServiceName: "vald.v1.Insert",
	HandlerType: (*InsertServer)(nil),
	Methods: []grpc.MethodDesc{
		{
			MethodName: "Insert",
			Handler:    _Insert_Insert_Handler,
		},
		{
			MethodName: "MultiInsert",
			Handler:    _Insert_MultiInsert_Handler,
		},
	},
	Streams: []grpc.StreamDesc{
		{
			StreamName:    "StreamInsert",
			Handler:       _Insert_StreamInsert_Handler,
			ServerStreams: true,
			ClientStreams: true,
		},
	},
	Metadata: "apis/proto/v1/vald/insert.proto",
}

Insert_ServiceDesc is the grpc.ServiceDesc for Insert service. It's only intended for direct use with grpc.RegisterService, and not to be introspected or modified (even as a copy)

View Source 
var Object_ServiceDesc = grpc.ServiceDesc{
	ServiceName: "vald.v1.Object",
	HandlerType: (*ObjectServer)(nil),
	Methods: []grpc.MethodDesc{
		{
			MethodName: "Exists",
			Handler:    _Object_Exists_Handler,
		},
		{
			MethodName: "GetObject",
			Handler:    _Object_GetObject_Handler,
		},
	},
	Streams: []grpc.StreamDesc{
		{
			StreamName:    "StreamGetObject",
			Handler:       _Object_StreamGetObject_Handler,
			ServerStreams: true,
			ClientStreams: true,
		},
	},
	Metadata: "apis/proto/v1/vald/object.proto",
}

Object_ServiceDesc is the grpc.ServiceDesc for Object service. It's only intended for direct use with grpc.RegisterService, and not to be introspected or modified (even as a copy)

View Source 
var Remove_ServiceDesc = grpc.ServiceDesc{
	ServiceName: "vald.v1.Remove",
	HandlerType: (*RemoveServer)(nil),
	Methods: []grpc.MethodDesc{
		{
			MethodName: "Remove",
			Handler:    _Remove_Remove_Handler,
		},
		{
			MethodName: "MultiRemove",
			Handler:    _Remove_MultiRemove_Handler,
		},
	},
	Streams: []grpc.StreamDesc{
		{
			StreamName:    "StreamRemove",
			Handler:       _Remove_StreamRemove_Handler,
			ServerStreams: true,
			ClientStreams: true,
		},
	},
	Metadata: "apis/proto/v1/vald/remove.proto",
}

Remove_ServiceDesc is the grpc.ServiceDesc for Remove service. It's only intended for direct use with grpc.RegisterService, and not to be introspected or modified (even as a copy)

View Source 
var Search_ServiceDesc = grpc.ServiceDesc{
	ServiceName: "vald.v1.Search",
	HandlerType: (*SearchServer)(nil),
	Methods: []grpc.MethodDesc{
		{
			MethodName: "Search",
			Handler:    _Search_Search_Handler,
		},
		{
			MethodName: "SearchByID",
			Handler:    _Search_SearchByID_Handler,
		},
		{
			MethodName: "MultiSearch",
			Handler:    _Search_MultiSearch_Handler,
		},
		{
			MethodName: "MultiSearchByID",
			Handler:    _Search_MultiSearchByID_Handler,
		},
		{
			MethodName: "LinearSearch",
			Handler:    _Search_LinearSearch_Handler,
		},
		{
			MethodName: "LinearSearchByID",
			Handler:    _Search_LinearSearchByID_Handler,
		},
		{
			MethodName: "MultiLinearSearch",
			Handler:    _Search_MultiLinearSearch_Handler,
		},
		{
			MethodName: "MultiLinearSearchByID",
			Handler:    _Search_MultiLinearSearchByID_Handler,
		},
	},
	Streams: []grpc.StreamDesc{
		{
			StreamName:    "StreamSearch",
			Handler:       _Search_StreamSearch_Handler,
			ServerStreams: true,
			ClientStreams: true,
		},
		{
			StreamName:    "StreamSearchByID",
			Handler:       _Search_StreamSearchByID_Handler,
			ServerStreams: true,
			ClientStreams: true,
		},
		{
			StreamName:    "StreamLinearSearch",
			Handler:       _Search_StreamLinearSearch_Handler,
			ServerStreams: true,
			ClientStreams: true,
		},
		{
			StreamName:    "StreamLinearSearchByID",
			Handler:       _Search_StreamLinearSearchByID_Handler,
			ServerStreams: true,
			ClientStreams: true,
		},
	},
	Metadata: "apis/proto/v1/vald/search.proto",
}

Search_ServiceDesc is the grpc.ServiceDesc for Search service. It's only intended for direct use with grpc.RegisterService, and not to be introspected or modified (even as a copy)

View Source 
var Update_ServiceDesc = grpc.ServiceDesc{
	ServiceName: "vald.v1.Update",
	HandlerType: (*UpdateServer)(nil),
	Methods: []grpc.MethodDesc{
		{
			MethodName: "Update",
			Handler:    _Update_Update_Handler,
		},
		{
			MethodName: "MultiUpdate",
			Handler:    _Update_MultiUpdate_Handler,
		},
	},
	Streams: []grpc.StreamDesc{
		{
			StreamName:    "StreamUpdate",
			Handler:       _Update_StreamUpdate_Handler,
			ServerStreams: true,
			ClientStreams: true,
		},
	},
	Metadata: "apis/proto/v1/vald/update.proto",
}

Update_ServiceDesc is the grpc.ServiceDesc for Update service. It's only intended for direct use with grpc.RegisterService, and not to be introspected or modified (even as a copy)

View Source 
var Upsert_ServiceDesc = grpc.ServiceDesc{
	ServiceName: "vald.v1.Upsert",
	HandlerType: (*UpsertServer)(nil),
	Methods: []grpc.MethodDesc{
		{
			MethodName: "Upsert",
			Handler:    _Upsert_Upsert_Handler,
		},
		{
			MethodName: "MultiUpsert",
			Handler:    _Upsert_MultiUpsert_Handler,
		},
	},
	Streams: []grpc.StreamDesc{
		{
			StreamName:    "StreamUpsert",
			Handler:       _Upsert_StreamUpsert_Handler,
			ServerStreams: true,
			ClientStreams: true,
		},
	},
	Metadata: "apis/proto/v1/vald/upsert.proto",
}

Upsert_ServiceDesc is the grpc.ServiceDesc for Upsert service. It's only intended for direct use with grpc.RegisterService, and not to be introspected or modified (even as a copy)

Functions

func RegisterFilterServer 

func RegisterFilterServer(s grpc.ServiceRegistrar, srv FilterServer)

func RegisterInsertServer 

func RegisterInsertServer(s grpc.ServiceRegistrar, srv InsertServer)

func RegisterObjectServer 

func RegisterObjectServer(s grpc.ServiceRegistrar, srv ObjectServer)

func RegisterRemoveServer 

func RegisterRemoveServer(s grpc.ServiceRegistrar, srv RemoveServer)

func RegisterSearchServer 

func RegisterSearchServer(s grpc.ServiceRegistrar, srv SearchServer)

func RegisterUpdateServer 

func RegisterUpdateServer(s grpc.ServiceRegistrar, srv UpdateServer)

func RegisterUpsertServer 

func RegisterUpsertServer(s grpc.ServiceRegistrar, srv UpsertServer)

func RegisterValdServer 

func RegisterValdServer(s *grpc.Server, srv Server)

func RegisterValdServerWithFilter 

func RegisterValdServerWithFilter(s *grpc.Server, srv ServerWithFilter)

Types

type Client 

type Client interface {
	InsertClient
	UpdateClient
	UpsertClient
	SearchClient
	RemoveClient
	ObjectClient
}

func NewValdClient 

func NewValdClient(conn *grpc.ClientConn) Client

type ClientWithFilter 

type ClientWithFilter interface {
	Client
	FilterClient
}

type FilterClient 

type FilterClient interface {
	// A method to search object.
	SearchObject(ctx context.Context, in *payload.Search_ObjectRequest, opts ...grpc.CallOption) (*payload.Search_Response, error)
	// A method to search multiple objects.
	MultiSearchObject(ctx context.Context, in *payload.Search_MultiObjectRequest, opts ...grpc.CallOption) (*payload.Search_Responses, error)
	// A method to search object by bidirectional streaming.
	StreamSearchObject(ctx context.Context, opts ...grpc.CallOption) (Filter_StreamSearchObjectClient, error)
	// A method insert object.
	InsertObject(ctx context.Context, in *payload.Insert_ObjectRequest, opts ...grpc.CallOption) (*payload.Object_Location, error)
	// Represent the streaming RPC to insert object by bidirectional streaming.
	StreamInsertObject(ctx context.Context, opts ...grpc.CallOption) (Filter_StreamInsertObjectClient, error)
	// A method to insert multiple objects.
	MultiInsertObject(ctx context.Context, in *payload.Insert_MultiObjectRequest, opts ...grpc.CallOption) (*payload.Object_Locations, error)
	// A method to update object.
	UpdateObject(ctx context.Context, in *payload.Update_ObjectRequest, opts ...grpc.CallOption) (*payload.Object_Location, error)
	// A method to update object by bidirectional streaming.
	StreamUpdateObject(ctx context.Context, opts ...grpc.CallOption) (Filter_StreamUpdateObjectClient, error)
	// A method to update multiple objects.
	MultiUpdateObject(ctx context.Context, in *payload.Update_MultiObjectRequest, opts ...grpc.CallOption) (*payload.Object_Locations, error)
	// A method to upsert object.
	UpsertObject(ctx context.Context, in *payload.Upsert_ObjectRequest, opts ...grpc.CallOption) (*payload.Object_Location, error)
	// A method to upsert object by bidirectional streaming.
	StreamUpsertObject(ctx context.Context, opts ...grpc.CallOption) (Filter_StreamUpsertObjectClient, error)
	// A method to upsert multiple objects.
	MultiUpsertObject(ctx context.Context, in *payload.Upsert_MultiObjectRequest, opts ...grpc.CallOption) (*payload.Object_Locations, error)
}

FilterClient is the client API for Filter service.

For semantics around ctx use and closing/ending streaming RPCs, please refer to https://pkg.go.dev/google.golang.org/grpc/?tab=doc#ClientConn.NewStream.

func NewFilterClient 

func NewFilterClient(cc grpc.ClientConnInterface) FilterClient

type FilterServer 

type FilterServer interface {
	// A method to search object.
	SearchObject(context.Context, *payload.Search_ObjectRequest) (*payload.Search_Response, error)
	// A method to search multiple objects.
	MultiSearchObject(context.Context, *payload.Search_MultiObjectRequest) (*payload.Search_Responses, error)
	// A method to search object by bidirectional streaming.
	StreamSearchObject(Filter_StreamSearchObjectServer) error
	// A method insert object.
	InsertObject(context.Context, *payload.Insert_ObjectRequest) (*payload.Object_Location, error)
	// Represent the streaming RPC to insert object by bidirectional streaming.
	StreamInsertObject(Filter_StreamInsertObjectServer) error
	// A method to insert multiple objects.
	MultiInsertObject(context.Context, *payload.Insert_MultiObjectRequest) (*payload.Object_Locations, error)
	// A method to update object.
	UpdateObject(context.Context, *payload.Update_ObjectRequest) (*payload.Object_Location, error)
	// A method to update object by bidirectional streaming.
	StreamUpdateObject(Filter_StreamUpdateObjectServer) error
	// A method to update multiple objects.
	MultiUpdateObject(context.Context, *payload.Update_MultiObjectRequest) (*payload.Object_Locations, error)
	// A method to upsert object.
	UpsertObject(context.Context, *payload.Upsert_ObjectRequest) (*payload.Object_Location, error)
	// A method to upsert object by bidirectional streaming.
	StreamUpsertObject(Filter_StreamUpsertObjectServer) error
	// A method to upsert multiple objects.
	MultiUpsertObject(context.Context, *payload.Upsert_MultiObjectRequest) (*payload.Object_Locations, error)
	// contains filtered or unexported methods
}

FilterServer is the server API for Filter service. All implementations must embed UnimplementedFilterServer for forward compatibility

type Filter_StreamInsertObjectClient 

type Filter_StreamInsertObjectClient interface {
	Send(*payload.Insert_ObjectRequest) error
	Recv() (*payload.Object_StreamLocation, error)
	grpc.ClientStream
}

type Filter_StreamInsertObjectServer 

type Filter_StreamInsertObjectServer interface {
	Send(*payload.Object_StreamLocation) error
	Recv() (*payload.Insert_ObjectRequest, error)
	grpc.ServerStream
}

type Filter_StreamSearchObjectClient 

type Filter_StreamSearchObjectClient interface {
	Send(*payload.Search_ObjectRequest) error
	Recv() (*payload.Search_StreamResponse, error)
	grpc.ClientStream
}

type Filter_StreamSearchObjectServer 

type Filter_StreamSearchObjectServer interface {
	Send(*payload.Search_StreamResponse) error
	Recv() (*payload.Search_ObjectRequest, error)
	grpc.ServerStream
}

type Filter_StreamUpdateObjectClient 

type Filter_StreamUpdateObjectClient interface {
	Send(*payload.Update_ObjectRequest) error
	Recv() (*payload.Object_StreamLocation, error)
	grpc.ClientStream
}

type Filter_StreamUpdateObjectServer 

type Filter_StreamUpdateObjectServer interface {
	Send(*payload.Object_StreamLocation) error
	Recv() (*payload.Update_ObjectRequest, error)
	grpc.ServerStream
}

type Filter_StreamUpsertObjectClient 

type Filter_StreamUpsertObjectClient interface {
	Send(*payload.Upsert_ObjectRequest) error
	Recv() (*payload.Object_StreamLocation, error)
	grpc.ClientStream
}

type Filter_StreamUpsertObjectServer 

type Filter_StreamUpsertObjectServer interface {
	Send(*payload.Object_StreamLocation) error
	Recv() (*payload.Upsert_ObjectRequest, error)
	grpc.ServerStream
}

type InsertClient 

type InsertClient interface {
	// A method to add a new single vector.
	Insert(ctx context.Context, in *payload.Insert_Request, opts ...grpc.CallOption) (*payload.Object_Location, error)
	// A method to add new multiple vectors by bidirectional streaming.
	StreamInsert(ctx context.Context, opts ...grpc.CallOption) (Insert_StreamInsertClient, error)
	// A method to add new multiple vectors in a single request.
	MultiInsert(ctx context.Context, in *payload.Insert_MultiRequest, opts ...grpc.CallOption) (*payload.Object_Locations, error)
}

InsertClient is the client API for Insert service.

For semantics around ctx use and closing/ending streaming RPCs, please refer to https://pkg.go.dev/google.golang.org/grpc/?tab=doc#ClientConn.NewStream.

func NewInsertClient 

func NewInsertClient(cc grpc.ClientConnInterface) InsertClient

type InsertServer 

type InsertServer interface {
	// A method to add a new single vector.
	Insert(context.Context, *payload.Insert_Request) (*payload.Object_Location, error)
	// A method to add new multiple vectors by bidirectional streaming.
	StreamInsert(Insert_StreamInsertServer) error
	// A method to add new multiple vectors in a single request.
	MultiInsert(context.Context, *payload.Insert_MultiRequest) (*payload.Object_Locations, error)
	// contains filtered or unexported methods
}

InsertServer is the server API for Insert service. All implementations must embed UnimplementedInsertServer for forward compatibility

type Insert_StreamInsertClient 

type Insert_StreamInsertClient interface {
	Send(*payload.Insert_Request) error
	Recv() (*payload.Object_StreamLocation, error)
	grpc.ClientStream
}

type Insert_StreamInsertServer 

type Insert_StreamInsertServer interface {
	Send(*payload.Object_StreamLocation) error
	Recv() (*payload.Insert_Request, error)
	grpc.ServerStream
}

type ObjectClient 

type ObjectClient interface {
	// A method to check whether a specified ID is indexed or not.
	Exists(ctx context.Context, in *payload.Object_ID, opts ...grpc.CallOption) (*payload.Object_ID, error)
	// A method to fetch a vector.
	GetObject(ctx context.Context, in *payload.Object_VectorRequest, opts ...grpc.CallOption) (*payload.Object_Vector, error)
	// A method to fetch vectors by bidirectional streaming.
	StreamGetObject(ctx context.Context, opts ...grpc.CallOption) (Object_StreamGetObjectClient, error)
}

ObjectClient is the client API for Object service.

For semantics around ctx use and closing/ending streaming RPCs, please refer to https://pkg.go.dev/google.golang.org/grpc/?tab=doc#ClientConn.NewStream.

func NewObjectClient 

func NewObjectClient(cc grpc.ClientConnInterface) ObjectClient

type ObjectServer 

type ObjectServer interface {
	// A method to check whether a specified ID is indexed or not.
	Exists(context.Context, *payload.Object_ID) (*payload.Object_ID, error)
	// A method to fetch a vector.
	GetObject(context.Context, *payload.Object_VectorRequest) (*payload.Object_Vector, error)
	// A method to fetch vectors by bidirectional streaming.
	StreamGetObject(Object_StreamGetObjectServer) error
	// contains filtered or unexported methods
}

ObjectServer is the server API for Object service. All implementations must embed UnimplementedObjectServer for forward compatibility

type Object_StreamGetObjectClient 

type Object_StreamGetObjectClient interface {
	Send(*payload.Object_VectorRequest) error
	Recv() (*payload.Object_StreamVector, error)
	grpc.ClientStream
}

type Object_StreamGetObjectServer 

type Object_StreamGetObjectServer interface {
	Send(*payload.Object_StreamVector) error
	Recv() (*payload.Object_VectorRequest, error)
	grpc.ServerStream
}

type RemoveClient 

type RemoveClient interface {
	// A method to remove an indexed vector.
	Remove(ctx context.Context, in *payload.Remove_Request, opts ...grpc.CallOption) (*payload.Object_Location, error)
	// A method to remove multiple indexed vectors by bidirectional streaming.
	StreamRemove(ctx context.Context, opts ...grpc.CallOption) (Remove_StreamRemoveClient, error)
	// A method to remove multiple indexed vectors in a single request.
	MultiRemove(ctx context.Context, in *payload.Remove_MultiRequest, opts ...grpc.CallOption) (*payload.Object_Locations, error)
}

RemoveClient is the client API for Remove service.

For semantics around ctx use and closing/ending streaming RPCs, please refer to https://pkg.go.dev/google.golang.org/grpc/?tab=doc#ClientConn.NewStream.

func NewRemoveClient 

func NewRemoveClient(cc grpc.ClientConnInterface) RemoveClient

type RemoveServer 

type RemoveServer interface {
	// A method to remove an indexed vector.
	Remove(context.Context, *payload.Remove_Request) (*payload.Object_Location, error)
	// A method to remove multiple indexed vectors by bidirectional streaming.
	StreamRemove(Remove_StreamRemoveServer) error
	// A method to remove multiple indexed vectors in a single request.
	MultiRemove(context.Context, *payload.Remove_MultiRequest) (*payload.Object_Locations, error)
	// contains filtered or unexported methods
}

RemoveServer is the server API for Remove service. All implementations must embed UnimplementedRemoveServer for forward compatibility

type Remove_StreamRemoveClient 

type Remove_StreamRemoveClient interface {
	Send(*payload.Remove_Request) error
	Recv() (*payload.Object_StreamLocation, error)
	grpc.ClientStream
}

type Remove_StreamRemoveServer 

type Remove_StreamRemoveServer interface {
	Send(*payload.Object_StreamLocation) error
	Recv() (*payload.Remove_Request, error)
	grpc.ServerStream
}

type SearchClient 

type SearchClient interface {
	// A method to search indexed vectors by a raw vector.
	Search(ctx context.Context, in *payload.Search_Request, opts ...grpc.CallOption) (*payload.Search_Response, error)
	// A method to search indexed vectors by ID.
	SearchByID(ctx context.Context, in *payload.Search_IDRequest, opts ...grpc.CallOption) (*payload.Search_Response, error)
	// A method to search indexed vectors by multiple vectors.
	StreamSearch(ctx context.Context, opts ...grpc.CallOption) (Search_StreamSearchClient, error)
	// A method to search indexed vectors by multiple IDs.
	StreamSearchByID(ctx context.Context, opts ...grpc.CallOption) (Search_StreamSearchByIDClient, error)
	// A method to search indexed vectors by multiple vectors in a single request.
	MultiSearch(ctx context.Context, in *payload.Search_MultiRequest, opts ...grpc.CallOption) (*payload.Search_Responses, error)
	// A method to search indexed vectors by multiple IDs in a single request.
	MultiSearchByID(ctx context.Context, in *payload.Search_MultiIDRequest, opts ...grpc.CallOption) (*payload.Search_Responses, error)
	// A method to linear search indexed vectors by a raw vector.
	LinearSearch(ctx context.Context, in *payload.Search_Request, opts ...grpc.CallOption) (*payload.Search_Response, error)
	// A method to linear search indexed vectors by ID.
	LinearSearchByID(ctx context.Context, in *payload.Search_IDRequest, opts ...grpc.CallOption) (*payload.Search_Response, error)
	// A method to linear search indexed vectors by multiple vectors.
	StreamLinearSearch(ctx context.Context, opts ...grpc.CallOption) (Search_StreamLinearSearchClient, error)
	// A method to linear search indexed vectors by multiple IDs.
	StreamLinearSearchByID(ctx context.Context, opts ...grpc.CallOption) (Search_StreamLinearSearchByIDClient, error)
	// A method to linear search indexed vectors by multiple vectors in a single request.
	MultiLinearSearch(ctx context.Context, in *payload.Search_MultiRequest, opts ...grpc.CallOption) (*payload.Search_Responses, error)
	// A method to linear search indexed vectors by multiple IDs in a single request.
	MultiLinearSearchByID(ctx context.Context, in *payload.Search_MultiIDRequest, opts ...grpc.CallOption) (*payload.Search_Responses, error)
}

SearchClient is the client API for Search service.

For semantics around ctx use and closing/ending streaming RPCs, please refer to https://pkg.go.dev/google.golang.org/grpc/?tab=doc#ClientConn.NewStream.

func NewSearchClient 

func NewSearchClient(cc grpc.ClientConnInterface) SearchClient

type SearchServer 

type SearchServer interface {
	// A method to search indexed vectors by a raw vector.
	Search(context.Context, *payload.Search_Request) (*payload.Search_Response, error)
	// A method to search indexed vectors by ID.
	SearchByID(context.Context, *payload.Search_IDRequest) (*payload.Search_Response, error)
	// A method to search indexed vectors by multiple vectors.
	StreamSearch(Search_StreamSearchServer) error
	// A method to search indexed vectors by multiple IDs.
	StreamSearchByID(Search_StreamSearchByIDServer) error
	// A method to search indexed vectors by multiple vectors in a single request.
	MultiSearch(context.Context, *payload.Search_MultiRequest) (*payload.Search_Responses, error)
	// A method to search indexed vectors by multiple IDs in a single request.
	MultiSearchByID(context.Context, *payload.Search_MultiIDRequest) (*payload.Search_Responses, error)
	// A method to linear search indexed vectors by a raw vector.
	LinearSearch(context.Context, *payload.Search_Request) (*payload.Search_Response, error)
	// A method to linear search indexed vectors by ID.
	LinearSearchByID(context.Context, *payload.Search_IDRequest) (*payload.Search_Response, error)
	// A method to linear search indexed vectors by multiple vectors.
	StreamLinearSearch(Search_StreamLinearSearchServer) error
	// A method to linear search indexed vectors by multiple IDs.
	StreamLinearSearchByID(Search_StreamLinearSearchByIDServer) error
	// A method to linear search indexed vectors by multiple vectors in a single request.
	MultiLinearSearch(context.Context, *payload.Search_MultiRequest) (*payload.Search_Responses, error)
	// A method to linear search indexed vectors by multiple IDs in a single request.
	MultiLinearSearchByID(context.Context, *payload.Search_MultiIDRequest) (*payload.Search_Responses, error)
	// contains filtered or unexported methods
}

SearchServer is the server API for Search service. All implementations must embed UnimplementedSearchServer for forward compatibility

type Search_StreamLinearSearchByIDClient added in v1.4.0 

type Search_StreamLinearSearchByIDClient interface {
	Send(*payload.Search_IDRequest) error
	Recv() (*payload.Search_StreamResponse, error)
	grpc.ClientStream
}

type Search_StreamLinearSearchByIDServer added in v1.4.0 

type Search_StreamLinearSearchByIDServer interface {
	Send(*payload.Search_StreamResponse) error
	Recv() (*payload.Search_IDRequest, error)
	grpc.ServerStream
}

type Search_StreamLinearSearchClient added in v1.4.0 

type Search_StreamLinearSearchClient interface {
	Send(*payload.Search_Request) error
	Recv() (*payload.Search_StreamResponse, error)
	grpc.ClientStream
}

type Search_StreamLinearSearchServer added in v1.4.0 

type Search_StreamLinearSearchServer interface {
	Send(*payload.Search_StreamResponse) error
	Recv() (*payload.Search_Request, error)
	grpc.ServerStream
}

type Search_StreamSearchByIDClient 

type Search_StreamSearchByIDClient interface {
	Send(*payload.Search_IDRequest) error
	Recv() (*payload.Search_StreamResponse, error)
	grpc.ClientStream
}

type Search_StreamSearchByIDServer 

type Search_StreamSearchByIDServer interface {
	Send(*payload.Search_StreamResponse) error
	Recv() (*payload.Search_IDRequest, error)
	grpc.ServerStream
}

type Search_StreamSearchClient 

type Search_StreamSearchClient interface {
	Send(*payload.Search_Request) error
	Recv() (*payload.Search_StreamResponse, error)
	grpc.ClientStream
}

type Search_StreamSearchServer 

type Search_StreamSearchServer interface {
	Send(*payload.Search_StreamResponse) error
	Recv() (*payload.Search_Request, error)
	grpc.ServerStream
}

type Server 

type Server interface {
	InsertServer
	UpdateServer
	UpsertServer
	SearchServer
	RemoveServer
	ObjectServer
}

type ServerWithFilter 

type ServerWithFilter interface {
	Server
	FilterServer
}

type UnimplementedFilterServer 

type UnimplementedFilterServer struct {
}

UnimplementedFilterServer must be embedded to have forward compatible implementations.

func (UnimplementedFilterServer) InsertObject 

func (UnimplementedFilterServer) InsertObject(context.Context, *payload.Insert_ObjectRequest) (*payload.Object_Location, error)

func (UnimplementedFilterServer) MultiInsertObject 

func (UnimplementedFilterServer) MultiInsertObject(context.Context, *payload.Insert_MultiObjectRequest) (*payload.Object_Locations, error)

func (UnimplementedFilterServer) MultiSearchObject 

func (UnimplementedFilterServer) MultiSearchObject(context.Context, *payload.Search_MultiObjectRequest) (*payload.Search_Responses, error)

func (UnimplementedFilterServer) MultiUpdateObject 

func (UnimplementedFilterServer) MultiUpdateObject(context.Context, *payload.Update_MultiObjectRequest) (*payload.Object_Locations, error)

func (UnimplementedFilterServer) MultiUpsertObject 

func (UnimplementedFilterServer) MultiUpsertObject(context.Context, *payload.Upsert_MultiObjectRequest) (*payload.Object_Locations, error)

func (UnimplementedFilterServer) SearchObject 

func (UnimplementedFilterServer) SearchObject(context.Context, *payload.Search_ObjectRequest) (*payload.Search_Response, error)

func (UnimplementedFilterServer) StreamInsertObject 

func (UnimplementedFilterServer) StreamInsertObject(Filter_StreamInsertObjectServer) error

func (UnimplementedFilterServer) StreamSearchObject 

func (UnimplementedFilterServer) StreamSearchObject(Filter_StreamSearchObjectServer) error

func (UnimplementedFilterServer) StreamUpdateObject 

func (UnimplementedFilterServer) StreamUpdateObject(Filter_StreamUpdateObjectServer) error

func (UnimplementedFilterServer) StreamUpsertObject 

func (UnimplementedFilterServer) StreamUpsertObject(Filter_StreamUpsertObjectServer) error

func (UnimplementedFilterServer) UpdateObject 

func (UnimplementedFilterServer) UpdateObject(context.Context, *payload.Update_ObjectRequest) (*payload.Object_Location, error)

func (UnimplementedFilterServer) UpsertObject 

func (UnimplementedFilterServer) UpsertObject(context.Context, *payload.Upsert_ObjectRequest) (*payload.Object_Location, error)

type UnimplementedInsertServer 

type UnimplementedInsertServer struct {
}

UnimplementedInsertServer must be embedded to have forward compatible implementations.

func (UnimplementedInsertServer) Insert 

func (UnimplementedInsertServer) Insert(context.Context, *payload.Insert_Request) (*payload.Object_Location, error)

func (UnimplementedInsertServer) MultiInsert 

func (UnimplementedInsertServer) MultiInsert(context.Context, *payload.Insert_MultiRequest) (*payload.Object_Locations, error)

func (UnimplementedInsertServer) StreamInsert 

func (UnimplementedInsertServer) StreamInsert(Insert_StreamInsertServer) error

type UnimplementedObjectServer 

type UnimplementedObjectServer struct {
}

UnimplementedObjectServer must be embedded to have forward compatible implementations.

func (UnimplementedObjectServer) Exists 

func (UnimplementedObjectServer) Exists(context.Context, *payload.Object_ID) (*payload.Object_ID, error)

func (UnimplementedObjectServer) GetObject 

func (UnimplementedObjectServer) GetObject(context.Context, *payload.Object_VectorRequest) (*payload.Object_Vector, error)

func (UnimplementedObjectServer) StreamGetObject 

func (UnimplementedObjectServer) StreamGetObject(Object_StreamGetObjectServer) error

type UnimplementedRemoveServer 

type UnimplementedRemoveServer struct {
}

UnimplementedRemoveServer must be embedded to have forward compatible implementations.

func (UnimplementedRemoveServer) MultiRemove 

func (UnimplementedRemoveServer) MultiRemove(context.Context, *payload.Remove_MultiRequest) (*payload.Object_Locations, error)

func (UnimplementedRemoveServer) Remove 

func (UnimplementedRemoveServer) Remove(context.Context, *payload.Remove_Request) (*payload.Object_Location, error)

func (UnimplementedRemoveServer) StreamRemove 

func (UnimplementedRemoveServer) StreamRemove(Remove_StreamRemoveServer) error

type UnimplementedSearchServer 

type UnimplementedSearchServer struct {
}

UnimplementedSearchServer must be embedded to have forward compatible implementations.

func (UnimplementedSearchServer) LinearSearch added in v1.4.0 

func (UnimplementedSearchServer) LinearSearch(context.Context, *payload.Search_Request) (*payload.Search_Response, error)

func (UnimplementedSearchServer) LinearSearchByID added in v1.4.0 

func (UnimplementedSearchServer) LinearSearchByID(context.Context, *payload.Search_IDRequest) (*payload.Search_Response, error)

func (UnimplementedSearchServer) MultiLinearSearch added in v1.4.0 

func (UnimplementedSearchServer) MultiLinearSearch(context.Context, *payload.Search_MultiRequest) (*payload.Search_Responses, error)

func (UnimplementedSearchServer) MultiLinearSearchByID added in v1.4.0 

func (UnimplementedSearchServer) MultiLinearSearchByID(context.Context, *payload.Search_MultiIDRequest) (*payload.Search_Responses, error)

func (UnimplementedSearchServer) MultiSearch 

func (UnimplementedSearchServer) MultiSearch(context.Context, *payload.Search_MultiRequest) (*payload.Search_Responses, error)

func (UnimplementedSearchServer) MultiSearchByID 

func (UnimplementedSearchServer) MultiSearchByID(context.Context, *payload.Search_MultiIDRequest) (*payload.Search_Responses, error)

func (UnimplementedSearchServer) Search 

func (UnimplementedSearchServer) Search(context.Context, *payload.Search_Request) (*payload.Search_Response, error)

func (UnimplementedSearchServer) SearchByID 

func (UnimplementedSearchServer) SearchByID(context.Context, *payload.Search_IDRequest) (*payload.Search_Response, error)

func (UnimplementedSearchServer) StreamLinearSearch added in v1.4.0 

func (UnimplementedSearchServer) StreamLinearSearch(Search_StreamLinearSearchServer) error

func (UnimplementedSearchServer) StreamLinearSearchByID added in v1.4.0 

func (UnimplementedSearchServer) StreamLinearSearchByID(Search_StreamLinearSearchByIDServer) error

func (UnimplementedSearchServer) StreamSearch 

func (UnimplementedSearchServer) StreamSearch(Search_StreamSearchServer) error

func (UnimplementedSearchServer) StreamSearchByID 

func (UnimplementedSearchServer) StreamSearchByID(Search_StreamSearchByIDServer) error

type UnimplementedUpdateServer 

type UnimplementedUpdateServer struct {
}

UnimplementedUpdateServer must be embedded to have forward compatible implementations.

func (UnimplementedUpdateServer) MultiUpdate 

func (UnimplementedUpdateServer) MultiUpdate(context.Context, *payload.Update_MultiRequest) (*payload.Object_Locations, error)

func (UnimplementedUpdateServer) StreamUpdate 

func (UnimplementedUpdateServer) StreamUpdate(Update_StreamUpdateServer) error

func (UnimplementedUpdateServer) Update 

func (UnimplementedUpdateServer) Update(context.Context, *payload.Update_Request) (*payload.Object_Location, error)

type UnimplementedUpsertServer 

type UnimplementedUpsertServer struct {
}

UnimplementedUpsertServer must be embedded to have forward compatible implementations.

func (UnimplementedUpsertServer) MultiUpsert 

func (UnimplementedUpsertServer) MultiUpsert(context.Context, *payload.Upsert_MultiRequest) (*payload.Object_Locations, error)

func (UnimplementedUpsertServer) StreamUpsert 

func (UnimplementedUpsertServer) StreamUpsert(Upsert_StreamUpsertServer) error

func (UnimplementedUpsertServer) Upsert 

func (UnimplementedUpsertServer) Upsert(context.Context, *payload.Upsert_Request) (*payload.Object_Location, error)

type UnimplementedValdServer added in v1.2.1 

type UnimplementedValdServer struct {
	UnimplementedInsertServer
	UnimplementedUpdateServer
	UnimplementedUpsertServer
	UnimplementedSearchServer
	UnimplementedRemoveServer
	UnimplementedObjectServer
}

type UnimplementedValdServerWithFilter added in v1.2.1 

type UnimplementedValdServerWithFilter struct {
	UnimplementedValdServer
	UnimplementedFilterServer
}

type UnsafeFilterServer added in v1.2.1 

type UnsafeFilterServer interface {
	// contains filtered or unexported methods
}

UnsafeFilterServer may be embedded to opt out of forward compatibility for this service. Use of this interface is not recommended, as added methods to FilterServer will result in compilation errors.

type UnsafeInsertServer added in v1.2.1 

type UnsafeInsertServer interface {
	// contains filtered or unexported methods
}

UnsafeInsertServer may be embedded to opt out of forward compatibility for this service. Use of this interface is not recommended, as added methods to InsertServer will result in compilation errors.

type UnsafeObjectServer added in v1.2.1 

type UnsafeObjectServer interface {
	// contains filtered or unexported methods
}

UnsafeObjectServer may be embedded to opt out of forward compatibility for this service. Use of this interface is not recommended, as added methods to ObjectServer will result in compilation errors.

type UnsafeRemoveServer added in v1.2.1 

type UnsafeRemoveServer interface {
	// contains filtered or unexported methods
}

UnsafeRemoveServer may be embedded to opt out of forward compatibility for this service. Use of this interface is not recommended, as added methods to RemoveServer will result in compilation errors.

type UnsafeSearchServer added in v1.2.1 

type UnsafeSearchServer interface {
	// contains filtered or unexported methods
}

UnsafeSearchServer may be embedded to opt out of forward compatibility for this service. Use of this interface is not recommended, as added methods to SearchServer will result in compilation errors.

type UnsafeUpdateServer added in v1.2.1 

type UnsafeUpdateServer interface {
	// contains filtered or unexported methods
}

UnsafeUpdateServer may be embedded to opt out of forward compatibility for this service. Use of this interface is not recommended, as added methods to UpdateServer will result in compilation errors.

type UnsafeUpsertServer added in v1.2.1 

type UnsafeUpsertServer interface {
	// contains filtered or unexported methods
}

UnsafeUpsertServer may be embedded to opt out of forward compatibility for this service. Use of this interface is not recommended, as added methods to UpsertServer will result in compilation errors.

type UpdateClient 

type UpdateClient interface {
	// A method to update an indexed vector.
	Update(ctx context.Context, in *payload.Update_Request, opts ...grpc.CallOption) (*payload.Object_Location, error)
	// A method to update multiple indexed vectors by bidirectional streaming.
	StreamUpdate(ctx context.Context, opts ...grpc.CallOption) (Update_StreamUpdateClient, error)
	// A method to update multiple indexed vectors in a single request.
	MultiUpdate(ctx context.Context, in *payload.Update_MultiRequest, opts ...grpc.CallOption) (*payload.Object_Locations, error)
}

UpdateClient is the client API for Update service.

For semantics around ctx use and closing/ending streaming RPCs, please refer to https://pkg.go.dev/google.golang.org/grpc/?tab=doc#ClientConn.NewStream.

func NewUpdateClient 

func NewUpdateClient(cc grpc.ClientConnInterface) UpdateClient

type UpdateServer 

type UpdateServer interface {
	// A method to update an indexed vector.
	Update(context.Context, *payload.Update_Request) (*payload.Object_Location, error)
	// A method to update multiple indexed vectors by bidirectional streaming.
	StreamUpdate(Update_StreamUpdateServer) error
	// A method to update multiple indexed vectors in a single request.
	MultiUpdate(context.Context, *payload.Update_MultiRequest) (*payload.Object_Locations, error)
	// contains filtered or unexported methods
}

UpdateServer is the server API for Update service. All implementations must embed UnimplementedUpdateServer for forward compatibility

type Update_StreamUpdateClient 

type Update_StreamUpdateClient interface {
	Send(*payload.Update_Request) error
	Recv() (*payload.Object_StreamLocation, error)
	grpc.ClientStream
}

type Update_StreamUpdateServer 

type Update_StreamUpdateServer interface {
	Send(*payload.Object_StreamLocation) error
	Recv() (*payload.Update_Request, error)
	grpc.ServerStream
}

type UpsertClient 

type UpsertClient interface {
	// A method to insert/update a vector.
	Upsert(ctx context.Context, in *payload.Upsert_Request, opts ...grpc.CallOption) (*payload.Object_Location, error)
	// A method to insert/update multiple vectors by bidirectional streaming.
	StreamUpsert(ctx context.Context, opts ...grpc.CallOption) (Upsert_StreamUpsertClient, error)
	// A method to insert/update multiple vectors in a single request.
	MultiUpsert(ctx context.Context, in *payload.Upsert_MultiRequest, opts ...grpc.CallOption) (*payload.Object_Locations, error)
}

UpsertClient is the client API for Upsert service.

For semantics around ctx use and closing/ending streaming RPCs, please refer to https://pkg.go.dev/google.golang.org/grpc/?tab=doc#ClientConn.NewStream.

func NewUpsertClient 

func NewUpsertClient(cc grpc.ClientConnInterface) UpsertClient

type UpsertServer 

type UpsertServer interface {
	// A method to insert/update a vector.
	Upsert(context.Context, *payload.Upsert_Request) (*payload.Object_Location, error)
	// A method to insert/update multiple vectors by bidirectional streaming.
	StreamUpsert(Upsert_StreamUpsertServer) error
	// A method to insert/update multiple vectors in a single request.
	MultiUpsert(context.Context, *payload.Upsert_MultiRequest) (*payload.Object_Locations, error)
	// contains filtered or unexported methods
}

UpsertServer is the server API for Upsert service. All implementations must embed UnimplementedUpsertServer for forward compatibility

type Upsert_StreamUpsertClient 

type Upsert_StreamUpsertClient interface {
	Send(*payload.Upsert_Request) error
	Recv() (*payload.Object_StreamLocation, error)
	grpc.ClientStream
}

type Upsert_StreamUpsertServer 

type Upsert_StreamUpsertServer interface {
	Send(*payload.Object_StreamLocation) error
	Recv() (*payload.Upsert_Request, error)
	grpc.ServerStream
}

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.