clients

Documentation

Index

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

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 RankInput

type RankInput struct {
	Documents []string `json:"documents"`
	Query     string   `json:"query"`
	Model     string   `json:"model"`
	TopN      int      `json:"top_n,omitempty"`
}

type RankResponse

type RankResponse struct {
	Results []Result `json:"results"`
	Model   string   `json:"model"`
	Usage   Usage    `json:"usage"`
}

type Result

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

type Usage

type Usage struct {
	TotalTokens  int `json:"total_tokens"`
	PromptTokens int `json:"prompt_tokens"`
}