index

type CreateIndexRequest struct {

	// id contains the index identifier. It may be generated or provided. If provided, caller must
	// support it. id cannot be more than 256 bytes long
	Id string `protobuf:"bytes,1,opt,name=id,proto3" json:"id,omitempty"`
	// format name. Format must exist
	Format string `protobuf:"bytes,2,opt,name=format,proto3" json:"format,omitempty"`
	// tags associated with the index. May be empty.
	Tags map[string]string `` /* 149-byte string literal not displayed */
	// document contains the binary data for the format provided. It may be empty
	Document []byte `protobuf:"bytes,4,opt,name=document,proto3,oneof" json:"document,omitempty"`
	// records contains the list of records that can be added to the index when it is created
	Records []*Record `protobuf:"bytes,5,rep,name=records,proto3" json:"records,omitempty"`
	// contains filtered or unexported fields
}

type CreateIndexStreamRequest struct {

	// CreateIndexRequest must be in the first packet of the gRPC stream
	Meta *CreateIndexRequest `protobuf:"bytes,1,opt,name=meta,proto3" json:"meta,omitempty"`
	// data is the body data, may start from the first packet of the stream
	Data []byte `protobuf:"bytes,2,opt,name=data,proto3" json:"data,omitempty"`
	// contains filtered or unexported fields
}

type Id struct {
	Id string `protobuf:"bytes,1,opt,name=id,proto3" json:"id,omitempty"`
	// contains filtered or unexported fields
}

type Index struct {

	// id the index uniquely identifier
	Id string `protobuf:"bytes,1,opt,name=id,proto3" json:"id,omitempty"`
	// format - the index format
	Format string `protobuf:"bytes,2,opt,name=format,proto3" json:"format,omitempty"`
	// tags the list of key:value pairs associated with the index
	Tags map[string]string `` /* 149-byte string literal not displayed */
	// createdAt the timestamp when the index was created
	CreatedAt *timestamppb.Timestamp `protobuf:"bytes,4,opt,name=createdAt,proto3" json:"createdAt,omitempty"`
	// contains filtered or unexported fields
}

type IndexRecord struct {
	IndexId     string  `protobuf:"bytes,1,opt,name=indexId,proto3" json:"indexId,omitempty"`
	IndexRecord *Record `protobuf:"bytes,2,opt,name=indexRecord,proto3" json:"indexRecord,omitempty"`
	// contains filtered or unexported fields
}

type Indexes struct {

	// indexes contains the list of indexes
	Indexes []*Index `protobuf:"bytes,1,rep,name=indexes,proto3" json:"indexes,omitempty"`
	// nextIndexId is used for pagination
	NextIndexId *string `protobuf:"bytes,2,opt,name=nextIndexId,proto3,oneof" json:"nextIndexId,omitempty"`
	// total contains the total number of known indexes
	Total int64 `protobuf:"varint,3,opt,name=total,proto3" json:"total,omitempty"`
	// contains filtered or unexported fields
}

type ListRecordsRequest struct {

	// id is the requested index id
	Id            string  `protobuf:"bytes,1,opt,name=id,proto3" json:"id,omitempty"`
	StartRecordId *string `protobuf:"bytes,2,opt,name=startRecordId,proto3,oneof" json:"startRecordId,omitempty"`
	Limit         *int64  `protobuf:"varint,3,opt,name=limit,proto3,oneof" json:"limit,omitempty"`
	// contains filtered or unexported fields
}

type ListRecordsResult struct {
	Records      []*Record `protobuf:"bytes,1,rep,name=records,proto3" json:"records,omitempty"`
	NextRecordId *string   `protobuf:"bytes,2,opt,name=nextRecordId,proto3,oneof" json:"nextRecordId,omitempty"`
	Total        int64     `protobuf:"varint,3,opt,name=total,proto3" json:"total,omitempty"`
	// contains filtered or unexported fields
}

