meilisearch

package module

Go to main page

Versions in this module

v0

v0.37.0

Nov 10, 2026

Changes in this version

+ type APIErrCode string

+ const APIErrCodeAPIKeyAlreadyExists

+ const APIErrCodeAPIKeyNotFound

+ const APIErrCodeBadRequest

+ const APIErrCodeBatchNotFound

+ const APIErrCodeDatabaseSizeLimitReached

+ const APIErrCodeDocumentFieldsLimitReached

+ const APIErrCodeDocumentNotFound

+ const APIErrCodeDumpProcessFailed

+ const APIErrCodeFacetSearchDisabled

+ const APIErrCodeFeatureNotEnabled

+ const APIErrCodeIOError

+ const APIErrCodeImmutableAPIKeyActions

+ const APIErrCodeImmutableAPIKeyCreatedAt

+ const APIErrCodeImmutableAPIKeyExpiresAt

+ const APIErrCodeImmutableAPIKeyIndexes

+ const APIErrCodeImmutableAPIKeyKey

+ const APIErrCodeImmutableAPIKeyUID

+ const APIErrCodeImmutableAPIKeyUpdatedAt

+ const APIErrCodeImmutableIndexUID

+ const APIErrCodeImmutableIndexUpdatedAt

+ const APIErrCodeImmutableWebhook

+ const APIErrCodeImmutableWebhookIsEditable

+ const APIErrCodeImmutableWebhookUUID

+ const APIErrCodeIndexAlreadyExists

+ const APIErrCodeIndexCreationFailed

+ const APIErrCodeIndexNotFound

+ const APIErrCodeIndexPrimaryKeyAlreadyExists

+ const APIErrCodeIndexPrimaryKeyMultipleCandidatesFound

+ const APIErrCodeIndexPrimaryKeyNoCandidateFound

+ const APIErrCodeInternal

+ const APIErrCodeInvalidAPIKey

+ const APIErrCodeInvalidAPIKeyActions

+ const APIErrCodeInvalidAPIKeyDescription

+ const APIErrCodeInvalidAPIKeyExpiresAt

+ const APIErrCodeInvalidAPIKeyIndexes

+ const APIErrCodeInvalidAPIKeyLimit

+ const APIErrCodeInvalidAPIKeyName

+ const APIErrCodeInvalidAPIKeyOffset

+ const APIErrCodeInvalidAPIKeyUID

+ const APIErrCodeInvalidContentType

+ const APIErrCodeInvalidDocumentCSVDelimiter

+ const APIErrCodeInvalidDocumentFields

+ const APIErrCodeInvalidDocumentFilter

+ const APIErrCodeInvalidDocumentGeoField

+ const APIErrCodeInvalidDocumentGeoJSONField

+ const APIErrCodeInvalidDocumentID

+ const APIErrCodeInvalidDocumentLimit

+ const APIErrCodeInvalidDocumentOffset

+ const APIErrCodeInvalidDocumentSort

+ const APIErrCodeInvalidExportAPIKey

+ const APIErrCodeInvalidExportIndexFilter

+ const APIErrCodeInvalidExportIndexesPatterns

+ const APIErrCodeInvalidExportPayloadSize

+ const APIErrCodeInvalidExportURL

+ const APIErrCodeInvalidFacetSearchFacetName

+ const APIErrCodeInvalidFacetSearchFacetQuery

+ const APIErrCodeInvalidFilter

+ const APIErrCodeInvalidIndexLimit

+ const APIErrCodeInvalidIndexOffset

+ const APIErrCodeInvalidIndexPrimaryKey

+ const APIErrCodeInvalidIndexUID

+ const APIErrCodeInvalidMultiSearchFacetOrder

+ const APIErrCodeInvalidMultiSearchFacets

+ const APIErrCodeInvalidMultiSearchFacetsByIndex

+ const APIErrCodeInvalidMultiSearchMaxValuesPerFacet

+ const APIErrCodeInvalidMultiSearchMergeFacets

+ const APIErrCodeInvalidMultiSearchQueriesRankingRules

+ const APIErrCodeInvalidMultiSearchQueryFacets

+ const APIErrCodeInvalidMultiSearchQueryFederated

+ const APIErrCodeInvalidMultiSearchQueryPagination

+ const APIErrCodeInvalidMultiSearchQueryPosition

+ const APIErrCodeInvalidMultiSearchRemote

+ const APIErrCodeInvalidMultiSearchSortFacetValuesBy

+ const APIErrCodeInvalidMultiSearchWeight

+ const APIErrCodeInvalidNetworkRemotes

+ const APIErrCodeInvalidNetworkSearchAPIKey

+ const APIErrCodeInvalidNetworkSelf

+ const APIErrCodeInvalidNetworkURL

+ const APIErrCodeInvalidSearchAttributesToCrop

+ const APIErrCodeInvalidSearchAttributesToHighlight

+ const APIErrCodeInvalidSearchAttributesToRetrieve

+ const APIErrCodeInvalidSearchAttributesToSearchOn

+ const APIErrCodeInvalidSearchCropLength

+ const APIErrCodeInvalidSearchCropMarker

+ const APIErrCodeInvalidSearchEmbedder

+ const APIErrCodeInvalidSearchFacets

+ const APIErrCodeInvalidSearchFilter

+ const APIErrCodeInvalidSearchHighlightPostTag

+ const APIErrCodeInvalidSearchHighlightPreTag

+ const APIErrCodeInvalidSearchHitsPerPage

+ const APIErrCodeInvalidSearchHybridQuery

+ const APIErrCodeInvalidSearchLimit

+ const APIErrCodeInvalidSearchLocales

+ const APIErrCodeInvalidSearchMatchingStrategy

+ const APIErrCodeInvalidSearchMedia

+ const APIErrCodeInvalidSearchMediaAndVector

+ const APIErrCodeInvalidSearchOffset

+ const APIErrCodeInvalidSearchPage

+ const APIErrCodeInvalidSearchQ

+ const APIErrCodeInvalidSearchRankingScoreThreshold

+ const APIErrCodeInvalidSearchShowMatchesPosition

+ const APIErrCodeInvalidSearchSort

+ const APIErrCodeInvalidSettingsDisplayedAttributes

+ const APIErrCodeInvalidSettingsDistinctAttribute

+ const APIErrCodeInvalidSettingsEmbedder

+ const APIErrCodeInvalidSettingsFacetSearch

+ const APIErrCodeInvalidSettingsFacetingMaxValuesPerFacet

+ const APIErrCodeInvalidSettingsFacetingSortFacetValuesBy

+ const APIErrCodeInvalidSettingsFilterableAttributes

+ const APIErrCodeInvalidSettingsLocalizedAttributes

+ const APIErrCodeInvalidSettingsPagination

+ const APIErrCodeInvalidSettingsPrefixSearch

+ const APIErrCodeInvalidSettingsRankingRules

+ const APIErrCodeInvalidSettingsSearchCutoffMS

+ const APIErrCodeInvalidSettingsSearchableAttributes

+ const APIErrCodeInvalidSettingsSortableAttributes

+ const APIErrCodeInvalidSettingsStopWords

+ const APIErrCodeInvalidSettingsSynonyms

+ const APIErrCodeInvalidSettingsTypoTolerance

+ const APIErrCodeInvalidSimilarAttributesToRetrieve

+ const APIErrCodeInvalidSimilarEmbedder

+ const APIErrCodeInvalidSimilarFilter

+ const APIErrCodeInvalidSimilarID

+ const APIErrCodeInvalidSimilarLimit

+ const APIErrCodeInvalidSimilarOffset

+ const APIErrCodeInvalidSimilarRankingScoreThreshold

+ const APIErrCodeInvalidSimilarShowRankingScore

+ const APIErrCodeInvalidSimilarShowRankingScoreDetails

+ const APIErrCodeInvalidState

+ const APIErrCodeInvalidStoreFile

+ const APIErrCodeInvalidSwapDuplicateIndexFound

+ const APIErrCodeInvalidSwapIndexes

+ const APIErrCodeInvalidTaskAfterEnqueuedAt

+ const APIErrCodeInvalidTaskAfterFinishedAt

+ const APIErrCodeInvalidTaskAfterStartedAt

+ const APIErrCodeInvalidTaskBeforeEnqueuedAt

+ const APIErrCodeInvalidTaskBeforeFinishedAt

+ const APIErrCodeInvalidTaskBeforeStartedAt

+ const APIErrCodeInvalidTaskCanceledBy

+ const APIErrCodeInvalidTaskIndexUIDs

+ const APIErrCodeInvalidTaskLimit

+ const APIErrCodeInvalidTaskStatuses

+ const APIErrCodeInvalidTaskTypes

+ const APIErrCodeInvalidTaskUIDs

+ const APIErrCodeInvalidWebhookHeaders

+ const APIErrCodeInvalidWebhookURL

+ const APIErrCodeInvalidWebhookUUID

+ const APIErrCodeInvalidWebhooks

+ const APIErrCodeMalformedPayload

+ const APIErrCodeMissingAPIKeyActions

+ const APIErrCodeMissingAPIKeyExpiresAt

+ const APIErrCodeMissingAPIKeyIndexes

+ const APIErrCodeMissingAuthorizationHeader

+ const APIErrCodeMissingContentType

+ const APIErrCodeMissingDocumentFilter

+ const APIErrCodeMissingDocumentID

+ const APIErrCodeMissingFacetSearchFacetName

+ const APIErrCodeMissingIndexUID

+ const APIErrCodeMissingMasterKey

+ const APIErrCodeMissingNetworkURL

+ const APIErrCodeMissingPayload

+ const APIErrCodeMissingSwapIndexes

+ const APIErrCodeMissingTaskFilters

+ const APIErrCodeNoSpaceLeftOnDevice

+ const APIErrCodeNotFound

+ const APIErrCodeNotFoundSimilarID

+ const APIErrCodePayloadTooLarge

+ const APIErrCodeRemoteBadRequest

+ const APIErrCodeRemoteBadResponse

+ const APIErrCodeRemoteCouldNotSendRequest

+ const APIErrCodeRemoteInvalidAPIKey

+ const APIErrCodeRemoteRemoteError

+ const APIErrCodeRemoteTimeout

+ const APIErrCodeTaskNotFound

+ const APIErrCodeTooManyOpenFiles

+ const APIErrCodeTooManySearchRequests

+ const APIErrCodeUnretrievableDocument

+ const APIErrCodeVectorEmbeddingError

+ const APIErrCodeWebhookNotFound

+ type APIErrorDetails struct

+ Code APIErrCode

+ Link string

+ Message string

+ Type string

+ type Actions struct

+ Pin []Pin

+ Scale []Scale

+ type Conditions struct

+ Filter *FilterCondition

+ Query *QueryCondition

+ Time *TimeCondition

type ErrCode

+ const APIError

+ const APIErrorWithoutMessage

+ const CommunicationError

+ const MaxRetriesExceeded

+ const TimeoutError

type Error

+ APIError APIErrorDetails

+ func (e *Error) HasCode(code APIErrCode) bool

+ func (e *Error) Unwrap() error

type ExperimentalFeatures

+ func (ef *ExperimentalFeatures) SetForeignKeys(enable bool) *ExperimentalFeatures

+ func (ef *ExperimentalFeatures) SetRenderRoute(renderRoot bool) *ExperimentalFeatures

type ExperimentalFeaturesBase

+ ForeignKeys *bool

+ RenderRoute *bool

type ExperimentalFeaturesResult

+ ForeignKeys bool

+ Personalize *SearchRequestPersonalize

+ RenderRoute bool

+ type FilterCondition struct

+ Values map[string]interface{}

+ type ForeignKey struct

+ FieldName string

+ ForeignIndexUid string

+ type ImportFrom struct

+ DocumentCount int64

+ IndexName string

+ RemoteName string

+ type InputKind string

+ const IndexDocument

+ const InlineDocument

+ const InlineSearch

type MultiSearchRequest

+ IncludeMetadata bool

type MultiSearchResponse

+ Metadata []SearchMetadata

type Origin

+ NetworkVersion string

+ type Pin struct

+ ID string

+ IndexUid string

+ Position int

+ type QueryCondition struct

+ IsEmpty *bool

+ Words string

type Remote

+ Status RemoteStatus

+ type RemoteStatus string

+ const RemoteStatusAvailable

+ const RemoteStatusUnavailable

+ type RenderTemplateParams struct

+ Input *TempelateInput

+ Template Template

+ type RenderTemplateResponse struct

+ Rendered any

+ Template any

+ type Scale struct

+ Filter interface{}

+ Ids []string

+ IndexUid string

+ Weight float64

+ type SearchMetadata struct

+ IndexUID string

+ InlineRuleConditionOutcomes map[string]interface{}

+ PrimaryKey string

+ Query string

+ QueryUID string

+ Remote string

type SearchRequest

+ IncludeMetadata bool

+ InlineRule *SearchRequestInlineRule

+ Personalize *SearchRequestPersonalize

+ type SearchRequestBuilder struct

+ func NewSearchRequestBuilder() *SearchRequestBuilder

+ func (b *SearchRequestBuilder) Build() *SearchRequest

+ func (b *SearchRequestBuilder) WithAttributesToCrop(attrs ...string) *SearchRequestBuilder

+ func (b *SearchRequestBuilder) WithAttributesToHighlight(attrs ...string) *SearchRequestBuilder

+ func (b *SearchRequestBuilder) WithAttributesToRetrieve(attrs ...string) *SearchRequestBuilder

+ func (b *SearchRequestBuilder) WithAttributesToSearchOn(attrs ...string) *SearchRequestBuilder

+ func (b *SearchRequestBuilder) WithCropLength(v int64) *SearchRequestBuilder

+ func (b *SearchRequestBuilder) WithCropMarker(v string) *SearchRequestBuilder

+ func (b *SearchRequestBuilder) WithDistinct(v string) *SearchRequestBuilder

+ func (b *SearchRequestBuilder) WithFacets(facets ...string) *SearchRequestBuilder

+ func (b *SearchRequestBuilder) WithFederationOptions(o *SearchFederationOptions) *SearchRequestBuilder

+ func (b *SearchRequestBuilder) WithFilter(v interface{}) *SearchRequestBuilder

+ func (b *SearchRequestBuilder) WithHighlightPostTag(v string) *SearchRequestBuilder

+ func (b *SearchRequestBuilder) WithHighlightPreTag(v string) *SearchRequestBuilder

+ func (b *SearchRequestBuilder) WithHitsPerPage(v int64) *SearchRequestBuilder

+ func (b *SearchRequestBuilder) WithHybrid(h *SearchRequestHybrid) *SearchRequestBuilder

+ func (b *SearchRequestBuilder) WithIndexUID(v string) *SearchRequestBuilder

+ func (b *SearchRequestBuilder) WithInlineRule(r *SearchRequestInlineRule) *SearchRequestBuilder

+ func (b *SearchRequestBuilder) WithLimit(v int64) *SearchRequestBuilder

+ func (b *SearchRequestBuilder) WithLocales(locales ...string) *SearchRequestBuilder

+ func (b *SearchRequestBuilder) WithMatchingStrategy(v MatchingStrategy) *SearchRequestBuilder

+ func (b *SearchRequestBuilder) WithMedia(m map[string]any) *SearchRequestBuilder

+ func (b *SearchRequestBuilder) WithOffset(v int64) *SearchRequestBuilder

+ func (b *SearchRequestBuilder) WithPage(v int64) *SearchRequestBuilder

+ func (b *SearchRequestBuilder) WithPersonalize(p *SearchRequestPersonalize) *SearchRequestBuilder

+ func (b *SearchRequestBuilder) WithQuery(v string) *SearchRequestBuilder

+ func (b *SearchRequestBuilder) WithRankingScoreThreshold(v float64) *SearchRequestBuilder

+ func (b *SearchRequestBuilder) WithRetrieveVectors(v bool) *SearchRequestBuilder

+ func (b *SearchRequestBuilder) WithShowMatchesPosition(v bool) *SearchRequestBuilder

+ func (b *SearchRequestBuilder) WithShowPerformanceDetails(v bool) *SearchRequestBuilder

+ func (b *SearchRequestBuilder) WithShowRankingScore(v bool) *SearchRequestBuilder

+ func (b *SearchRequestBuilder) WithShowRankingScoreDetails(v bool) *SearchRequestBuilder

+ func (b *SearchRequestBuilder) WithSort(sort ...string) *SearchRequestBuilder

+ func (b *SearchRequestBuilder) WithVector(v []float32) *SearchRequestBuilder

+ type SearchRequestInlineRule struct

+ Actions *Actions

+ Active *bool

+ Conditions *Conditions

+ Precedence *int

+ Uid string

+ type SearchRequestPersonalize struct

+ UserContext string

type SearchResponse

+ Metadata *SearchMetadata

type SearchRule

+ Precedence int

type SearchRulesFilter

+ Query string

type SearchRulesRequest

+ Precedence *int

type ServiceManager

+ RenderTemplate func(ctx context.Context, params *RenderTemplateParams) (*RenderTemplateResponse, error)

type Settings

+ ForeignKeys []ForeignKey

type SettingsManager

+ ResetForeignKeys func(ctx context.Context) (*TaskInfo, error)

+ UpdateForeignKeys func(ctx context.Context, foreignKeys []ForeignKey) (*TaskInfo, error)

type SettingsReader

+ GetForeignKeys func(ctx context.Context) ([]ForeignKey, error)

type SortFacetType

+ const SortFacetTypeSampledCount

type StatsIndex

+ IndexSize any

+ UsedIndexSize any

type TaskNetwork

+ ImportFrom *ImportFrom

+ NetworkChange *Origin

+ NetworkVersion string

+ RemoteTasks map[string]*TaskRemote

+ type TempelateInput struct

+ ID *string

+ IndexUID *string

+ Inline any

+ Kind InputKind

+ type Template struct

+ DocumentTemplateMaxBytes *int64

+ Embedder *string

+ Fragment *string

+ IndexUID *string

+ Inline any

+ Kind TemplateKind

+ type TemplateKind string

+ const ChatDocumentTemplate

+ const DocumentTemplate

+ const IndexingFragment

+ const InlineDocumentTemplate

+ const InlineFragment

+ const SearchFragment

+ type TimeCondition struct

+ End *time.Time

+ Start *time.Time

v0.36.3

Jun 1, 2026

Changes in this version

+ type Action struct

+ Action ActionDef

+ Selector Selector

+ type ActionDef struct

+ Position int

+ Type string

+ type Condition struct

+ End *time.Time

+ IsEmpty *bool

+ Scope string

+ Start *time.Time

type ExperimentalFeatures

+ func (ef *ExperimentalFeatures) SetDynamicSearchRules(dynamicSearchRule bool) *ExperimentalFeatures

+ func (ef *ExperimentalFeatures) SetGetTaskDocumentsRoute(enable bool) *ExperimentalFeatures

type ExperimentalFeaturesBase

+ DynamicSearchRules *bool

+ GetTaskDocumentsRoute *bool

type ExperimentalFeaturesResult

+ DynamicSearchRules bool

+ GetTaskDocumentsRoute bool

