clients

Documentation

Index

• func New(apiKey string, timeout time.Duration, logger logrus.FieldLogger) *client
• type APIVersion
• type Document
• type Meta
• type RankInput
• type RankResponse
• type Result

Functions

func New

func New(apiKey string, timeout time.Duration, logger logrus.FieldLogger) *client

Types

type APIVersion

type APIVersion struct {
	Version string `json:"version"`
}

type Document

type Document struct {
	Text string `json:"text"`
}

type Meta

type Meta struct {
	APIVersion APIVersion `json:"api_version"`
}

type RankInput

type RankInput struct {
	Documents       []string `json:"documents"`
	Query           string   `json:"query"`
	Model           string   `json:"model"`
	ReturnDocuments bool     `json:"return_documents"`
}

type RankResponse

type RankResponse struct {
	ID      string   `json:"id"`
	Results []Result `json:"results"`
	Meta    Meta     `json:"meta"`
}

type Result

type Result struct {
	Index          int      `json:"index"`
	RelevanceScore float64  `json:"relevance_score"`
	Document       Document `json:"document"`
}