type ListRequest struct {
	StartIndexId  string                 `protobuf:"bytes,1,opt,name=startIndexId,proto3" json:"startIndexId,omitempty"`
	Format        *string                `protobuf:"bytes,2,opt,name=format,proto3,oneof" json:"format,omitempty"`
	Tags          map[string]string      `` /* 149-byte string literal not displayed */
	CreatedAfter  *timestamppb.Timestamp `protobuf:"bytes,4,opt,name=createdAfter,proto3,oneof" json:"createdAfter,omitempty"`
	CreatedBefore *timestamppb.Timestamp `protobuf:"bytes,5,opt,name=createdBefore,proto3,oneof" json:"createdBefore,omitempty"`
	Limit         *int64                 `protobuf:"varint,6,opt,name=limit,proto3,oneof" json:"limit,omitempty"`
	// contains filtered or unexported fields
}

type PatchRecordsRequest struct {

	// id is the patched index id
	Id string `protobuf:"bytes,1,opt,name=id,proto3" json:"id,omitempty"`
	// upsertRecords contains the list of records that should be inserted or updated
	UpsertRecords []*Record `protobuf:"bytes,2,rep,name=upsertRecords,proto3" json:"upsertRecords,omitempty"`
	// deleteRecords contains the list of records that should be deleted
	DeleteRecords []*Record `protobuf:"bytes,3,rep,name=deleteRecords,proto3" json:"deleteRecords,omitempty"`
	// contains filtered or unexported fields
}

type PatchRecordsResult struct {
	Upserted int64 `protobuf:"varint,1,opt,name=upserted,proto3" json:"upserted,omitempty"`
	Deleted  int64 `protobuf:"varint,2,opt,name=deleted,proto3" json:"deleted,omitempty"`
	// contains filtered or unexported fields
}

type Record struct {

	// id is the record id - this field is populated by parser or it is provided when records are created.
	Id string `protobuf:"bytes,1,opt,name=id,proto3" json:"id,omitempty"`
	// segment contains the searchable text for the record
	Segment string `protobuf:"bytes,2,opt,name=segment,proto3" json:"segment,omitempty"`
	// vector is the list of the byte values (stringified) ordered according the basis fields definition
	Vector []byte `protobuf:"bytes,3,opt,name=vector,proto3" json:"vector,omitempty"`
	// contains filtered or unexported fields
}

type SearchRecordsRequest struct {
	Text     string            `protobuf:"bytes,1,opt,name=text,proto3" json:"text,omitempty"`
	Tags     map[string]string `` /* 149-byte string literal not displayed */
	IndexIDs []string          `protobuf:"bytes,3,rep,name=indexIDs,proto3" json:"indexIDs,omitempty"`
	// distinct - if it is true and specified the result will contain only one record(first) per index,
	// even if the index contains multiple places where the text is found. If the parameter is false,
	// or not specified, the result set will contain all found places for each index.
	Distinct *bool `protobuf:"varint,4,opt,name=distinct,proto3,oneof" json:"distinct,omitempty"`
	// orderByScore - if true the results are ordered by the result relevancy score. No cursor pagination
	// is supported in this case (no "nextPageId" is returned in the result), the "offset" could be used to
	// get the next page results.
	OrderByScore *bool   `protobuf:"varint,5,opt,name=orderByScore,proto3,oneof" json:"orderByScore,omitempty"`
	PageId       *string `protobuf:"bytes,6,opt,name=pageId,proto3,oneof" json:"pageId,omitempty"`
	// offset specifies how many records to skip before beginning to return records.
	// This parameter must be used with care since it just "skips records" (the full scan)
	// thus it is not very performant and may create a significant load.
	Offset *int64 `protobuf:"varint,7,opt,name=offset,proto3,oneof" json:"offset,omitempty"`
	// limit specifies the maximum number of records in the result set
	Limit *int64 `protobuf:"varint,8,opt,name=limit,proto3,oneof" json:"limit,omitempty"`
	// contains filtered or unexported fields
}