+ type SearchRule struct

+ Actions []Action

+ Active bool

+ Conditions []Condition

+ Description string

+ Priority int

+ Uid string

+ type SearchRulesFilter struct

+ Active *bool

+ AttributePatterns []string

+ type SearchRulesManager interface

+ DeleteSearchRule func(uid string) error

+ DeleteSearchRuleWithContext func(ctx context.Context, uid string) error

+ UpdateSearchRule func(uid string, params *SearchRulesRequest) (*SearchRule, error)

+ UpdateSearchRuleWithContext func(ctx context.Context, uid string, params *SearchRulesRequest) (*SearchRule, error)

+ type SearchRulesParams struct

+ Filter *SearchRulesFilter

+ Limit int64

+ Offset int64

+ type SearchRulesReader interface

+ GetSearchRule func(uid string) (*SearchRule, error)

+ GetSearchRuleWithContext func(ctx context.Context, uid string) (*SearchRule, error)

+ ListSearchRules func(params *SearchRulesParams) (*SearchRulesResults, error)

+ ListSearchRulesWithContext func(ctx context.Context, params *SearchRulesParams) (*SearchRulesResults, error)

+ type SearchRulesRequest struct

+ Actions []Action

+ Active *bool

+ Conditions []Condition

+ Description string

+ Priority *int

+ type SearchRulesResults struct

+ Limit int64

+ Offset int64

+ Results []SearchRule

+ Total int64

+ type Selector struct

+ ID string

+ IndexUid string

type ServiceManager

+ SearchRulesManager func() SearchRulesManager

+ SearchRulesReader func() SearchRulesReader

type StatsIndex

+ InternalDatabaseSizes map[string]any

+ type StatsParams struct

+ ShowInternalDatabaseSizes bool

+ SizeFormat string

type TaskManager

+ GetTaskDocuments func(taskUID int64, dst interface{}) error

+ GetTaskDocumentsWithContext func(ctx context.Context, taskUID int64, dst interface{}) error

v0.36.2

Apr 13, 2026

Changes in this version

type MultiSearchFederation

+ Distinct string

type Network

+ Shards map[string]Shard

+ type Shard struct

+ Remotes []string

type UpdateNetworkRequest

+ Shards Opt[map[string]Opt[UpdateRemoteShard]]

+ type UpdateRemoteShard struct

+ AddRemotes Opt[[]string]

+ Remotes Opt[[]string]

+ RemoveRemotes Opt[[]string]

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

v0.36.1

Feb 10, 2026

Changes in this version

type SearchRequest

+ ShowPerformanceDetails bool

type SearchResponse

+ PerformanceDetails map[string]any

type SimilarDocumentQuery

+ ShowPerformanceDetails bool

type SimilarDocumentResult

+ PerformanceDetails map[string]any

v0.36.0

Jan 26, 2026

v0.35.1

Jan 2, 2026

Changes in this version

type CsvDocumentsQuery

+ SkipCreation bool

type DocumentOptions

+ SkipCreation bool

v0.35.0

Dec 22, 2025

Changes in this version

type CsvDocumentsQuery

+ TaskCustomMetadata string

+ type DocumentOptions struct

+ PrimaryKey *string

+ TaskCustomMetadata string

type Network

+ Leader string

+ Version string

type Task

+ CustomMetadata string

type UpdateDocumentByFunctionRequest

+ TaskCustomMetadata string

+ type UpdateNetworkRequest struct

+ Leader Opt[string]

+ Remotes Opt[map[string]Opt[UpdateRemote]]

+ Self Opt[string]

+ Version Opt[string]

+ func (n UpdateNetworkRequest) MarshalJSON() ([]byte, error)

+ type UpdateRemote struct

+ SearchAPIKey Opt[string]

+ URL Opt[string]

+ WriteAPIKey Opt[string]

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

v0.34.2

Nov 16, 2025

Changes in this version

type IndexManager

+ Compact func() (*TaskInfo, error)

+ CompactWithContext func(ctx context.Context) (*TaskInfo, error)

v0.34.1

Oct 18, 2025

v0.34.0

Sep 12, 2025

Changes in this version

type Hit

+ func (h Hit) DecodeInto(out any) error

type Hits

+ func (h Hits) DecodeInto(vSlicePtr interface{}) error

type SearchResponse

+ QueryVector *[]float32

type SwapIndexesParams

+ Rename bool

+ type UpdateIndexRequestParams struct

+ PrimaryKey string

+ UID string

v0.33.3

Sep 4, 2025

Changes in this version

type Network

+ Sharding Opt[bool]

+ type Origin struct

+ RemoteName string

+ TaskUID string

type Remote

+ WriteAPIKey Opt[string]

type Task

+ TaskNetwork TaskNetwork

+ type TaskNetwork struct

+ Origin *Origin

+ Remotes map[string]*TaskRemote

+ type TaskRemote struct

+ Error *string

+ TaskUID *string

v0.33.2

Aug 22, 2025

Changes in this version

+ func BoolPtr(v bool) *bool

+ func FloatPtr(v float64) *float64

+ func Int64Ptr(v int64) *int64

+ func IntPtr(v int) *int

+ func StringPtr(v string) *string

+ func TimePtr(v time.Time) *time.Time

type MultiSearchResponse

+ RemoteErrors map[string]*RemoteError

+ type Network struct

+ Remotes Opt[map[string]Opt[Remote]]

+ Self Opt[string]

+ func (n Network) MarshalJSON() ([]byte, error)

+ type Opt struct

+ Value T

+ func Bool(v bool) Opt[bool]

+ func Float(v float64) Opt[float64]

+ func Int(v int) Opt[int]

+ func Int64(v int64) Opt[int64]

+ func NewOpt[T any](v T) Opt[T]

+ func Null[T any]() Opt[T]

+ func String(v string) Opt[string]

+ func (o *Opt[T]) UnmarshalJSON(b []byte) error

+ func (o Opt[T]) MarshalJSON() ([]byte, error)

+ func (o Opt[T]) Null() bool

+ func (o Opt[T]) Valid() bool

+ type Remote struct

+ SearchAPIKey Opt[string]

+ URL Opt[string]

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

+ type RemoteError struct

+ Code string

+ Link string

+ Message string

+ Type string

type ServiceManager

+ UpdateNetwork func(params *Network) (*Network, error)

+ UpdateNetworkWithContext func(ctx context.Context, params *Network) (*Network, error)

type ServiceReader

+ GetNetwork func() (*Network, error)

+ GetNetworkWithContext func(ctx context.Context) (*Network, error)

v0.33.1

Aug 16, 2025

Changes in this version

+ func RegisterDecoder(contentType string, decoder func(io.ReadCloser) Decoder)

+ type AddWebhookRequest struct

+ Headers map[string]string

+ URL string

+ type Chat struct

+ Description string

+ DocumentTemplate string

+ DocumentTemplateMaxBytes int

+ SearchParameters *SearchParameters

+ type ChatCompletionChoice struct

+ Delta *ChatCompletionChoiceDelta

+ FinishReason *string

+ Index int64

+ Logprobs any

+ type ChatCompletionChoiceDelta struct

+ Content *string

+ FunctionCall *string

+ Refusal *string

+ Role *ChatRole

+ ToolCalls *string

+ type ChatCompletionMessage struct

+ Content string

+ Role ChatRole

+ type ChatCompletionQuery struct

+ Messages []*ChatCompletionMessage

+ Model string

+ Stream bool

+ type ChatCompletionStreamChunk struct

+ Choices []*ChatCompletionChoice

+ Created Timestampz

+ ID string

+ Model string

+ Object *string

+ ServiceTier *string

+ SystemFingerprint *string

+ Usage any

+ type ChatManager interface

+ ResetChatWorkspace func(uid string) (*ChatWorkspaceSettings, error)

+ ResetChatWorkspaceWithContext func(ctx context.Context, uid string) (*ChatWorkspaceSettings, error)

+ UpdateChatWorkspace func(uid string, settings *ChatWorkspaceSettings) (*ChatWorkspaceSettings, error)

+ UpdateChatWorkspaceWithContext func(ctx context.Context, uid string, settings *ChatWorkspaceSettings) (*ChatWorkspaceSettings, error)

+ type ChatReader interface

+ ChatCompletionStream func(workspace string, query *ChatCompletionQuery) (*Stream[*ChatCompletionStreamChunk], error)

+ ChatCompletionStreamWithContext func(ctx context.Context, workspace string, query *ChatCompletionQuery) (*Stream[*ChatCompletionStreamChunk], error)

+ GetChatWorkspace func(uid string) (*ChatWorkspace, error)

+ GetChatWorkspaceSettings func(uid string) (*ChatWorkspaceSettings, error)

+ GetChatWorkspaceSettingsWithContext func(ctx context.Context, uid string) (*ChatWorkspaceSettings, error)

+ GetChatWorkspaceWithContext func(ctx context.Context, uid string) (*ChatWorkspace, error)

+ ListChatWorkspaces func(query *ListChatWorkSpaceQuery) (*ListChatWorkspace, error)

+ ListChatWorkspacesWithContext func(ctx context.Context, query *ListChatWorkSpaceQuery) (*ListChatWorkspace, error)

+ type ChatRole string

+ const ChatRoleAssistant

+ const ChatRoleSystem

+ const ChatRoleUser

+ type ChatSource string

+ const AzureOpenAiChatSource

+ const GeminiChatSource

+ const MistralChatSource

+ const OpenaiChatSource

+ const VLlmChatSource

+ type ChatWorkspace struct

+ UID string

+ type ChatWorkspaceSettings struct

+ ApiKey string

+ ApiVersion string

+ BaseUrl string

+ DeploymentId string

+ OrgId string

+ ProjectId string

+ Prompts *ChatWorkspaceSettingsPrompts

+ Source ChatSource

+ type ChatWorkspaceSettingsPrompts struct

+ SearchDescription string

+ SearchFilterParam string

+ SearchIndexUidParam string

+ SearchQParam string

+ System string

+ type Decoder interface

+ Close func() error

+ Err func() error

+ Event func() Event

+ Next func() bool

+ func NewDecoder(res *http.Response) Decoder

type DocumentsQuery

+ Sort []string

type Embedder

+ IndexingFragments map[string]Fragment

+ SearchFragments map[string]Fragment

+ type Event struct

+ Data []byte

+ Type string

type ExperimentalFeatures

+ func (ef *ExperimentalFeatures) SetChatCompletions(enable bool) *ExperimentalFeatures

+ func (ef *ExperimentalFeatures) SetMultiModal(enable bool) *ExperimentalFeatures

type ExperimentalFeaturesBase

+ ChatCompletions *bool

+ MultiModal *bool

type ExperimentalFeaturesResult

+ ChatCompletions bool

+ MultiModal bool

+ type ExportParams struct

+ APIKey string

+ Indexes map[string]IndexExportOptions

+ PayloadSize string

+ URL string

+ type Fragment struct

+ Value map[string]any

+ type IndexExportOptions struct

+ Filter string

+ OverrideSettings bool

+ type ListChatWorkSpaceQuery struct

+ Limit int64

+ Offset int64

+ type ListChatWorkspace struct

+ Limit int64

+ Offset int64

+ Results []*ChatWorkspace

+ Total int64

+ type SearchParameters struct

+ AttributesToSearchOn []string

+ Distinct string

+ Hybrid *SearchRequestHybrid

+ Limit int64

+ MatchingStrategy MatchingStrategy

+ RankingScoreThreshold float64

+ Sort []string

type SearchRequest

+ Media map[string]any

type ServiceManager

+ ChatManager func() ChatManager

+ ChatReader func() ChatReader

+ Export func(params *ExportParams) (*TaskInfo, error)

+ ExportWithContext func(ctx context.Context, params *ExportParams) (*TaskInfo, error)

+ WebhookManager func() WebhookManager

+ WebhookReader func() WebhookReader

type Settings

+ Chat *Chat

+ type Stream struct

+ func NewStream[T any](decoder Decoder, unmarshal JSONUnmarshal) *Stream[T]

+ func (s *Stream[T]) Close() error

+ func (s *Stream[T]) Current() T

+ func (s *Stream[T]) Err() error

+ func (s *Stream[T]) Next() bool

type TaskType

+ const TaskTypeExport

+ type Timestampz int64

+ func (t Timestampz) String() string

+ func (t Timestampz) ToTime() time.Time

+ type UpdateWebhookRequest struct

+ Headers map[string]string

+ URL string

+ type Webhook struct

+ Headers map[string]string

+ IsEditable bool

+ URL string

+ UUID string

+ type WebhookManager interface

+ AddWebhook func(params *AddWebhookRequest) (*Webhook, error)

+ AddWebhookWithContext func(ctx context.Context, params *AddWebhookRequest) (*Webhook, error)

+ DeleteWebhook func(uuid string) error

+ DeleteWebhookWithContext func(ctx context.Context, uuid string) error

+ UpdateWebhook func(uuid string, params *UpdateWebhookRequest) (*Webhook, error)

+ UpdateWebhookWithContext func(ctx context.Context, uuid string, params *UpdateWebhookRequest) (*Webhook, error)

+ type WebhookReader interface

+ GetWebhook func(uuid string) (*Webhook, error)

+ GetWebhookWithContext func(ctx context.Context, uuid string) (*Webhook, error)

+ ListWebhooks func() (*WebhookResults, error)

+ ListWebhooksWithContext func(ctx context.Context) (*WebhookResults, error)

+ type WebhookResults struct

+ Result []*Webhook

v0.33.0

Aug 4, 2025

Changes in this version

+ var ErrMeilisearchNotAvailable = errors.New("meilisearch service is not available")

+ type AttributeFeatures struct

+ FacetSearch bool

+ Filter FilterFeatures

+ type AttributeRule struct

+ AttributePatterns []string

+ Features AttributeFeatures

+ type Batch struct

+ BatchStrategy string

+ Details map[string]interface{}

+ Duration string

+ FinishedAt time.Time

+ Progress *BatchProgress

+ StartedAt time.Time

+ Stats *BatchStats

+ UID int

+ type BatchProgress struct

+ Percentage float64

+ Steps []*BatchProgressStep

+ type BatchProgressStep struct

+ CurrentStep string

+ Finished int

+ Total int

+ type BatchStats struct

+ IndexedUIDs map[string]int

+ InternalDatabaseSizes *BatchStatsInternalDatabaseSize

+ ProgressTrace map[string]string

+ Status map[string]int

+ TotalNbTasks int

+ Types map[string]int

+ WriteChannelCongestion *BatchStatsWriteChannelCongestion

+ type BatchStatsInternalDatabaseSize struct

+ Documents string

+ ExternalDocumentsIDs string

+ FieldIdWordCountDocIDs string

+ WordDocIDs string

+ WordFidDocIDs string

+ WordPairProximityDocIDs string

+ WordPositionDocIDs string

+ type BatchStatsWriteChannelCongestion struct

+ Attempts int

+ BlockingAttempts int

+ BlockingRatio float64

+ type BatchesQuery struct

+ AfterEnqueuedAt time.Time

+ AfterFinishedAt time.Time

+ AfterStartedAt time.Time

+ BatchUIDs []int64

+ BeforeEnqueuedAt time.Time

+ BeforeFinishedAt time.Time

+ BeforeStartedAt time.Time

+ From int64

+ IndexUIDs []string

+ Limit int64

+ Reverse bool

+ Statuses []string

+ Types []string

+ UIDs []int64

+ type BatchesResults struct

+ From int64

+ Limit int64

+ Next int64

+ Results []*Batch

+ Total int64

type DocumentQuery

+ RetrieveVectors bool

type DocumentsQuery

+ Ids []string

+ RetrieveVectors bool

type Embedder

+ BinaryQuantized bool

+ DocumentTemplateMaxBytes int

+ IndexingEmbedder *Embedder

+ Pooling EmbedderPooling

+ SearchEmbedder *Embedder

+ type EmbedderPooling string

+ const ForceClsEmbedderPooling

+ const ForceMeanEmbedderPooling

+ const UseModelEmbedderPooling

+ type EmbedderSource string

+ const CompositeEmbedderSource

+ const HuggingFaceEmbedderSource

+ const OllamaEmbedderSource

+ const OpenaiEmbedderSource

+ const RestEmbedderSource

+ const UserProvidedEmbedderSource

type ExperimentalFeatures

+ func (ef *ExperimentalFeatures) SetCompositeEmbedders(enable bool) *ExperimentalFeatures

+ func (ef *ExperimentalFeatures) SetNetwork(enable bool) *ExperimentalFeatures

type ExperimentalFeaturesBase

+ CompositeEmbedders *bool

+ Network *bool

type ExperimentalFeaturesResult

+ CompositeEmbedders bool

+ Network bool

type FacetSearchRequest

+ ExhaustiveFacetCount bool

+ type FilterFeatures struct

+ Comparison bool

+ Equality bool

+ type Hit map[string]json.RawMessage

+ func (h Hit) Decode(vPtr interface{}) error

+ func (h Hit) DecodeWith(vPtr interface{}, marshal JSONMarshal, unmarshal JSONUnmarshal) error

+ type Hits []Hit

+ func (h Hits) Decode(vSlicePtr interface{}) error

+ func (h Hits) DecodeWith(vSlicePtr interface{}, marshal JSONMarshal, unmarshal JSONUnmarshal) error

+ func (h Hits) Len() int

+ type JSONMarshal func(v interface{}) ([]byte, error)

+ type JSONUnmarshal func(data []byte, v interface{}) error

type MultiSearchFederation

+ FacetsByIndex map[string][]string

+ MergeFacets *MultiSearchFederationMergeFacets

+ type MultiSearchFederationMergeFacets struct

+ MaxValuesPerFacet int

type MultiSearchResponse

+ FacetDistribution map[string]json.RawMessage

+ FacetStats map[string]json.RawMessage

type Option

+ func WithCustomDialContext(dial func(ctx context.Context, network, addr string) (net.Conn, error)) Option

+ func WithCustomExpectContinueTimeout(timeout time.Duration) Option

+ func WithCustomIdleConnTimeout(timeout time.Duration) Option

+ func WithCustomJsonMarshaler(marshal JSONMarshal) Option

+ func WithCustomJsonUnmarshaler(unmarshal JSONUnmarshal) Option

+ func WithCustomMaxIdleConns(maxIdleConns int) Option

+ func WithCustomMaxIdleConnsPerHost(maxIdleConnsPerHost int) Option

+ func WithCustomProxy(proxy func(*http.Request) (*url.URL, error)) Option

+ func WithCustomTLSHandshakeTimeout(timeout time.Duration) Option

type SearchFederationOptions

+ Remote string

type SearchRequest

+ Locales []string

type ServiceReader

+ GetBatch func(batchUID int) (*Batch, error)

+ GetBatchWithContext func(ctx context.Context, batchUID int) (*Batch, error)

+ GetBatches func(param *BatchesQuery) (*BatchesResults, error)

+ GetBatchesWithContext func(ctx context.Context, param *BatchesQuery) (*BatchesResults, error)

type TypoTolerance

+ DisableOnNumbers bool

v0.32.0

May 5, 2025

v0.31.1

