api

README

REST API v1

/v1/formats

Format object:

{
    name: "pdf"
}

Create a format

curl -XPOST -H "content-type: application/json" -d '{"name": "pdf"}' http://localhost:8080/v1/formats

Retrieve a format

curl -XGET http://localhost:8080/v1/formats/{name}

Delete a format

curl -XDELETE http://localhost:8080/v1/formats/{name}

List all formats

curl -XGET http://localhost:8080/v1/formats

/v1/indexes

Index object:

{
    id: "the index ID"
    format: "pdf"
    tags: ["userABC", "salesTeam"]
    document: "a base64 encoded document, used for create new index only" 
    records: [{id: "abcd", segment: "hello world", vector: [1, 2]}]
}

An index record object:

{
    id: "a base64 encoded vector"
    segment: "this is searcheable piece of the text"
    vector: [1, "abc", 3]
}

Create new index

POST /v1/indexes

An index may be created via providing the whole data in the content-type: application/json body:

curl -XPOST -H "content-type: application/json" -d '{"id": "1234", "format": "pdf"}' http://localhost:8080/v1/indexes

or 'multipart/form-data' is also supported:

example:

curl -i -X POST -H "content-type: multipart/form-data" -F"file=@/Users/user/Downloads/fr_9782_size1024.jpg" -F "meta={\"id\": \"1234\", \"format\": \"jpg\"};type=application/json" http://localhost:8080/v1/indexes

Documentation

Index

• func BindAppJson(c *gin.Context, inf interface{}) error
• func ComposeURI(r *http.Request, id string) string
• func CreateIndexRequest2Proto(ci CreateIndexRequest) *index.CreateIndexRequest
• func ParseTime(s string) (time.Time, error)
• func PatchIndexRecordsRequest2Proto(pr PatchRecordsRequest) *index.PatchRecordsRequest
• func Record2Proto(r *Record) *index.Record
• func Records2Proto(rs []*Record) []*index.Record
• func ResolveHost(r *http.Request) (host string)
• func ResolveScheme(r *http.Request) string
• type CreateIndexRequest
• type ErrorMsg
• type HttpEP
  • func NewHttpEP(svc *Service) *HttpEP
  • func (hep *HttpEP) RegisterEPs(g *gin.Engine) error
• type IndexRecord
  • func IndexRecord2Rest(ir *index.IndexRecord) *IndexRecord
  • func IndexRecords2Rest(irs []*index.IndexRecord) []*IndexRecord
• type ListRecordsResult
  • func ListRecordsResult2Proto(lrr *index.ListRecordsResult) ListRecordsResult
• type PatchRecordsRequest
• type Record
  • func Record2Rest(r *index.Record) *Record
  • func Records2Rest(rs []*index.Record) []*Record
• type SearchRecordsResult
  • func SearchRecordsResult2Rest(srr *index.SearchRecordsResult) SearchRecordsResult
• type Service
  • func NewService() *Service
  • func (s *Service) FormatServiceServer() format.ServiceServer
  • func (s *Service) IndexServiceServer() index.ServiceServer

Functions

func BindAppJson

func BindAppJson(c *gin.Context, inf interface{}) error

BindAppJson turns the request body to inf, but for "application/json" contents only

func ComposeURI

func ComposeURI(r *http.Request, id string) string

ComposeURI helper function which composes URI, adding ID to the request path

func CreateIndexRequest2Proto

func CreateIndexRequest2Proto(ci CreateIndexRequest) *index.CreateIndexRequest

func ParseTime

func ParseTime(s string) (time.Time, error)

func PatchIndexRecordsRequest2Proto

func PatchIndexRecordsRequest2Proto(pr PatchRecordsRequest) *index.PatchRecordsRequest

func Record2Proto

func Record2Proto(r *Record) *index.Record

func Records2Proto

func Records2Proto(rs []*Record) []*index.Record

func ResolveHost

func ResolveHost(r *http.Request) (host string)

ResolveHost returns host part of r

func ResolveScheme

func ResolveScheme(r *http.Request) string

ResolveScheme resolves initial request type by r

Types

type CreateIndexRequest

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 `json:"id,omitempty"`
	// format name. Format must exist
	Format string `json:"format,omitempty"`
	// tags associated with the index. May be empty.
	Tags map[string]string `json:"tags,omitempty"`
	// document contains the binary data for the format provided. It may be empty
	Document []byte `json:"document,omitempty"`
	// records contains the list of records that can be added to the index when it is created
	Records []*Record `json:"records,omitempty"`
}

type ErrorMsg

type ErrorMsg struct {
	Error string `json:"error"`
}

type HttpEP

type HttpEP struct {
	// contains filtered or unexported fields
}

HttpEP provides the api endpoints for the HTTP interface

func NewHttpEP

func NewHttpEP(svc *Service) *HttpEP

func (*HttpEP) RegisterEPs

func (hep *HttpEP) RegisterEPs(g *gin.Engine) error

type IndexRecord

type IndexRecord struct {
	IndexId     string  `json:"indexId,omitempty"`
	IndexRecord *Record `json:"indexRecord,omitempty"`
}

func IndexRecord2Rest

func IndexRecord2Rest(ir *index.IndexRecord) *IndexRecord

func IndexRecords2Rest

func IndexRecords2Rest(irs []*index.IndexRecord) []*IndexRecord

type ListRecordsResult

type ListRecordsResult struct {
	Records      []*Record `json:"records,omitempty"`
	NextRecordId *string   `json:"nextRecordId,omitempty"`
}

func ListRecordsResult2Proto

func ListRecordsResult2Proto(lrr *index.ListRecordsResult) ListRecordsResult

type PatchRecordsRequest

type PatchRecordsRequest struct {
	// id is the patched index id
	Id string `json:"id,omitempty"`
	// upsertRecords contains the list of records that should be inserted or updated
	UpsertRecords []*Record `json:"upsertRecords,omitempty"`
	// deleteRecords contains the list of records that should be deleted
	DeleteRecords []*Record `json:"deleteRecords,omitempty"`
}

type Record

type Record struct {
	// id is the record id - this field is populated by parser or it is provided when records are created.
	Id string `json:"id,omitempty"`
	// segment contains the searchable text for the record
	Segment string `json:"segment,omitempty"`
	// vector is the list of the byte values (stringified) ordered according the basis fields definition
	Vector json.RawMessage `json:"vector,omitempty"`
}

func Record2Rest

func Record2Rest(r *index.Record) *Record

func Records2Rest

func Records2Rest(rs []*index.Record) []*Record

type SearchRecordsResult

type SearchRecordsResult struct {
	Records    []*IndexRecord `json:"records,omitempty"`
	NextPageId *string        `json:"nextPageId,omitempty"`
}

func SearchRecordsResult2Rest

func SearchRecordsResult2Rest(srr *index.SearchRecordsResult) SearchRecordsResult

type Service

type Service struct {
	PProvider parser.Provider `inject:""`
	Db        persistence.Db  `inject:""`
	// contains filtered or unexported fields
}

Service implements the gRPC API endpoints

func NewService

func NewService() *Service

func (*Service) FormatServiceServer

func (s *Service) FormatServiceServer() format.ServiceServer

func (*Service) IndexServiceServer

func (s *Service) IndexServiceServer() index.ServiceServer

IndexServiceServer returns index.ServiceServer