models_search.go

package meilisearch

import (
	"encoding/json"
	"time"
)

type SearchRulesRequest struct {
	Description string      `json:"description,omitempty"`
	Precedence  *int        `json:"precedence,omitempty"`
	Active      *bool       `json:"active,omitempty"`
	Conditions  *Conditions `json:"conditions,omitempty"`
	Actions     *Actions    `json:"actions,omitempty"`
}

type Actions struct {
	Pin   []Pin   `json:"pin,omitempty"`
	Scale []Scale `json:"scale,omitempty"`
}

type Pin struct {
	ID       string `json:"id"`
	Position int    `json:"position"`
	IndexUid string `json:"indexUid,omitempty"`
}

type Scale struct {
	Weight   float64     `json:"weight"`
	Ids      []string    `json:"ids"`
	Filter   interface{} `json:"filter,omitempty"`
	IndexUid string      `json:"indexUid,omitempty"`
}

type SearchRulesResults struct {
	Results []SearchRule `json:"results"`
	Offset  int64        `json:"offset"`
	Limit   int64        `json:"limit"`
	Total   int64        `json:"total"`
}

type SearchRulesParams struct {
	Offset int64              `json:"offset"`
	Limit  int64              `json:"limit"`
	Filter *SearchRulesFilter `json:"filter,omitempty"`
}

type SearchRulesFilter struct {
	Query  string `json:"query,omitempty"`
	Active *bool  `json:"active,omitempty"`
}

type SearchRule struct {
	Uid         string      `json:"uid"`
	Description string      `json:"description"`
	Precedence  int         `json:"precedence"`
	Active      bool        `json:"active"`
	Conditions  *Conditions `json:"conditions"`
	Actions     Actions     `json:"actions"`
}

type Conditions struct {
	Query  *QueryCondition  `json:"query,omitempty"`
	Time   *TimeCondition   `json:"time,omitempty"`
	Filter *FilterCondition `json:"filter,omitempty"`
}

// FilterCondition matches when the search filter sets the given fields to the given values.
type FilterCondition struct {
	Values map[string]interface{} `json:"values,omitempty"`
}

type QueryCondition struct {
	IsEmpty *bool  `json:"isEmpty,omitempty"`
	Words   string `json:"words,omitempty"`
}

type TimeCondition struct {
	Start *time.Time `json:"start,omitempty"`
	End   *time.Time `json:"end,omitempty"`
}

type Action struct {
	Selector Selector  `json:"selector"`
	Action   ActionDef `json:"action"`
}

type Selector struct {
	ID       string `json:"id"`
	IndexUid string `json:"indexUid"`
}

type ActionDef struct {
	Type     string `json:"type"`
	Position int    `json:"position"`
}

// SearchRequest is the request url param needed for a search query.
// This struct will be converted to url param before sent.
//
// Documentation: https://www.meilisearch.com/docs/reference/api/search#search-parameters
type SearchRequest struct {
	Offset                  int64                     `json:"offset,omitempty"`
	Limit                   int64                     `json:"limit,omitempty"`
	AttributesToRetrieve    []string                  `json:"attributesToRetrieve,omitempty"`
	AttributesToSearchOn    []string                  `json:"attributesToSearchOn,omitempty"`
	AttributesToCrop        []string                  `json:"attributesToCrop,omitempty"`
	CropLength              int64                     `json:"cropLength,omitempty"`
	CropMarker              string                    `json:"cropMarker,omitempty"`
	AttributesToHighlight   []string                  `json:"attributesToHighlight,omitempty"`
	HighlightPreTag         string                    `json:"highlightPreTag,omitempty"`
	HighlightPostTag        string                    `json:"highlightPostTag,omitempty"`
	MatchingStrategy        MatchingStrategy          `json:"matchingStrategy,omitempty"`
	Filter                  interface{}               `json:"filter,omitempty"`
	ShowMatchesPosition     bool                      `json:"showMatchesPosition,omitempty"`
	ShowRankingScore        bool                      `json:"showRankingScore,omitempty"`
	ShowRankingScoreDetails bool                      `json:"showRankingScoreDetails,omitempty"`
	ShowPerformanceDetails  bool                      `json:"showPerformanceDetails,omitempty"`
	Facets                  []string                  `json:"facets,omitempty"`
	Sort                    []string                  `json:"sort,omitempty"`
	Vector                  []float32                 `json:"vector,omitempty"`
	HitsPerPage             *int64                    `json:"hitsPerPage,omitempty"`
	Page                    int64                     `json:"page,omitempty"`
	IndexUID                string                    `json:"indexUid,omitempty"`
	Query                   string                    `json:"q"`
	Distinct                string                    `json:"distinct,omitempty"`
	Hybrid                  *SearchRequestHybrid      `json:"hybrid"`
	RetrieveVectors         bool                      `json:"retrieveVectors,omitempty"`
	RankingScoreThreshold   float64                   `json:"rankingScoreThreshold,omitempty"`
	FederationOptions       *SearchFederationOptions  `json:"federationOptions,omitempty"`
	Locales                 []string                  `json:"locales,omitempty"`
	Media                   map[string]any            `json:"media,omitempty"`
	Personalize             *SearchRequestPersonalize `json:"personalize,omitempty"`
	InlineRule              *SearchRequestInlineRule  `json:"inlineRule,omitempty"`
	// IncludeMetadata sends the Meili-Include-Metadata header so the response includes metadata.
	IncludeMetadata bool `json:"-"`
}

