rerank

Aug 30, 2026

Changes in this version

+ var ErrInvalidOptions = errors.New("rerank: invalid options")

+ var ErrInvalidRequest = errors.New("rerank: invalid request")

+ var ErrInvalidResponse = errors.New("rerank: invalid response")

+ type Model interface

+ Call func(ctx context.Context, request *Request) (*Response, error)

+ type ModelFunc func(context.Context, *Request) (*Response, error)

+ func (m ModelFunc) Call(ctx context.Context, request *Request) (*Response, error)

+ type Options struct

+ Extensions metadata.Extensions

+ Model string

+ TopK int

+ func (o *Options) UnmarshalJSON(data []byte) error

+ func (o Options) Clone() Options

+ func (o Options) MarshalJSON() ([]byte, error)

+ func (o Options) Resolve(override Options) (Options, error)

+ func (o Options) ResultLimit(documentCount int) int

+ func (o Options) Validate() error

+ type Request struct

+ Documents []string

+ Options Options

+ Query string

+ func NewRequest(query string, documents []string) (*Request, error)

+ func (r *Request) UnmarshalJSON(data []byte) error

+ func (r *Request) Validate() error

+ func (r Request) MarshalJSON() ([]byte, error)

+ type Response struct

+ Metadata *ResponseMetadata

+ Results []*Result

+ func NewResponse(results []*Result, responseMetadata *ResponseMetadata) (*Response, error)

+ func (r *Response) First() *Result

+ func (r *Response) UnmarshalJSON(data []byte) error

+ func (r *Response) Validate() error

+ func (r *Response) ValidateFor(request *Request) error

+ func (r Response) MarshalJSON() ([]byte, error)

+ type ResponseMetadata struct

+ Extra metadata.Map

+ Model string

+ Usage *Usage

+ func (r *ResponseMetadata) UnmarshalJSON(data []byte) error

+ func (r ResponseMetadata) MarshalJSON() ([]byte, error)

+ type Result struct

+ Index int

+ Score Score

+ func NewResult(index int, score Score) (*Result, error)

+ func (r *Result) UnmarshalJSON(data []byte) error

+ func (r *Result) Validate() error

+ func (r Result) MarshalJSON() ([]byte, error)

+ type Score float64

+ func (s *Score) UnmarshalJSON(data []byte) error

+ func (s Score) Float64() float64

+ func (s Score) MarshalJSON() ([]byte, error)

+ func (s Score) Validate() error

+ type Usage struct

+ InputTokens int64

+ func (u *Usage) UnmarshalJSON(data []byte) error

+ func (u Usage) MarshalJSON() ([]byte, error)