type SearchRecordsResult struct {
	Items      []*SearchRecordsResultItem `protobuf:"bytes,1,rep,name=items,proto3" json:"items,omitempty"`
	NextPageId *string                    `protobuf:"bytes,2,opt,name=nextPageId,proto3,oneof" json:"nextPageId,omitempty"`
	Total      int64                      `protobuf:"varint,3,opt,name=total,proto3" json:"total,omitempty"`
	// contains filtered or unexported fields
}

type SearchRecordsResultItem struct {
	IndexId         string   `protobuf:"bytes,1,opt,name=indexId,proto3" json:"indexId,omitempty"`
	IndexRecord     *Record  `protobuf:"bytes,2,opt,name=indexRecord,proto3" json:"indexRecord,omitempty"`
	MatchedKeywords []string `protobuf:"bytes,3,rep,name=MatchedKeywords,proto3" json:"MatchedKeywords,omitempty"`
	Score           *float32 `protobuf:"fixed32,4,opt,name=score,proto3,oneof" json:"score,omitempty"`
	// contains filtered or unexported fields
}

type ServiceClient interface {
	// Create allows to create a new index.
	Create(ctx context.Context, in *CreateIndexRequest, opts ...grpc.CallOption) (*Index, error)
	// Create allows to create a new index, streaming the records data in the request
	CreateWithStreamData(ctx context.Context, opts ...grpc.CallOption) (Service_CreateWithStreamDataClient, error)
	// Delete allows to remove an index by its id
	Delete(ctx context.Context, in *Id, opts ...grpc.CallOption) (*emptypb.Empty, error)
	// Get returns information about the index
	Get(ctx context.Context, in *Id, opts ...grpc.CallOption) (*Index, error)
	// Put allows to update the index tags
	Put(ctx context.Context, in *Index, opts ...grpc.CallOption) (*Index, error)
	// List returns list of known indexes
	List(ctx context.Context, in *ListRequest, opts ...grpc.CallOption) (*Indexes, error)
	// PatchRecords allows to insert, update or delete an index's records
	PatchRecords(ctx context.Context, in *PatchRecordsRequest, opts ...grpc.CallOption) (*PatchRecordsResult, error)
	// ListRecords returns list of records for an index
	ListRecords(ctx context.Context, in *ListRecordsRequest, opts ...grpc.CallOption) (*ListRecordsResult, error)
	// SearchRecords runs the search across all indexes by the specified query. Result will
	// be ordered by indexID:recordID order
	SearchRecords(ctx context.Context, in *SearchRecordsRequest, opts ...grpc.CallOption) (*SearchRecordsResult, error)
}

type ServiceServer interface {
	// Create allows to create a new index.
	Create(context.Context, *CreateIndexRequest) (*Index, error)
	// Create allows to create a new index, streaming the records data in the request
	CreateWithStreamData(Service_CreateWithStreamDataServer) error
	// Delete allows to remove an index by its id
	Delete(context.Context, *Id) (*emptypb.Empty, error)
	// Get returns information about the index
	Get(context.Context, *Id) (*Index, error)
	// Put allows to update the index tags
	Put(context.Context, *Index) (*Index, error)
	// List returns list of known indexes
	List(context.Context, *ListRequest) (*Indexes, error)
	// PatchRecords allows to insert, update or delete an index's records
	PatchRecords(context.Context, *PatchRecordsRequest) (*PatchRecordsResult, error)
	// ListRecords returns list of records for an index
	ListRecords(context.Context, *ListRecordsRequest) (*ListRecordsResult, error)
	// SearchRecords runs the search across all indexes by the specified query. Result will
	// be ordered by indexID:recordID order
	SearchRecords(context.Context, *SearchRecordsRequest) (*SearchRecordsResult, error)
	// contains filtered or unexported methods
}

type Service_CreateWithStreamDataClient interface {
	Send(*CreateIndexStreamRequest) error
	CloseAndRecv() (*Index, error)
	grpc.ClientStream
}

type Service_CreateWithStreamDataServer interface {
	SendAndClose(*Index) error
	Recv() (*CreateIndexStreamRequest, error)
	grpc.ServerStream
}

type UnimplementedServiceServer struct {
}

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