api

README

REST API v1

/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

Overview

Copyright 2023 The Simila Authors

Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.

Index

• func BindAppJson(c *gin.Context, inf interface{}) error
• func ComposeURI(r *http.Request, id string) string
• func ParseTime(s string) (time.Time, error)
• func ResolveHost(r *http.Request) (host string)
• func ResolveScheme(r *http.Request) string
• type HttpEP
  • func NewHttpEP(svc *Service) *HttpEP
  • func (hep *HttpEP) RegisterEPs(g *gin.Engine) error
• 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 ParseTime

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

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 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 Service

type Service struct {
	// 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