// SearchRequestInlineRule is a search rule sent with a query to preview its effect without saving it.
type SearchRequestInlineRule struct {
	Uid        string      `json:"uid"`
	Precedence *int        `json:"precedence,omitempty"`
	Active     *bool       `json:"active,omitempty"`
	Conditions *Conditions `json:"conditions,omitempty"`
	Actions    *Actions    `json:"actions,omitempty"`
}

type SearchFederationOptions struct {
	Weight float64 `json:"weight,omitempty"`
	Remote string  `json:"remote,omitempty"`
}

// SearchRequestPersonalize configures personalized search.
// When set, Meilisearch re-ranks results based on the user profile described in UserContext.
//
// Requires the experimental search personalization feature to be enabled on the server.
// Documentation: https://www.meilisearch.com/docs/capabilities/personalization/getting_started/personalized_search
type SearchRequestPersonalize struct {
	// UserContext is a free-text, natural-language description of the user's
	// preferences, behavior, or intent (e.g. "Prefers compact mechanical keyboards
	// from Keychron, mid-range budget"). The re-ranking model only processes
	// positive signals, so state preferences affirmatively.
	UserContext string `json:"userContext"`
}

type SearchRequestHybrid struct {
	SemanticRatio float64 `json:"semanticRatio,omitempty"`
	Embedder      string  `json:"embedder"`
}

type MultiSearchRequest struct {
	Federation *MultiSearchFederation `json:"federation,omitempty"`
	Queries    []*SearchRequest       `json:"queries"`
	// IncludeMetadata sends the Meili-Include-Metadata header so the response includes metadata.
	IncludeMetadata bool `json:"-"`
}

type MultiSearchFederation struct {
	Offset        int64                             `json:"offset,omitempty"`
	Limit         int64                             `json:"limit,omitempty"`
	FacetsByIndex map[string][]string               `json:"facetsByIndex,omitempty"`
	MergeFacets   *MultiSearchFederationMergeFacets `json:"mergeFacets,omitempty"`
	Distinct      string                            `json:"distinct,omitempty"`
}

type MultiSearchFederationMergeFacets struct {
	MaxValuesPerFacet int `json:"maxValuesPerFacet,omitempty"`
}

// SearchResponse is the response body for search method
type SearchResponse struct {
	Hits               Hits            `json:"hits"`
	EstimatedTotalHits int64           `json:"estimatedTotalHits,omitempty"`
	Offset             int64           `json:"offset,omitempty"`
	Limit              int64           `json:"limit,omitempty"`
	ProcessingTimeMs   int64           `json:"processingTimeMs"`
	Query              string          `json:"query"`
	FacetDistribution  json.RawMessage `json:"facetDistribution,omitempty"`
	TotalHits          int64           `json:"totalHits,omitempty"`
	HitsPerPage        int64           `json:"hitsPerPage,omitempty"`
	Page               int64           `json:"page,omitempty"`
	TotalPages         int64           `json:"totalPages,omitempty"`
	FacetStats         json.RawMessage `json:"facetStats,omitempty"`
	IndexUID           string          `json:"indexUid,omitempty"`
	QueryVector        *[]float32      `json:"queryVector,omitempty"`
	PerformanceDetails map[string]any  `json:"performanceDetails,omitempty"`
	Metadata           *SearchMetadata `json:"metadata,omitempty"`
}

// SearchMetadata is returned when the Meili-Include-Metadata header is set to true.

type SearchMetadata struct {
	Query                       string                 `json:"query,omitempty"`
	QueryUID                    string                 `json:"queryUid,omitempty"`
	IndexUID                    string                 `json:"indexUid,omitempty"`
	PrimaryKey                  string                 `json:"primaryKey,omitempty"`
	Remote                      string                 `json:"remote,omitempty"`
	InlineRuleConditionOutcomes map[string]interface{} `json:"inlineRuleConditionOutcomes,omitempty"`
}

type MultiSearchResponse struct {
	Results            []SearchResponse           `json:"results,omitempty"`
	Hits               Hits                       `json:"hits,omitempty"`
	ProcessingTimeMs   int64                      `json:"processingTimeMs,omitempty"`
	Offset             int64                      `json:"offset,omitempty"`
	Limit              int64                      `json:"limit,omitempty"`
	EstimatedTotalHits int64                      `json:"estimatedTotalHits,omitempty"`
	SemanticHitCount   int64                      `json:"semanticHitCount,omitempty"`
	FacetDistribution  map[string]json.RawMessage `json:"facetDistribution,omitempty"`
	FacetStats         map[string]json.RawMessage `json:"facetStats,omitempty"`
	RemoteErrors       map[string]*RemoteError    `json:"remoteErrors,omitempty"`
	Metadata           []SearchMetadata           `json:"metadata,omitempty"`
}

type RemoteError struct {
	Message string `json:"message"`
	Code    string `json:"code"`
	Type    string `json:"type"`
	Link    string `json:"link"`
}

type FacetSearchRequest struct {
	FacetName            string      `json:"facetName,omitempty"`
	FacetQuery           string      `json:"facetQuery,omitempty"`
	Q                    string      `json:"q,omitempty"`
	Filter               interface{} `json:"filter,omitempty"`
	MatchingStrategy     string      `json:"matchingStrategy,omitempty"`
	AttributesToSearchOn []string    `json:"attributesToSearchOn,omitempty"`
	ExhaustiveFacetCount bool        `json:"exhaustiveFacetCount,omitempty"`
}

type FacetSearchResponse struct {
	FacetHits        Hits   `json:"facetHits"`
	FacetQuery       string `json:"facetQuery"`
	ProcessingTimeMs int64  `json:"processingTimeMs"`
}

func (s *SearchRequest) validate() {
	if s.Hybrid != nil && s.Hybrid.Embedder == "" {
		s.Hybrid.Embedder = "default"
	}
}