May 5, 2025

Changes in this version

type Settings

+ FacetSearch bool

+ PrefixSearch *string

type SettingsManager

+ ResetFacetSearch func() (*TaskInfo, error)

+ ResetFacetSearchWithContext func(ctx context.Context) (*TaskInfo, error)

+ ResetPrefixSearch func() (*TaskInfo, error)

+ ResetPrefixSearchWithContext func(ctx context.Context) (*TaskInfo, error)

+ UpdateFacetSearch func(request bool) (*TaskInfo, error)

+ UpdateFacetSearchWithContext func(ctx context.Context, request bool) (*TaskInfo, error)

+ UpdatePrefixSearch func(request string) (*TaskInfo, error)

+ UpdatePrefixSearchWithContext func(ctx context.Context, request string) (*TaskInfo, error)

type SettingsReader

+ GetFacetSearch func() (bool, error)

+ GetFacetSearchWithContext func(ctx context.Context) (bool, error)

+ GetPrefixSearch func() (*string, error)

+ GetPrefixSearchWithContext func(ctx context.Context) (*string, error)

type Stats

+ UsedDatabaseSize int64

type StatsIndex

+ AvgDocumentSize int64

+ NumberOfEmbeddedDocuments int64

+ NumberOfEmbeddings int64

+ RawDocumentDbSize int64

v0.31.0

Feb 19, 2025

Changes in this version

type TasksQuery

+ Reverse bool

v0.30.0

Dec 31, 2024

Changes in this version

+ type Distribution struct

+ Mean float64

+ Sigma float64

+ func (v *Distribution) UnmarshalEasyJSON(l *jlexer.Lexer)

+ func (v *Distribution) UnmarshalJSON(data []byte) error

+ func (v Distribution) MarshalEasyJSON(w *jwriter.Writer)

+ func (v Distribution) MarshalJSON() ([]byte, error)

+ type DocumentManager interface

+ AddDocuments func(documentsPtr interface{}, primaryKey ...string) (*TaskInfo, error)

+ AddDocumentsCsv func(documents []byte, options *CsvDocumentsQuery) (*TaskInfo, error)

+ AddDocumentsCsvFromReader func(documents io.Reader, options *CsvDocumentsQuery) (*TaskInfo, error)

+ AddDocumentsCsvFromReaderInBatches func(documents io.Reader, batchSize int, options *CsvDocumentsQuery) ([]TaskInfo, error)

+ AddDocumentsCsvFromReaderInBatchesWithContext func(ctx context.Context, documents io.Reader, batchSize int, ...) ([]TaskInfo, error)

+ AddDocumentsCsvFromReaderWithContext func(ctx context.Context, documents io.Reader, options *CsvDocumentsQuery) (*TaskInfo, error)

+ AddDocumentsCsvInBatches func(documents []byte, batchSize int, options *CsvDocumentsQuery) ([]TaskInfo, error)

+ AddDocumentsCsvInBatchesWithContext func(ctx context.Context, documents []byte, batchSize int, ...) ([]TaskInfo, error)

+ AddDocumentsCsvWithContext func(ctx context.Context, documents []byte, options *CsvDocumentsQuery) (*TaskInfo, error)

+ AddDocumentsInBatches func(documentsPtr interface{}, batchSize int, primaryKey ...string) ([]TaskInfo, error)

+ AddDocumentsInBatchesWithContext func(ctx context.Context, documentsPtr interface{}, batchSize int, ...) ([]TaskInfo, error)

+ AddDocumentsNdjson func(documents []byte, primaryKey ...string) (*TaskInfo, error)

+ AddDocumentsNdjsonFromReader func(documents io.Reader, primaryKey ...string) (*TaskInfo, error)

+ AddDocumentsNdjsonFromReaderInBatches func(documents io.Reader, batchSize int, primaryKey ...string) ([]TaskInfo, error)

+ AddDocumentsNdjsonFromReaderInBatchesWithContext func(ctx context.Context, documents io.Reader, batchSize int, primaryKey ...string) ([]TaskInfo, error)

+ AddDocumentsNdjsonFromReaderWithContext func(ctx context.Context, documents io.Reader, primaryKey ...string) (*TaskInfo, error)

+ AddDocumentsNdjsonInBatches func(documents []byte, batchSize int, primaryKey ...string) ([]TaskInfo, error)

+ AddDocumentsNdjsonInBatchesWithContext func(ctx context.Context, documents []byte, batchSize int, primaryKey ...string) ([]TaskInfo, error)

+ AddDocumentsNdjsonWithContext func(ctx context.Context, documents []byte, primaryKey ...string) (*TaskInfo, error)

+ AddDocumentsWithContext func(ctx context.Context, documentsPtr interface{}, primaryKey ...string) (*TaskInfo, error)

+ DeleteAllDocuments func() (*TaskInfo, error)

+ DeleteAllDocumentsWithContext func(ctx context.Context) (*TaskInfo, error)

+ DeleteDocument func(identifier string) (*TaskInfo, error)

+ DeleteDocumentWithContext func(ctx context.Context, identifier string) (*TaskInfo, error)

+ DeleteDocuments func(identifiers []string) (*TaskInfo, error)

+ DeleteDocumentsByFilter func(filter interface{}) (*TaskInfo, error)

+ DeleteDocumentsByFilterWithContext func(ctx context.Context, filter interface{}) (*TaskInfo, error)

+ DeleteDocumentsWithContext func(ctx context.Context, identifiers []string) (*TaskInfo, error)

+ UpdateDocuments func(documentsPtr interface{}, primaryKey ...string) (*TaskInfo, error)

+ UpdateDocumentsByFunction func(req *UpdateDocumentByFunctionRequest) (*TaskInfo, error)

+ UpdateDocumentsByFunctionWithContext func(ctx context.Context, req *UpdateDocumentByFunctionRequest) (*TaskInfo, error)

+ UpdateDocumentsCsv func(documents []byte, options *CsvDocumentsQuery) (*TaskInfo, error)

+ UpdateDocumentsCsvInBatches func(documents []byte, batchsize int, options *CsvDocumentsQuery) ([]TaskInfo, error)

+ UpdateDocumentsCsvInBatchesWithContext func(ctx context.Context, documents []byte, batchsize int, ...) ([]TaskInfo, error)

+ UpdateDocumentsCsvWithContext func(ctx context.Context, documents []byte, options *CsvDocumentsQuery) (*TaskInfo, error)

+ UpdateDocumentsInBatches func(documentsPtr interface{}, batchSize int, primaryKey ...string) ([]TaskInfo, error)

+ UpdateDocumentsInBatchesWithContext func(ctx context.Context, documentsPtr interface{}, batchSize int, ...) ([]TaskInfo, error)

+ UpdateDocumentsNdjson func(documents []byte, primaryKey ...string) (*TaskInfo, error)

+ UpdateDocumentsNdjsonInBatches func(documents []byte, batchsize int, primaryKey ...string) ([]TaskInfo, error)

+ UpdateDocumentsNdjsonInBatchesWithContext func(ctx context.Context, documents []byte, batchsize int, primaryKey ...string) ([]TaskInfo, error)

+ UpdateDocumentsNdjsonWithContext func(ctx context.Context, documents []byte, primaryKey ...string) (*TaskInfo, error)

+ UpdateDocumentsWithContext func(ctx context.Context, documentsPtr interface{}, primaryKey ...string) (*TaskInfo, error)

+ type DocumentReader interface

+ GetDocument func(identifier string, request *DocumentQuery, documentPtr interface{}) error

+ GetDocumentWithContext func(ctx context.Context, identifier string, request *DocumentQuery, ...) error

+ GetDocuments func(param *DocumentsQuery, resp *DocumentsResult) error

+ GetDocumentsWithContext func(ctx context.Context, param *DocumentsQuery, resp *DocumentsResult) error

type Embedder

+ APIKey string

+ Distribution *Distribution

+ Headers map[string]string

+ Request map[string]interface{}

+ Response map[string]interface{}

+ Revision string

type IndexManager

+ GetDocumentManager func() DocumentManager

+ GetDocumentReader func() DocumentReader

+ GetIndexReader func() IndexReader

+ GetSearch func() SearchReader

+ GetSettingsManager func() SettingsManager

+ GetSettingsReader func() SettingsReader

+ GetTaskReader func() TaskReader

+ type IndexReader interface

+ FetchInfo func() (*IndexResult, error)

+ FetchInfoWithContext func(ctx context.Context) (*IndexResult, error)

+ FetchPrimaryKey func() (*string, error)

+ FetchPrimaryKeyWithContext func(ctx context.Context) (*string, error)

+ GetStats func() (*StatsIndex, error)

+ GetStatsWithContext func(ctx context.Context) (*StatsIndex, error)

+ type KeyManager interface

+ CreateKey func(request *Key) (*Key, error)

+ CreateKeyWithContext func(ctx context.Context, request *Key) (*Key, error)

+ DeleteKey func(keyOrUID string) (bool, error)

+ DeleteKeyWithContext func(ctx context.Context, keyOrUID string) (bool, error)

+ UpdateKey func(keyOrUID string, request *Key) (*Key, error)

+ UpdateKeyWithContext func(ctx context.Context, keyOrUID string, request *Key) (*Key, error)

+ type KeyReader interface

+ GetKey func(identifier string) (*Key, error)

+ GetKeyWithContext func(ctx context.Context, identifier string) (*Key, error)

+ GetKeys func(param *KeysQuery) (*KeysResults, error)

+ GetKeysWithContext func(ctx context.Context, param *KeysQuery) (*KeysResults, error)

+ type SearchReader interface

+ FacetSearch func(request *FacetSearchRequest) (*json.RawMessage, error)

+ FacetSearchWithContext func(ctx context.Context, request *FacetSearchRequest) (*json.RawMessage, error)

+ Search func(query string, request *SearchRequest) (*SearchResponse, error)

+ SearchRaw func(query string, request *SearchRequest) (*json.RawMessage, error)

+ SearchRawWithContext func(ctx context.Context, query string, request *SearchRequest) (*json.RawMessage, error)

+ SearchWithContext func(ctx context.Context, query string, request *SearchRequest) (*SearchResponse, error)

type ServiceManager

+ KeyManager func() KeyManager

+ KeyReader func() KeyReader

+ ServiceReader func() ServiceReader

+ TaskManager func() TaskManager

+ TaskReader func() TaskReader

+ type ServiceReader interface

+ GetIndex func(indexID string) (*IndexResult, error)

+ GetIndexWithContext func(ctx context.Context, indexID string) (*IndexResult, error)

+ GetRawIndex func(uid string) (map[string]interface{}, error)

+ GetRawIndexWithContext func(ctx context.Context, uid string) (map[string]interface{}, error)

+ GetRawIndexes func(param *IndexesQuery) (map[string]interface{}, error)

+ GetRawIndexesWithContext func(ctx context.Context, param *IndexesQuery) (map[string]interface{}, error)

+ GetStats func() (*Stats, error)

+ GetStatsWithContext func(ctx context.Context) (*Stats, error)

+ Health func() (*Health, error)

+ HealthWithContext func(ctx context.Context) (*Health, error)

+ Index func(uid string) IndexManager

+ IsHealthy func() bool

+ ListIndexes func(param *IndexesQuery) (*IndexesResults, error)

+ ListIndexesWithContext func(ctx context.Context, param *IndexesQuery) (*IndexesResults, error)

+ MultiSearch func(queries *MultiSearchRequest) (*MultiSearchResponse, error)

+ MultiSearchWithContext func(ctx context.Context, queries *MultiSearchRequest) (*MultiSearchResponse, error)

+ Version func() (*Version, error)

+ VersionWithContext func(ctx context.Context) (*Version, error)

+ type SettingsManager interface

+ ResetDictionary func() (*TaskInfo, error)

+ ResetDictionaryWithContext func(ctx context.Context) (*TaskInfo, error)

+ ResetDisplayedAttributes func() (*TaskInfo, error)

+ ResetDisplayedAttributesWithContext func(ctx context.Context) (*TaskInfo, error)

+ ResetDistinctAttribute func() (*TaskInfo, error)

+ ResetDistinctAttributeWithContext func(ctx context.Context) (*TaskInfo, error)

+ ResetEmbedders func() (*TaskInfo, error)

+ ResetEmbeddersWithContext func(ctx context.Context) (*TaskInfo, error)

+ ResetFaceting func() (*TaskInfo, error)

+ ResetFacetingWithContext func(ctx context.Context) (*TaskInfo, error)

+ ResetFilterableAttributes func() (*TaskInfo, error)

+ ResetFilterableAttributesWithContext func(ctx context.Context) (*TaskInfo, error)

+ ResetLocalizedAttributes func() (*TaskInfo, error)

+ ResetLocalizedAttributesWithContext func(ctx context.Context) (*TaskInfo, error)

+ ResetNonSeparatorTokens func() (*TaskInfo, error)

+ ResetNonSeparatorTokensWithContext func(ctx context.Context) (*TaskInfo, error)

+ ResetPagination func() (*TaskInfo, error)

+ ResetPaginationWithContext func(ctx context.Context) (*TaskInfo, error)

+ ResetProximityPrecision func() (*TaskInfo, error)

+ ResetProximityPrecisionWithContext func(ctx context.Context) (*TaskInfo, error)

+ ResetRankingRules func() (*TaskInfo, error)

+ ResetRankingRulesWithContext func(ctx context.Context) (*TaskInfo, error)

+ ResetSearchCutoffMs func() (*TaskInfo, error)

+ ResetSearchCutoffMsWithContext func(ctx context.Context) (*TaskInfo, error)

+ ResetSearchableAttributes func() (*TaskInfo, error)

+ ResetSearchableAttributesWithContext func(ctx context.Context) (*TaskInfo, error)

+ ResetSeparatorTokens func() (*TaskInfo, error)

+ ResetSeparatorTokensWithContext func(ctx context.Context) (*TaskInfo, error)

+ ResetSettings func() (*TaskInfo, error)

+ ResetSettingsWithContext func(ctx context.Context) (*TaskInfo, error)

+ ResetSortableAttributes func() (*TaskInfo, error)

+ ResetSortableAttributesWithContext func(ctx context.Context) (*TaskInfo, error)

+ ResetStopWords func() (*TaskInfo, error)

+ ResetStopWordsWithContext func(ctx context.Context) (*TaskInfo, error)

+ ResetSynonyms func() (*TaskInfo, error)

+ ResetSynonymsWithContext func(ctx context.Context) (*TaskInfo, error)

+ ResetTypoTolerance func() (*TaskInfo, error)

+ ResetTypoToleranceWithContext func(ctx context.Context) (*TaskInfo, error)

+ UpdateDictionary func(words []string) (*TaskInfo, error)

+ UpdateDictionaryWithContext func(ctx context.Context, words []string) (*TaskInfo, error)

+ UpdateDisplayedAttributes func(request *[]string) (*TaskInfo, error)

+ UpdateDisplayedAttributesWithContext func(ctx context.Context, request *[]string) (*TaskInfo, error)

+ UpdateDistinctAttribute func(request string) (*TaskInfo, error)

+ UpdateDistinctAttributeWithContext func(ctx context.Context, request string) (*TaskInfo, error)

+ UpdateEmbedders func(request map[string]Embedder) (*TaskInfo, error)

+ UpdateEmbeddersWithContext func(ctx context.Context, request map[string]Embedder) (*TaskInfo, error)

+ UpdateFaceting func(request *Faceting) (*TaskInfo, error)

+ UpdateFacetingWithContext func(ctx context.Context, request *Faceting) (*TaskInfo, error)

+ UpdateFilterableAttributes func(request *[]string) (*TaskInfo, error)

+ UpdateFilterableAttributesWithContext func(ctx context.Context, request *[]string) (*TaskInfo, error)

+ UpdateLocalizedAttributes func(request []*LocalizedAttributes) (*TaskInfo, error)

+ UpdateLocalizedAttributesWithContext func(ctx context.Context, request []*LocalizedAttributes) (*TaskInfo, error)

+ UpdateNonSeparatorTokens func(tokens []string) (*TaskInfo, error)

+ UpdateNonSeparatorTokensWithContext func(ctx context.Context, tokens []string) (*TaskInfo, error)

+ UpdatePagination func(request *Pagination) (*TaskInfo, error)

+ UpdatePaginationWithContext func(ctx context.Context, request *Pagination) (*TaskInfo, error)

+ UpdateProximityPrecision func(proximityType ProximityPrecisionType) (*TaskInfo, error)

+ UpdateProximityPrecisionWithContext func(ctx context.Context, proximityType ProximityPrecisionType) (*TaskInfo, error)

+ UpdateRankingRules func(request *[]string) (*TaskInfo, error)

+ UpdateRankingRulesWithContext func(ctx context.Context, request *[]string) (*TaskInfo, error)

+ UpdateSearchCutoffMs func(request int64) (*TaskInfo, error)

+ UpdateSearchCutoffMsWithContext func(ctx context.Context, request int64) (*TaskInfo, error)

+ UpdateSearchableAttributes func(request *[]string) (*TaskInfo, error)

+ UpdateSearchableAttributesWithContext func(ctx context.Context, request *[]string) (*TaskInfo, error)

+ UpdateSeparatorTokens func(tokens []string) (*TaskInfo, error)

+ UpdateSeparatorTokensWithContext func(ctx context.Context, tokens []string) (*TaskInfo, error)

+ UpdateSettings func(request *Settings) (*TaskInfo, error)

+ UpdateSettingsWithContext func(ctx context.Context, request *Settings) (*TaskInfo, error)

+ UpdateSortableAttributes func(request *[]string) (*TaskInfo, error)

+ UpdateSortableAttributesWithContext func(ctx context.Context, request *[]string) (*TaskInfo, error)

+ UpdateStopWords func(request *[]string) (*TaskInfo, error)

+ UpdateStopWordsWithContext func(ctx context.Context, request *[]string) (*TaskInfo, error)

+ UpdateSynonyms func(request *map[string][]string) (*TaskInfo, error)

+ UpdateSynonymsWithContext func(ctx context.Context, request *map[string][]string) (*TaskInfo, error)

+ UpdateTypoTolerance func(request *TypoTolerance) (*TaskInfo, error)

+ UpdateTypoToleranceWithContext func(ctx context.Context, request *TypoTolerance) (*TaskInfo, error)

+ type SettingsReader interface

+ GetDictionary func() ([]string, error)

+ GetDictionaryWithContext func(ctx context.Context) ([]string, error)

+ GetDisplayedAttributes func() (*[]string, error)

+ GetDisplayedAttributesWithContext func(ctx context.Context) (*[]string, error)

+ GetDistinctAttribute func() (*string, error)

+ GetDistinctAttributeWithContext func(ctx context.Context) (*string, error)

+ GetEmbedders func() (map[string]Embedder, error)

+ GetEmbeddersWithContext func(ctx context.Context) (map[string]Embedder, error)

+ GetFaceting func() (*Faceting, error)

+ GetFacetingWithContext func(ctx context.Context) (*Faceting, error)

+ GetFilterableAttributes func() (*[]string, error)

+ GetFilterableAttributesWithContext func(ctx context.Context) (*[]string, error)

