Versions in this module Expand all Collapse all v3 v3.4.0 Sep 24, 2019 Changes in this version + const DefaultMaxBatchSize + func GenerateSecuredAPIKey(apiKey string, opts ...interface{}) (string, error) + type Account struct + func NewAccount() *Account + func (a *Account) CopyIndex(src, dst *Index, opts ...interface{}) (*wait.Group, error) + type AltCorrection1 struct + Corrections []string + Word string + func NewAltCorrection1(objectID, word string, corrections ...string) AltCorrection1 + func (s *AltCorrection1) UnmarshalJSON(data []byte) error + func (s AltCorrection1) MarshalJSON() ([]byte, error) + func (s AltCorrection1) ObjectID() string + func (s AltCorrection1) Type() SynonymType + type AltCorrection2 AltCorrection1 + func NewAltCorrection2(objectID, word string, corrections ...string) AltCorrection2 + func (s *AltCorrection2) UnmarshalJSON(data []byte) error + func (s AltCorrection2) MarshalJSON() ([]byte, error) + func (s AltCorrection2) ObjectID() string + func (s AltCorrection2) Type() SynonymType + type Alternatives struct + func AlternativesDisabled() *Alternatives + func AlternativesEnabled() *Alternatives + func (a *Alternatives) UnmarshalJSON(data []byte) error + func (a Alternatives) MarshalJSON() ([]byte, error) + type AppliedRule struct + ObjectID string + type AssignUserIDRes struct + CreatedAt string + type AutomaticFacetFilter struct + Disjunctive bool + Facet string + Score int + type BatchAction string + const AddObject + const Clear + const Delete + const DeleteObject + const PartialUpdateObject + const PartialUpdateObjectNoCreate + const UpdateObject + type BatchOperation struct + Action BatchAction + Body interface{} + type BatchOperationIndexed struct + IndexName string + type BatchRes struct + ObjectIDs []string + TaskID int + func (r BatchRes) Wait() error + type Client struct + func NewClient(appID, apiKey string) *Client + func NewClientWithConfig(config Configuration) *Client + func (c *Client) AddAPIKey(key Key, opts ...interface{}) (res CreateKeyRes, err error) + func (c *Client) AssignUserID(userID, clusterName string, opts ...interface{}) (res AssignUserIDRes, err error) + func (c *Client) CopyIndex(source, destination string, opts ...interface{}) (UpdateTaskRes, error) + func (c *Client) CopyRules(source, destination string, opts ...interface{}) (UpdateTaskRes, error) + func (c *Client) CopySettings(source, destination string, opts ...interface{}) (UpdateTaskRes, error) + func (c *Client) CopySynonyms(source, destination string, opts ...interface{}) (UpdateTaskRes, error) + func (c *Client) CustomRequest(res interface{}, method string, path string, body interface{}, k call.Kind, ...) error + func (c *Client) DeleteAPIKey(keyID string, opts ...interface{}) (res DeleteKeyRes, err error) + func (c *Client) GetAPIKey(keyID string, opts ...interface{}) (key Key, err error) + func (c *Client) GetLogs(opts ...interface{}) (res GetLogsRes, err error) + func (c *Client) GetPersonalizationStrategy(opts ...interface{}) (res GetPersonalizationStrategyRes, err error) + func (c *Client) GetTopUserIDs(opts ...interface{}) (res TopUserIDs, err error) + func (c *Client) GetUserID(userID string, opts ...interface{}) (res UserID, err error) + func (c *Client) InitIndex(indexName string) *Index + func (c *Client) ListAPIKeys(opts ...interface{}) (res ListAPIKeysRes, err error) + func (c *Client) ListClusters(opts ...interface{}) (res ListClustersRes, err error) + func (c *Client) ListIndices(opts ...interface{}) (res ListIndicesRes, err error) + func (c *Client) ListUserIDs(opts ...interface{}) (res ListUserIDsRes, err error) + func (c *Client) MoveIndex(source, destination string, opts ...interface{}) (UpdateTaskRes, error) + func (c *Client) MultipleBatch(operations []BatchOperationIndexed, opts ...interface{}) (res MultipleBatchRes, err error) + func (c *Client) MultipleGetObjects(requests []IndexedGetObject, objects interface{}, opts ...interface{}) (err error) + func (c *Client) MultipleQueries(queries []IndexedQuery, strategy string, opts ...interface{}) (res MultipleQueriesRes, err error) + func (c *Client) RemoveUserID(userID string, opts ...interface{}) (res RemoveUserIDRes, err error) + func (c *Client) RestoreAPIKey(keyID string, opts ...interface{}) (res RestoreKeyRes, err error) + func (c *Client) SearchUserIDs(query string, opts ...interface{}) (res SearchUserIDRes, err error) + func (c *Client) SetPersonalizationStrategy(strategy Strategy, opts ...interface{}) (res SetPersonalizationStrategyRes, err error) + func (c *Client) UpdateAPIKey(key Key, opts ...interface{}) (res UpdateKeyRes, err error) + type ClientInterface interface + AddAPIKey func(key Key, opts ...interface{}) (res CreateKeyRes, err error) + AssignUserID func(userID, clusterName string, opts ...interface{}) (res AssignUserIDRes, err error) + CopyIndex func(source, destination string, opts ...interface{}) (UpdateTaskRes, error) + CopyRules func(source, destination string, opts ...interface{}) (UpdateTaskRes, error) + CopySettings func(source, destination string, opts ...interface{}) (UpdateTaskRes, error) + CopySynonyms func(source, destination string, opts ...interface{}) (UpdateTaskRes, error) + CustomRequest func(res interface{}, method string, path string, body interface{}, k call.Kind, ...) error + DeleteAPIKey func(keyID string, opts ...interface{}) (res DeleteKeyRes, err error) + GetAPIKey func(keyID string, opts ...interface{}) (key Key, err error) + GetLogs func(opts ...interface{}) (res GetLogsRes, err error) + GetPersonalizationStrategy func(opts ...interface{}) (res GetPersonalizationStrategyRes, err error) + GetTopUserIDs func(opts ...interface{}) (res TopUserIDs, err error) + GetUserID func(userID string, opts ...interface{}) (res UserID, err error) + InitIndex func(indexName string) *Index + ListAPIKeys func(opts ...interface{}) (res ListAPIKeysRes, err error) + ListClusters func(opts ...interface{}) (res ListClustersRes, err error) + ListIndices func(opts ...interface{}) (res ListIndicesRes, err error) + ListUserIDs func(opts ...interface{}) (res ListUserIDsRes, err error) + MoveIndex func(source, destination string, opts ...interface{}) (UpdateTaskRes, error) + MultipleBatch func(operations []BatchOperationIndexed, opts ...interface{}) (res MultipleBatchRes, err error) + MultipleGetObjects func(requests []IndexedGetObject, objects interface{}, opts ...interface{}) (err error) + MultipleQueries func(queries []IndexedQuery, strategy string, opts ...interface{}) (res MultipleQueriesRes, err error) + RemoveUserID func(userID string, opts ...interface{}) (res RemoveUserIDRes, err error) + RestoreAPIKey func(keyID string, opts ...interface{}) (res RestoreKeyRes, err error) + SearchUserIDs func(query string, opts ...interface{}) (res SearchUserIDRes, err error) + SetPersonalizationStrategy func(strategy Strategy, opts ...interface{}) (res SetPersonalizationStrategyRes, err error) + UpdateAPIKey func(key Key, opts ...interface{}) (res UpdateKeyRes, err error) + type Cluster struct + ClusterName string + DataSize int + NbRecords int + NbUserIDs int + type Configuration struct + APIKey string + AppID string + Compression compression.Compression + ExtraUserAgent string + Headers map[string]string + Hosts []string + MaxBatchSize int + ReadTimeout time.Duration + Requester transport.Requester + WriteTimeout time.Duration + type CreateKeyRes struct + CreatedAt time.Time + Key string + func (r CreateKeyRes) Wait() error + type DeleteKeyRes struct + DeletedAt time.Time + func (r DeleteKeyRes) Wait() error + type DeleteTaskRes struct + DeletedAt time.Time + TaskID int + func (r DeleteTaskRes) Wait() error + type EventsScoring struct + Score int + Type string + type FacetHit struct + Count int + Highlighted string + Value string + type FacetStat struct + Avg float64 + Max float64 + Min float64 + Sum float64 + type FacetsScoring struct + Score int + type GetLogsRes struct + Logs []LogRes + type GetPersonalizationStrategyRes struct + TaskID int + type GroupBatchRes struct + Responses []BatchRes + func (r GroupBatchRes) ObjectIDs() []string + func (r GroupBatchRes) Wait() error + type HiddenObject struct + ObjectID string + type HighlightResult map[string]HighlightedResult + type HighlightedResult struct + FullyHighlighted bool + MatchLevel string + MatchedWords []string + Value string + type Index struct + func (i *Index) Batch(operations []BatchOperation, opts ...interface{}) (res BatchRes, err error) + func (i *Index) BrowseObjects(opts ...interface{}) (*ObjectIterator, error) + func (i *Index) BrowseRules(opts ...interface{}) (*RuleIterator, error) + func (i *Index) BrowseSynonyms(opts ...interface{}) (*SynonymIterator, error) + func (i *Index) ClearObjects(opts ...interface{}) (res UpdateTaskRes, err error) + func (i *Index) ClearRules(opts ...interface{}) (res UpdateTaskRes, err error) + func (i *Index) ClearSynonyms(opts ...interface{}) (res UpdateTaskRes, err error) + func (i *Index) Delete(opts ...interface{}) (res DeleteTaskRes, err error) + func (i *Index) DeleteBy(opts ...interface{}) (res UpdateTaskRes, err error) + func (i *Index) DeleteObject(objectID string, opts ...interface{}) (res DeleteTaskRes, err error) + func (i *Index) DeleteObjects(objectIDs []string, opts ...interface{}) (res BatchRes, err error) + func (i *Index) DeleteRule(objectID string, opts ...interface{}) (res UpdateTaskRes, err error) + func (i *Index) DeleteSynonym(objectID string, opts ...interface{}) (res DeleteTaskRes, err error) + func (i *Index) Exists() (bool, error) + func (i *Index) FindFirstObject(filterFunc func(object map[string]interface{}) bool, query string, ...) (*ObjectWithPosition, error) + func (i *Index) FindObject(filterFunc func(object map[string]interface{}) bool, query string, ...) (*ObjectWithPosition, error) + func (i *Index) GetAppID() string + func (i *Index) GetObject(objectID string, object interface{}, opts ...interface{}) error + func (i *Index) GetObjects(objectIDs []string, objects interface{}, opts ...interface{}) error + func (i *Index) GetRule(objectID string, opts ...interface{}) (rule Rule, err error) + func (i *Index) GetSettings(opts ...interface{}) (settings Settings, err error) + func (i *Index) GetStatus(taskID int) (res TaskStatusRes, err error) + func (i *Index) GetSynonym(objectID string, opts ...interface{}) (synonym Synonym, err error) + func (i *Index) PartialUpdateObject(object interface{}, opts ...interface{}) (res UpdateTaskRes, err error) + func (i *Index) PartialUpdateObjects(objects interface{}, opts ...interface{}) (res GroupBatchRes, err error) + func (i *Index) ReplaceAllObjects(objects interface{}, opts ...interface{}) (g *wait.Group, err error) + func (i *Index) ReplaceAllRules(rules []Rule, opts ...interface{}) (UpdateTaskRes, error) + func (i *Index) ReplaceAllSynonyms(synonyms []Synonym, opts ...interface{}) (UpdateTaskRes, error) + func (i *Index) SaveObject(object interface{}, opts ...interface{}) (res SaveObjectRes, err error) + func (i *Index) SaveObjects(objects interface{}, opts ...interface{}) (res GroupBatchRes, err error) + func (i *Index) SaveRule(rule Rule, opts ...interface{}) (res UpdateTaskRes, err error) + func (i *Index) SaveRules(rules []Rule, opts ...interface{}) (res UpdateTaskRes, err error) + func (i *Index) SaveSynonym(synonym Synonym, opts ...interface{}) (res UpdateTaskRes, err error) + func (i *Index) SaveSynonyms(synonyms []Synonym, opts ...interface{}) (res UpdateTaskRes, err error) + func (i *Index) Search(query string, opts ...interface{}) (res QueryRes, err error) + func (i *Index) SearchForFacetValues(facet, query string, opts ...interface{}) (res SearchForFacetValuesRes, err error) + func (i *Index) SearchRules(query string, opts ...interface{}) (res SearchRulesRes, err error) + func (i *Index) SearchSynonyms(query string, opts ...interface{}) (res SearchSynonymsRes, err error) + func (i *Index) SetSettings(settings Settings, opts ...interface{}) (res UpdateTaskRes, err error) + func (i *Index) WaitTask(taskID int) error + type IndexInterface interface + Batch func(operations []BatchOperation, opts ...interface{}) (res BatchRes, err error) + BrowseObjects func(opts ...interface{}) (*ObjectIterator, error) + BrowseRules func(opts ...interface{}) (*RuleIterator, error) + BrowseSynonyms func(opts ...interface{}) (*SynonymIterator, error) + ClearObjects func(opts ...interface{}) (res UpdateTaskRes, err error) + ClearRules func(opts ...interface{}) (res UpdateTaskRes, err error) + ClearSynonyms func(opts ...interface{}) (res UpdateTaskRes, err error) + Delete func(opts ...interface{}) (res DeleteTaskRes, err error) + DeleteBy func(opts ...interface{}) (res UpdateTaskRes, err error) + DeleteObject func(objectID string, opts ...interface{}) (res DeleteTaskRes, err error) + DeleteObjects func(objectIDs []string, opts ...interface{}) (res BatchRes, err error) + DeleteRule func(objectID string, opts ...interface{}) (res UpdateTaskRes, err error) + DeleteSynonym func(objectID string, opts ...interface{}) (res DeleteTaskRes, err error) + Exists func() (exists bool, err error) + GetAppID func() string + GetObject func(objectID string, object interface{}, opts ...interface{}) error + GetObjects func(objectIDs []string, objects interface{}, opts ...interface{}) error + GetRule func(objectID string, opts ...interface{}) (rule Rule, err error) + GetSettings func(opts ...interface{}) (settings Settings, err error) + GetStatus func(taskID int) (res TaskStatusRes, err error) + GetSynonym func(objectID string, opts ...interface{}) (synonym Synonym, err error) + PartialUpdateObject func(object interface{}, opts ...interface{}) (res UpdateTaskRes, err error) + PartialUpdateObjects func(objects interface{}, opts ...interface{}) (res GroupBatchRes, err error) + ReplaceAllObjects func(objects interface{}, opts ...interface{}) (*wait.Group, error) + ReplaceAllRules func(rules []Rule, opts ...interface{}) (UpdateTaskRes, error) + ReplaceAllSynonyms func(synonyms []Synonym, opts ...interface{}) (UpdateTaskRes, error) + SaveObject func(object interface{}, opts ...interface{}) (res SaveObjectRes, err error) + SaveObjects func(objects interface{}, opts ...interface{}) (res GroupBatchRes, err error) + SaveRule func(rule Rule, opts ...interface{}) (res UpdateTaskRes, err error) + SaveRules func(rules []Rule, opts ...interface{}) (res UpdateTaskRes, err error) + SaveSynonym func(synonym Synonym, opts ...interface{}) (res UpdateTaskRes, err error) + SaveSynonyms func(synonyms []Synonym, opts ...interface{}) (res UpdateTaskRes, err error) + Search func(query string, opts ...interface{}) (res QueryRes, err error) + SearchForFacetValues func(facet, query string, opts ...interface{}) (res SearchForFacetValuesRes, err error) + SearchRules func(query string, opts ...interface{}) (res SearchRulesRes, err error) + SearchSynonyms func(query string, opts ...interface{}) (res SearchSynonymsRes, err error) + SetSettings func(settings Settings, opts ...interface{}) (res UpdateTaskRes, err error) + WaitTask func(taskID int) error + type IndexOperation struct + Destination string + Operation string + Scopes []string + type IndexRes struct + CreatedAt time.Time + DataSize int64 + Entries int64 + FileSize int64 + LastBuildTime time.Duration + Name string + NumberOfPendingTasks int64 + PendingTask bool + UpdatedAt time.Time + func (r *IndexRes) UnmarshalJSON(data []byte) error + type IndexedGetObject struct + AttributesToRetrieve string + IndexName string + ObjectID string + type IndexedQuery struct + IndexName string + func NewIndexedQuery(index string, opts ...interface{}) IndexedQuery + func (p IndexedQuery) MarshalJSON() ([]byte, error) + type IndexedQueryRes struct + Processed bool + type Key struct + ACL []string + CreatedAt time.Time + Description string + Indexes []string + MaxHitsPerQuery int + MaxQueriesPerIPPerHour int + QueryParameters KeyQueryParams + Referers []string + Validity time.Duration + Value string + func (k *Key) SetQueryParameters(opts ...interface{}) *Key + func (k *Key) UnmarshalJSON(data []byte) error + func (k Key) Equal(k2 Key) bool + func (k Key) MarshalJSON() ([]byte, error) + type KeyQueryParams struct + RestrictSources *opt.RestrictSourcesOption + type ListAPIKeysRes struct + Keys []Key + type ListClustersRes struct + Clusters []Cluster + type ListIndicesRes struct + Items []IndexRes + NbPages int + type ListUserIDsRes struct + HitsPerPage int + Page int + UserIDs []UserID + type LogRes struct + Answer string + AnswerCode int + IP string + Method string + NbAPICalls int + ProcessingTime time.Duration + QueryBody string + QueryHeaders string + QueryNbHits int + SHA1 string + Timestamp time.Time + URL string + func (res *LogRes) UnmarshalJSON(data []byte) error + type MultipleBatchRes struct + ObjectIDs []string + TaskIDs map[string]int + func (r MultipleBatchRes) Wait() error + type MultipleQueriesRes struct + Results []IndexedQueryRes + type ObjectIterator struct + func (it *ObjectIterator) Next(opts ...interface{}) (interface{}, error) + type ObjectWithPosition struct + Object map[string]interface{} + Page int + Position int + type OneWaySynonym struct + Input string + Synonyms []string + func NewOneWaySynonym(objectID, input string, synonyms ...string) OneWaySynonym + func (s *OneWaySynonym) UnmarshalJSON(data []byte) error + func (s OneWaySynonym) MarshalJSON() ([]byte, error) + func (s OneWaySynonym) ObjectID() string + func (s OneWaySynonym) Type() SynonymType + type Placeholder struct + Placeholder string + Replacements []string + func NewPlaceholder(objectID, placeholder string, replacements ...string) Placeholder + func (s *Placeholder) UnmarshalJSON(data []byte) error + func (s Placeholder) MarshalJSON() ([]byte, error) + func (s Placeholder) ObjectID() string + func (s Placeholder) Type() SynonymType + type PromotedObject struct + ObjectID string + Position int + type QueryEdit struct + Delete string + Insert string + Type QueryEditType + func RemoveEdit(word string) QueryEdit + func ReplaceEdit(old, new string) QueryEdit + type QueryEditType string + const Remove + const Replace + type QueryParams struct + AdvancedSyntax *opt.AdvancedSyntaxOption + AdvancedSyntaxFeatures *opt.AdvancedSyntaxFeaturesOption + AllowTyposOnNumericTokens *opt.AllowTyposOnNumericTokensOption + AlternativesAsExact *opt.AlternativesAsExactOption + Analytics *opt.AnalyticsOption + AnalyticsTags *opt.AnalyticsTagsOption + AroundLatLng *opt.AroundLatLngOption + AroundLatLngViaIP *opt.AroundLatLngViaIPOption + AroundPrecision *opt.AroundPrecisionOption + AroundRadius *opt.AroundRadiusOption + AttributeCriteriaComputedByMinProximity *opt.AttributeCriteriaComputedByMinProximityOption + AttributesToHighlight *opt.AttributesToHighlightOption + AttributesToRetrieve *opt.AttributesToRetrieveOption + AttributesToSnippet *opt.AttributesToSnippetOption + ClickAnalytics *opt.ClickAnalyticsOption + DisableExactOnAttributes *opt.DisableExactOnAttributesOption + DisableTypoToleranceOnAttributes *opt.DisableTypoToleranceOnAttributesOption + Distinct *opt.DistinctOption + EnablePersonalization *opt.EnablePersonalizationOption + EnableRules *opt.EnableRulesOption + ExactOnSingleWordQuery *opt.ExactOnSingleWordQueryOption + Explain *opt.ExplainOption + FacetFilters *opt.FacetFiltersOption + FacetingAfterDistinct *opt.FacetingAfterDistinctOption + Facets *opt.FacetsOption + Filters *opt.FiltersOption + GetRankingInfo *opt.GetRankingInfoOption + HighlightPostTag *opt.HighlightPostTagOption + HighlightPreTag *opt.HighlightPreTagOption + HitsPerPage *opt.HitsPerPageOption + IgnorePlurals *opt.IgnorePluralsOption + InsideBoundingBox *opt.InsideBoundingBoxOption + InsidePolygon *opt.InsidePolygonOption + Length *opt.LengthOption + MaxFacetHits *opt.MaxFacetHitsOption + MaxValuesPerFacet *opt.MaxValuesPerFacetOption + MinProximity *opt.MinProximityOption + MinWordSizefor1Typo *opt.MinWordSizefor1TypoOption + MinWordSizefor2Typos *opt.MinWordSizefor2TyposOption + MinimumAroundRadius *opt.MinimumAroundRadiusOption + NumericFilters *opt.NumericFiltersOption + Offset *opt.OffsetOption + OptionalFilters *opt.OptionalFiltersOption + OptionalWords *opt.OptionalWordsOption + Page *opt.PageOption + PercentileComputation *opt.PercentileComputationOption + PersonalizationImpact *opt.PersonalizationImpactOption + QueryLanguages *opt.QueryLanguagesOption + QueryType *opt.QueryTypeOption + RemoveStopWords *opt.RemoveStopWordsOption + RemoveWordsIfNoResults *opt.RemoveWordsIfNoResultsOption + ReplaceSynonymsInHighlight *opt.ReplaceSynonymsInHighlightOption + ResponseFields *opt.ResponseFieldsOption + RestrictHighlightAndSnippetArrays *opt.RestrictHighlightAndSnippetArraysOption + RestrictSearchableAttributes *opt.RestrictSearchableAttributesOption + RuleContexts *opt.RuleContextsOption + SimilarQuery *opt.SimilarQueryOption + SnippetEllipsisText *opt.SnippetEllipsisTextOption + SortFacetValuesBy *opt.SortFacetValuesByOption + SumOrFiltersScores *opt.SumOrFiltersScoresOption + Synonyms *opt.SynonymsOption + TagFilters *opt.TagFiltersOption + TypoTolerance *opt.TypoToleranceOption + UserToken *opt.UserTokenOption + type QueryRes struct + ABTestVariantID int + AppliedRules []AppliedRule + AroundLatLng string + AutomaticRadius string + ExhaustiveFacetsCount bool + ExhaustiveNbHits bool + Explain map[string]map[string]interface{} + Facets map[string]map[string]int + FacetsStats map[string]FacetStat + Hits []map[string]interface{} + HitsPerPage int + Index string + IndexUsed string + Length int + Message string + NbHits int + NbPages int + Offset int + Page int + Params string + ParsedQuery string + ProcessingTimeMS int + Query string + QueryAfterRemoval string + QueryID string + ServerUsed string + TimeoutCounts bool + TimeoutHits bool + UserData []interface{} + func (r QueryRes) GetObjectIDPosition(objectID string) int + func (r QueryRes) GetObjectPosition(objectID string) int + func (r QueryRes) UnmarshalHits(v interface{}) error + func (r QueryRes) UnmarshalUserData(v interface{}) error + type RankingInfo struct + Filters int + FirstMatchedWord int + GeoDistance int + GeoPrecision int + NbExactWords int + NbTypos int + ProximityDistance int + UserScore int + Words int + type RegularSynonym struct + Synonyms []string + func NewRegularSynonym(objectID string, synonyms ...string) RegularSynonym + func (s *RegularSynonym) UnmarshalJSON(data []byte) error + func (s RegularSynonym) MarshalJSON() ([]byte, error) + func (s RegularSynonym) ObjectID() string + func (s RegularSynonym) Type() SynonymType + type RemoveUserIDRes struct + DeletedAt string + type RestoreKeyRes struct + CreatedAt time.Time + func (r RestoreKeyRes) Wait() error + type Rule struct + Condition RuleCondition + Consequence RuleConsequence + Description string + Enabled *opt.EnabledOption + ObjectID string + Validity []TimeRange + func (r Rule) Equal(r2 Rule) bool + type RuleCondition struct + Alternatives *Alternatives + Anchoring RulePatternAnchoring + Context string + Pattern string + type RuleConsequence struct + Hide []HiddenObject + Params *RuleParams + Promote []PromotedObject + UserData interface{} + type RuleIterator struct + func (it *RuleIterator) Next(opts ...interface{}) (*Rule, error) + type RuleParams struct + AutomaticFacetFilters []AutomaticFacetFilter + AutomaticOptionalFacetFilters []AutomaticFacetFilter + Query *RuleQuery + type RulePatternAnchoring string + const Contains + const EndsWith + const Is + const StartsWith + type RuleQuery struct + func NewRuleQueryObject(object RuleQueryObjectQuery) *RuleQuery + func NewRuleQuerySimple(query string) *RuleQuery + func (q *RuleQuery) UnmarshalJSON(data []byte) error + func (q RuleQuery) Get() (string, *RuleQueryObjectQuery) + func (q RuleQuery) MarshalJSON() ([]byte, error) + type RuleQueryObjectQuery struct + Edits []QueryEdit + type SaveObjectRes struct + CreatedAt time.Time + ObjectID string + TaskID int + func (r SaveObjectRes) Wait() error + type SearchForFacetValuesRes struct + ExhaustiveFacetsCount bool + FacetHits []FacetHit + ProcessingTime time.Duration + func (r *SearchForFacetValuesRes) UnmarshalJSON(data []byte) error + type SearchRulesRes struct + Hits interface{} + NbHits int + NbPages int + Page int + func (r SearchRulesRes) Rules() (rules []Rule, err error) + func (r SearchRulesRes) UnmarshalHits(v interface{}) error + type SearchSynonymsRes struct + Hits []map[string]interface{} + NbHits int + func (r SearchSynonymsRes) Synonyms() ([]Synonym, error) + type SearchUserIDRes struct + Hits []UserIDHit + HitsPerPage int + NbHits int + Page int + UpdatedAt int + type SetPersonalizationStrategyRes struct + UpdatedAt time.Time + type Settings struct + Advanced *opt.AdvancedOption + AdvancedSyntax *opt.AdvancedSyntaxOption + AdvancedSyntaxFeatures *opt.AdvancedSyntaxFeaturesOption + AllowCompressionOfIntegerArray *opt.AllowCompressionOfIntegerArrayOption + AllowTyposOnNumericTokens *opt.AllowTyposOnNumericTokensOption + AlternativesAsExact *opt.AlternativesAsExactOption + AttributeCriteriaComputedByMinProximity *opt.AttributeCriteriaComputedByMinProximityOption + AttributeForDistinct *opt.AttributeForDistinctOption + AttributesForFaceting *opt.AttributesForFacetingOption + AttributesToHighlight *opt.AttributesToHighlightOption + AttributesToRetrieve *opt.AttributesToRetrieveOption + AttributesToSnippet *opt.AttributesToSnippetOption + CamelCaseAttributes *opt.CamelCaseAttributesOption + CustomRanking *opt.CustomRankingOption + CustomSettings map[string]interface{} + DecompoundedAttributes *opt.DecompoundedAttributesOption + DisableExactOnAttributes *opt.DisableExactOnAttributesOption + DisablePrefixOnAttributes *opt.DisablePrefixOnAttributesOption + DisableTypoToleranceOnAttributes *opt.DisableTypoToleranceOnAttributesOption + DisableTypoToleranceOnWords *opt.DisableTypoToleranceOnWordsOption + Distinct *opt.DistinctOption + EnableRules *opt.EnableRulesOption + ExactOnSingleWordQuery *opt.ExactOnSingleWordQueryOption + HighlightPostTag *opt.HighlightPostTagOption + HighlightPreTag *opt.HighlightPreTagOption + HitsPerPage *opt.HitsPerPageOption + IgnorePlurals *opt.IgnorePluralsOption + IndexLanguages *opt.IndexLanguagesOption + KeepDiacriticsOnCharacters *opt.KeepDiacriticsOnCharactersOption + MaxFacetHits *opt.MaxFacetHitsOption + MaxValuesPerFacet *opt.MaxValuesPerFacetOption + MinProximity *opt.MinProximityOption + MinWordSizefor1Typo *opt.MinWordSizefor1TypoOption + MinWordSizefor2Typos *opt.MinWordSizefor2TyposOption + NumericAttributesForFiltering *opt.NumericAttributesForFilteringOption + OptionalWords *opt.OptionalWordsOption + PaginationLimitedTo *opt.PaginationLimitedToOption + Primary *opt.PrimaryOption + QueryLanguages *opt.QueryLanguagesOption + QueryType *opt.QueryTypeOption + Ranking *opt.RankingOption + RemoveStopWords *opt.RemoveStopWordsOption + RemoveWordsIfNoResults *opt.RemoveWordsIfNoResultsOption + ReplaceSynonymsInHighlight *opt.ReplaceSynonymsInHighlightOption + Replicas *opt.ReplicasOption + ResponseFields *opt.ResponseFieldsOption + RestrictHighlightAndSnippetArrays *opt.RestrictHighlightAndSnippetArraysOption + SearchableAttributes *opt.SearchableAttributesOption + SeparatorsToIndex *opt.SeparatorsToIndexOption + SnippetEllipsisText *opt.SnippetEllipsisTextOption + SortFacetValuesBy *opt.SortFacetValuesByOption + TypoTolerance *opt.TypoToleranceOption + UnretrievableAttributes *opt.UnretrievableAttributesOption + UserData *opt.UserDataOption + func (s *Settings) UnmarshalJSON(data []byte) error + func (s Settings) Equal(s2 Settings) bool + func (s Settings) MarshalJSON() ([]byte, error) + func (s Settings) String() string + type Strategy struct + EventsScoring map[string]EventsScoring + FacetsScoring map[string]FacetsScoring + type Synonym interface + ObjectID func() string + Type func() SynonymType + type SynonymIterator struct + func (it *SynonymIterator) Next(opts ...interface{}) (Synonym, error) + type SynonymType string + const AltCorrection1Type + const AltCorrection2Type + const OneWaySynonymType + const PlaceholderType + const RegularSynonymType + type TaskStatusRes struct + PendingTask bool + Status string + type TimeRange struct + From time.Time + Until time.Time + func (r *TimeRange) UnmarshalJSON(b []byte) error + func (r TimeRange) Equal(r2 TimeRange) bool + func (r TimeRange) MarshalJSON() ([]byte, error) + type TopUserIDs struct + PerCluster map[string][]UserIDCore + type UpdateKeyRes struct + Key string + UpdatedAt time.Time + func (r UpdateKeyRes) Wait() error + type UpdateTaskRes struct + TaskID int + UpdatedAt time.Time + func (r UpdateTaskRes) Wait() error + type UserID struct + ClusterName string + type UserIDCore struct + DataSize int + ID string + NbRecords int + type UserIDHit struct + HighlightResult interface{} + ObjectID string + func (h UserIDHit) UnmarshalHighlightResult(v interface{}) error
Go to main page