package
2.28.0+incompatible
Repository: https://github.com/algolia/algoliasearch-client-go.git
Documentation: pkg.go.dev

# Packages

No description provided by the author

# Functions

No description provided by the author
No description provided by the author
No description provided by the author
DeleteEdit returns a new `Edit` instance used to remove the given `word` from an original query when used as a `RuleConsequence.Params`.
GenerateSecuredAPIKey generates a public API key intended to restrict access to certain records.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
NewClient instantiates a new `Client` from the provided `appID` and `apiKey`.
NewClientWithHosts instantiates a new `Client` from the provided `appID` and `apiKey`.
NewIndex instantiates a new `Index`.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
NewRuleCondition generates a RuleCondition where all the possible fields can be specified.
NewRuleIterator returns a new RuleIterator that will iterate over all the rules of the declared index.
NewSimpleRuleCondition generates a RuleCondition where only the `Anchoring` and `Pattern` fields are specified.
No description provided by the author
NewSynonymIterator returns a new SynonymIterator that will iterate over all the synonyms of the declared index.
NewTransport instantiates a new Transport with the default Algolia hosts to connect to.
NewTransport instantiates a new Transport with the specificed hosts as main servers to connect to.
No description provided by the author
ReplaceEdit returns a new `Edit` instance used to replace the given `old` term with `new` in a query when used as a `RuleConsequence.Params`.

# Constants

No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author

# Variables

No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author

# Structs

No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
AutomaticFacetFilter.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
NetError is used internally to differente regular error from errors following the net.Error interface in order to propagate them with a custom message.
No description provided by the author
No description provided by the author
QueryIncrementalEdit can be used as a value for the `query` key when used in the `RuleConsequence.Params` map.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
RuleCondition is the part of an Algolia Rule which describes the condition for the rule.
No description provided by the author
RuleIterator is the exposed structure to iterate over all the rules of an index.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
Settings is the structure returned by `GetSettigs` to ease the use of the index settings.
No description provided by the author
No description provided by the author
SynonymIterator is the exposed structure to iterate over all the synonyms of an index.
No description provided by the author
No description provided by the author
No description provided by the author
Transport is responsible for the connection and the retry strategy to Algolia servers.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author

# Interfaces

AccountClient is responsible for handling cross-application operations.
No description provided by the author
Client is a representation of an Algolia application.
Index is a representation used to manipulate an Algolia index.
IndexIterator is used by the BrowseAll functions to iterate over all the records of an index (or a subset according to what the query and the params are).
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author

# Type aliases

No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author