+ GetLocalizedAttributes func() ([]*LocalizedAttributes, error)

+ GetLocalizedAttributesWithContext func(ctx context.Context) ([]*LocalizedAttributes, error)

+ GetNonSeparatorTokens func() ([]string, error)

+ GetNonSeparatorTokensWithContext func(ctx context.Context) ([]string, error)

+ GetPagination func() (*Pagination, error)

+ GetPaginationWithContext func(ctx context.Context) (*Pagination, error)

+ GetProximityPrecision func() (ProximityPrecisionType, error)

+ GetProximityPrecisionWithContext func(ctx context.Context) (ProximityPrecisionType, error)

+ GetRankingRules func() (*[]string, error)

+ GetRankingRulesWithContext func(ctx context.Context) (*[]string, error)

+ GetSearchCutoffMs func() (int64, error)

+ GetSearchCutoffMsWithContext func(ctx context.Context) (int64, error)

+ GetSearchableAttributes func() (*[]string, error)

+ GetSearchableAttributesWithContext func(ctx context.Context) (*[]string, error)

+ GetSeparatorTokens func() ([]string, error)

+ GetSeparatorTokensWithContext func(ctx context.Context) ([]string, error)

+ GetSettings func() (*Settings, error)

+ GetSettingsWithContext func(ctx context.Context) (*Settings, error)

+ GetSortableAttributes func() (*[]string, error)

+ GetSortableAttributesWithContext func(ctx context.Context) (*[]string, error)

+ GetStopWords func() (*[]string, error)

+ GetStopWordsWithContext func(ctx context.Context) (*[]string, error)

+ GetSynonyms func() (*map[string][]string, error)

+ GetSynonymsWithContext func(ctx context.Context) (*map[string][]string, error)

+ GetTypoTolerance func() (*TypoTolerance, error)

+ GetTypoToleranceWithContext func(ctx context.Context) (*TypoTolerance, error)

+ type TaskManager interface

+ CancelTasks func(param *CancelTasksQuery) (*TaskInfo, error)

+ CancelTasksWithContext func(ctx context.Context, param *CancelTasksQuery) (*TaskInfo, error)

+ DeleteTasks func(param *DeleteTasksQuery) (*TaskInfo, error)

+ DeleteTasksWithContext func(ctx context.Context, param *DeleteTasksQuery) (*TaskInfo, error)

+ type TaskReader interface

+ GetTask func(taskUID int64) (*Task, error)

+ GetTaskWithContext func(ctx context.Context, taskUID int64) (*Task, error)

+ GetTasks func(param *TasksQuery) (*TaskResult, error)

+ GetTasksWithContext func(ctx context.Context, param *TasksQuery) (*TaskResult, error)

+ WaitForTask func(taskUID int64, interval time.Duration) (*Task, error)

+ WaitForTaskWithContext func(ctx context.Context, taskUID int64, interval time.Duration) (*Task, error)

+ type UpdateDocumentByFunctionRequest struct

+ Context map[string]interface{}

+ Filter string

+ Function string

+ func (v *UpdateDocumentByFunctionRequest) UnmarshalEasyJSON(l *jlexer.Lexer)

+ func (v *UpdateDocumentByFunctionRequest) UnmarshalJSON(data []byte) error

+ func (v UpdateDocumentByFunctionRequest) MarshalEasyJSON(w *jwriter.Writer)

+ func (v UpdateDocumentByFunctionRequest) MarshalJSON() ([]byte, error)

v0.29.0

Oct 28, 2024

Changes in this version

+ const BestCompression

+ const BestSpeed

+ const BrotliEncoding

+ const ConstantCompression

+ const DefaultCompression

+ const DeflateEncoding

+ const GzipEncoding

+ const HuffmanOnlyCompression

+ const NoCompression

+ const StatelessCompression

+ type ContentEncoding string

+ func (c ContentEncoding) IsZero() bool

+ func (c ContentEncoding) String() string

type Embedder

+ URL string

+ type EncodingCompressionLevel int

+ func (c EncodingCompressionLevel) Int() int

type ErrCode

+ const MeilisearchMaxRetriesExceeded

+ type ExperimentalFeatures struct

+ func (ef *ExperimentalFeatures) Get() (*ExperimentalFeaturesResult, error)

+ func (ef *ExperimentalFeatures) GetWithContext(ctx context.Context) (*ExperimentalFeaturesResult, error)

+ func (ef *ExperimentalFeatures) SetContainsFilter(containsFilter bool) *ExperimentalFeatures

+ func (ef *ExperimentalFeatures) SetEditDocumentsByFunction(editDocumentsByFunction bool) *ExperimentalFeatures

+ func (ef *ExperimentalFeatures) SetLogsRoute(logsRoute bool) *ExperimentalFeatures

+ func (ef *ExperimentalFeatures) SetMetrics(metrics bool) *ExperimentalFeatures

+ func (ef *ExperimentalFeatures) SetVectorStore(vectorStore bool) *ExperimentalFeatures

+ func (ef *ExperimentalFeatures) Update() (*ExperimentalFeaturesResult, error)

+ func (ef *ExperimentalFeatures) UpdateWithContext(ctx context.Context) (*ExperimentalFeaturesResult, error)

+ type ExperimentalFeaturesBase struct

+ ContainsFilter *bool

+ EditDocumentsByFunction *bool

+ LogsRoute *bool

+ Metrics *bool

+ VectorStore *bool

+ func (v *ExperimentalFeaturesBase) UnmarshalEasyJSON(l *jlexer.Lexer)

+ func (v *ExperimentalFeaturesBase) UnmarshalJSON(data []byte) error

+ func (v ExperimentalFeaturesBase) MarshalEasyJSON(w *jwriter.Writer)

+ func (v ExperimentalFeaturesBase) MarshalJSON() ([]byte, error)

+ type ExperimentalFeaturesResult struct

+ ContainsFilter bool

+ EditDocumentsByFunction bool

+ LogsRoute bool

+ Metrics bool

+ VectorStore bool

+ func (v *ExperimentalFeaturesResult) UnmarshalEasyJSON(l *jlexer.Lexer)

+ func (v *ExperimentalFeaturesResult) UnmarshalJSON(data []byte) error

+ func (v ExperimentalFeaturesResult) MarshalEasyJSON(w *jwriter.Writer)

+ func (v ExperimentalFeaturesResult) MarshalJSON() ([]byte, error)

type IndexManager

+ GetLocalizedAttributes func() ([]*LocalizedAttributes, error)

+ GetLocalizedAttributesWithContext func(ctx context.Context) ([]*LocalizedAttributes, error)

+ ResetLocalizedAttributes func() (*TaskInfo, error)

+ ResetLocalizedAttributesWithContext func(ctx context.Context) (*TaskInfo, error)

+ UpdateLocalizedAttributes func(request []*LocalizedAttributes) (*TaskInfo, error)

+ UpdateLocalizedAttributesWithContext func(ctx context.Context, request []*LocalizedAttributes) (*TaskInfo, error)

+ type LocalizedAttributes struct

+ AttributePatterns []string

+ Locales []string

+ func (v *LocalizedAttributes) UnmarshalEasyJSON(l *jlexer.Lexer)

+ func (v *LocalizedAttributes) UnmarshalJSON(data []byte) error

+ func (v LocalizedAttributes) MarshalEasyJSON(w *jwriter.Writer)

+ func (v LocalizedAttributes) MarshalJSON() ([]byte, error)

+ type MultiSearchFederation struct

+ Limit int64

+ Offset int64

+ func (v *MultiSearchFederation) UnmarshalEasyJSON(l *jlexer.Lexer)

+ func (v *MultiSearchFederation) UnmarshalJSON(data []byte) error

+ func (v MultiSearchFederation) MarshalEasyJSON(w *jwriter.Writer)

+ func (v MultiSearchFederation) MarshalJSON() ([]byte, error)

type MultiSearchRequest

+ Federation *MultiSearchFederation

type MultiSearchResponse

+ EstimatedTotalHits int64

+ Hits []interface{}

+ Limit int64

+ Offset int64

+ ProcessingTimeMs int64

+ SemanticHitCount int64

type Option

+ func DisableRetries() Option

+ func WithContentEncoding(encodingType ContentEncoding, level EncodingCompressionLevel) Option

+ func WithCustomRetries(retryOnStatus []int, maxRetries uint8) Option

+ type SearchFederationOptions struct

+ Weight float64

+ func (v *SearchFederationOptions) UnmarshalEasyJSON(l *jlexer.Lexer)

+ func (v *SearchFederationOptions) UnmarshalJSON(data []byte) error

+ func (v SearchFederationOptions) MarshalEasyJSON(w *jwriter.Writer)

+ func (v SearchFederationOptions) MarshalJSON() ([]byte, error)

type SearchRequest

+ FederationOptions *SearchFederationOptions

+ Locates []string

type ServiceManager

+ ExperimentalFeatures func() *ExperimentalFeatures

type Settings

+ LocalizedAttributes []*LocalizedAttributes

v0.28.0

Aug 21, 2024

Changes in this version

+ var ErrConnectingFailed = errors.New("meilisearch is not connected")

+ var ErrInvalidRequestMethod = errors.New("request body is not expected for GET and HEAD requests")

+ var ErrRequestBodyWithoutContentType = errors.New("request body without Content-Type is not allowed")

type Faceting

+ SortFacetValuesBy map[string]SortFacetType

type IndexConfig

+ func (v *IndexConfig) UnmarshalEasyJSON(l *jlexer.Lexer)

+ func (v *IndexConfig) UnmarshalJSON(data []byte) error

+ func (v IndexConfig) MarshalEasyJSON(w *jwriter.Writer)

+ func (v IndexConfig) MarshalJSON() ([]byte, error)

+ type IndexManager interface

+ AddDocuments func(documentsPtr interface{}, primaryKey ...string) (*TaskInfo, error)

+ AddDocumentsCsv func(documents []byte, options *CsvDocumentsQuery) (*TaskInfo, error)

+ AddDocumentsCsvFromReader func(documents io.Reader, options *CsvDocumentsQuery) (*TaskInfo, error)

+ AddDocumentsCsvFromReaderInBatches func(documents io.Reader, batchSize int, options *CsvDocumentsQuery) ([]TaskInfo, error)

+ AddDocumentsCsvFromReaderInBatchesWithContext func(ctx context.Context, documents io.Reader, batchSize int, ...) ([]TaskInfo, error)

+ AddDocumentsCsvFromReaderWithContext func(ctx context.Context, documents io.Reader, options *CsvDocumentsQuery) (*TaskInfo, error)

+ AddDocumentsCsvInBatches func(documents []byte, batchSize int, options *CsvDocumentsQuery) ([]TaskInfo, error)

+ AddDocumentsCsvInBatchesWithContext func(ctx context.Context, documents []byte, batchSize int, ...) ([]TaskInfo, error)

+ AddDocumentsCsvWithContext func(ctx context.Context, documents []byte, options *CsvDocumentsQuery) (*TaskInfo, error)

+ AddDocumentsInBatches func(documentsPtr interface{}, batchSize int, primaryKey ...string) ([]TaskInfo, error)

+ AddDocumentsInBatchesWithContext func(ctx context.Context, documentsPtr interface{}, batchSize int, ...) ([]TaskInfo, error)

+ AddDocumentsNdjson func(documents []byte, primaryKey ...string) (*TaskInfo, error)

+ AddDocumentsNdjsonFromReader func(documents io.Reader, primaryKey ...string) (*TaskInfo, error)

+ AddDocumentsNdjsonFromReaderInBatches func(documents io.Reader, batchSize int, primaryKey ...string) ([]TaskInfo, error)

+ AddDocumentsNdjsonFromReaderInBatchesWithContext func(ctx context.Context, documents io.Reader, batchSize int, primaryKey ...string) ([]TaskInfo, error)

+ AddDocumentsNdjsonFromReaderWithContext func(ctx context.Context, documents io.Reader, primaryKey ...string) (*TaskInfo, error)

+ AddDocumentsNdjsonInBatches func(documents []byte, batchSize int, primaryKey ...string) ([]TaskInfo, error)

+ AddDocumentsNdjsonInBatchesWithContext func(ctx context.Context, documents []byte, batchSize int, primaryKey ...string) ([]TaskInfo, error)

+ AddDocumentsNdjsonWithContext func(ctx context.Context, documents []byte, primaryKey ...string) (*TaskInfo, error)

+ AddDocumentsWithContext func(ctx context.Context, documentsPtr interface{}, primaryKey ...string) (*TaskInfo, error)

+ Delete func(uid string) (bool, error)

+ DeleteAllDocuments func() (*TaskInfo, error)

+ DeleteAllDocumentsWithContext func(ctx context.Context) (*TaskInfo, error)

+ DeleteDocument func(identifier string) (*TaskInfo, error)

+ DeleteDocumentWithContext func(ctx context.Context, identifier string) (*TaskInfo, error)

+ DeleteDocuments func(identifiers []string) (*TaskInfo, error)

+ DeleteDocumentsByFilter func(filter interface{}) (*TaskInfo, error)

+ DeleteDocumentsByFilterWithContext func(ctx context.Context, filter interface{}) (*TaskInfo, error)

+ DeleteDocumentsWithContext func(ctx context.Context, identifiers []string) (*TaskInfo, error)

+ DeleteWithContext func(ctx context.Context, uid string) (bool, error)

+ FacetSearch func(request *FacetSearchRequest) (*json.RawMessage, error)

+ FacetSearchWithContext func(ctx context.Context, request *FacetSearchRequest) (*json.RawMessage, error)

+ FetchInfo func() (*IndexResult, error)

+ FetchInfoWithContext func(ctx context.Context) (*IndexResult, error)

+ FetchPrimaryKey func() (*string, error)

+ FetchPrimaryKeyWithContext func(ctx context.Context) (*string, error)

+ GetDictionary func() ([]string, error)

+ GetDictionaryWithContext func(ctx context.Context) ([]string, error)

+ GetDisplayedAttributes func() (*[]string, error)

+ GetDisplayedAttributesWithContext func(ctx context.Context) (*[]string, error)

+ GetDistinctAttribute func() (*string, error)

+ GetDistinctAttributeWithContext func(ctx context.Context) (*string, error)

+ GetDocument func(identifier string, request *DocumentQuery, documentPtr interface{}) error

+ GetDocumentWithContext func(ctx context.Context, identifier string, request *DocumentQuery, ...) error

+ GetDocuments func(param *DocumentsQuery, resp *DocumentsResult) error

+ GetDocumentsWithContext func(ctx context.Context, param *DocumentsQuery, resp *DocumentsResult) error

+ GetEmbedders func() (map[string]Embedder, error)

+ GetEmbeddersWithContext func(ctx context.Context) (map[string]Embedder, error)

+ GetFaceting func() (*Faceting, error)

+ GetFacetingWithContext func(ctx context.Context) (*Faceting, error)

+ GetFilterableAttributes func() (*[]string, error)

+ GetFilterableAttributesWithContext func(ctx context.Context) (*[]string, error)

+ GetNonSeparatorTokens func() ([]string, error)

+ GetNonSeparatorTokensWithContext func(ctx context.Context) ([]string, error)

+ GetPagination func() (*Pagination, error)

+ GetPaginationWithContext func(ctx context.Context) (*Pagination, error)

+ GetProximityPrecision func() (ProximityPrecisionType, error)

+ GetProximityPrecisionWithContext func(ctx context.Context) (ProximityPrecisionType, error)

+ GetRankingRules func() (*[]string, error)

+ GetRankingRulesWithContext func(ctx context.Context) (*[]string, error)

+ GetSearchCutoffMs func() (int64, error)

+ GetSearchCutoffMsWithContext func(ctx context.Context) (int64, error)

+ GetSearchableAttributes func() (*[]string, error)

+ GetSearchableAttributesWithContext func(ctx context.Context) (*[]string, error)

+ GetSeparatorTokens func() ([]string, error)

+ GetSeparatorTokensWithContext func(ctx context.Context) ([]string, error)

+ GetSettings func() (*Settings, error)

+ GetSettingsWithContext func(ctx context.Context) (*Settings, error)

+ GetSortableAttributes func() (*[]string, error)

+ GetSortableAttributesWithContext func(ctx context.Context) (*[]string, error)

+ GetStats func() (*StatsIndex, error)

+ GetStatsWithContext func(ctx context.Context) (*StatsIndex, error)

+ GetStopWords func() (*[]string, error)

+ GetStopWordsWithContext func(ctx context.Context) (*[]string, error)

+ GetSynonyms func() (*map[string][]string, error)

+ GetSynonymsWithContext func(ctx context.Context) (*map[string][]string, error)

+ GetTask func(taskUID int64) (*Task, error)

+ GetTaskWithContext func(ctx context.Context, taskUID int64) (*Task, error)

+ GetTasks func(param *TasksQuery) (*TaskResult, error)

+ GetTasksWithContext func(ctx context.Context, param *TasksQuery) (*TaskResult, error)

+ GetTypoTolerance func() (*TypoTolerance, error)

+ GetTypoToleranceWithContext func(ctx context.Context) (*TypoTolerance, error)

+ ResetDictionary func() (*TaskInfo, error)

+ ResetDictionaryWithContext func(ctx context.Context) (*TaskInfo, error)

+ ResetDisplayedAttributes func() (*TaskInfo, error)

+ ResetDisplayedAttributesWithContext func(ctx context.Context) (*TaskInfo, error)

+ ResetDistinctAttribute func() (*TaskInfo, error)

+ ResetDistinctAttributeWithContext func(ctx context.Context) (*TaskInfo, error)

+ ResetEmbedders func() (*TaskInfo, error)

+ ResetEmbeddersWithContext func(ctx context.Context) (*TaskInfo, error)

+ ResetFaceting func() (*TaskInfo, error)

+ ResetFacetingWithContext func(ctx context.Context) (*TaskInfo, error)

+ ResetFilterableAttributes func() (*TaskInfo, error)

+ ResetFilterableAttributesWithContext func(ctx context.Context) (*TaskInfo, error)

+ ResetNonSeparatorTokens func() (*TaskInfo, error)

+ ResetNonSeparatorTokensWithContext func(ctx context.Context) (*TaskInfo, error)

+ ResetPagination func() (*TaskInfo, error)

+ ResetPaginationWithContext func(ctx context.Context) (*TaskInfo, error)

+ ResetProximityPrecision func() (*TaskInfo, error)

+ ResetProximityPrecisionWithContext func(ctx context.Context) (*TaskInfo, error)

+ ResetRankingRules func() (*TaskInfo, error)

+ ResetRankingRulesWithContext func(ctx context.Context) (*TaskInfo, error)

+ ResetSearchCutoffMs func() (*TaskInfo, error)

+ ResetSearchCutoffMsWithContext func(ctx context.Context) (*TaskInfo, error)

+ ResetSearchableAttributes func() (*TaskInfo, error)

+ ResetSearchableAttributesWithContext func(ctx context.Context) (*TaskInfo, error)

+ ResetSeparatorTokens func() (*TaskInfo, error)

+ ResetSeparatorTokensWithContext func(ctx context.Context) (*TaskInfo, error)

+ ResetSettings func() (*TaskInfo, error)

+ ResetSettingsWithContext func(ctx context.Context) (*TaskInfo, error)

+ ResetSortableAttributes func() (*TaskInfo, error)

+ ResetSortableAttributesWithContext func(ctx context.Context) (*TaskInfo, error)

+ ResetStopWords func() (*TaskInfo, error)

+ ResetStopWordsWithContext func(ctx context.Context) (*TaskInfo, error)

+ ResetSynonyms func() (*TaskInfo, error)

+ ResetSynonymsWithContext func(ctx context.Context) (*TaskInfo, error)

+ ResetTypoTolerance func() (*TaskInfo, error)

+ ResetTypoToleranceWithContext func(ctx context.Context) (*TaskInfo, error)

+ Search func(query string, request *SearchRequest) (*SearchResponse, error)

+ SearchRaw func(query string, request *SearchRequest) (*json.RawMessage, error)

+ SearchRawWithContext func(ctx context.Context, query string, request *SearchRequest) (*json.RawMessage, error)

+ SearchWithContext func(ctx context.Context, query string, request *SearchRequest) (*SearchResponse, error)

+ UpdateDictionary func(words []string) (*TaskInfo, error)

+ UpdateDictionaryWithContext func(ctx context.Context, words []string) (*TaskInfo, error)

+ UpdateDisplayedAttributes func(request *[]string) (*TaskInfo, error)

+ UpdateDisplayedAttributesWithContext func(ctx context.Context, request *[]string) (*TaskInfo, error)

+ UpdateDistinctAttribute func(request string) (*TaskInfo, error)

+ UpdateDistinctAttributeWithContext func(ctx context.Context, request string) (*TaskInfo, error)

+ UpdateDocuments func(documentsPtr interface{}, primaryKey ...string) (*TaskInfo, error)

+ UpdateDocumentsCsv func(documents []byte, options *CsvDocumentsQuery) (*TaskInfo, error)

+ UpdateDocumentsCsvInBatches func(documents []byte, batchsize int, options *CsvDocumentsQuery) ([]TaskInfo, error)

+ UpdateDocumentsCsvInBatchesWithContext func(ctx context.Context, documents []byte, batchsize int, ...) ([]TaskInfo, error)

+ UpdateDocumentsCsvWithContext func(ctx context.Context, documents []byte, options *CsvDocumentsQuery) (*TaskInfo, error)

+ UpdateDocumentsInBatches func(documentsPtr interface{}, batchSize int, primaryKey ...string) ([]TaskInfo, error)

+ UpdateDocumentsInBatchesWithContext func(ctx context.Context, documentsPtr interface{}, batchSize int, ...) ([]TaskInfo, error)

+ UpdateDocumentsNdjson func(documents []byte, primaryKey ...string) (*TaskInfo, error)

+ UpdateDocumentsNdjsonInBatches func(documents []byte, batchsize int, primaryKey ...string) ([]TaskInfo, error)

+ UpdateDocumentsNdjsonInBatchesWithContext func(ctx context.Context, documents []byte, batchsize int, primaryKey ...string) ([]TaskInfo, error)

+ UpdateDocumentsNdjsonWithContext func(ctx context.Context, documents []byte, primaryKey ...string) (*TaskInfo, error)

+ UpdateDocumentsWithContext func(ctx context.Context, documentsPtr interface{}, primaryKey ...string) (*TaskInfo, error)

+ UpdateEmbedders func(request map[string]Embedder) (*TaskInfo, error)

+ UpdateEmbeddersWithContext func(ctx context.Context, request map[string]Embedder) (*TaskInfo, error)

+ UpdateFaceting func(request *Faceting) (*TaskInfo, error)

+ UpdateFacetingWithContext func(ctx context.Context, request *Faceting) (*TaskInfo, error)

+ UpdateFilterableAttributes func(request *[]string) (*TaskInfo, error)

+ UpdateFilterableAttributesWithContext func(ctx context.Context, request *[]string) (*TaskInfo, error)

+ UpdateIndex func(primaryKey string) (*TaskInfo, error)

+ UpdateIndexWithContext func(ctx context.Context, primaryKey string) (*TaskInfo, error)

+ UpdateNonSeparatorTokens func(tokens []string) (*TaskInfo, error)

+ UpdateNonSeparatorTokensWithContext func(ctx context.Context, tokens []string) (*TaskInfo, error)

+ UpdatePagination func(request *Pagination) (*TaskInfo, error)

+ UpdatePaginationWithContext func(ctx context.Context, request *Pagination) (*TaskInfo, error)

+ UpdateProximityPrecision func(proximityType ProximityPrecisionType) (*TaskInfo, error)

+ UpdateProximityPrecisionWithContext func(ctx context.Context, proximityType ProximityPrecisionType) (*TaskInfo, error)

+ UpdateRankingRules func(request *[]string) (*TaskInfo, error)

+ UpdateRankingRulesWithContext func(ctx context.Context, request *[]string) (*TaskInfo, error)

+ UpdateSearchCutoffMs func(request int64) (*TaskInfo, error)

+ UpdateSearchCutoffMsWithContext func(ctx context.Context, request int64) (*TaskInfo, error)

+ UpdateSearchableAttributes func(request *[]string) (*TaskInfo, error)

+ UpdateSearchableAttributesWithContext func(ctx context.Context, request *[]string) (*TaskInfo, error)

+ UpdateSeparatorTokens func(tokens []string) (*TaskInfo, error)

+ UpdateSeparatorTokensWithContext func(ctx context.Context, tokens []string) (*TaskInfo, error)

+ UpdateSettings func(request *Settings) (*TaskInfo, error)

+ UpdateSettingsWithContext func(ctx context.Context, request *Settings) (*TaskInfo, error)

+ UpdateSortableAttributes func(request *[]string) (*TaskInfo, error)

+ UpdateSortableAttributesWithContext func(ctx context.Context, request *[]string) (*TaskInfo, error)

+ UpdateStopWords func(request *[]string) (*TaskInfo, error)

+ UpdateStopWordsWithContext func(ctx context.Context, request *[]string) (*TaskInfo, error)

+ UpdateSynonyms func(request *map[string][]string) (*TaskInfo, error)

+ UpdateSynonymsWithContext func(ctx context.Context, request *map[string][]string) (*TaskInfo, error)

+ UpdateTypoTolerance func(request *TypoTolerance) (*TaskInfo, error)

+ UpdateTypoToleranceWithContext func(ctx context.Context, request *TypoTolerance) (*TaskInfo, error)

+ WaitForTask func(taskUID int64, interval time.Duration) (*Task, error)

+ WaitForTaskWithContext func(ctx context.Context, taskUID int64, interval time.Duration) (*Task, error)

+ type IndexResult struct

+ CreatedAt time.Time

+ PrimaryKey string

+ UID string

+ UpdatedAt time.Time

+ func (v *IndexResult) UnmarshalEasyJSON(l *jlexer.Lexer)

+ func (v *IndexResult) UnmarshalJSON(data []byte) error

+ func (v IndexResult) MarshalEasyJSON(w *jwriter.Writer)

+ func (v IndexResult) MarshalJSON() ([]byte, error)

+ type MatchingStrategy string

+ const All

+ const Frequency

+ const Last

+ type Option func(*meiliOpt)

+ func WithAPIKey(key string) Option

+ func WithCustomClient(client *http.Client) Option

+ func WithCustomClientWithTLS(tlsConfig *tls.Config) Option

+ type ProximityPrecisionType string

+ const ByAttribute

+ const ByWord

+ type ServiceManager interface

+ CancelTasks func(param *CancelTasksQuery) (*TaskInfo, error)

+ CancelTasksWithContext func(ctx context.Context, param *CancelTasksQuery) (*TaskInfo, error)

+ Close func()

+ CreateDump func() (*TaskInfo, error)

+ CreateDumpWithContext func(ctx context.Context) (*TaskInfo, error)

+ CreateIndex func(config *IndexConfig) (*TaskInfo, error)

+ CreateIndexWithContext func(ctx context.Context, config *IndexConfig) (*TaskInfo, error)

+ CreateKey func(request *Key) (*Key, error)

+ CreateKeyWithContext func(ctx context.Context, request *Key) (*Key, error)

+ CreateSnapshot func() (*TaskInfo, error)

+ CreateSnapshotWithContext func(ctx context.Context) (*TaskInfo, error)

+ DeleteIndex func(uid string) (*TaskInfo, error)

+ DeleteIndexWithContext func(ctx context.Context, uid string) (*TaskInfo, error)

+ DeleteKey func(keyOrUID string) (bool, error)

+ DeleteKeyWithContext func(ctx context.Context, keyOrUID string) (bool, error)

+ DeleteTasks func(param *DeleteTasksQuery) (*TaskInfo, error)

+ DeleteTasksWithContext func(ctx context.Context, param *DeleteTasksQuery) (*TaskInfo, error)

+ GenerateTenantToken func(apiKeyUID string, searchRules map[string]interface{}, ...) (string, error)

+ GetIndex func(indexID string) (*IndexResult, error)

+ GetIndexWithContext func(ctx context.Context, indexID string) (*IndexResult, error)

+ GetKey func(identifier string) (*Key, error)

+ GetKeyWithContext func(ctx context.Context, identifier string) (*Key, error)

+ GetKeys func(param *KeysQuery) (*KeysResults, error)

+ GetKeysWithContext func(ctx context.Context, param *KeysQuery) (*KeysResults, error)

+ GetRawIndex func(uid string) (map[string]interface{}, error)

+ GetRawIndexWithContext func(ctx context.Context, uid string) (map[string]interface{}, error)

+ GetRawIndexes func(param *IndexesQuery) (map[string]interface{}, error)

+ GetRawIndexesWithContext func(ctx context.Context, param *IndexesQuery) (map[string]interface{}, error)

+ GetStats func() (*Stats, error)

+ GetStatsWithContext func(ctx context.Context) (*Stats, error)

+ GetTask func(taskUID int64) (*Task, error)

+ GetTaskWithContext func(ctx context.Context, taskUID int64) (*Task, error)

+ GetTasks func(param *TasksQuery) (*TaskResult, error)

+ GetTasksWithContext func(ctx context.Context, param *TasksQuery) (*TaskResult, error)

+ Health func() (*Health, error)

+ HealthWithContext func(ctx context.Context) (*Health, error)

+ Index func(uid string) IndexManager

+ IsHealthy func() bool

+ ListIndexes func(param *IndexesQuery) (*IndexesResults, error)

+ ListIndexesWithContext func(ctx context.Context, param *IndexesQuery) (*IndexesResults, error)

+ MultiSearch func(queries *MultiSearchRequest) (*MultiSearchResponse, error)

+ MultiSearchWithContext func(ctx context.Context, queries *MultiSearchRequest) (*MultiSearchResponse, error)

+ SwapIndexes func(param []*SwapIndexesParams) (*TaskInfo, error)

+ SwapIndexesWithContext func(ctx context.Context, param []*SwapIndexesParams) (*TaskInfo, error)

+ UpdateKey func(keyOrUID string, request *Key) (*Key, error)

+ UpdateKeyWithContext func(ctx context.Context, keyOrUID string, request *Key) (*Key, error)

+ Version func() (*Version, error)

+ VersionWithContext func(ctx context.Context) (*Version, error)

+ WaitForTask func(taskUID int64, interval time.Duration) (*Task, error)

+ WaitForTaskWithContext func(ctx context.Context, taskUID int64, interval time.Duration) (*Task, error)

+ func Connect(host string, options ...Option) (ServiceManager, error)

+ func New(host string, options ...Option) ServiceManager

type Settings

+ Dictionary []string

+ NonSeparatorTokens []string

+ ProximityPrecision ProximityPrecisionType

+ SeparatorTokens []string

+ type SortFacetType string

+ const SortFacetTypeAlpha

+ const SortFacetTypeCount

v0.27.2

Aug 3, 2024

Changes in this version

type Index

+ func (i Index) GetSearchCutoffMs() (resp int64, err error)

+ func (i Index) ResetSearchCutoffMs() (resp *TaskInfo, err error)

+ func (i Index) SearchSimilarDocuments(param *SimilarDocumentQuery, resp *SimilarDocumentResult) error

+ func (i Index) UpdateSearchCutoffMs(request int64) (resp *TaskInfo, err error)

type IndexInterface

+ GetSearchCutoffMs func() (resp int64, err error)

+ ResetSearchCutoffMs func() (resp *TaskInfo, err error)

+ UpdateSearchCutoffMs func(request int64) (resp *TaskInfo, err error)

type SearchRequest

+ Distinct string

type Settings

+ SearchCutoffMs int64

+ type SimilarDocumentQuery struct

+ AttributesToRetrieve []string

+ Embedder string

+ Filter string

+ Id interface{}

+ Limit int64

+ Offset int64

+ RankingScoreThreshold float64

+ RetrieveVectors bool

+ ShowRankingScore bool

+ ShowRankingScoreDetails bool

+ func (v *SimilarDocumentQuery) UnmarshalEasyJSON(l *jlexer.Lexer)

+ func (v *SimilarDocumentQuery) UnmarshalJSON(data []byte) error

+ func (v SimilarDocumentQuery) MarshalEasyJSON(w *jwriter.Writer)

+ func (v SimilarDocumentQuery) MarshalJSON() ([]byte, error)

+ type SimilarDocumentResult struct

+ EstimatedTotalHits int64

+ Hits []interface{}

+ ID string

+ Limit int64

+ Offset int64

+ ProcessingTimeMS int64

+ func (v *SimilarDocumentResult) UnmarshalEasyJSON(l *jlexer.Lexer)

+ func (v *SimilarDocumentResult) UnmarshalJSON(data []byte) error

+ func (v SimilarDocumentResult) MarshalEasyJSON(w *jwriter.Writer)

+ func (v SimilarDocumentResult) MarshalJSON() ([]byte, error)

v0.27.1

Jul 30, 2024

Changes in this version

+ var ErrNoFacetSearchRequest = errors.New("no search facet request provided")

+ func FacetSearchPostRequestParams(request *FacetSearchRequest) map[string]interface

+ type FacetSearchRequest struct

+ AttributesToSearchOn []string

+ FacetName string

+ FacetQuery string

+ Filter string

+ MatchingStrategy string

+ Q string

+ func (v *FacetSearchRequest) UnmarshalEasyJSON(l *jlexer.Lexer)

+ func (v *FacetSearchRequest) UnmarshalJSON(data []byte) error

+ func (v FacetSearchRequest) MarshalEasyJSON(w *jwriter.Writer)

+ func (v FacetSearchRequest) MarshalJSON() ([]byte, error)

+ type FacetSearchResponse struct

+ FacetHits []interface{}

+ FacetQuery string

+ ProcessingTimeMs int64

+ func (v *FacetSearchResponse) UnmarshalEasyJSON(l *jlexer.Lexer)

+ func (v *FacetSearchResponse) UnmarshalJSON(data []byte) error

+ func (v FacetSearchResponse) MarshalEasyJSON(w *jwriter.Writer)

+ func (v FacetSearchResponse) MarshalJSON() ([]byte, error)

type Index

+ func (i Index) FacetSearch(request *FacetSearchRequest) (*json.RawMessage, error)

type SearchRequest

+ RankingScoreThreshold float64

v0.27.0

Jul 1, 2024

Changes in this version

type SearchRequest

+ RetrieveVectors bool

v0.26.3

May 6, 2024

Changes in this version

+ type Embedder struct

+ ApiKey string

+ Dimensions int

+ DocumentTemplate string

+ Model string

+ Source string

+ func (v *Embedder) UnmarshalEasyJSON(l *jlexer.Lexer)

+ func (v *Embedder) UnmarshalJSON(data []byte) error

+ func (v Embedder) MarshalEasyJSON(w *jwriter.Writer)

+ func (v Embedder) MarshalJSON() ([]byte, error)

type Index

+ func (i Index) GetEmbedders() (resp map[string]Embedder, err error)

+ func (i Index) ResetEmbedders() (resp *TaskInfo, err error)

+ func (i Index) UpdateEmbedders(request map[string]Embedder) (resp *TaskInfo, err error)

type SearchRequest

+ Hybrid *SearchRequestHybrid

+ ShowRankingScoreDetails bool

+ type SearchRequestHybrid struct

+ Embedder string

+ SemanticRatio float64

+ func (v *SearchRequestHybrid) UnmarshalEasyJSON(l *jlexer.Lexer)

+ func (v *SearchRequestHybrid) UnmarshalJSON(data []byte) error

+ func (v SearchRequestHybrid) MarshalEasyJSON(w *jwriter.Writer)

+ func (v SearchRequestHybrid) MarshalJSON() ([]byte, error)

type Settings

+ Embedders map[string]Embedder

v0.26.2

Feb 19, 2024

Changes in this version

type IndexInterface

+ DeleteDocumentsByFilter func(filter interface{}) (resp *TaskInfo, err error)

v0.26.1

Jan 17, 2024

Changes in this version

type Details

+ DumpUid string

v0.26.0

Nov 2, 2023

Changes in this version

type TaskStatus

+ const TaskStatusCanceled

+ type TaskType string

+ const TaskTypeDocumentAdditionOrUpdate

+ const TaskTypeDocumentDeletion

+ const TaskTypeDumpCreation

+ const TaskTypeIndexCreation

+ const TaskTypeIndexDeletion

+ const TaskTypeIndexSwap

+ const TaskTypeIndexUpdate

+ const TaskTypeSettingsUpdate

+ const TaskTypeSnapshotCreation

+ const TaskTypeTaskCancelation

+ const TaskTypeTaskDeletion

v0.25.1

Sep 13, 2023

Changes in this version

+ var ErrNoSearchRequest = errors.New("no search request provided")

type SearchRequest

+ AttributesToSearchOn []string

+ ShowRankingScore bool

+ Vector []float64

type TaskResult

+ Total int64

v0.25.0

Jun 5, 2023

Changes in this version

+ func VersionErrorHintMessage(err error, req *internalRequest) error

type DocumentsQuery

+ Filter interface{}

type Index

+ func (i Index) DeleteDocumentsByFilter(filter interface{}) (resp *TaskInfo, err error)

v0.24.0

Apr 3, 2023

Changes in this version

type Client

+ func (c *Client) MultiSearch(queries *MultiSearchRequest) (*MultiSearchResponse, error)

type ClientInterface

+ MultiSearch func(queries *MultiSearchRequest) (*MultiSearchResponse, error)

+ type CsvDocumentsQuery struct

+ CsvDelimiter string

+ PrimaryKey string

+ func (v *CsvDocumentsQuery) UnmarshalEasyJSON(l *jlexer.Lexer)

+ func (v *CsvDocumentsQuery) UnmarshalJSON(data []byte) error

+ func (v CsvDocumentsQuery) MarshalEasyJSON(w *jwriter.Writer)

+ func (v CsvDocumentsQuery) MarshalJSON() ([]byte, error)

+ type MultiSearchRequest struct

+ Queries []SearchRequest

+ func (v *MultiSearchRequest) UnmarshalEasyJSON(l *jlexer.Lexer)

+ func (v *MultiSearchRequest) UnmarshalJSON(data []byte) error

+ func (v MultiSearchRequest) MarshalEasyJSON(w *jwriter.Writer)

+ func (v MultiSearchRequest) MarshalJSON() ([]byte, error)

+ type MultiSearchResponse struct

+ Results []SearchResponse

+ func (v *MultiSearchResponse) UnmarshalEasyJSON(l *jlexer.Lexer)

+ func (v *MultiSearchResponse) UnmarshalJSON(data []byte) error

+ func (v MultiSearchResponse) MarshalEasyJSON(w *jwriter.Writer)

+ func (v MultiSearchResponse) MarshalJSON() ([]byte, error)

type SearchRequest

+ IndexUID string

type SearchResponse

+ FacetStats interface{}

+ IndexUID string

v0.23.1

Mar 16, 2023

Changes in this version

type Index

+ func (i Index) UpdateDocumentsCsv(documents []byte, primaryKey ...string) (resp *TaskInfo, err error)

+ func (i Index) UpdateDocumentsCsvFromReader(documents io.Reader, primaryKey ...string) (resp *TaskInfo, err error)

+ func (i Index) UpdateDocumentsCsvFromReaderInBatches(documents io.Reader, batchSize int, primaryKey ...string) (resp []TaskInfo, err error)

+ func (i Index) UpdateDocumentsCsvInBatches(documents []byte, batchSize int, primaryKey ...string) (resp []TaskInfo, err error)

+ func (i Index) UpdateDocumentsNdjson(documents []byte, primaryKey ...string) (resp *TaskInfo, err error)

+ func (i Index) UpdateDocumentsNdjsonFromReader(documents io.Reader, primaryKey ...string) (resp *TaskInfo, err error)

+ func (i Index) UpdateDocumentsNdjsonInBatches(documents []byte, batchsize int, primaryKey ...string) (resp []TaskInfo, err error)

type IndexInterface

+ UpdateDocumentsCsv func(documents []byte, primaryKey ...string) (resp *TaskInfo, err error)

+ UpdateDocumentsCsvInBatches func(documents []byte, batchsize int, primaryKey ...string) (resp []TaskInfo, err error)

+ UpdateDocumentsInBatches func(documentsPtr interface{}, batchSize int, primaryKey ...string) (resp []TaskInfo, err error)

+ UpdateDocumentsNdjson func(documents []byte, primaryKey ...string) (resp *TaskInfo, err error)

+ UpdateDocumentsNdjsonInBatches func(documents []byte, batchsize int, primaryKey ...string) (resp []TaskInfo, err error)

v0.23.0

Feb 6, 2023

v0.22.0

Dec 15, 2022

Changes in this version

+ type CancelTasksQuery struct

+ AfterEnqueuedAt time.Time

+ AfterStartedAt time.Time

+ BeforeEnqueuedAt time.Time

+ BeforeStartedAt time.Time

+ IndexUIDS []string

+ Statuses []string

+ Types []string

+ UIDS []int64

+ func (v *CancelTasksQuery) UnmarshalEasyJSON(l *jlexer.Lexer)

+ func (v *CancelTasksQuery) UnmarshalJSON(data []byte) error

+ func (v CancelTasksQuery) MarshalEasyJSON(w *jwriter.Writer)

+ func (v CancelTasksQuery) MarshalJSON() ([]byte, error)

type Client

+ func (c *Client) CancelTasks(param *CancelTasksQuery) (resp *TaskInfo, err error)

+ func (c *Client) DeleteTasks(param *DeleteTasksQuery) (resp *TaskInfo, err error)

+ func (c *Client) SwapIndexes(param []SwapIndexesParams) (resp *TaskInfo, err error)

type ClientInterface

+ CancelTasks func(param *CancelTasksQuery) (resp *TaskInfo, err error)

+ DeleteTasks func(param *DeleteTasksQuery) (resp *TaskInfo, err error)

+ SwapIndexes func(param []SwapIndexesParams) (resp *TaskInfo, err error)

+ type DeleteTasksQuery struct

+ AfterEnqueuedAt time.Time

+ AfterFinishedAt time.Time

+ AfterStartedAt time.Time

+ BeforeEnqueuedAt time.Time

+ BeforeFinishedAt time.Time

+ BeforeStartedAt time.Time

+ CanceledBy []int64

+ IndexUIDS []string

+ Statuses []string

+ Types []string

+ UIDS []int64

+ func (v *DeleteTasksQuery) UnmarshalEasyJSON(l *jlexer.Lexer)

+ func (v *DeleteTasksQuery) UnmarshalJSON(data []byte) error

+ func (v DeleteTasksQuery) MarshalEasyJSON(w *jwriter.Writer)

+ func (v DeleteTasksQuery) MarshalJSON() ([]byte, error)

type Details

+ CanceledTasks int64

+ DeletedTasks int64

+ Faceting *Faceting

+ MatchedTasks int64

+ OriginalFilter string

+ Pagination *Pagination

+ ProvidedIds int64

+ Swaps []SwapIndexesParams

+ TypoTolerance *TypoTolerance

type SearchRequest

+ HitsPerPage int64

+ Page int64

type SearchResponse

+ HitsPerPage int64

+ Page int64

+ TotalHits int64

+ TotalPages int64

+ type SwapIndexesParams struct

+ Indexes []string

+ func (v *SwapIndexesParams) UnmarshalEasyJSON(l *jlexer.Lexer)

+ func (v *SwapIndexesParams) UnmarshalJSON(data []byte) error

+ func (v SwapIndexesParams) MarshalEasyJSON(w *jwriter.Writer)

+ func (v SwapIndexesParams) MarshalJSON() ([]byte, error)

type Task

+ CanceledBy int64

type TasksQuery

+ AfterEnqueuedAt time.Time

+ AfterFinishedAt time.Time

+ AfterStartedAt time.Time

+ BeforeEnqueuedAt time.Time

+ BeforeFinishedAt time.Time

+ BeforeStartedAt time.Time

+ CanceledBy []int64

+ IndexUIDS []string

+ Statuses []string

+ Types []string

+ UIDS []int64

v0.21.1

Nov 8, 2022

Changes in this version

type Index

+ func (i Index) SearchRaw(query string, request *SearchRequest) (*json.RawMessage, error)

type IndexInterface

+ SearchRaw func(query string, request *SearchRequest) (*json.RawMessage, error)

v0.21.0

Oct 3, 2022

Changes in this version

type Client

+ func (c *Client) GetIndexes(param *IndexesQuery) (resp *IndexesResults, err error)

+ func (c *Client) GetRawIndexes(param *IndexesQuery) (resp map[string]interface{}, err error)

+ func (c *Client) GetStats() (resp *Stats, err error)

type ClientInterface

+ GetIndexes func(param *IndexesQuery) (resp *IndexesResults, err error)

+ GetRawIndexes func(param *IndexesQuery) (resp map[string]interface{}, err error)

+ GetStats func() (resp *Stats, err error)

type KeyParsed

+ UID string

type SearchRequest

+ MatchingStrategy string

v0.20.1

Jul 28, 2022

Changes in this version

+ type Faceting struct

+ MaxValuesPerFacet int64

+ func (v *Faceting) UnmarshalEasyJSON(l *jlexer.Lexer)

+ func (v *Faceting) UnmarshalJSON(data []byte) error

+ func (v Faceting) MarshalEasyJSON(w *jwriter.Writer)

+ func (v Faceting) MarshalJSON() ([]byte, error)

type Index

+ func (i Index) GetFaceting() (resp *Faceting, err error)

+ func (i Index) GetPagination() (resp *Pagination, err error)

+ func (i Index) ResetFaceting() (resp *TaskInfo, err error)

+ func (i Index) ResetPagination() (resp *TaskInfo, err error)

+ func (i Index) UpdateFaceting(request *Faceting) (resp *TaskInfo, err error)

+ func (i Index) UpdatePagination(request *Pagination) (resp *TaskInfo, err error)

+ type Pagination struct

+ MaxTotalHits int64

+ func (v *Pagination) UnmarshalEasyJSON(l *jlexer.Lexer)

+ func (v *Pagination) UnmarshalJSON(data []byte) error

+ func (v Pagination) MarshalEasyJSON(w *jwriter.Writer)

+ func (v Pagination) MarshalJSON() ([]byte, error)

type Settings

+ Faceting *Faceting

+ Pagination *Pagination

v0.20.0

Jul 11, 2022

Changes in this version

+ func IsValidUUID(uuid string) bool

+ type DocumentQuery struct

+ Fields []string

+ func (v *DocumentQuery) UnmarshalEasyJSON(l *jlexer.Lexer)

+ func (v *DocumentQuery) UnmarshalJSON(data []byte) error

+ func (v DocumentQuery) MarshalEasyJSON(w *jwriter.Writer)

+ func (v DocumentQuery) MarshalJSON() ([]byte, error)

+ type DocumentsQuery struct

+ Fields []string

+ Limit int64

+ Offset int64

+ func (v *DocumentsQuery) UnmarshalEasyJSON(l *jlexer.Lexer)

+ func (v *DocumentsQuery) UnmarshalJSON(data []byte) error

+ func (v DocumentsQuery) MarshalEasyJSON(w *jwriter.Writer)

+ func (v DocumentsQuery) MarshalJSON() ([]byte, error)

+ type DocumentsResult struct

+ Limit int64

+ Offset int64

+ Results []map[string]interface{}

+ Total int64

+ func (v *DocumentsResult) UnmarshalEasyJSON(l *jlexer.Lexer)

+ func (v *DocumentsResult) UnmarshalJSON(data []byte) error

+ func (v DocumentsResult) MarshalEasyJSON(w *jwriter.Writer)

+ func (v DocumentsResult) MarshalJSON() ([]byte, error)

+ type IndexesQuery struct

+ Limit int64

+ Offset int64

+ func (v *IndexesQuery) UnmarshalEasyJSON(l *jlexer.Lexer)

+ func (v *IndexesQuery) UnmarshalJSON(data []byte) error

+ func (v IndexesQuery) MarshalEasyJSON(w *jwriter.Writer)

+ func (v IndexesQuery) MarshalJSON() ([]byte, error)

+ type IndexesResults struct

+ Limit int64

+ Offset int64

+ Results []Index

+ Total int64

+ func (v *IndexesResults) UnmarshalEasyJSON(l *jlexer.Lexer)

+ func (v *IndexesResults) UnmarshalJSON(data []byte) error

+ func (v IndexesResults) MarshalEasyJSON(w *jwriter.Writer)

+ func (v IndexesResults) MarshalJSON() ([]byte, error)

type Key

+ Name string

+ UID string

type KeyParsed

+ Name string

+ type KeyUpdate struct

+ Description string

+ Name string

+ func (v *KeyUpdate) UnmarshalEasyJSON(l *jlexer.Lexer)

+ func (v *KeyUpdate) UnmarshalJSON(data []byte) error

+ func (v KeyUpdate) MarshalEasyJSON(w *jwriter.Writer)

+ func (v KeyUpdate) MarshalJSON() ([]byte, error)

+ type KeysQuery struct

+ Limit int64

+ Offset int64

+ func (v *KeysQuery) UnmarshalEasyJSON(l *jlexer.Lexer)

+ func (v *KeysQuery) UnmarshalJSON(data []byte) error

+ func (v KeysQuery) MarshalEasyJSON(w *jwriter.Writer)

+ func (v KeysQuery) MarshalJSON() ([]byte, error)

+ type KeysResults struct

+ Limit int64

+ Offset int64

+ Results []Key

+ Total int64

+ func (v *KeysResults) UnmarshalEasyJSON(l *jlexer.Lexer)

+ func (v *KeysResults) UnmarshalJSON(data []byte) error

+ func (v KeysResults) MarshalEasyJSON(w *jwriter.Writer)

+ func (v KeysResults) MarshalJSON() ([]byte, error)

type SearchRequest

+ Facets []string

+ ShowMatchesPosition bool

type SearchResponse

+ EstimatedTotalHits int64

+ FacetDistribution interface{}

type Task

+ TaskUID int64

+ type TaskInfo struct

+ Details Details

+ Duration string

+ EnqueuedAt time.Time

+ Error meilisearchApiError

+ FinishedAt time.Time

+ IndexUID string

+ StartedAt time.Time

+ Status TaskStatus

+ TaskUID int64

+ Type string

+ func (v *TaskInfo) UnmarshalEasyJSON(l *jlexer.Lexer)

+ func (v *TaskInfo) UnmarshalJSON(data []byte) error

+ func (v TaskInfo) MarshalEasyJSON(w *jwriter.Writer)

+ func (v TaskInfo) MarshalJSON() ([]byte, error)

+ type TaskResult struct

+ From int64

+ Limit int64

+ Next int64

+ Results []Task

+ func (v *TaskResult) UnmarshalEasyJSON(l *jlexer.Lexer)

+ func (v *TaskResult) UnmarshalJSON(data []byte) error

+ func (v TaskResult) MarshalEasyJSON(w *jwriter.Writer)

+ func (v TaskResult) MarshalJSON() ([]byte, error)

+ type TasksQuery struct

+ From int64

+ IndexUID []string

+ Limit int64

+ Status []string

+ Type []string

+ func (v *TasksQuery) UnmarshalEasyJSON(l *jlexer.Lexer)

+ func (v *TasksQuery) UnmarshalJSON(data []byte) error

+ func (v TasksQuery) MarshalEasyJSON(w *jwriter.Writer)

+ func (v TasksQuery) MarshalJSON() ([]byte, error)

type TenantTokenClaims

+ APIKeyUID string

v0.19.2

Jul 11, 2022

v0.19.1

May 9, 2022

Changes in this version

+ const VERSION

+ func GetQualifiedVersion() (qualifiedVersion string)

type Index

+ func (i Index) GetTypoTolerance() (resp *TypoTolerance, err error)

+ func (i Index) ResetTypoTolerance() (resp *Task, err error)

+ func (i Index) UpdateTypoTolerance(request *TypoTolerance) (resp *Task, err error)

+ type MinWordSizeForTypos struct

+ OneTypo int64

+ TwoTypos int64

+ func (v *MinWordSizeForTypos) UnmarshalEasyJSON(l *jlexer.Lexer)

+ func (v *MinWordSizeForTypos) UnmarshalJSON(data []byte) error

+ func (v MinWordSizeForTypos) MarshalEasyJSON(w *jwriter.Writer)

+ func (v MinWordSizeForTypos) MarshalJSON() ([]byte, error)

type SearchRequest

+ CropMarker string

+ HighlightPostTag string

+ HighlightPreTag string

type Settings

+ TypoTolerance *TypoTolerance

+ type TypoTolerance struct

+ DisableOnAttributes []string

+ DisableOnWords []string

+ Enabled bool

+ MinWordSizeForTypos MinWordSizeForTypos

+ func (v *TypoTolerance) UnmarshalEasyJSON(l *jlexer.Lexer)

+ func (v *TypoTolerance) UnmarshalJSON(data []byte) error

+ func (v TypoTolerance) MarshalEasyJSON(w *jwriter.Writer)

+ func (v TypoTolerance) MarshalJSON() ([]byte, error)

v0.19.0

Mar 14, 2022

Changes in this version

type Client

+ func (c *Client) GenerateTenantToken(SearchRules map[string]interface{}, Options *TenantTokenOptions) (resp string, err error)

type ClientInterface

+ GenerateTenantToken func(searchRules map[string]interface{}, options *TenantTokenOptions) (resp string, err error)

+ type TenantTokenClaims struct

+ APIKeyPrefix string

+ SearchRules interface{}

+ func (v *TenantTokenClaims) UnmarshalEasyJSON(l *jlexer.Lexer)

+ func (v *TenantTokenClaims) UnmarshalJSON(data []byte) error

+ func (v TenantTokenClaims) MarshalEasyJSON(w *jwriter.Writer)

+ func (v TenantTokenClaims) MarshalJSON() ([]byte, error)

+ type TenantTokenOptions struct

+ APIKey string

+ ExpiresAt time.Time

+ func (v *TenantTokenOptions) UnmarshalEasyJSON(l *jlexer.Lexer)

+ func (v *TenantTokenOptions) UnmarshalJSON(data []byte) error

+ func (v TenantTokenOptions) MarshalEasyJSON(w *jwriter.Writer)

+ func (v TenantTokenOptions) MarshalJSON() ([]byte, error)

+ type WaitParams struct

+ Context context.Context

+ Interval time.Duration

v0.18.0

Feb 8, 2022

Changes in this version

type Client

+ func (c *Client) CreateKey(request *Key) (resp *Key, err error)

+ func (c *Client) DeleteKey(identifier string) (resp bool, err error)

+ func (c *Client) GetKey(identifier string) (resp *Key, err error)

+ func (c *Client) GetTask(taskID int64) (resp *Task, err error)

+ func (c *Client) GetTasks() (resp *ResultTask, err error)

+ func (c *Client) UpdateKey(identifier string, request *Key) (resp *Key, err error)

+ func (c *Client) WaitForTask(task *Task, options ...waitParams) (*Task, error)

type ClientInterface

+ CreateKey func(request *Key) (resp *Key, err error)

+ DeleteKey func(identifier string) (resp bool, err error)

+ GetKey func(identifier string) (resp *Key, err error)

+ GetTask func(taskID int64) (resp *Task, err error)

+ GetTasks func() (resp *ResultTask, err error)

+ UpdateKey func(identifier string, request *Key) (resp *Key, err error)

+ WaitForTask func(task *Task, options ...waitParams) (*Task, error)

+ type Details struct

+ DeletedDocuments int

+ DisplayedAttributes []string

+ DistinctAttribute *string

+ FilterableAttributes []string

+ IndexedDocuments int

+ PrimaryKey string

+ RankingRules []string

+ ReceivedDocuments int

+ SearchableAttributes []string

+ SortableAttributes []string

+ StopWords []string

+ Synonyms map[string][]string

+ func (v *Details) UnmarshalEasyJSON(l *jlexer.Lexer)

+ func (v *Details) UnmarshalJSON(data []byte) error

+ func (v Details) MarshalEasyJSON(w *jwriter.Writer)

+ func (v Details) MarshalJSON() ([]byte, error)

type Error

+ MeilisearchApiError meilisearchApiError

type Index

+ func (i Index) AddDocumentsCsv(documents []byte, primaryKey ...string) (resp *Task, err error)

+ func (i Index) AddDocumentsCsvFromReader(documents io.Reader, primaryKey ...string) (resp *Task, err error)

+ func (i Index) AddDocumentsCsvFromReaderInBatches(documents io.Reader, batchSize int, primaryKey ...string) (resp []Task, err error)

+ func (i Index) AddDocumentsCsvInBatches(documents []byte, batchSize int, primaryKey ...string) (resp []Task, err error)

+ func (i Index) AddDocumentsNdjson(documents []byte, primaryKey ...string) (resp *Task, err error)

+ func (i Index) AddDocumentsNdjsonFromReader(documents io.Reader, primaryKey ...string) (resp *Task, err error)

+ func (i Index) AddDocumentsNdjsonFromReaderInBatches(documents io.Reader, batchSize int, primaryKey ...string) (resp []Task, err error)

+ func (i Index) AddDocumentsNdjsonInBatches(documents []byte, batchSize int, primaryKey ...string) (resp []Task, err error)

+ func (i Index) GetTask(taskID int64) (resp *Task, err error)

+ func (i Index) GetTasks() (resp *ResultTask, err error)

+ func (i Index) WaitForTask(task *Task, options ...waitParams) (*Task, error)

type IndexInterface

+ AddDocumentsCsv func(documents []byte, primaryKey ...string) (resp *Task, err error)

+ AddDocumentsCsvInBatches func(documents []byte, batchSize int, primaryKey ...string) (resp []Task, err error)

+ AddDocumentsInBatches func(documentsPtr interface{}, batchSize int, primaryKey ...string) (resp []Task, err error)

+ AddDocumentsNdjson func(documents []byte, primaryKey ...string) (resp *Task, err error)

+ AddDocumentsNdjsonInBatches func(documents []byte, batchSize int, primaryKey ...string) (resp []Task, err error)

+ GetTask func(taskID int64) (resp *Task, err error)

+ GetTasks func() (resp *ResultTask, err error)

+ WaitForTask func(task *Task, options ...waitParams) (*Task, error)

+ type Key struct

+ Actions []string

+ CreatedAt time.Time

+ Description string

+ ExpiresAt time.Time

+ Indexes []string

+ Key string

+ UpdatedAt time.Time

+ func (v *Key) UnmarshalEasyJSON(l *jlexer.Lexer)

+ func (v *Key) UnmarshalJSON(data []byte) error

+ func (v Key) MarshalEasyJSON(w *jwriter.Writer)

+ func (v Key) MarshalJSON() ([]byte, error)

+ type KeyParsed struct

+ Actions []string

+ CreatedAt time.Time

+ Description string

+ ExpiresAt *string

+ Indexes []string

+ Key string

+ UpdatedAt time.Time

+ func (v *KeyParsed) UnmarshalEasyJSON(l *jlexer.Lexer)

+ func (v *KeyParsed) UnmarshalJSON(data []byte) error

+ func (v KeyParsed) MarshalEasyJSON(w *jwriter.Writer)

+ func (v KeyParsed) MarshalJSON() ([]byte, error)

+ type ResultKey struct

+ Results []Key

+ func (v *ResultKey) UnmarshalEasyJSON(l *jlexer.Lexer)

+ func (v *ResultKey) UnmarshalJSON(data []byte) error

+ func (v ResultKey) MarshalEasyJSON(w *jwriter.Writer)

+ func (v ResultKey) MarshalJSON() ([]byte, error)

+ type ResultTask struct

+ Results []Task

+ func (v *ResultTask) UnmarshalEasyJSON(l *jlexer.Lexer)

+ func (v *ResultTask) UnmarshalJSON(data []byte) error

+ func (v ResultTask) MarshalEasyJSON(w *jwriter.Writer)

+ func (v ResultTask) MarshalJSON() ([]byte, error)

+ type Task struct

+ Details Details

+ Duration string

+ EnqueuedAt time.Time

+ Error meilisearchApiError

+ FinishedAt time.Time

+ IndexUID string

+ StartedAt time.Time

+ Status TaskStatus

+ Type string

+ UID int64

+ func (v *Task) UnmarshalEasyJSON(l *jlexer.Lexer)

+ func (v *Task) UnmarshalJSON(data []byte) error

+ func (v Task) MarshalEasyJSON(w *jwriter.Writer)

+ func (v Task) MarshalJSON() ([]byte, error)

+ type TaskStatus string

+ const TaskStatusEnqueued

+ const TaskStatusFailed

+ const TaskStatusProcessing

+ const TaskStatusSucceeded

+ const TaskStatusUnknown

v0.17.0

Nov 23, 2021

Changes in this version

type Client

+ func (c *Client) GetRawIndex(uid string) (resp map[string]interface{}, err error)

type ClientInterface

+ GetRawIndex func(uid string) (resp map[string]interface{}, err error)

+ type DumpStatus string

+ const DumpStatusDone

+ const DumpStatusFailed

+ const DumpStatusInProgress

type Index

+ func (i Index) AddDocumentsInBatches(documentsPtr interface{}, batchSize int, primaryKey ...string) (resp []AsyncUpdateID, err error)

+ func (i Index) UpdateDocumentsInBatches(documentsPtr interface{}, batchSize int, primaryKey ...string) (resp []AsyncUpdateID, err error)

v0.16.2

Oct 12, 2021

Changes in this version

type Client

+ func (c *Client) DeleteIndexIfExists(uid string) (ok bool, err error)

+ func (c *Client) GetAllRawIndexes() (resp []map[string]interface{}, err error)

type ClientInterface

+ DeleteIndexIfExists func(uid string) (bool, error)

+ GetAllRawIndexes func() (resp []map[string]interface{}, err error)

type Index

+ func (i Index) DeleteIfExists(uid string) (ok bool, err error)

type IndexInterface

+ DeleteIfExists func(uid string) (ok bool, err error)

v0.16.1

Sep 13, 2021

Changes in this version

type Index

+ func (i Index) GetSortableAttributes() (resp *[]string, err error)

+ func (i Index) ResetSortableAttributes() (resp *AsyncUpdateID, err error)

+ func (i Index) UpdateSortableAttributes(request *[]string) (resp *AsyncUpdateID, err error)

type SearchRequest

+ Sort []string

type Settings

+ SortableAttributes []string

v0.16.0

Aug 24, 2021

Changes in this version

type Dump

+ FinishedAt time.Time

+ StartedAt time.Time

type Index

+ func (i Index) GetFilterableAttributes() (resp *[]string, err error)

+ func (i Index) ResetFilterableAttributes() (resp *AsyncUpdateID, err error)

+ func (i Index) UpdateFilterableAttributes(request *[]string) (resp *AsyncUpdateID, err error)

type IndexInterface

+ GetFilterableAttributes func() (resp *[]string, err error)

+ ResetFilterableAttributes func() (resp *AsyncUpdateID, err error)

+ UpdateFilterableAttributes func(request *[]string) (resp *AsyncUpdateID, err error)

type SearchRequest

+ Filter interface{}

type Settings

+ FilterableAttributes []string

type StatsIndex

+ FieldDistribution map[string]int64

type UpdateStatus

+ const UpdateStatusProcessing

type Version

+ CommitDate string

v0.15.0

Jun 29, 2021

Changes in this version

+ const DefaultLimit

type Client

+ func (c *Client) CreateDump() (resp *Dump, err error)

+ func (c *Client) CreateIndex(config *IndexConfig) (resp *Index, err error)

+ func (c *Client) DeleteIndex(uid string) (ok bool, err error)

+ func (c *Client) GetAllIndexes() (resp []*Index, err error)

+ func (c *Client) GetAllStats() (resp *Stats, err error)

+ func (c *Client) GetDumpStatus(dumpUID string) (resp *Dump, err error)

+ func (c *Client) GetIndex(uid string) (resp *Index, err error)

+ func (c *Client) GetKeys() (resp *Keys, err error)

+ func (c *Client) GetOrCreateIndex(config *IndexConfig) (resp *Index, err error)

+ func (c *Client) GetVersion() (resp *Version, err error)

+ func (c *Client) Index(uid string) *Index

+ func (c *Client) IsHealthy() bool

+ func (v *Client) UnmarshalEasyJSON(l *jlexer.Lexer)

+ func (v *Client) UnmarshalJSON(data []byte) error

+ func (v Client) MarshalEasyJSON(w *jwriter.Writer)

+ func (v Client) MarshalJSON() ([]byte, error)

+ type ClientConfig struct

+ APIKey string

+ Host string

+ Timeout time.Duration

type ClientInterface

+ CreateDump func() (resp *Dump, err error)

+ CreateIndex func(config *IndexConfig) (resp *Index, err error)

+ DeleteIndex func(uid string) (bool, error)

+ GetAllIndexes func() (resp []*Index, err error)

+ GetAllStats func() (resp *Stats, err error)

+ GetDumpStatus func(dumpUID string) (resp *Dump, err error)

+ GetIndex func(indexID string) (resp *Index, err error)

+ GetKeys func() (resp *Keys, err error)

+ GetOrCreateIndex func(config *IndexConfig) (resp *Index, err error)

+ GetVersion func() (resp *Version, err error)

+ Index func(uid string) *Index

+ IsHealthy func() bool

+ type DocumentsRequest struct

+ AttributesToRetrieve []string

+ Limit int64

+ Offset int64

+ func (v *DocumentsRequest) UnmarshalEasyJSON(l *jlexer.Lexer)

+ func (v *DocumentsRequest) UnmarshalJSON(data []byte) error

+ func (v DocumentsRequest) MarshalEasyJSON(w *jwriter.Writer)

+ func (v DocumentsRequest) MarshalJSON() ([]byte, error)

type ErrCode

+ const MeilisearchApiError

+ const MeilisearchApiErrorWithoutMessage

+ const MeilisearchCommunicationError

+ const MeilisearchTimeoutError

type Error

+ MeilisearchApiMessage meilisearchApiMessage

type Health

+ Status string

type Index

+ func (i Index) AddDocuments(documentsPtr interface{}) (resp *AsyncUpdateID, err error)

+ func (i Index) AddDocumentsWithPrimaryKey(documentsPtr interface{}, primaryKey string) (resp *AsyncUpdateID, err error)

+ func (i Index) DefaultWaitForPendingUpdate(updateID *AsyncUpdateID) (UpdateStatus, error)

+ func (i Index) Delete(uid string) (ok bool, err error)

+ func (i Index) DeleteAllDocuments() (resp *AsyncUpdateID, err error)

+ func (i Index) DeleteDocument(identifier string) (resp *AsyncUpdateID, err error)

+ func (i Index) DeleteDocuments(identifier []string) (resp *AsyncUpdateID, err error)

+ func (i Index) FetchInfo() (resp *Index, err error)

+ func (i Index) FetchPrimaryKey() (resp *string, err error)

+ func (i Index) GetAllUpdateStatus() (resp *[]Update, err error)

+ func (i Index) GetAttributesForFaceting() (resp *[]string, err error)

+ func (i Index) GetDisplayedAttributes() (resp *[]string, err error)

+ func (i Index) GetDistinctAttribute() (resp *string, err error)

+ func (i Index) GetDocument(identifier string, documentPtr interface{}) error

+ func (i Index) GetDocuments(request *DocumentsRequest, resp interface{}) error

+ func (i Index) GetRankingRules() (resp *[]string, err error)

+ func (i Index) GetSearchableAttributes() (resp *[]string, err error)

+ func (i Index) GetSettings() (resp *Settings, err error)

+ func (i Index) GetStats() (resp *StatsIndex, err error)

+ func (i Index) GetStopWords() (resp *[]string, err error)

+ func (i Index) GetSynonyms() (resp *map[string][]string, err error)

+ func (i Index) GetUpdateStatus(updateID int64) (resp *Update, err error)

+ func (i Index) ResetAttributesForFaceting() (resp *AsyncUpdateID, err error)

+ func (i Index) ResetDisplayedAttributes() (resp *AsyncUpdateID, err error)

+ func (i Index) ResetDistinctAttribute() (resp *AsyncUpdateID, err error)

+ func (i Index) ResetRankingRules() (resp *AsyncUpdateID, err error)

+ func (i Index) ResetSearchableAttributes() (resp *AsyncUpdateID, err error)

+ func (i Index) ResetSettings() (resp *AsyncUpdateID, err error)

+ func (i Index) ResetStopWords() (resp *AsyncUpdateID, err error)

+ func (i Index) ResetSynonyms() (resp *AsyncUpdateID, err error)

+ func (i Index) Search(query string, request *SearchRequest) (*SearchResponse, error)

+ func (i Index) UpdateAttributesForFaceting(request *[]string) (resp *AsyncUpdateID, err error)

+ func (i Index) UpdateDisplayedAttributes(request *[]string) (resp *AsyncUpdateID, err error)

+ func (i Index) UpdateDistinctAttribute(request string) (resp *AsyncUpdateID, err error)

+ func (i Index) UpdateDocuments(documentsPtr interface{}) (*AsyncUpdateID, error)

+ func (i Index) UpdateDocumentsWithPrimaryKey(documentsPtr interface{}, primaryKey string) (resp *AsyncUpdateID, err error)

+ func (i Index) UpdateIndex(primaryKey string) (resp *Index, err error)

+ func (i Index) UpdateRankingRules(request *[]string) (resp *AsyncUpdateID, err error)

+ func (i Index) UpdateSearchableAttributes(request *[]string) (resp *AsyncUpdateID, err error)

+ func (i Index) UpdateSettings(request *Settings) (resp *AsyncUpdateID, err error)

+ func (i Index) UpdateStopWords(request *[]string) (resp *AsyncUpdateID, err error)

+ func (i Index) UpdateSynonyms(request *map[string][]string) (resp *AsyncUpdateID, err error)

+ func (i Index) WaitForPendingUpdate(ctx context.Context, interval time.Duration, updateID *AsyncUpdateID) (UpdateStatus, error)

+ type IndexConfig struct

+ PrimaryKey string

+ Uid string

+ type IndexInterface interface

+ AddDocuments func(documentsPtr interface{}) (resp *AsyncUpdateID, err error)

+ AddDocumentsWithPrimaryKey func(documentsPtr interface{}, primaryKey string) (resp *AsyncUpdateID, err error)

+ DefaultWaitForPendingUpdate func(updateID *AsyncUpdateID) (UpdateStatus, error)

+ Delete func(uid string) (ok bool, err error)

+ DeleteAllDocuments func() (resp *AsyncUpdateID, err error)

+ DeleteDocument func(uid string) (resp *AsyncUpdateID, err error)

+ DeleteDocuments func(uid []string) (resp *AsyncUpdateID, err error)

+ FetchInfo func() (resp *Index, err error)

+ FetchPrimaryKey func() (resp *string, err error)

+ GetAllUpdateStatus func() (resp *[]Update, err error)

+ GetAttributesForFaceting func() (resp *[]string, err error)

+ GetDisplayedAttributes func() (resp *[]string, err error)

+ GetDistinctAttribute func() (resp *string, err error)

+ GetDocument func(uid string, documentPtr interface{}) error

+ GetDocuments func(request *DocumentsRequest, resp interface{}) error

+ GetRankingRules func() (resp *[]string, err error)

+ GetSearchableAttributes func() (resp *[]string, err error)

+ GetSettings func() (resp *Settings, err error)

+ GetStats func() (resp *StatsIndex, err error)

+ GetStopWords func() (resp *[]string, err error)

+ GetSynonyms func() (resp *map[string][]string, err error)

+ GetUpdateStatus func(updateID int64) (resp *Update, err error)

+ ResetAttributesForFaceting func() (resp *AsyncUpdateID, err error)

+ ResetDisplayedAttributes func() (resp *AsyncUpdateID, err error)

+ ResetDistinctAttribute func() (resp *AsyncUpdateID, err error)

+ ResetRankingRules func() (resp *AsyncUpdateID, err error)

+ ResetSearchableAttributes func() (resp *AsyncUpdateID, err error)

+ ResetSettings func() (resp *AsyncUpdateID, err error)

+ ResetStopWords func() (resp *AsyncUpdateID, err error)

+ ResetSynonyms func() (resp *AsyncUpdateID, err error)

+ Search func(query string, request *SearchRequest) (*SearchResponse, error)

+ UpdateAttributesForFaceting func(request *[]string) (resp *AsyncUpdateID, err error)

+ UpdateDisplayedAttributes func(request *[]string) (resp *AsyncUpdateID, err error)

+ UpdateDistinctAttribute func(request string) (resp *AsyncUpdateID, err error)

+ UpdateDocuments func(documentsPtr interface{}) (resp *AsyncUpdateID, err error)

+ UpdateDocumentsWithPrimaryKey func(documentsPtr interface{}, primaryKey string) (resp *AsyncUpdateID, err error)

+ UpdateIndex func(primaryKey string) (resp *Index, err error)

+ UpdateRankingRules func(request *[]string) (resp *AsyncUpdateID, err error)

+ UpdateSearchableAttributes func(request *[]string) (resp *AsyncUpdateID, err error)

+ UpdateSettings func(request *Settings) (resp *AsyncUpdateID, err error)

+ UpdateStopWords func(request *[]string) (resp *AsyncUpdateID, err error)

+ UpdateSynonyms func(request *map[string][]string) (resp *AsyncUpdateID, err error)

+ WaitForPendingUpdate func(ctx context.Context, interval time.Duration, updateID *AsyncUpdateID) (UpdateStatus, error)

type SearchResponse

+ ExhaustiveNbHits bool

+ type UpdateIndexRequest struct

+ PrimaryKey string

+ func (v *UpdateIndexRequest) UnmarshalEasyJSON(l *jlexer.Lexer)

+ func (v *UpdateIndexRequest) UnmarshalJSON(data []byte) error

+ func (v UpdateIndexRequest) MarshalEasyJSON(w *jwriter.Writer)

+ func (v UpdateIndexRequest) MarshalJSON() ([]byte, error)

v0.14.1

Feb 24, 2021

Changes in this version

+ type APIDumps interface

+ Create func() (*Dump, error)

+ GetStatus func(dumpUID string) (*Dump, error)

type Client

+ func (c *Client) Dumps() APIDumps

type ClientInterface

+ Dumps func() APIDumps

+ type Dump struct

+ Status string

+ UID string

+ func (v *Dump) UnmarshalEasyJSON(l *jlexer.Lexer)

+ func (v *Dump) UnmarshalJSON(data []byte) error

+ func (v Dump) MarshalEasyJSON(w *jwriter.Writer)

+ func (v Dump) MarshalJSON() ([]byte, error)

v0.14.0

Feb 9, 2021

v0.13.1

Nov 5, 2020

Changes in this version

type AsyncUpdateID

+ func (v *AsyncUpdateID) UnmarshalEasyJSON(l *jlexer.Lexer)

+ func (v *AsyncUpdateID) UnmarshalJSON(data []byte) error

+ func (v AsyncUpdateID) MarshalEasyJSON(w *jwriter.Writer)

+ func (v AsyncUpdateID) MarshalJSON() ([]byte, error)

+ type ClientInterface interface

+ DefaultWaitForPendingUpdate func(indexUID string, updateID *AsyncUpdateID) (UpdateStatus, error)

+ Documents func(indexID string) APIDocuments

+ Health func() APIHealth

+ Indexes func() APIIndexes

+ Keys func() APIKeys

+ Search func(indexID string) APISearch

+ Settings func(indexID string) APISettings

+ Stats func() APIStats

+ Updates func(indexID string) APIUpdates

+ Version func() APIVersion

+ WaitForPendingUpdate func(ctx context.Context, interval time.Duration, indexID string, ...) (UpdateStatus, error)

+ func NewFastHTTPCustomClient(config Config, client *fasthttp.Client) ClientInterface

type CreateIndexRequest

+ func (v *CreateIndexRequest) UnmarshalEasyJSON(l *jlexer.Lexer)

+ func (v *CreateIndexRequest) UnmarshalJSON(data []byte) error

+ func (v CreateIndexRequest) MarshalEasyJSON(w *jwriter.Writer)

+ func (v CreateIndexRequest) MarshalJSON() ([]byte, error)

type CreateIndexResponse

+ func (v *CreateIndexResponse) UnmarshalEasyJSON(l *jlexer.Lexer)

+ func (v *CreateIndexResponse) UnmarshalJSON(data []byte) error

+ func (v CreateIndexResponse) MarshalEasyJSON(w *jwriter.Writer)

+ func (v CreateIndexResponse) MarshalJSON() ([]byte, error)

+ type Health struct

+ Health bool

+ func (v *Health) UnmarshalEasyJSON(l *jlexer.Lexer)

+ func (v *Health) UnmarshalJSON(data []byte) error

+ func (v Health) MarshalEasyJSON(w *jwriter.Writer)

+ func (v Health) MarshalJSON() ([]byte, error)

type Index

+ func (v *Index) UnmarshalEasyJSON(l *jlexer.Lexer)

+ func (v *Index) UnmarshalJSON(data []byte) error

+ func (v Index) MarshalEasyJSON(w *jwriter.Writer)

+ func (v Index) MarshalJSON() ([]byte, error)

type Keys

+ func (v *Keys) UnmarshalEasyJSON(l *jlexer.Lexer)

+ func (v *Keys) UnmarshalJSON(data []byte) error

+ func (v Keys) MarshalEasyJSON(w *jwriter.Writer)

+ func (v Keys) MarshalJSON() ([]byte, error)

type ListDocumentsRequest

+ func (v *ListDocumentsRequest) UnmarshalEasyJSON(l *jlexer.Lexer)

+ func (v *ListDocumentsRequest) UnmarshalJSON(data []byte) error

+ func (v ListDocumentsRequest) MarshalEasyJSON(w *jwriter.Writer)

+ func (v ListDocumentsRequest) MarshalJSON() ([]byte, error)

+ type Name struct

+ Name string

+ func (v *Name) UnmarshalEasyJSON(l *jlexer.Lexer)

+ func (v *Name) UnmarshalJSON(data []byte) error

+ func (v Name) MarshalEasyJSON(w *jwriter.Writer)

+ func (v Name) MarshalJSON() ([]byte, error)

+ type PrimaryKey struct

+ PrimaryKey string

+ func (v *PrimaryKey) UnmarshalEasyJSON(l *jlexer.Lexer)

+ func (v *PrimaryKey) UnmarshalJSON(data []byte) error

+ func (v PrimaryKey) MarshalEasyJSON(w *jwriter.Writer)

+ func (v PrimaryKey) MarshalJSON() ([]byte, error)

+ type RawType []byte

+ func (b *RawType) UnmarshalJSON(data []byte) error

+ func (b RawType) MarshalJSON() ([]byte, error)

type SearchRequest

+ func (v *SearchRequest) UnmarshalEasyJSON(l *jlexer.Lexer)

+ func (v *SearchRequest) UnmarshalJSON(data []byte) error

+ func (v SearchRequest) MarshalEasyJSON(w *jwriter.Writer)

+ func (v SearchRequest) MarshalJSON() ([]byte, error)

type SearchResponse

+ func (v *SearchResponse) UnmarshalEasyJSON(l *jlexer.Lexer)

+ func (v *SearchResponse) UnmarshalJSON(data []byte) error

+ func (v SearchResponse) MarshalEasyJSON(w *jwriter.Writer)

+ func (v SearchResponse) MarshalJSON() ([]byte, error)

type Settings

+ func (v *Settings) UnmarshalEasyJSON(l *jlexer.Lexer)

+ func (v *Settings) UnmarshalJSON(data []byte) error

+ func (v Settings) MarshalEasyJSON(w *jwriter.Writer)

+ func (v Settings) MarshalJSON() ([]byte, error)

type Stats

+ func (v *Stats) UnmarshalEasyJSON(l *jlexer.Lexer)

+ func (v *Stats) UnmarshalJSON(data []byte) error

+ func (v Stats) MarshalEasyJSON(w *jwriter.Writer)

+ func (v Stats) MarshalJSON() ([]byte, error)

type StatsIndex

+ func (v *StatsIndex) UnmarshalEasyJSON(l *jlexer.Lexer)

+ func (v *StatsIndex) UnmarshalJSON(data []byte) error

+ func (v StatsIndex) MarshalEasyJSON(w *jwriter.Writer)

+ func (v StatsIndex) MarshalJSON() ([]byte, error)

type Update

+ func (v *Update) UnmarshalEasyJSON(l *jlexer.Lexer)

+ func (v *Update) UnmarshalJSON(data []byte) error

+ func (v Update) MarshalEasyJSON(w *jwriter.Writer)

+ func (v Update) MarshalJSON() ([]byte, error)

type Version

+ func (v *Version) UnmarshalEasyJSON(l *jlexer.Lexer)

+ func (v *Version) UnmarshalJSON(data []byte) error

+ func (v Version) MarshalEasyJSON(w *jwriter.Writer)

+ func (v Version) MarshalJSON() ([]byte, error)

v0.12.1

Sep 1, 2020

v0.12.0

Aug 3, 2020

Changes in this version

type SearchRequest

+ PlaceholderSearch bool

v0.11.1

Jul 1, 2020

Changes in this version

type SearchResponse

+ NbHits int64

v0.11.0

Jun 15, 2020

Changes in this version

type APISettings

+ GetAttributesForFaceting func() (*[]string, error)

+ ResetAttributesForFaceting func() (*AsyncUpdateID, error)

+ UpdateAttributesForFaceting func([]string) (*AsyncUpdateID, error)

type SearchRequest

+ FacetFilters interface{}

+ FacetsDistribution []string

type SearchResponse

+ ExhaustiveFacetsCount interface{}

+ FacetsDistribution interface{}

type Settings

+ AttributesForFaceting []string

v0.9.1

Apr 3, 2020

Changes in this version

type APIStats

+ GetAll func() (*Stats, error)

type Client

+ func (c Client) DefaultWaitForPendingUpdate(indexUID string, updateID *AsyncUpdateID) (UpdateStatus, error)

+ func (c Client) WaitForPendingUpdate(ctx context.Context, interval time.Duration, indexID string, ...) (UpdateStatus, error)

type Stats

+ DatabaseSize int64

+ Indexes map[string]StatsIndex

+ LastUpdate time.Time

+ type StatsIndex struct

+ FieldsFrequency map[string]int64

+ IsIndexing bool

+ NumberOfDocuments int64

v0.9.0

Mar 20, 2020

Changes in this version

+ type APIDocuments interface

+ AddOrReplace func(documentsPtr interface{}) (*AsyncUpdateID, error)

+ AddOrReplaceWithPrimaryKey func(documentsPtr interface{}, primaryKey string) (resp *AsyncUpdateID, err error)

+ AddOrUpdate func(documentsPtr interface{}) (*AsyncUpdateID, error)

+ AddOrUpdateWithPrimaryKey func(documentsPtr interface{}, primaryKey string) (resp *AsyncUpdateID, err error)

+ Delete func(identifier string) (*AsyncUpdateID, error)

+ DeleteAllDocuments func() (*AsyncUpdateID, error)

+ Deletes func(identifier []string) (*AsyncUpdateID, error)

+ Get func(identifier string, documentPtr interface{}) error

+ List func(request ListDocumentsRequest, documentsPtr interface{}) error

+ type APIHealth interface

+ Get func() error

+ Update func(health bool) error

+ type APIIndexes interface

+ Create func(request CreateIndexRequest) (*CreateIndexResponse, error)

+ Delete func(uid string) (bool, error)

+ Get func(uid string) (*Index, error)

+ List func() ([]Index, error)

+ UpdateName func(uid string, name string) (*Index, error)

+ UpdatePrimaryKey func(uid string, primaryKey string) (*Index, error)

+ type APIKeys interface

+ Get func() (*Keys, error)

+ type APISearch interface

+ Search func(params SearchRequest) (*SearchResponse, error)

+ type APISettings interface

+ GetAcceptNewFields func() (*bool, error)

+ GetAll func() (*Settings, error)

+ GetDisplayedAttributes func() (*[]string, error)

+ GetDistinctAttribute func() (*string, error)

+ GetRankingRules func() (*[]string, error)

+ GetSearchableAttributes func() (*[]string, error)

+ GetStopWords func() (*[]string, error)

+ GetSynonyms func() (*map[string][]string, error)

+ ResetAll func() (*AsyncUpdateID, error)

+ ResetDisplayedAttributes func() (*AsyncUpdateID, error)

+ ResetDistinctAttribute func() (*AsyncUpdateID, error)

+ ResetRankingRules func() (*AsyncUpdateID, error)

+ ResetSearchableAttributes func() (*AsyncUpdateID, error)

+ ResetStopWords func() (*AsyncUpdateID, error)

+ ResetSynonyms func() (*AsyncUpdateID, error)

+ UpdateAcceptNewFields func(bool) (*AsyncUpdateID, error)

+ UpdateAll func(request Settings) (*AsyncUpdateID, error)

+ UpdateDisplayedAttributes func([]string) (*AsyncUpdateID, error)

+ UpdateDistinctAttribute func(string) (*AsyncUpdateID, error)

+ UpdateRankingRules func([]string) (*AsyncUpdateID, error)

+ UpdateSearchableAttributes func([]string) (*AsyncUpdateID, error)

+ UpdateStopWords func([]string) (*AsyncUpdateID, error)

+ UpdateSynonyms func(map[string][]string) (*AsyncUpdateID, error)

+ type APIStats interface

+ Get func() (*Stats, error)

+ type APISystemInformation interface

+ Get func() (*SystemInformation, error)

+ GetPretty func() (*SystemInformationPretty, error)

+ type APIUpdates interface

+ Get func(id int64) (*Update, error)

+ List func() ([]Update, error)

+ type APIVersion interface

+ Get func() (*Version, error)

+ type APIWithIndexID interface

+ Client func() *Client

+ IndexID func() string

+ type AsyncUpdateID struct

+ UpdateID int64

type Client

+ func NewClientWithCustomHTTPClient(config Config, client http.Client) *Client

+ func (c *Client) Settings(indexID string) APISettings

+ func (c Client) AwaitAsyncUpdateID(indexID string, updateID *AsyncUpdateID) UpdateStatus

type CreateIndexRequest

+ PrimaryKey string

type CreateIndexResponse

+ PrimaryKey string

type ErrCode

+ const ErrCodeURLParsing

type Index

+ PrimaryKey string

+ type Keys struct

+ Private string

+ Public string

type Settings

+ AcceptNewFields bool

+ DisplayedAttributes []string

+ DistinctAttribute *string

+ SearchableAttributes []string

+ StopWords []string

+ Synonyms map[string][]string

type UpdateStatus

+ func AwaitAsyncUpdateID(api APIWithIndexID, updateID *AsyncUpdateID) UpdateStatus

v0.8.4

Feb 5, 2020

Changes in this version

+ type ACL string

+ const AclAdmin

+ const AclAll

+ const AclDocumentsRead

+ const AclDocumentsWrite

+ const AclIndexesRead

+ const AclIndexesWrite

+ const AclSettingsRead

+ const AclSettingsWrite

+ type APIKey struct

+ Acl []ACL

+ CreatedAt time.Time

+ Description string

+ ExpiresAt time.Time

+ Indexes []string

+ Key string

+ Revoked bool

+ UpdatedAt time.Time

+ type ApiDocuments interface

+ AddOrUpdate func(documentsPtr interface{}) (*AsyncUpdateId, error)

+ Delete func(identifier string) (*AsyncUpdateId, error)

+ DeleteAllDocuments func() (*AsyncUpdateId, error)

+ Deletes func(identifier []string) (*AsyncUpdateId, error)

+ Get func(identifier string, documentPtr interface{}) error

+ List func(request ListDocumentsRequest, documentsPtr interface{}) error

+ type ApiHealth interface

+ Get func() error

+ Set func(health bool) error

+ type ApiIndexes interface

+ Create func(request CreateIndexRequest) (*CreateIndexResponse, error)

+ Delete func(uid string) (bool, error)

+ Get func(uid string) (*Index, error)

+ GetRawSchema func(uid string) (*RawSchema, error)

+ GetSchema func(uid string) (*Schema, error)

+ List func() ([]Index, error)

+ Update func(uid string, name string) (*Index, error)

+ UpdateSchema func(uid string, schema Schema) (*AsyncUpdateId, error)

+ UpdateWithRawSchema func(uid string, schema RawSchema) (*AsyncUpdateId, error)

+ type ApiKeys interface

+ Create func(request CreateApiKeyRequest) (*APIKey, error)

+ Delete func(key string) (deleted bool, err error)

+ Get func(key string) (*APIKey, error)

+ List func() ([]APIKey, error)

+ Update func(key string, request UpdateApiKeyRequest) (*APIKey, error)

+ type ApiSearch interface

+ Search func(params SearchRequest) (*SearchResponse, error)

+ type ApiSettings interface

+ AddOrUpdate func(request Settings) (*AsyncUpdateId, error)

+ Get func() (*Settings, error)

+ type ApiStats interface

+ Get func(indexId string) (*Stats, error)

+ List func() ([]Stats, error)

+ type ApiStopWords interface

+ Add func(words []string) (*AsyncUpdateId, error)

+ Deletes func(words []string) (*AsyncUpdateId, error)

+ List func() ([]string, error)

+ type ApiSynonyms interface

+ BatchCreate func(request BatchCreateSynonymsRequest) (*AsyncUpdateId, error)

+ Create func(word string, synonyms []string) (*AsyncUpdateId, error)

+ Delete func(word string) (*AsyncUpdateId, error)

+ DeleteAll func() (*AsyncUpdateId, error)

+ List func(word string) ([]string, error)

+ ListAll func() ([]ListSynonymsResponse, error)

+ Update func(word string, synonyms []string) (*AsyncUpdateId, error)

+ type ApiSystemInformation interface

+ Get func() (*SystemInformation, error)

+ GetPretty func() (*SystemInformationPretty, error)

+ type ApiUpdates interface

+ Get func(id int64) (*Update, error)

+ List func() ([]Update, error)

+ type ApiVersion interface

+ Get func() (*Version, error)

+ type ApiWithIndexID interface

+ Client func() *Client

+ IndexId func() string

+ type AsyncUpdateId struct

+ UpdateID int64

+ type Attributes map[string]bool

+ type BatchCreateSynonymsRequest []Synonym

+ type Client struct

+ func NewClient(config Config) *Client

+ func NewClientWithCustomHttpClient(config Config, client http.Client) *Client

+ func (c *Client) Documents(indexId string) ApiDocuments

+ func (c *Client) Health() ApiHealth

+ func (c *Client) Indexes() ApiIndexes

+ func (c *Client) Keys() ApiKeys

+ func (c *Client) Search(indexId string) ApiSearch

+ func (c *Client) Stats() ApiStats

+ func (c *Client) StopWords(indexId string) ApiStopWords

+ func (c *Client) Updates(indexId string) ApiUpdates

+ func (c *Client) Version() ApiVersion

+ func (c Client) AwaitAsyncUpdateId(indexId string, updateId *AsyncUpdateId) UpdateStatus

+ type Config struct

+ APIKey string

+ Host string

+ type CreateApiKeyRequest struct

+ Acl []ACL

+ Description string

+ ExpireAt int64

+ Indexes []string

+ type CreateIndexRequest struct

+ Name string

+ Schema Schema

+ UID string

+ type CreateIndexResponse struct

+ CreatedAt time.Time

+ Name string

+ Schema Schema

+ UID string

+ UpdateID int64

+ UpdatedAt time.Time

+ type ErrCode int

+ const ErrCodeMarshalRequest

+ const ErrCodeRequestCreation

+ const ErrCodeRequestExecution

+ const ErrCodeResponseReadBody

+ const ErrCodeResponseStatusCode

+ const ErrCodeResponseUnmarshalBody

+ const ErrCodeUnknown

+ const ErrCodeUrlParsing

+ type Error struct

+ APIName string

+ Endpoint string

+ ErrCode ErrCode

+ Function string

+ MeilisearchMessage string

+ Method string

+ OriginError error

+ RequestToString string

+ ResponseToString string

+ StatusCode int

+ StatusCodeExpected []int

+ func (e *Error) ErrorBody(body []byte)

+ func (e *Error) WithErrCode(err ErrCode, errs ...error) *Error

+ func (e *Error) WithMessage(str string, errs ...error) *Error

+ func (e Error) Error() string

+ type Index struct

+ CreatedAt time.Time

+ Name string

+ UID string

+ UpdatedAt time.Time

+ type ListDocumentsRequest struct

+ AttributesToRetrieve []string

+ Limit int64

+ Offset int64

+ type ListSynonymsResponse map[string][]string

+ type RawAttribute struct

+ Displayed bool

+ Indexed bool

+ Ranked bool

+ type RawSchema struct

+ Attributes map[string]RawAttribute

+ Identifier string

+ type Schema map[string][]SchemaAttributes

+ type SchemaAttributes string

+ const SchemaAttributesDisplayed

+ const SchemaAttributesIdentifier

+ const SchemaAttributesIndexed

+ const SchemaAttributesRanked

+ type SearchRequest struct

+ AttributesToCrop []string

+ AttributesToHighlight []string

+ AttributesToRetrieve []string

+ AttributesToSearchIn []string

+ CropLength int64

+ Filters string

+ Limit int64

+ Matches bool

+ Offset int64

+ Query string

+ TimeoutMs int64

+ type SearchResponse struct

+ Hits []interface{}

+ Limit int64

+ Offset int64

+ ProcessingTimeMs int64

+ Query string

+ type Settings struct

+ DistinctField string

+ RankingOrder []string

+ RankingRules map[string]string

+ type Stats struct

+ FieldsFrequency map[string]int64

+ IsIndexing bool

+ NumberOfDocuments int64

+ type Synonym struct

+ Input string

+ Synonyms []string

+ type SystemInformation struct

+ Global struct{ ... }

+ MemoryUsage float64

+ Process struct{ ... }

+ ProcessorUsage []float64

+ type SystemInformationPretty struct

+ Global struct{ ... }

+ MemoryUsage string

+ Process struct{ ... }

+ ProcessorUsage []string

+ type Unknown map[string]interface

+ type Update struct

+ EnqueuedAt time.Time

+ Error string

+ ProcessedAt time.Time

+ Status UpdateStatus

+ Type Unknown

+ UpdateID int64

+ type UpdateApiKeyRequest struct

+ Acl []ACL

+ Description string

+ Indexes []string

+ Revoked bool

+ type UpdateStatus string

+ const UpdateStatusEnqueued

+ const UpdateStatusFailed

+ const UpdateStatusProcessed

+ const UpdateStatusUnknown

+ func AwaitAsyncUpdateId(api ApiWithIndexID, updateId *AsyncUpdateId) UpdateStatus

+ type Version struct

+ BuildDate time.Time

+ CommitSha string

+ PkgVersion string

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL