composition

package
v4.39.1 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: May 5, 2026 License: MIT Imports: 16 Imported by: 0

Documentation

Overview

Code generated by OpenAPI Generator (https://openapi-generator.tech), manual changes will be lost - read more on https://github.com/algolia/api-clients-automation. DO NOT EDIT.

Code generated by OpenAPI Generator (https://openapi-generator.tech), manual changes will be lost - read more on https://github.com/algolia/api-clients-automation. DO NOT EDIT.

Code generated by OpenAPI Generator (https://openapi-generator.tech), manual changes will be lost - read more on https://github.com/algolia/api-clients-automation. DO NOT EDIT.

Code generated by OpenAPI Generator (https://openapi-generator.tech), manual changes will be lost - read more on https://github.com/algolia/api-clients-automation. DO NOT EDIT.

Code generated by OpenAPI Generator (https://openapi-generator.tech), manual changes will be lost - read more on https://github.com/algolia/api-clients-automation. DO NOT EDIT.

Code generated by OpenAPI Generator (https://openapi-generator.tech), manual changes will be lost - read more on https://github.com/algolia/api-clients-automation. DO NOT EDIT.

Code generated by OpenAPI Generator (https://openapi-generator.tech), manual changes will be lost - read more on https://github.com/algolia/api-clients-automation. DO NOT EDIT.

Code generated by OpenAPI Generator (https://openapi-generator.tech), manual changes will be lost - read more on https://github.com/algolia/api-clients-automation. DO NOT EDIT.

Code generated by OpenAPI Generator (https://openapi-generator.tech), manual changes will be lost - read more on https://github.com/algolia/api-clients-automation. DO NOT EDIT.

Code generated by OpenAPI Generator (https://openapi-generator.tech), manual changes will be lost - read more on https://github.com/algolia/api-clients-automation. DO NOT EDIT.

Code generated by OpenAPI Generator (https://openapi-generator.tech), manual changes will be lost - read more on https://github.com/algolia/api-clients-automation. DO NOT EDIT.

Code generated by OpenAPI Generator (https://openapi-generator.tech), manual changes will be lost - read more on https://github.com/algolia/api-clients-automation. DO NOT EDIT.

Code generated by OpenAPI Generator (https://openapi-generator.tech), manual changes will be lost - read more on https://github.com/algolia/api-clients-automation. DO NOT EDIT.

Code generated by OpenAPI Generator (https://openapi-generator.tech), manual changes will be lost - read more on https://github.com/algolia/api-clients-automation. DO NOT EDIT.

Code generated by OpenAPI Generator (https://openapi-generator.tech), manual changes will be lost - read more on https://github.com/algolia/api-clients-automation. DO NOT EDIT.

Code generated by OpenAPI Generator (https://openapi-generator.tech), manual changes will be lost - read more on https://github.com/algolia/api-clients-automation. DO NOT EDIT.

Code generated by OpenAPI Generator (https://openapi-generator.tech), manual changes will be lost - read more on https://github.com/algolia/api-clients-automation. DO NOT EDIT.

Code generated by OpenAPI Generator (https://openapi-generator.tech), manual changes will be lost - read more on https://github.com/algolia/api-clients-automation. DO NOT EDIT.

Code generated by OpenAPI Generator (https://openapi-generator.tech), manual changes will be lost - read more on https://github.com/algolia/api-clients-automation. DO NOT EDIT.

Code generated by OpenAPI Generator (https://openapi-generator.tech), manual changes will be lost - read more on https://github.com/algolia/api-clients-automation. DO NOT EDIT.

Code generated by OpenAPI Generator (https://openapi-generator.tech), manual changes will be lost - read more on https://github.com/algolia/api-clients-automation. DO NOT EDIT.

Code generated by OpenAPI Generator (https://openapi-generator.tech), manual changes will be lost - read more on https://github.com/algolia/api-clients-automation. DO NOT EDIT.

Code generated by OpenAPI Generator (https://openapi-generator.tech), manual changes will be lost - read more on https://github.com/algolia/api-clients-automation. DO NOT EDIT.

Code generated by OpenAPI Generator (https://openapi-generator.tech), manual changes will be lost - read more on https://github.com/algolia/api-clients-automation. DO NOT EDIT.

Code generated by OpenAPI Generator (https://openapi-generator.tech), manual changes will be lost - read more on https://github.com/algolia/api-clients-automation. DO NOT EDIT.

Code generated by OpenAPI Generator (https://openapi-generator.tech), manual changes will be lost - read more on https://github.com/algolia/api-clients-automation. DO NOT EDIT.

Code generated by OpenAPI Generator (https://openapi-generator.tech), manual changes will be lost - read more on https://github.com/algolia/api-clients-automation. DO NOT EDIT.

Code generated by OpenAPI Generator (https://openapi-generator.tech), manual changes will be lost - read more on https://github.com/algolia/api-clients-automation. DO NOT EDIT.

Code generated by OpenAPI Generator (https://openapi-generator.tech), manual changes will be lost - read more on https://github.com/algolia/api-clients-automation. DO NOT EDIT.

Code generated by OpenAPI Generator (https://openapi-generator.tech), manual changes will be lost - read more on https://github.com/algolia/api-clients-automation. DO NOT EDIT.

Code generated by OpenAPI Generator (https://openapi-generator.tech), manual changes will be lost - read more on https://github.com/algolia/api-clients-automation. DO NOT EDIT.

Code generated by OpenAPI Generator (https://openapi-generator.tech), manual changes will be lost - read more on https://github.com/algolia/api-clients-automation. DO NOT EDIT.

Code generated by OpenAPI Generator (https://openapi-generator.tech), manual changes will be lost - read more on https://github.com/algolia/api-clients-automation. DO NOT EDIT.

Code generated by OpenAPI Generator (https://openapi-generator.tech), manual changes will be lost - read more on https://github.com/algolia/api-clients-automation. DO NOT EDIT.

Code generated by OpenAPI Generator (https://openapi-generator.tech), manual changes will be lost - read more on https://github.com/algolia/api-clients-automation. DO NOT EDIT.

Code generated by OpenAPI Generator (https://openapi-generator.tech), manual changes will be lost - read more on https://github.com/algolia/api-clients-automation. DO NOT EDIT.

Code generated by OpenAPI Generator (https://openapi-generator.tech), manual changes will be lost - read more on https://github.com/algolia/api-clients-automation. DO NOT EDIT.

Code generated by OpenAPI Generator (https://openapi-generator.tech), manual changes will be lost - read more on https://github.com/algolia/api-clients-automation. DO NOT EDIT.

Code generated by OpenAPI Generator (https://openapi-generator.tech), manual changes will be lost - read more on https://github.com/algolia/api-clients-automation. DO NOT EDIT.

Code generated by OpenAPI Generator (https://openapi-generator.tech), manual changes will be lost - read more on https://github.com/algolia/api-clients-automation. DO NOT EDIT.

Code generated by OpenAPI Generator (https://openapi-generator.tech), manual changes will be lost - read more on https://github.com/algolia/api-clients-automation. DO NOT EDIT.

Code generated by OpenAPI Generator (https://openapi-generator.tech), manual changes will be lost - read more on https://github.com/algolia/api-clients-automation. DO NOT EDIT.

Code generated by OpenAPI Generator (https://openapi-generator.tech), manual changes will be lost - read more on https://github.com/algolia/api-clients-automation. DO NOT EDIT.

Code generated by OpenAPI Generator (https://openapi-generator.tech), manual changes will be lost - read more on https://github.com/algolia/api-clients-automation. DO NOT EDIT.

Code generated by OpenAPI Generator (https://openapi-generator.tech), manual changes will be lost - read more on https://github.com/algolia/api-clients-automation. DO NOT EDIT.

Code generated by OpenAPI Generator (https://openapi-generator.tech), manual changes will be lost - read more on https://github.com/algolia/api-clients-automation. DO NOT EDIT.

Code generated by OpenAPI Generator (https://openapi-generator.tech), manual changes will be lost - read more on https://github.com/algolia/api-clients-automation. DO NOT EDIT.

Code generated by OpenAPI Generator (https://openapi-generator.tech), manual changes will be lost - read more on https://github.com/algolia/api-clients-automation. DO NOT EDIT.

Code generated by OpenAPI Generator (https://openapi-generator.tech), manual changes will be lost - read more on https://github.com/algolia/api-clients-automation. DO NOT EDIT.

Code generated by OpenAPI Generator (https://openapi-generator.tech), manual changes will be lost - read more on https://github.com/algolia/api-clients-automation. DO NOT EDIT.

Code generated by OpenAPI Generator (https://openapi-generator.tech), manual changes will be lost - read more on https://github.com/algolia/api-clients-automation. DO NOT EDIT.

Code generated by OpenAPI Generator (https://openapi-generator.tech), manual changes will be lost - read more on https://github.com/algolia/api-clients-automation. DO NOT EDIT.

Code generated by OpenAPI Generator (https://openapi-generator.tech), manual changes will be lost - read more on https://github.com/algolia/api-clients-automation. DO NOT EDIT.

Code generated by OpenAPI Generator (https://openapi-generator.tech), manual changes will be lost - read more on https://github.com/algolia/api-clients-automation. DO NOT EDIT.

Code generated by OpenAPI Generator (https://openapi-generator.tech), manual changes will be lost - read more on https://github.com/algolia/api-clients-automation. DO NOT EDIT.

Code generated by OpenAPI Generator (https://openapi-generator.tech), manual changes will be lost - read more on https://github.com/algolia/api-clients-automation. DO NOT EDIT.

Code generated by OpenAPI Generator (https://openapi-generator.tech), manual changes will be lost - read more on https://github.com/algolia/api-clients-automation. DO NOT EDIT.

Code generated by OpenAPI Generator (https://openapi-generator.tech), manual changes will be lost - read more on https://github.com/algolia/api-clients-automation. DO NOT EDIT.

Code generated by OpenAPI Generator (https://openapi-generator.tech), manual changes will be lost - read more on https://github.com/algolia/api-clients-automation. DO NOT EDIT.

Code generated by OpenAPI Generator (https://openapi-generator.tech), manual changes will be lost - read more on https://github.com/algolia/api-clients-automation. DO NOT EDIT.

Code generated by OpenAPI Generator (https://openapi-generator.tech), manual changes will be lost - read more on https://github.com/algolia/api-clients-automation. DO NOT EDIT.

Code generated by OpenAPI Generator (https://openapi-generator.tech), manual changes will be lost - read more on https://github.com/algolia/api-clients-automation. DO NOT EDIT.

Code generated by OpenAPI Generator (https://openapi-generator.tech), manual changes will be lost - read more on https://github.com/algolia/api-clients-automation. DO NOT EDIT.

Code generated by OpenAPI Generator (https://openapi-generator.tech), manual changes will be lost - read more on https://github.com/algolia/api-clients-automation. DO NOT EDIT.

Code generated by OpenAPI Generator (https://openapi-generator.tech), manual changes will be lost - read more on https://github.com/algolia/api-clients-automation. DO NOT EDIT.

Code generated by OpenAPI Generator (https://openapi-generator.tech), manual changes will be lost - read more on https://github.com/algolia/api-clients-automation. DO NOT EDIT.

Code generated by OpenAPI Generator (https://openapi-generator.tech), manual changes will be lost - read more on https://github.com/algolia/api-clients-automation. DO NOT EDIT.

Code generated by OpenAPI Generator (https://openapi-generator.tech), manual changes will be lost - read more on https://github.com/algolia/api-clients-automation. DO NOT EDIT.

Code generated by OpenAPI Generator (https://openapi-generator.tech), manual changes will be lost - read more on https://github.com/algolia/api-clients-automation. DO NOT EDIT.

Code generated by OpenAPI Generator (https://openapi-generator.tech), manual changes will be lost - read more on https://github.com/algolia/api-clients-automation. DO NOT EDIT.

Code generated by OpenAPI Generator (https://openapi-generator.tech), manual changes will be lost - read more on https://github.com/algolia/api-clients-automation. DO NOT EDIT.

Code generated by OpenAPI Generator (https://openapi-generator.tech), manual changes will be lost - read more on https://github.com/algolia/api-clients-automation. DO NOT EDIT.

Code generated by OpenAPI Generator (https://openapi-generator.tech), manual changes will be lost - read more on https://github.com/algolia/api-clients-automation. DO NOT EDIT.

Code generated by OpenAPI Generator (https://openapi-generator.tech), manual changes will be lost - read more on https://github.com/algolia/api-clients-automation. DO NOT EDIT.

Code generated by OpenAPI Generator (https://openapi-generator.tech), manual changes will be lost - read more on https://github.com/algolia/api-clients-automation. DO NOT EDIT.

Code generated by OpenAPI Generator (https://openapi-generator.tech), manual changes will be lost - read more on https://github.com/algolia/api-clients-automation. DO NOT EDIT.

Code generated by OpenAPI Generator (https://openapi-generator.tech), manual changes will be lost - read more on https://github.com/algolia/api-clients-automation. DO NOT EDIT.

Code generated by OpenAPI Generator (https://openapi-generator.tech), manual changes will be lost - read more on https://github.com/algolia/api-clients-automation. DO NOT EDIT.

Code generated by OpenAPI Generator (https://openapi-generator.tech), manual changes will be lost - read more on https://github.com/algolia/api-clients-automation. DO NOT EDIT.

Code generated by OpenAPI Generator (https://openapi-generator.tech), manual changes will be lost - read more on https://github.com/algolia/api-clients-automation. DO NOT EDIT.

Code generated by OpenAPI Generator (https://openapi-generator.tech), manual changes will be lost - read more on https://github.com/algolia/api-clients-automation. DO NOT EDIT.

Code generated by OpenAPI Generator (https://openapi-generator.tech), manual changes will be lost - read more on https://github.com/algolia/api-clients-automation. DO NOT EDIT.

Code generated by OpenAPI Generator (https://openapi-generator.tech), manual changes will be lost - read more on https://github.com/algolia/api-clients-automation. DO NOT EDIT.

Code generated by OpenAPI Generator (https://openapi-generator.tech), manual changes will be lost - read more on https://github.com/algolia/api-clients-automation. DO NOT EDIT.

Code generated by OpenAPI Generator (https://openapi-generator.tech), manual changes will be lost - read more on https://github.com/algolia/api-clients-automation. DO NOT EDIT.

Code generated by OpenAPI Generator (https://openapi-generator.tech), manual changes will be lost - read more on https://github.com/algolia/api-clients-automation. DO NOT EDIT.

Code generated by OpenAPI Generator (https://openapi-generator.tech), manual changes will be lost - read more on https://github.com/algolia/api-clients-automation. DO NOT EDIT.

Code generated by OpenAPI Generator (https://openapi-generator.tech), manual changes will be lost - read more on https://github.com/algolia/api-clients-automation. DO NOT EDIT.

Code generated by OpenAPI Generator (https://openapi-generator.tech), manual changes will be lost - read more on https://github.com/algolia/api-clients-automation. DO NOT EDIT.

Code generated by OpenAPI Generator (https://openapi-generator.tech), manual changes will be lost - read more on https://github.com/algolia/api-clients-automation. DO NOT EDIT.

Code generated by OpenAPI Generator (https://openapi-generator.tech), manual changes will be lost - read more on https://github.com/algolia/api-clients-automation. DO NOT EDIT.

Code generated by OpenAPI Generator (https://openapi-generator.tech), manual changes will be lost - read more on https://github.com/algolia/api-clients-automation. DO NOT EDIT.

Code generated by OpenAPI Generator (https://openapi-generator.tech), manual changes will be lost - read more on https://github.com/algolia/api-clients-automation. DO NOT EDIT.

Code generated by OpenAPI Generator (https://openapi-generator.tech), manual changes will be lost - read more on https://github.com/algolia/api-clients-automation. DO NOT EDIT.

Code generated by OpenAPI Generator (https://openapi-generator.tech), manual changes will be lost - read more on https://github.com/algolia/api-clients-automation. DO NOT EDIT.

Code generated by OpenAPI Generator (https://openapi-generator.tech), manual changes will be lost - read more on https://github.com/algolia/api-clients-automation. DO NOT EDIT.

Code generated by OpenAPI Generator (https://openapi-generator.tech), manual changes will be lost - read more on https://github.com/algolia/api-clients-automation. DO NOT EDIT.

Code generated by OpenAPI Generator (https://openapi-generator.tech), manual changes will be lost - read more on https://github.com/algolia/api-clients-automation. DO NOT EDIT.

Code generated by OpenAPI Generator (https://openapi-generator.tech), manual changes will be lost - read more on https://github.com/algolia/api-clients-automation. DO NOT EDIT.

Code generated by OpenAPI Generator (https://openapi-generator.tech), manual changes will be lost - read more on https://github.com/algolia/api-clients-automation. DO NOT EDIT.

Code generated by OpenAPI Generator (https://openapi-generator.tech), manual changes will be lost - read more on https://github.com/algolia/api-clients-automation. DO NOT EDIT.

Code generated by OpenAPI Generator (https://openapi-generator.tech), manual changes will be lost - read more on https://github.com/algolia/api-clients-automation. DO NOT EDIT.

Code generated by OpenAPI Generator (https://openapi-generator.tech), manual changes will be lost - read more on https://github.com/algolia/api-clients-automation. DO NOT EDIT.

Code generated by OpenAPI Generator (https://openapi-generator.tech), manual changes will be lost - read more on https://github.com/algolia/api-clients-automation. DO NOT EDIT.

Code generated by OpenAPI Generator (https://openapi-generator.tech), manual changes will be lost - read more on https://github.com/algolia/api-clients-automation. DO NOT EDIT.

Code generated by OpenAPI Generator (https://openapi-generator.tech), manual changes will be lost - read more on https://github.com/algolia/api-clients-automation. DO NOT EDIT.

Code generated by OpenAPI Generator (https://openapi-generator.tech), manual changes will be lost - read more on https://github.com/algolia/api-clients-automation. DO NOT EDIT.

Code generated by OpenAPI Generator (https://openapi-generator.tech), manual changes will be lost - read more on https://github.com/algolia/api-clients-automation. DO NOT EDIT.

Code generated by OpenAPI Generator (https://openapi-generator.tech), manual changes will be lost - read more on https://github.com/algolia/api-clients-automation. DO NOT EDIT.

Code generated by OpenAPI Generator (https://openapi-generator.tech), manual changes will be lost - read more on https://github.com/algolia/api-clients-automation. DO NOT EDIT.

Code generated by OpenAPI Generator (https://openapi-generator.tech), manual changes will be lost - read more on https://github.com/algolia/api-clients-automation. DO NOT EDIT.

Code generated by OpenAPI Generator (https://openapi-generator.tech), manual changes will be lost - read more on https://github.com/algolia/api-clients-automation. DO NOT EDIT.

Code generated by OpenAPI Generator (https://openapi-generator.tech), manual changes will be lost - read more on https://github.com/algolia/api-clients-automation. DO NOT EDIT.

Code generated by OpenAPI Generator (https://openapi-generator.tech), manual changes will be lost - read more on https://github.com/algolia/api-clients-automation. DO NOT EDIT.

Code generated by OpenAPI Generator (https://openapi-generator.tech), manual changes will be lost - read more on https://github.com/algolia/api-clients-automation. DO NOT EDIT.

Code generated by OpenAPI Generator (https://openapi-generator.tech), manual changes will be lost - read more on https://github.com/algolia/api-clients-automation. DO NOT EDIT.

Code generated by OpenAPI Generator (https://openapi-generator.tech), manual changes will be lost - read more on https://github.com/algolia/api-clients-automation. DO NOT EDIT.

Code generated by OpenAPI Generator (https://openapi-generator.tech), manual changes will be lost - read more on https://github.com/algolia/api-clients-automation. DO NOT EDIT.

Code generated by OpenAPI Generator (https://openapi-generator.tech), manual changes will be lost - read more on https://github.com/algolia/api-clients-automation. DO NOT EDIT.

Code generated by OpenAPI Generator (https://openapi-generator.tech), manual changes will be lost - read more on https://github.com/algolia/api-clients-automation. DO NOT EDIT.

Index

Constants

This section is empty.

Variables

View Source 
var AllowedActionEnumValues = []Action{
	"upsert",
	"delete",
}

All allowed values of Action enum.

View Source 
var AllowedAdvancedSyntaxFeaturesEnumValues = []AdvancedSyntaxFeatures{
	"exactPhrase",
	"excludeWords",
}

All allowed values of AdvancedSyntaxFeatures enum.

View Source 
var AllowedAlternativesAsExactEnumValues = []AlternativesAsExact{
	"ignorePlurals",
	"singleWordSynonym",
	"multiWordsSynonym",
	"ignoreConjugations",
}

All allowed values of AlternativesAsExact enum.

View Source 
var AllowedAnchoringEnumValues = []Anchoring{
	"is",
	"startsWith",
	"endsWith",
	"contains",
}

All allowed values of Anchoring enum.

View Source 
var AllowedAroundRadiusAllEnumValues = []AroundRadiusAll{
	"all",
}

All allowed values of AroundRadiusAll enum.

View Source 
var AllowedBooleanStringEnumValues = []BooleanString{
	"true",
	"false",
}

All allowed values of BooleanString enum.

View Source 
var AllowedDedupPositioningEnumValues = []DedupPositioning{
	"highest",
	"highestInjected",
}

All allowed values of DedupPositioning enum.

View Source 
var AllowedExactOnSingleWordQueryEnumValues = []ExactOnSingleWordQuery{
	"attribute",
	"none",
	"word",
}

All allowed values of ExactOnSingleWordQuery enum.

View Source 
var AllowedExternalOrderingEnumValues = []ExternalOrdering{
	"default",
	"userDefined",
}

All allowed values of ExternalOrdering enum.

View Source 
var AllowedMatchLevelEnumValues = []MatchLevel{
	"none",
	"partial",
	"full",
}

All allowed values of MatchLevel enum.

View Source 
var AllowedModelEnumValues = []Model{
	"trending-items",
}

All allowed values of Model enum.

View Source 
var AllowedQueryTypeEnumValues = []QueryType{
	"prefixLast",
	"prefixAll",
	"prefixNone",
}

All allowed values of QueryType enum.

View Source 
var AllowedRemoveWordsIfNoResultsEnumValues = []RemoveWordsIfNoResults{
	"none",
	"lastWords",
	"firstWords",
	"allOptional",
}

All allowed values of RemoveWordsIfNoResults enum.

View Source 
var AllowedSortRemainingByEnumValues = []SortRemainingBy{
	"count",
	"alpha",
	"hidden",
}

All allowed values of SortRemainingBy enum.

View Source 
var AllowedSupportedLanguageEnumValues = []SupportedLanguage{
	"af",
	"ar",
	"az",
	"bg",
	"bn",
	"ca",
	"cs",
	"cy",
	"da",
	"de",
	"el",
	"en",
	"eo",
	"es",
	"et",
	"eu",
	"fa",
	"fi",
	"fo",
	"fr",
	"ga",
	"gl",
	"he",
	"hi",
	"hu",
	"hy",
	"id",
	"is",
	"it",
	"ja",
	"ka",
	"kk",
	"ko",
	"ku",
	"ky",
	"lt",
	"lv",
	"mi",
	"mn",
	"mr",
	"ms",
	"mt",
	"nb",
	"nl",
	"no",
	"ns",
	"pl",
	"ps",
	"pt",
	"pt-br",
	"qu",
	"ro",
	"ru",
	"sk",
	"sq",
	"sv",
	"sw",
	"ta",
	"te",
	"th",
	"tl",
	"tn",
	"tr",
	"tt",
	"uk",
	"ur",
	"uz",
	"zh",
}

All allowed values of SupportedLanguage enum.

View Source 
var AllowedTaskStatusEnumValues = []TaskStatus{
	"published",
	"notPublished",
}

All allowed values of TaskStatus enum.

View Source 
var AllowedTypoToleranceEnumEnumValues = []TypoToleranceEnum{
	"min",
	"strict",
	"true",
	"false",
}

All allowed values of TypoToleranceEnum enum.

Functions

func WithBodyParam added in v4.35.0 

func WithBodyParam(key string, value any) requestOption

WithBodyParam adds a single custom parameter to the request body. For write requests (POST, PUT, PATCH, DELETE), the param is merged into the body. For read requests (GET), the param is converted to a query parameter. Custom values override typed values when keys conflict.

func WithBodyParams added in v4.35.0 

func WithBodyParams(params map[string]any) requestOption

WithBodyParams adds multiple custom parameters to the request body. Parameters are deep-merged into the typed request body. For write requests, params are merged into the body. For read requests, params are converted to query parameters. Custom values override typed values when keys conflict.

func WithConnectTimeout 

func WithConnectTimeout(timeout time.Duration) requestOption

func WithContext 

func WithContext(ctx context.Context) requestOption

func WithHeaderParam 

func WithHeaderParam(key string, value any) requestOption

func WithQueryParam 

func WithQueryParam(key string, value any) requestOption

func WithReadTimeout 

func WithReadTimeout(timeout time.Duration) requestOption

func WithWriteTimeout 

func WithWriteTimeout(timeout time.Duration) requestOption

Types

type APIClient 

type APIClient struct {
	// contains filtered or unexported fields
}

APIClient manages communication with the Composition API API v1.0.0 In most cases there should be only one, shared, APIClient.

func NewClient 

func NewClient(appID, apiKey string) (*APIClient, error)

NewClient creates a new API client with appID and apiKey.

func NewClientWithConfig 

func NewClientWithConfig(cfg CompositionConfiguration) (*APIClient, error)

NewClientWithConfig creates a new API client with the given configuration to fully customize the client behaviour.

func (*APIClient) AddDefaultHeader 

func (c *APIClient) AddDefaultHeader(key string, value string)

AddDefaultHeader adds a new HTTP header to the default header in the request.

func (*APIClient) CustomDelete added in v4.26.0 

func (c *APIClient) CustomDelete(r ApiCustomDeleteRequest, opts ...RequestOption) (*map[string]any, error)

CustomDelete casts the HTTP response body to a defined struct.

This method lets you send requests to the Algolia REST API.

Request can be constructed by NewApiCustomDeleteRequest with parameters below. 

@param path string - Path of the endpoint, for example `1/newFeature`.
@param parameters map[string]any - Query parameters to apply to the current query.
@return map[string]any

func (*APIClient) CustomDeleteWithHTTPInfo added in v4.26.0 

func (c *APIClient) CustomDeleteWithHTTPInfo(r ApiCustomDeleteRequest, opts ...RequestOption) (*http.Response, []byte, error)

CustomDelete calls the API and returns the raw response from it. 

  This method lets you send requests to the Algolia REST API.

Request can be constructed by NewApiCustomDeleteRequest with parameters below.
  @param path string - Path of the endpoint, for example `1/newFeature`.
  @param parameters map[string]any - Query parameters to apply to the current query.
@param opts ...RequestOption - Optional parameters for the API call
@return *http.Response - The raw response from the API
@return []byte - The raw response body from the API
@return error - An error if the API call fails

func (*APIClient) CustomGet added in v4.26.0 

func (c *APIClient) CustomGet(r ApiCustomGetRequest, opts ...RequestOption) (*map[string]any, error)

CustomGet casts the HTTP response body to a defined struct.

This method lets you send requests to the Algolia REST API.

Request can be constructed by NewApiCustomGetRequest with parameters below. 

@param path string - Path of the endpoint, for example `1/newFeature`.
@param parameters map[string]any - Query parameters to apply to the current query.
@return map[string]any

func (*APIClient) CustomGetWithHTTPInfo added in v4.26.0 

func (c *APIClient) CustomGetWithHTTPInfo(r ApiCustomGetRequest, opts ...RequestOption) (*http.Response, []byte, error)

CustomGet calls the API and returns the raw response from it. 

  This method lets you send requests to the Algolia REST API.

Request can be constructed by NewApiCustomGetRequest with parameters below.
  @param path string - Path of the endpoint, for example `1/newFeature`.
  @param parameters map[string]any - Query parameters to apply to the current query.
@param opts ...RequestOption - Optional parameters for the API call
@return *http.Response - The raw response from the API
@return []byte - The raw response body from the API
@return error - An error if the API call fails

func (*APIClient) CustomPost added in v4.26.0 

func (c *APIClient) CustomPost(r ApiCustomPostRequest, opts ...RequestOption) (*map[string]any, error)

CustomPost casts the HTTP response body to a defined struct.

This method lets you send requests to the Algolia REST API.

Request can be constructed by NewApiCustomPostRequest with parameters below. 

@param path string - Path of the endpoint, for example `1/newFeature`.
@param parameters map[string]any - Query parameters to apply to the current query.
@param body map[string]any - Parameters to send with the custom request.
@return map[string]any

func (*APIClient) CustomPostWithHTTPInfo added in v4.26.0 

func (c *APIClient) CustomPostWithHTTPInfo(r ApiCustomPostRequest, opts ...RequestOption) (*http.Response, []byte, error)

CustomPost calls the API and returns the raw response from it. 

  This method lets you send requests to the Algolia REST API.

Request can be constructed by NewApiCustomPostRequest with parameters below.
  @param path string - Path of the endpoint, for example `1/newFeature`.
  @param parameters map[string]any - Query parameters to apply to the current query.
  @param body map[string]any - Parameters to send with the custom request.
@param opts ...RequestOption - Optional parameters for the API call
@return *http.Response - The raw response from the API
@return []byte - The raw response body from the API
@return error - An error if the API call fails

func (*APIClient) CustomPut added in v4.26.0 

func (c *APIClient) CustomPut(r ApiCustomPutRequest, opts ...RequestOption) (*map[string]any, error)

CustomPut casts the HTTP response body to a defined struct.

This method lets you send requests to the Algolia REST API.

Request can be constructed by NewApiCustomPutRequest with parameters below. 

@param path string - Path of the endpoint, for example `1/newFeature`.
@param parameters map[string]any - Query parameters to apply to the current query.
@param body map[string]any - Parameters to send with the custom request.
@return map[string]any

func (*APIClient) CustomPutWithHTTPInfo added in v4.26.0 

func (c *APIClient) CustomPutWithHTTPInfo(r ApiCustomPutRequest, opts ...RequestOption) (*http.Response, []byte, error)

CustomPut calls the API and returns the raw response from it. 

  This method lets you send requests to the Algolia REST API.

Request can be constructed by NewApiCustomPutRequest with parameters below.
  @param path string - Path of the endpoint, for example `1/newFeature`.
  @param parameters map[string]any - Query parameters to apply to the current query.
  @param body map[string]any - Parameters to send with the custom request.
@param opts ...RequestOption - Optional parameters for the API call
@return *http.Response - The raw response from the API
@return []byte - The raw response body from the API
@return error - An error if the API call fails

func (*APIClient) DeleteComposition added in v4.26.0 

func (c *APIClient) DeleteComposition(r ApiDeleteCompositionRequest, opts ...RequestOption) (*TaskIDResponse, error)

DeleteComposition casts the HTTP response body to a defined struct.

Delete a composition from the current Algolia application.

Required API Key ACLs:

  • editSettings

Request can be constructed by NewApiDeleteCompositionRequest with parameters below. 

@param compositionID string - Unique Composition ObjectID.
@return TaskIDResponse

func (*APIClient) DeleteCompositionRule added in v4.26.0 

func (c *APIClient) DeleteCompositionRule(r ApiDeleteCompositionRuleRequest, opts ...RequestOption) (*TaskIDResponse, error)

DeleteCompositionRule casts the HTTP response body to a defined struct.

Delete a Composition Rule from the specified Composition ID.

Required API Key ACLs:

  • editSettings

Request can be constructed by NewApiDeleteCompositionRuleRequest with parameters below. 

@param compositionID string - Unique Composition ObjectID.
@param objectID string - Unique identifier of a rule object.
@return TaskIDResponse

func (*APIClient) DeleteCompositionRuleWithHTTPInfo added in v4.26.0 

func (c *APIClient) DeleteCompositionRuleWithHTTPInfo(r ApiDeleteCompositionRuleRequest, opts ...RequestOption) (*http.Response, []byte, error)

DeleteCompositionRule calls the API and returns the raw response from it. 

  Delete a Composition Rule from the specified Composition ID.

    Required API Key ACLs:
    - editSettings

Request can be constructed by NewApiDeleteCompositionRuleRequest with parameters below.
  @param compositionID string - Unique Composition ObjectID.
  @param objectID string - Unique identifier of a rule object.
@param opts ...RequestOption - Optional parameters for the API call
@return *http.Response - The raw response from the API
@return []byte - The raw response body from the API
@return error - An error if the API call fails

func (*APIClient) DeleteCompositionWithHTTPInfo added in v4.26.0 

func (c *APIClient) DeleteCompositionWithHTTPInfo(r ApiDeleteCompositionRequest, opts ...RequestOption) (*http.Response, []byte, error)

DeleteComposition calls the API and returns the raw response from it. 

  Delete a composition from the current Algolia application.

    Required API Key ACLs:
    - editSettings

Request can be constructed by NewApiDeleteCompositionRequest with parameters below.
  @param compositionID string - Unique Composition ObjectID.
@param opts ...RequestOption - Optional parameters for the API call
@return *http.Response - The raw response from the API
@return []byte - The raw response body from the API
@return error - An error if the API call fails

func (*APIClient) GetComposition added in v4.26.0 

func (c *APIClient) GetComposition(r ApiGetCompositionRequest, opts ...RequestOption) (*Composition, error)

GetComposition casts the HTTP response body to a defined struct.

Retrieve a single composition in the current Algolia application.

Required API Key ACLs:

  • editSettings
  • settings

Request can be constructed by NewApiGetCompositionRequest with parameters below. 

@param compositionID string - Unique Composition ObjectID.
@return Composition

func (*APIClient) GetCompositionWithHTTPInfo added in v4.26.0 

func (c *APIClient) GetCompositionWithHTTPInfo(r ApiGetCompositionRequest, opts ...RequestOption) (*http.Response, []byte, error)

GetComposition calls the API and returns the raw response from it. 

  Retrieve a single composition in the current Algolia application.

    Required API Key ACLs:
    - editSettings
    - settings

Request can be constructed by NewApiGetCompositionRequest with parameters below.
  @param compositionID string - Unique Composition ObjectID.
@param opts ...RequestOption - Optional parameters for the API call
@return *http.Response - The raw response from the API
@return []byte - The raw response body from the API
@return error - An error if the API call fails

func (*APIClient) GetConfiguration 

func (c *APIClient) GetConfiguration() *CompositionConfiguration

Allow modification of underlying config for alternate implementations and testing. Caution: modifying the configuration while live can cause data races and potentially unwanted behavior.

func (*APIClient) GetRule added in v4.26.0 

func (c *APIClient) GetRule(r ApiGetRuleRequest, opts ...RequestOption) (*CompositionRule, error)

GetRule casts the HTTP response body to a defined struct.

Retrieves a rule by its ID.

To find the object ID of a rule, use the [`search` operation](https://www.algolia.com/doc/rest-api/composition/search-composition-rules).

Required API Key ACLs:

  • editSettings
  • settings

Request can be constructed by NewApiGetRuleRequest with parameters below. 

@param compositionID string - Unique Composition ObjectID.
@param objectID string - Unique identifier of a rule object.
@return CompositionRule

func (*APIClient) GetRuleWithHTTPInfo added in v4.26.0 

func (c *APIClient) GetRuleWithHTTPInfo(r ApiGetRuleRequest, opts ...RequestOption) (*http.Response, []byte, error)

GetRule calls the API and returns the raw response from it. 

Retrieves a rule by its ID.

To find the object ID of a rule, use the [`search` operation](https://www.algolia.com/doc/rest-api/composition/search-composition-rules). 

    Required API Key ACLs:
    - editSettings
    - settings

Request can be constructed by NewApiGetRuleRequest with parameters below.
  @param compositionID string - Unique Composition ObjectID.
  @param objectID string - Unique identifier of a rule object.
@param opts ...RequestOption - Optional parameters for the API call
@return *http.Response - The raw response from the API
@return []byte - The raw response body from the API
@return error - An error if the API call fails

func (*APIClient) GetTask added in v4.26.0 

func (c *APIClient) GetTask(r ApiGetTaskRequest, opts ...RequestOption) (*GetTaskResponse, error)

GetTask casts the HTTP response body to a defined struct.

Checks the status of a given task.

Required API Key ACLs:

  • editSettings
  • settings
  • addObject
  • deleteObject
  • deleteIndex

Request can be constructed by NewApiGetTaskRequest with parameters below. 

@param compositionID string - Unique Composition ObjectID.
@param taskID int64 - Unique task identifier.
@return GetTaskResponse

func (*APIClient) GetTaskWithHTTPInfo added in v4.26.0 

func (c *APIClient) GetTaskWithHTTPInfo(r ApiGetTaskRequest, opts ...RequestOption) (*http.Response, []byte, error)

GetTask calls the API and returns the raw response from it. 

  Checks the status of a given task.

    Required API Key ACLs:
    - editSettings
    - settings
    - addObject
    - deleteObject
    - deleteIndex

Request can be constructed by NewApiGetTaskRequest with parameters below.
  @param compositionID string - Unique Composition ObjectID.
  @param taskID int64 - Unique task identifier.
@param opts ...RequestOption - Optional parameters for the API call
@return *http.Response - The raw response from the API
@return []byte - The raw response body from the API
@return error - An error if the API call fails

func (*APIClient) ListCompositions added in v4.26.0 

func (c *APIClient) ListCompositions(r ApiListCompositionsRequest, opts ...RequestOption) (*ListCompositionsResponse, error)

ListCompositions casts the HTTP response body to a defined struct.

Lists all compositions in the current Algolia application.

Required API Key ACLs:

  • editSettings
  • settings

Request can be constructed by NewApiListCompositionsRequest with parameters below. 

@param page int32 - Requested page of the API response. If `null`, the API response is not paginated.
@param hitsPerPage int32 - Number of hits per page.
@return ListCompositionsResponse

func (*APIClient) ListCompositionsWithHTTPInfo added in v4.26.0 

func (c *APIClient) ListCompositionsWithHTTPInfo(r ApiListCompositionsRequest, opts ...RequestOption) (*http.Response, []byte, error)

ListCompositions calls the API and returns the raw response from it. 

  Lists all compositions in the current Algolia application.

    Required API Key ACLs:
    - editSettings
    - settings

Request can be constructed by NewApiListCompositionsRequest with parameters below.
  @param page int32 - Requested page of the API response. If `null`, the API response is not paginated.
  @param hitsPerPage int32 - Number of hits per page.
@param opts ...RequestOption - Optional parameters for the API call
@return *http.Response - The raw response from the API
@return []byte - The raw response body from the API
@return error - An error if the API call fails

func (*APIClient) MultipleBatch added in v4.26.0 

func (c *APIClient) MultipleBatch(r ApiMultipleBatchRequest, opts ...RequestOption) (*MultipleBatchResponse, error)

MultipleBatch casts the HTTP response body to a defined struct.

Adds, updates, or deletes compositions with a single API request.

Required API Key ACLs:

  • editSettings

Request can be constructed by NewApiMultipleBatchRequest with parameters below. 

@param batchParams BatchParams
@return MultipleBatchResponse

func (*APIClient) MultipleBatchWithHTTPInfo added in v4.26.0 

func (c *APIClient) MultipleBatchWithHTTPInfo(r ApiMultipleBatchRequest, opts ...RequestOption) (*http.Response, []byte, error)

MultipleBatch calls the API and returns the raw response from it. 

  Adds, updates, or deletes compositions with a single API request.

    Required API Key ACLs:
    - editSettings

Request can be constructed by NewApiMultipleBatchRequest with parameters below.
  @param batchParams BatchParams
@param opts ...RequestOption - Optional parameters for the API call
@return *http.Response - The raw response from the API
@return []byte - The raw response body from the API
@return error - An error if the API call fails

func (*APIClient) NewApiCustomDeleteRequest added in v4.26.0 

func (c *APIClient) NewApiCustomDeleteRequest(path string) ApiCustomDeleteRequest

NewApiCustomDeleteRequest creates an instance of the ApiCustomDeleteRequest to be used for the API call.

func (*APIClient) NewApiCustomGetRequest added in v4.26.0 

func (c *APIClient) NewApiCustomGetRequest(path string) ApiCustomGetRequest

NewApiCustomGetRequest creates an instance of the ApiCustomGetRequest to be used for the API call.

func (*APIClient) NewApiCustomPostRequest added in v4.26.0 

func (c *APIClient) NewApiCustomPostRequest(path string) ApiCustomPostRequest

NewApiCustomPostRequest creates an instance of the ApiCustomPostRequest to be used for the API call.

func (*APIClient) NewApiCustomPutRequest added in v4.26.0 

func (c *APIClient) NewApiCustomPutRequest(path string) ApiCustomPutRequest

NewApiCustomPutRequest creates an instance of the ApiCustomPutRequest to be used for the API call.

func (*APIClient) NewApiDeleteCompositionRequest added in v4.26.0 

func (c *APIClient) NewApiDeleteCompositionRequest(compositionID string) ApiDeleteCompositionRequest

NewApiDeleteCompositionRequest creates an instance of the ApiDeleteCompositionRequest to be used for the API call.

func (*APIClient) NewApiDeleteCompositionRuleRequest added in v4.26.0 

func (c *APIClient) NewApiDeleteCompositionRuleRequest(compositionID string, objectID string) ApiDeleteCompositionRuleRequest

NewApiDeleteCompositionRuleRequest creates an instance of the ApiDeleteCompositionRuleRequest to be used for the API call.

func (*APIClient) NewApiGetCompositionRequest added in v4.26.0 

func (c *APIClient) NewApiGetCompositionRequest(compositionID string) ApiGetCompositionRequest

NewApiGetCompositionRequest creates an instance of the ApiGetCompositionRequest to be used for the API call.

func (*APIClient) NewApiGetRuleRequest added in v4.26.0 

func (c *APIClient) NewApiGetRuleRequest(compositionID string, objectID string) ApiGetRuleRequest

NewApiGetRuleRequest creates an instance of the ApiGetRuleRequest to be used for the API call.

func (*APIClient) NewApiGetTaskRequest added in v4.26.0 

func (c *APIClient) NewApiGetTaskRequest(compositionID string, taskID int64) ApiGetTaskRequest

NewApiGetTaskRequest creates an instance of the ApiGetTaskRequest to be used for the API call.

func (*APIClient) NewApiListCompositionsRequest added in v4.26.0 

func (c *APIClient) NewApiListCompositionsRequest() ApiListCompositionsRequest

NewApiListCompositionsRequest creates an instance of the ApiListCompositionsRequest to be used for the API call.

func (*APIClient) NewApiMultipleBatchRequest added in v4.26.0 

func (c *APIClient) NewApiMultipleBatchRequest(batchParams *BatchParams) ApiMultipleBatchRequest

NewApiMultipleBatchRequest creates an instance of the ApiMultipleBatchRequest to be used for the API call.

func (*APIClient) NewApiPutCompositionRequest added in v4.26.0 

func (c *APIClient) NewApiPutCompositionRequest(compositionID string, composition *Composition) ApiPutCompositionRequest

NewApiPutCompositionRequest creates an instance of the ApiPutCompositionRequest to be used for the API call.

func (*APIClient) NewApiPutCompositionRuleRequest added in v4.26.0 

func (c *APIClient) NewApiPutCompositionRuleRequest(
	compositionID string,
	objectID string,
	compositionRule *CompositionRule,
) ApiPutCompositionRuleRequest

NewApiPutCompositionRuleRequest creates an instance of the ApiPutCompositionRuleRequest to be used for the API call.

func (*APIClient) NewApiSaveRulesRequest added in v4.26.0 

func (c *APIClient) NewApiSaveRulesRequest(compositionID string, rules *CompositionRulesBatchParams) ApiSaveRulesRequest

NewApiSaveRulesRequest creates an instance of the ApiSaveRulesRequest to be used for the API call.

func (*APIClient) NewApiSearchCompositionRulesRequest added in v4.26.0 

func (c *APIClient) NewApiSearchCompositionRulesRequest(compositionID string) ApiSearchCompositionRulesRequest

NewApiSearchCompositionRulesRequest creates an instance of the ApiSearchCompositionRulesRequest to be used for the API call.

func (*APIClient) NewApiSearchForFacetValuesRequest 

func (c *APIClient) NewApiSearchForFacetValuesRequest(compositionID string, facetName string) ApiSearchForFacetValuesRequest

NewApiSearchForFacetValuesRequest creates an instance of the ApiSearchForFacetValuesRequest to be used for the API call.

func (*APIClient) NewApiSearchRequest 

func (c *APIClient) NewApiSearchRequest(compositionID string, requestBody *RequestBody) ApiSearchRequest

NewApiSearchRequest creates an instance of the ApiSearchRequest to be used for the API call.

func (*APIClient) NewApiUpdateSortingStrategyCompositionRequest added in v4.34.0 

func (c *APIClient) NewApiUpdateSortingStrategyCompositionRequest(
	compositionID string,
	requestBody map[string]string,
) ApiUpdateSortingStrategyCompositionRequest

NewApiUpdateSortingStrategyCompositionRequest creates an instance of the ApiUpdateSortingStrategyCompositionRequest to be used for the API call.

func (*APIClient) PutComposition added in v4.26.0 

func (c *APIClient) PutComposition(r ApiPutCompositionRequest, opts ...RequestOption) (*TaskIDResponse, error)

PutComposition casts the HTTP response body to a defined struct.

Update and insert a composition in the current Algolia application.

Required API Key ACLs:

  • editSettings

Request can be constructed by NewApiPutCompositionRequest with parameters below. 

@param compositionID string - Unique Composition ObjectID.
@param composition Composition
@return TaskIDResponse

func (*APIClient) PutCompositionRule added in v4.26.0 

func (c *APIClient) PutCompositionRule(r ApiPutCompositionRuleRequest, opts ...RequestOption) (*TaskIDResponse, error)

PutCompositionRule casts the HTTP response body to a defined struct.

If a composition rule with the provided ID already exists, it's replaced. Otherwise, a new one is added.

Required API Key ACLs:

  • editSettings

Request can be constructed by NewApiPutCompositionRuleRequest with parameters below. 

@param compositionID string - Unique Composition ObjectID.
@param objectID string - Unique identifier of a rule object.
@param compositionRule CompositionRule
@return TaskIDResponse

func (*APIClient) PutCompositionRuleWithHTTPInfo added in v4.26.0 

func (c *APIClient) PutCompositionRuleWithHTTPInfo(r ApiPutCompositionRuleRequest, opts ...RequestOption) (*http.Response, []byte, error)

PutCompositionRule calls the API and returns the raw response from it. 

If a composition rule with the provided ID already exists,

it's replaced. Otherwise, a new one is added. 

    Required API Key ACLs:
    - editSettings

Request can be constructed by NewApiPutCompositionRuleRequest with parameters below.
  @param compositionID string - Unique Composition ObjectID.
  @param objectID string - Unique identifier of a rule object.
  @param compositionRule CompositionRule
@param opts ...RequestOption - Optional parameters for the API call
@return *http.Response - The raw response from the API
@return []byte - The raw response body from the API
@return error - An error if the API call fails

func (*APIClient) PutCompositionWithHTTPInfo added in v4.26.0 

func (c *APIClient) PutCompositionWithHTTPInfo(r ApiPutCompositionRequest, opts ...RequestOption) (*http.Response, []byte, error)

PutComposition calls the API and returns the raw response from it. 

  Update and insert a composition in the current Algolia application.

    Required API Key ACLs:
    - editSettings

Request can be constructed by NewApiPutCompositionRequest with parameters below.
  @param compositionID string - Unique Composition ObjectID.
  @param composition Composition
@param opts ...RequestOption - Optional parameters for the API call
@return *http.Response - The raw response from the API
@return []byte - The raw response body from the API
@return error - An error if the API call fails

func (*APIClient) SaveRules added in v4.26.0 

func (c *APIClient) SaveRules(r ApiSaveRulesRequest, opts ...RequestOption) (*RulesMultipleBatchResponse, error)

SaveRules casts the HTTP response body to a defined struct.

Create or update or delete multiple composition rules.

Required API Key ACLs:

  • editSettings

Request can be constructed by NewApiSaveRulesRequest with parameters below. 

@param compositionID string - Unique Composition ObjectID.
@param rules CompositionRulesBatchParams
@return RulesMultipleBatchResponse

func (*APIClient) SaveRulesWithHTTPInfo added in v4.26.0 

func (c *APIClient) SaveRulesWithHTTPInfo(r ApiSaveRulesRequest, opts ...RequestOption) (*http.Response, []byte, error)

SaveRules calls the API and returns the raw response from it. 

  Create or update or delete multiple composition rules.

    Required API Key ACLs:
    - editSettings

Request can be constructed by NewApiSaveRulesRequest with parameters below.
  @param compositionID string - Unique Composition ObjectID.
  @param rules CompositionRulesBatchParams
@param opts ...RequestOption - Optional parameters for the API call
@return *http.Response - The raw response from the API
@return []byte - The raw response body from the API
@return error - An error if the API call fails

func (*APIClient) Search 

func (c *APIClient) Search(r ApiSearchRequest, opts ...RequestOption) (*SearchResponse, error)

Search casts the HTTP response body to a defined struct.

Runs a query on a single composition and returns matching results.

Required API Key ACLs:

  • search

Request can be constructed by NewApiSearchRequest with parameters below. 

@param compositionID string - Unique Composition ObjectID.
@param requestBody RequestBody
@return SearchResponse

func (*APIClient) SearchCompositionRules added in v4.26.0 

func (c *APIClient) SearchCompositionRules(r ApiSearchCompositionRulesRequest, opts ...RequestOption) (*SearchCompositionRulesResponse, error)

SearchCompositionRules casts the HTTP response body to a defined struct.

Searches for composition rules in your index.

Required API Key ACLs:

  • settings

Request can be constructed by NewApiSearchCompositionRulesRequest with parameters below. 

@param compositionID string - Unique Composition ObjectID.
@param searchCompositionRulesParams SearchCompositionRulesParams
@return SearchCompositionRulesResponse

func (*APIClient) SearchCompositionRulesWithHTTPInfo added in v4.26.0 

func (c *APIClient) SearchCompositionRulesWithHTTPInfo(r ApiSearchCompositionRulesRequest, opts ...RequestOption) (*http.Response, []byte, error)

SearchCompositionRules calls the API and returns the raw response from it. 

  Searches for composition rules in your index.

    Required API Key ACLs:
    - settings

Request can be constructed by NewApiSearchCompositionRulesRequest with parameters below.
  @param compositionID string - Unique Composition ObjectID.
  @param searchCompositionRulesParams SearchCompositionRulesParams
@param opts ...RequestOption - Optional parameters for the API call
@return *http.Response - The raw response from the API
@return []byte - The raw response body from the API
@return error - An error if the API call fails

func (*APIClient) SearchForFacetValues 

func (c *APIClient) SearchForFacetValues(r ApiSearchForFacetValuesRequest, opts ...RequestOption) (*SearchForFacetValuesResponse, error)

SearchForFacetValues casts the HTTP response body to a defined struct.

Searches for values of a specified facet attribute on the composition's main source's index.

  • By default, facet values are sorted by decreasing count. You can adjust this with the `sortFacetValueBy` parameter.
  • Searching for facet values doesn't work if you have **more than 65 searchable facets and searchable attributes combined**.

Required API Key ACLs:

  • search

Request can be constructed by NewApiSearchForFacetValuesRequest with parameters below. 

@param compositionID string - Unique Composition ObjectID.

@param facetName string - Facet attribute in which to search for values.  This attribute must be included in the `attributesForFaceting` index setting with the `searchable()` modifier.
@param searchForFacetValuesRequest SearchForFacetValuesRequest
@return SearchForFacetValuesResponse

func (*APIClient) SearchForFacetValuesWithHTTPInfo 

func (c *APIClient) SearchForFacetValuesWithHTTPInfo(r ApiSearchForFacetValuesRequest, opts ...RequestOption) (*http.Response, []byte, error)

SearchForFacetValues calls the API and returns the raw response from it. 

	Searches for values of a specified facet attribute on the composition's main source's index.

  - By default, facet values are sorted by decreasing count.
    You can adjust this with the `sortFacetValueBy` parameter.

  - Searching for facet values doesn't work if you have **more than 65 searchable facets and searchable attributes combined**.

    Required API Key ACLs:

  - search

    Request can be constructed by NewApiSearchForFacetValuesRequest with parameters below.
    @param compositionID string - Unique Composition ObjectID.

@param facetName string - Facet attribute in which to search for values.  This attribute must be included in the `attributesForFaceting` index setting with the `searchable()` modifier.
@param searchForFacetValuesRequest SearchForFacetValuesRequest
@param opts ...RequestOption - Optional parameters for the API call
@return *http.Response - The raw response from the API
@return []byte - The raw response body from the API
@return error - An error if the API call fails

func (*APIClient) SearchWithHTTPInfo 

func (c *APIClient) SearchWithHTTPInfo(r ApiSearchRequest, opts ...RequestOption) (*http.Response, []byte, error)

Search calls the API and returns the raw response from it. 

  Runs a query on a single composition and returns matching results.

    Required API Key ACLs:
    - search

Request can be constructed by NewApiSearchRequest with parameters below.
  @param compositionID string - Unique Composition ObjectID.
  @param requestBody RequestBody
@param opts ...RequestOption - Optional parameters for the API call
@return *http.Response - The raw response from the API
@return []byte - The raw response body from the API
@return error - An error if the API call fails

func (*APIClient) SetClientApiKey 

func (c *APIClient) SetClientApiKey(apiKey string) error

Allow update of stored API key used to authenticate requests.

func (*APIClient) UpdateSortingStrategyComposition added in v4.34.0 

func (c *APIClient) UpdateSortingStrategyComposition(r ApiUpdateSortingStrategyCompositionRequest, opts ...RequestOption) (*TaskIDResponse, error)

UpdateSortingStrategyComposition casts the HTTP response body to a defined struct.

Updates the "sortingStrategy" field of an existing composition. This endpoint lets you create a new sorting strategy mapping or replace the configured one. The provided sorting indices must be associated indices or replicas of the main targeted index.

This endpoint can't validate whether the sort index is related to the composition's main index. Validation fails at runtime if the index you updated isn't related.

The update is applied to the specified composition within the current Algolia application and returns a taskID that can be used to track the operation’s completion.

Required API Key ACLs:

  • editSettings

Request can be constructed by NewApiUpdateSortingStrategyCompositionRequest with parameters below. 

@param compositionID string - Unique Composition ObjectID.
@param requestBody map[string]string
@return TaskIDResponse

func (*APIClient) UpdateSortingStrategyCompositionWithHTTPInfo added in v4.34.0 

func (c *APIClient) UpdateSortingStrategyCompositionWithHTTPInfo(
	r ApiUpdateSortingStrategyCompositionRequest,
	opts ...RequestOption,
) (*http.Response, []byte, error)

UpdateSortingStrategyComposition calls the API and returns the raw response from it. 

Updates the "sortingStrategy" field of an existing composition.

This endpoint lets you create a new sorting strategy mapping or replace the configured one. The provided sorting indices must be associated indices or replicas of the main targeted index.

This endpoint can't validate whether the sort index is related to the composition's main index. Validation fails at runtime if the index you updated isn't related.

The update is applied to the specified composition within the current Algolia application and returns a taskID that can be used to track the operation’s completion. 

    Required API Key ACLs:
    - editSettings

Request can be constructed by NewApiUpdateSortingStrategyCompositionRequest with parameters below.
  @param compositionID string - Unique Composition ObjectID.
  @param requestBody map[string]string
@param opts ...RequestOption - Optional parameters for the API call
@return *http.Response - The raw response from the API
@return []byte - The raw response body from the API
@return error - An error if the API call fails

type APIError 

type APIError struct {
	Message              string         `json:"message"`
	Status               int            `json:"status"`
	AdditionalProperties map[string]any `json:"-"`
}

func (APIError) Error 

func (e APIError) Error() string

func (APIError) Is added in v4.13.0 

func (a APIError) Is(target error) bool

func (APIError) MarshalJSON 

func (o APIError) MarshalJSON() ([]byte, error)

func (*APIError) UnmarshalJSON 

func (o *APIError) UnmarshalJSON(bytes []byte) error

type Action added in v4.26.0 

type Action string

Action Type of Composition Batch operation. 

const (
	ACTION_UPSERT Action = "upsert"
	ACTION_DELETE Action = "delete"
)

List of action.

func NewActionFromValue added in v4.26.0 

func NewActionFromValue(v string) (*Action, error)

NewActionFromValue returns a pointer to a valid Action. for the value passed as argument, or an error if the value passed is not allowed by the enum.

func (Action) IsValid added in v4.26.0 

func (v Action) IsValid() bool

IsValid return true if the value is valid for the enum, false otherwise.

func (Action) Ptr added in v4.26.0 

func (v Action) Ptr() *Action

Ptr returns reference to action value.

func (*Action) UnmarshalJSON added in v4.26.0 

func (v *Action) UnmarshalJSON(src []byte) error

type AdvancedSyntaxFeatures added in v4.26.0 

type AdvancedSyntaxFeatures string

AdvancedSyntaxFeatures the model 'AdvancedSyntaxFeatures'. 

const (
	ADVANCED_SYNTAX_FEATURES_EXACT_PHRASE  AdvancedSyntaxFeatures = "exactPhrase"
	ADVANCED_SYNTAX_FEATURES_EXCLUDE_WORDS AdvancedSyntaxFeatures = "excludeWords"
)

List of advancedSyntaxFeatures.

func NewAdvancedSyntaxFeaturesFromValue added in v4.26.0 

func NewAdvancedSyntaxFeaturesFromValue(v string) (*AdvancedSyntaxFeatures, error)

NewAdvancedSyntaxFeaturesFromValue returns a pointer to a valid AdvancedSyntaxFeatures. for the value passed as argument, or an error if the value passed is not allowed by the enum.

func (AdvancedSyntaxFeatures) IsValid added in v4.26.0 

func (v AdvancedSyntaxFeatures) IsValid() bool

IsValid return true if the value is valid for the enum, false otherwise.

func (AdvancedSyntaxFeatures) Ptr added in v4.26.0 

func (v AdvancedSyntaxFeatures) Ptr() *AdvancedSyntaxFeatures

Ptr returns reference to advancedSyntaxFeatures value.

func (*AdvancedSyntaxFeatures) UnmarshalJSON added in v4.26.0 

func (v *AdvancedSyntaxFeatures) UnmarshalJSON(src []byte) error

type AlternativesAsExact added in v4.26.0 

type AlternativesAsExact string

AlternativesAsExact the model 'AlternativesAsExact'. 

const (
	ALTERNATIVES_AS_EXACT_IGNORE_PLURALS      AlternativesAsExact = "ignorePlurals"
	ALTERNATIVES_AS_EXACT_SINGLE_WORD_SYNONYM AlternativesAsExact = "singleWordSynonym"
	ALTERNATIVES_AS_EXACT_MULTI_WORDS_SYNONYM AlternativesAsExact = "multiWordsSynonym"
	ALTERNATIVES_AS_EXACT_IGNORE_CONJUGATIONS AlternativesAsExact = "ignoreConjugations"
)

List of alternativesAsExact.

func NewAlternativesAsExactFromValue added in v4.26.0 

func NewAlternativesAsExactFromValue(v string) (*AlternativesAsExact, error)

NewAlternativesAsExactFromValue returns a pointer to a valid AlternativesAsExact. for the value passed as argument, or an error if the value passed is not allowed by the enum.

func (AlternativesAsExact) IsValid added in v4.26.0 

func (v AlternativesAsExact) IsValid() bool

IsValid return true if the value is valid for the enum, false otherwise.

func (AlternativesAsExact) Ptr added in v4.26.0 

func (v AlternativesAsExact) Ptr() *AlternativesAsExact

Ptr returns reference to alternativesAsExact value.

func (*AlternativesAsExact) UnmarshalJSON added in v4.26.0 

func (v *AlternativesAsExact) UnmarshalJSON(src []byte) error

type Anchoring added in v4.26.0 

type Anchoring string

Anchoring Which part of the search query the pattern should match: - `startsWith`. The pattern must match the beginning of the query. - `endsWith`. The pattern must match the end of the query. - `is`. The pattern must match the query exactly. - `contains`. The pattern must match anywhere in the query. Empty queries are only allowed as patterns with `anchoring: is`. 

const (
	ANCHORING_IS          Anchoring = "is"
	ANCHORING_STARTS_WITH Anchoring = "startsWith"
	ANCHORING_ENDS_WITH   Anchoring = "endsWith"
	ANCHORING_CONTAINS    Anchoring = "contains"
)

List of anchoring.

func NewAnchoringFromValue added in v4.26.0 

func NewAnchoringFromValue(v string) (*Anchoring, error)

NewAnchoringFromValue returns a pointer to a valid Anchoring. for the value passed as argument, or an error if the value passed is not allowed by the enum.

func (Anchoring) IsValid added in v4.26.0 

func (v Anchoring) IsValid() bool

IsValid return true if the value is valid for the enum, false otherwise.

func (Anchoring) Ptr added in v4.26.0 

func (v Anchoring) Ptr() *Anchoring

Ptr returns reference to anchoring value.

func (*Anchoring) UnmarshalJSON added in v4.26.0 

func (v *Anchoring) UnmarshalJSON(src []byte) error

type ApiCustomDeleteRequest added in v4.26.0 

type ApiCustomDeleteRequest struct {
	// contains filtered or unexported fields
}

ApiCustomDeleteRequest represents the request with all the parameters for the API call.

func (*ApiCustomDeleteRequest) UnmarshalJSON added in v4.26.0 

func (r *ApiCustomDeleteRequest) UnmarshalJSON(b []byte) error

func (ApiCustomDeleteRequest) WithParameters added in v4.26.0 

func (r ApiCustomDeleteRequest) WithParameters(parameters map[string]any) ApiCustomDeleteRequest

WithParameters adds the parameters to the ApiCustomDeleteRequest and returns the request for chaining.

type ApiCustomGetRequest added in v4.26.0 

type ApiCustomGetRequest struct {
	// contains filtered or unexported fields
}

ApiCustomGetRequest represents the request with all the parameters for the API call.

func (*ApiCustomGetRequest) UnmarshalJSON added in v4.26.0 

func (r *ApiCustomGetRequest) UnmarshalJSON(b []byte) error

func (ApiCustomGetRequest) WithParameters added in v4.26.0 

func (r ApiCustomGetRequest) WithParameters(parameters map[string]any) ApiCustomGetRequest

WithParameters adds the parameters to the ApiCustomGetRequest and returns the request for chaining.

type ApiCustomPostRequest added in v4.26.0 

type ApiCustomPostRequest struct {
	// contains filtered or unexported fields
}

ApiCustomPostRequest represents the request with all the parameters for the API call.

func (*ApiCustomPostRequest) UnmarshalJSON added in v4.26.0 

func (r *ApiCustomPostRequest) UnmarshalJSON(b []byte) error

func (ApiCustomPostRequest) WithBody added in v4.26.0 

func (r ApiCustomPostRequest) WithBody(body map[string]any) ApiCustomPostRequest

WithBody adds the body to the ApiCustomPostRequest and returns the request for chaining.

func (ApiCustomPostRequest) WithParameters added in v4.26.0 

func (r ApiCustomPostRequest) WithParameters(parameters map[string]any) ApiCustomPostRequest

WithParameters adds the parameters to the ApiCustomPostRequest and returns the request for chaining.

type ApiCustomPutRequest added in v4.26.0 

type ApiCustomPutRequest struct {
	// contains filtered or unexported fields
}

ApiCustomPutRequest represents the request with all the parameters for the API call.

func (*ApiCustomPutRequest) UnmarshalJSON added in v4.26.0 

func (r *ApiCustomPutRequest) UnmarshalJSON(b []byte) error

func (ApiCustomPutRequest) WithBody added in v4.26.0 

func (r ApiCustomPutRequest) WithBody(body map[string]any) ApiCustomPutRequest

WithBody adds the body to the ApiCustomPutRequest and returns the request for chaining.

func (ApiCustomPutRequest) WithParameters added in v4.26.0 

func (r ApiCustomPutRequest) WithParameters(parameters map[string]any) ApiCustomPutRequest

WithParameters adds the parameters to the ApiCustomPutRequest and returns the request for chaining.

type ApiDeleteCompositionRequest added in v4.26.0 

type ApiDeleteCompositionRequest struct {
	// contains filtered or unexported fields
}

ApiDeleteCompositionRequest represents the request with all the parameters for the API call.

func (*ApiDeleteCompositionRequest) UnmarshalJSON added in v4.26.0 

func (r *ApiDeleteCompositionRequest) UnmarshalJSON(b []byte) error

type ApiDeleteCompositionRuleRequest added in v4.26.0 

type ApiDeleteCompositionRuleRequest struct {
	// contains filtered or unexported fields
}

ApiDeleteCompositionRuleRequest represents the request with all the parameters for the API call.

func (*ApiDeleteCompositionRuleRequest) UnmarshalJSON added in v4.26.0 

func (r *ApiDeleteCompositionRuleRequest) UnmarshalJSON(b []byte) error

type ApiGetCompositionRequest added in v4.26.0 

type ApiGetCompositionRequest struct {
	// contains filtered or unexported fields
}

ApiGetCompositionRequest represents the request with all the parameters for the API call.

func (*ApiGetCompositionRequest) UnmarshalJSON added in v4.26.0 

func (r *ApiGetCompositionRequest) UnmarshalJSON(b []byte) error

type ApiGetRuleRequest added in v4.26.0 

type ApiGetRuleRequest struct {
	// contains filtered or unexported fields
}

ApiGetRuleRequest represents the request with all the parameters for the API call.

func (*ApiGetRuleRequest) UnmarshalJSON added in v4.26.0 

func (r *ApiGetRuleRequest) UnmarshalJSON(b []byte) error

type ApiGetTaskRequest added in v4.26.0 

type ApiGetTaskRequest struct {
	// contains filtered or unexported fields
}

ApiGetTaskRequest represents the request with all the parameters for the API call.

func (*ApiGetTaskRequest) UnmarshalJSON added in v4.26.0 

func (r *ApiGetTaskRequest) UnmarshalJSON(b []byte) error

type ApiListCompositionsRequest added in v4.26.0 

type ApiListCompositionsRequest struct {
	// contains filtered or unexported fields
}

ApiListCompositionsRequest represents the request with all the parameters for the API call.

func (*ApiListCompositionsRequest) UnmarshalJSON added in v4.26.0 

func (r *ApiListCompositionsRequest) UnmarshalJSON(b []byte) error

func (ApiListCompositionsRequest) WithHitsPerPage added in v4.26.0 

func (r ApiListCompositionsRequest) WithHitsPerPage(hitsPerPage int32) ApiListCompositionsRequest

WithHitsPerPage adds the hitsPerPage to the ApiListCompositionsRequest and returns the request for chaining.

func (ApiListCompositionsRequest) WithPage added in v4.26.0 

func (r ApiListCompositionsRequest) WithPage(page int32) ApiListCompositionsRequest

WithPage adds the page to the ApiListCompositionsRequest and returns the request for chaining.

type ApiMultipleBatchRequest added in v4.26.0 

type ApiMultipleBatchRequest struct {
	// contains filtered or unexported fields
}

ApiMultipleBatchRequest represents the request with all the parameters for the API call.

func (*ApiMultipleBatchRequest) UnmarshalJSON added in v4.26.0 

func (r *ApiMultipleBatchRequest) UnmarshalJSON(b []byte) error

type ApiPutCompositionRequest added in v4.26.0 

type ApiPutCompositionRequest struct {
	// contains filtered or unexported fields
}

ApiPutCompositionRequest represents the request with all the parameters for the API call.

func (*ApiPutCompositionRequest) UnmarshalJSON added in v4.26.0 

func (r *ApiPutCompositionRequest) UnmarshalJSON(b []byte) error

type ApiPutCompositionRuleRequest added in v4.26.0 

type ApiPutCompositionRuleRequest struct {
	// contains filtered or unexported fields
}

ApiPutCompositionRuleRequest represents the request with all the parameters for the API call.

func (*ApiPutCompositionRuleRequest) UnmarshalJSON added in v4.26.0 

func (r *ApiPutCompositionRuleRequest) UnmarshalJSON(b []byte) error

type ApiSaveRulesRequest added in v4.26.0 

type ApiSaveRulesRequest struct {
	// contains filtered or unexported fields
}

ApiSaveRulesRequest represents the request with all the parameters for the API call.

func (*ApiSaveRulesRequest) UnmarshalJSON added in v4.26.0 

func (r *ApiSaveRulesRequest) UnmarshalJSON(b []byte) error

type ApiSearchCompositionRulesRequest added in v4.26.0 

type ApiSearchCompositionRulesRequest struct {
	// contains filtered or unexported fields
}

ApiSearchCompositionRulesRequest represents the request with all the parameters for the API call.

func (*ApiSearchCompositionRulesRequest) UnmarshalJSON added in v4.26.0 

func (r *ApiSearchCompositionRulesRequest) UnmarshalJSON(b []byte) error

func (ApiSearchCompositionRulesRequest) WithSearchCompositionRulesParams added in v4.26.0 

func (r ApiSearchCompositionRulesRequest) WithSearchCompositionRulesParams(
	searchCompositionRulesParams *SearchCompositionRulesParams,
) ApiSearchCompositionRulesRequest

WithSearchCompositionRulesParams adds the searchCompositionRulesParams to the ApiSearchCompositionRulesRequest and returns the request for chaining.

type ApiSearchForFacetValuesRequest 

type ApiSearchForFacetValuesRequest struct {
	// contains filtered or unexported fields
}

ApiSearchForFacetValuesRequest represents the request with all the parameters for the API call.

func (*ApiSearchForFacetValuesRequest) UnmarshalJSON 

func (r *ApiSearchForFacetValuesRequest) UnmarshalJSON(b []byte) error

func (ApiSearchForFacetValuesRequest) WithSearchForFacetValuesRequest 

func (r ApiSearchForFacetValuesRequest) WithSearchForFacetValuesRequest(
	searchForFacetValuesRequest *SearchForFacetValuesRequest,
) ApiSearchForFacetValuesRequest

WithSearchForFacetValuesRequest adds the searchForFacetValuesRequest to the ApiSearchForFacetValuesRequest and returns the request for chaining.

type ApiSearchRequest 

type ApiSearchRequest struct {
	// contains filtered or unexported fields
}

ApiSearchRequest represents the request with all the parameters for the API call.

func (*ApiSearchRequest) UnmarshalJSON 

func (r *ApiSearchRequest) UnmarshalJSON(b []byte) error

type ApiUpdateSortingStrategyCompositionRequest added in v4.34.0 

type ApiUpdateSortingStrategyCompositionRequest struct {
	// contains filtered or unexported fields
}

ApiUpdateSortingStrategyCompositionRequest represents the request with all the parameters for the API call.

func (*ApiUpdateSortingStrategyCompositionRequest) UnmarshalJSON added in v4.34.0 

func (r *ApiUpdateSortingStrategyCompositionRequest) UnmarshalJSON(b []byte) error

type AroundPrecision 

type AroundPrecision struct {
	ArrayOfModelRange *[]ModelRange
	Int32             *int32
}

AroundPrecision - Precision of a coordinate-based search in meters to group results with similar distances. The Geo ranking criterion considers all matches within the same range of distances to be equal.

func ArrayOfModelRangeAsAroundPrecision 

func ArrayOfModelRangeAsAroundPrecision(v []ModelRange) *AroundPrecision

[]ModelRangeAsAroundPrecision is a convenience function that returns []ModelRange wrapped in AroundPrecision.

func Int32AsAroundPrecision 

func Int32AsAroundPrecision(v int32) *AroundPrecision

int32AsAroundPrecision is a convenience function that returns int32 wrapped in AroundPrecision.

func (AroundPrecision) GetActualInstance 

func (obj AroundPrecision) GetActualInstance() any

Get the actual instance.

func (AroundPrecision) MarshalJSON 

func (src AroundPrecision) MarshalJSON() ([]byte, error)

Marshal data from the first non-nil pointers in the struct to JSON.

func (*AroundPrecision) UnmarshalJSON 

func (dst *AroundPrecision) UnmarshalJSON(data []byte) error

Unmarshal JSON data into one or more of the pointers in the struct.

type AroundRadius 

type AroundRadius struct {
	AroundRadiusAll *AroundRadiusAll
	Int32           *int32
}

AroundRadius - Maximum radius for a search around a central location. This parameter works in combination with the `aroundLatLng` and `aroundLatLngViaIP` parameters. By default, the search radius is determined automatically from the density of hits around the central location. The search radius is small if there are many hits close to the central coordinates.

func AroundRadiusAllAsAroundRadius 

func AroundRadiusAllAsAroundRadius(v AroundRadiusAll) *AroundRadius

AroundRadiusAllAsAroundRadius is a convenience function that returns AroundRadiusAll wrapped in AroundRadius.

func Int32AsAroundRadius 

func Int32AsAroundRadius(v int32) *AroundRadius

int32AsAroundRadius is a convenience function that returns int32 wrapped in AroundRadius.

func (AroundRadius) GetActualInstance 

func (obj AroundRadius) GetActualInstance() any

Get the actual instance.

func (AroundRadius) MarshalJSON 

func (src AroundRadius) MarshalJSON() ([]byte, error)

Marshal data from the first non-nil pointers in the struct to JSON.

func (*AroundRadius) UnmarshalJSON 

func (dst *AroundRadius) UnmarshalJSON(data []byte) error

Unmarshal JSON data into one or more of the pointers in the struct.

type AroundRadiusAll 

type AroundRadiusAll string

AroundRadiusAll Return all records with a valid `_geoloc` attribute. Don't filter by distance. 

const (
	AROUND_RADIUS_ALL_ALL AroundRadiusAll = "all"
)

List of aroundRadiusAll.

func NewAroundRadiusAllFromValue 

func NewAroundRadiusAllFromValue(v string) (*AroundRadiusAll, error)

NewAroundRadiusAllFromValue returns a pointer to a valid AroundRadiusAll. for the value passed as argument, or an error if the value passed is not allowed by the enum.

func (AroundRadiusAll) IsValid 

func (v AroundRadiusAll) IsValid() bool

IsValid return true if the value is valid for the enum, false otherwise.

func (AroundRadiusAll) Ptr 

func (v AroundRadiusAll) Ptr() *AroundRadiusAll

Ptr returns reference to aroundRadiusAll value.

func (*AroundRadiusAll) UnmarshalJSON 

func (v *AroundRadiusAll) UnmarshalJSON(src []byte) error
type Banner struct {
	Image *BannerImage `json:"image,omitempty"`
	Link  *BannerLink  `json:"link,omitempty"`
}

Banner Banner with image and link to redirect users.

func NewBanner 

func NewBanner(opts ...BannerOption) *Banner

NewBanner instantiates a new Banner object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed.

func NewEmptyBanner 

func NewEmptyBanner() *Banner

NewEmptyBanner return a pointer to an empty Banner object.

func (*Banner) GetImage 

func (o *Banner) GetImage() BannerImage

GetImage returns the Image field value if set, zero value otherwise.

func (*Banner) GetImageOk 

func (o *Banner) GetImageOk() (*BannerImage, bool)

GetImageOk returns a tuple with the Image field value if set, nil otherwise and a boolean to check if the value has been set. 

func (o *Banner) GetLink() BannerLink

GetLink returns the Link field value if set, zero value otherwise.

func (*Banner) GetLinkOk 

func (o *Banner) GetLinkOk() (*BannerLink, bool)

GetLinkOk returns a tuple with the Link field value if set, nil otherwise and a boolean to check if the value has been set.

func (*Banner) HasImage 

func (o *Banner) HasImage() bool

HasImage returns a boolean if a field has been set. 

func (o *Banner) HasLink() bool

HasLink returns a boolean if a field has been set.

func (Banner) MarshalJSON 

func (o Banner) MarshalJSON() ([]byte, error)

func (*Banner) SetImage 

func (o *Banner) SetImage(v *BannerImage) *Banner

SetImage gets a reference to the given BannerImage and assigns it to the Image field. 

func (o *Banner) SetLink(v *BannerLink) *Banner

SetLink gets a reference to the given BannerLink and assigns it to the Link field.

func (Banner) String 

func (o Banner) String() string

type BannerImage 

type BannerImage struct {
	Urls  []BannerImageUrl `json:"urls,omitempty"`
	Title *string          `json:"title,omitempty"`
}

BannerImage Image to show inside a banner.

func NewBannerImage 

func NewBannerImage(opts ...BannerImageOption) *BannerImage

NewBannerImage instantiates a new BannerImage object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed.

func NewEmptyBannerImage 

func NewEmptyBannerImage() *BannerImage

NewEmptyBannerImage return a pointer to an empty BannerImage object.

func (*BannerImage) GetTitle 

func (o *BannerImage) GetTitle() string

GetTitle returns the Title field value if set, zero value otherwise.

func (*BannerImage) GetTitleOk 

func (o *BannerImage) GetTitleOk() (*string, bool)

GetTitleOk returns a tuple with the Title field value if set, nil otherwise and a boolean to check if the value has been set.

func (*BannerImage) GetUrls 

func (o *BannerImage) GetUrls() []BannerImageUrl

GetUrls returns the Urls field value if set, zero value otherwise.

func (*BannerImage) GetUrlsOk 

func (o *BannerImage) GetUrlsOk() ([]BannerImageUrl, bool)

GetUrlsOk returns a tuple with the Urls field value if set, nil otherwise and a boolean to check if the value has been set.

func (*BannerImage) HasTitle 

func (o *BannerImage) HasTitle() bool

HasTitle returns a boolean if a field has been set.

func (*BannerImage) HasUrls 

func (o *BannerImage) HasUrls() bool

HasUrls returns a boolean if a field has been set.

func (BannerImage) MarshalJSON 

func (o BannerImage) MarshalJSON() ([]byte, error)

func (*BannerImage) SetTitle 

func (o *BannerImage) SetTitle(v string) *BannerImage

SetTitle gets a reference to the given string and assigns it to the Title field.

func (*BannerImage) SetUrls 

func (o *BannerImage) SetUrls(v []BannerImageUrl) *BannerImage

SetUrls gets a reference to the given []BannerImageUrl and assigns it to the Urls field.

func (BannerImage) String 

func (o BannerImage) String() string

type BannerImageOption 

type BannerImageOption func(f *BannerImage)

func WithBannerImageTitle 

func WithBannerImageTitle(val string) BannerImageOption

func WithBannerImageUrls 

func WithBannerImageUrls(val []BannerImageUrl) BannerImageOption

type BannerImageUrl 

type BannerImageUrl struct {
	Url *string `json:"url,omitempty"`
}

BannerImageUrl URL for an image to show inside a banner.

func NewBannerImageUrl 

func NewBannerImageUrl(opts ...BannerImageUrlOption) *BannerImageUrl

NewBannerImageUrl instantiates a new BannerImageUrl object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed.

func NewEmptyBannerImageUrl 

func NewEmptyBannerImageUrl() *BannerImageUrl

NewEmptyBannerImageUrl return a pointer to an empty BannerImageUrl object.

func (*BannerImageUrl) GetUrl 

func (o *BannerImageUrl) GetUrl() string

GetUrl returns the Url field value if set, zero value otherwise.

func (*BannerImageUrl) GetUrlOk 

func (o *BannerImageUrl) GetUrlOk() (*string, bool)

GetUrlOk returns a tuple with the Url field value if set, nil otherwise and a boolean to check if the value has been set.

func (*BannerImageUrl) HasUrl 

func (o *BannerImageUrl) HasUrl() bool

HasUrl returns a boolean if a field has been set.

func (BannerImageUrl) MarshalJSON 

func (o BannerImageUrl) MarshalJSON() ([]byte, error)

func (*BannerImageUrl) SetUrl 

func (o *BannerImageUrl) SetUrl(v string) *BannerImageUrl

SetUrl gets a reference to the given string and assigns it to the Url field.

func (BannerImageUrl) String 

func (o BannerImageUrl) String() string

type BannerImageUrlOption 

type BannerImageUrlOption func(f *BannerImageUrl)

func WithBannerImageUrlUrl 

func WithBannerImageUrlUrl(val string) BannerImageUrlOption
type BannerLink struct {
	Url *string `json:"url,omitempty"`
}

BannerLink Link for a banner defined in the Merchandising Studio. 

func NewBannerLink(opts ...BannerLinkOption) *BannerLink

NewBannerLink instantiates a new BannerLink object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed. 

func NewEmptyBannerLink() *BannerLink

NewEmptyBannerLink return a pointer to an empty BannerLink object.

func (*BannerLink) GetUrl 

func (o *BannerLink) GetUrl() string

GetUrl returns the Url field value if set, zero value otherwise.

func (*BannerLink) GetUrlOk 

func (o *BannerLink) GetUrlOk() (*string, bool)

GetUrlOk returns a tuple with the Url field value if set, nil otherwise and a boolean to check if the value has been set.

func (*BannerLink) HasUrl 

func (o *BannerLink) HasUrl() bool

HasUrl returns a boolean if a field has been set.

func (BannerLink) MarshalJSON 

func (o BannerLink) MarshalJSON() ([]byte, error)

func (*BannerLink) SetUrl 

func (o *BannerLink) SetUrl(v string) *BannerLink

SetUrl gets a reference to the given string and assigns it to the Url field.

func (BannerLink) String 

func (o BannerLink) String() string

type BannerLinkOption 

type BannerLinkOption func(f *BannerLink)

func WithBannerLinkUrl 

func WithBannerLinkUrl(val string) BannerLinkOption

type BannerOption 

type BannerOption func(f *Banner)

func WithBannerImage 

func WithBannerImage(val BannerImage) BannerOption
func WithBannerLink(val BannerLink) BannerOption

type BaseInjectionQueryParameters added in v4.26.0 

type BaseInjectionQueryParameters struct {
	// Whether to support phrase matching and excluding words from search queries Use the `advancedSyntaxFeatures` parameter to control which feature is supported.
	AdvancedSyntax *bool `json:"advancedSyntax,omitempty"`
	// Advanced search syntax features you want to support - `exactPhrase`.   Phrases in quotes must match exactly.   For example, `sparkly blue \"iPhone case\"` only returns records with the exact string \"iPhone case\" - `excludeWords`.   Query words prefixed with a `-` must not occur in a record.   For example, `search -engine` matches records that contain \"search\" but not \"engine\" This setting only has an effect if `advancedSyntax` is true.
	AdvancedSyntaxFeatures []AdvancedSyntaxFeatures `json:"advancedSyntaxFeatures,omitempty"`
	// Whether to allow typos on numbers in the search query Turn off this setting to reduce the number of irrelevant matches when searching in large sets of similar numbers.
	AllowTyposOnNumericTokens *bool `json:"allowTyposOnNumericTokens,omitempty"`
	// Determine which plurals and synonyms should be considered an exact matches By default, Algolia treats singular and plural forms of a word, and single-word synonyms, as [exact](https://www.algolia.com/doc/guides/managing-results/relevance-overview/in-depth/ranking-criteria/#exact) matches when searching. For example - \"swimsuit\" and \"swimsuits\" are treated the same - \"swimsuit\" and \"swimwear\" are treated the same (if they are [synonyms](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/adding-synonyms/#regular-synonyms)) - `ignorePlurals`.   Plurals and similar declensions added by the `ignorePlurals` setting are considered exact matches - `singleWordSynonym`.   Single-word synonyms, such as \"NY\" = \"NYC\", are considered exact matches - `multiWordsSynonym`.   Multi-word synonyms, such as \"NY\" = \"New York\", are considered exact matches.
	AlternativesAsExact []AlternativesAsExact `json:"alternativesAsExact,omitempty"`
	// Whether the best matching attribute should be determined by minimum proximity This setting only affects ranking if the Attribute ranking criterion comes before Proximity in the `ranking` setting. If true, the best matching attribute is selected based on the minimum proximity of multiple matches. Otherwise, the best matching attribute is determined by the order in the `searchableAttributes` setting.
	AttributeCriteriaComputedByMinProximity *bool `json:"attributeCriteriaComputedByMinProximity,omitempty"`
	// Attributes to highlight By default, all searchable attributes are highlighted. Use `*` to highlight all attributes or use an empty array `[]` to turn off highlighting. Attribute names are case-sensitive With highlighting, strings that match the search query are surrounded by HTML tags defined by `highlightPreTag` and `highlightPostTag`. You can use this to visually highlight matching parts of a search query in your UI For more information, see [Highlighting and snippeting](https://www.algolia.com/doc/guides/building-search-ui/ui-and-ux-patterns/highlighting-snippeting/js).
	AttributesToHighlight []string `json:"attributesToHighlight,omitempty"`
	// Attributes to include in the API response To reduce the size of your response, you can retrieve only some of the attributes. Attribute names are case-sensitive - `*` retrieves all attributes, except attributes included in the `customRanking` and `unretrievableAttributes` settings. - To retrieve all attributes except a specific one, prefix the attribute with a dash and combine it with the `*`: `[\"*\", \"-ATTRIBUTE\"]`. - The `objectID` attribute is always included.
	AttributesToRetrieve []string `json:"attributesToRetrieve,omitempty"`
	// Attributes for which to enable snippets. Attribute names are case-sensitive Snippets provide additional context to matched words. If you enable snippets, they include 10 words, including the matched word. The matched word will also be wrapped by HTML tags for highlighting. You can adjust the number of words with the following notation: `ATTRIBUTE:NUMBER`, where `NUMBER` is the number of words to be extracted.
	AttributesToSnippet []string `json:"attributesToSnippet,omitempty"`
	// Whether to include a `queryID` attribute in the response The query ID is a unique identifier for a search query and is required for tracking [click and conversion events](https://www.algolia.com/doc/guides/sending-events/getting-started).
	ClickAnalytics *bool `json:"clickAnalytics,omitempty"`
	// Searchable attributes for which you want to [turn off the Exact ranking criterion](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/override-search-engine-defaults/in-depth/adjust-exact-settings/#turn-off-exact-for-some-attributes). Attribute names are case-sensitive This can be useful for attributes with long values, where the likelihood of an exact match is high, such as product descriptions. Turning off the Exact ranking criterion for these attributes favors exact matching on other attributes. This reduces the impact of individual attributes with a lot of content on ranking.
	DisableExactOnAttributes []string `json:"disableExactOnAttributes,omitempty"`
	// Attributes for which you want to turn off [typo tolerance](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/typo-tolerance). Attribute names are case-sensitive Returning only exact matches can help when - [Searching in hyphenated attributes](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/typo-tolerance/how-to/how-to-search-in-hyphenated-attributes). - Reducing the number of matches when you have too many.   This can happen with attributes that are long blocks of text, such as product descriptions Consider alternatives such as `disableTypoToleranceOnWords` or adding synonyms if your attributes have intentional unusual spellings that might look like typos.
	DisableTypoToleranceOnAttributes []string  `json:"disableTypoToleranceOnAttributes,omitempty"`
	Distinct                         *Distinct `json:"distinct,omitempty"`
	// Whether to enable A/B testing for this search.
	EnableABTest *bool `json:"enableABTest,omitempty"`
	// Whether to enable Personalization.
	EnablePersonalization *bool `json:"enablePersonalization,omitempty"`
	// Whether this search will use [Dynamic Re-Ranking](https://www.algolia.com/doc/guides/algolia-ai/re-ranking) This setting only has an effect if you activated Dynamic Re-Ranking for this index in the Algolia dashboard.
	EnableReRanking *bool `json:"enableReRanking,omitempty"`
	// Whether to enable rules.
	EnableRules            *bool                   `json:"enableRules,omitempty"`
	ExactOnSingleWordQuery *ExactOnSingleWordQuery `json:"exactOnSingleWordQuery,omitempty"`
	FacetFilters           *FacetFilters           `json:"facetFilters,omitempty"`
	// Filter expression to only include items that match the filter criteria in the response.  You can use these filter expressions:  - **Numeric filters.** `<facet> <op> <number>`, where `<op>` is one of `<`, `<=`, `=`, `!=`, `>`, `>=`. - **Ranges.** `<facet>:<lower> TO <upper>`, where `<lower>` and `<upper>` are the lower and upper limits of the range (inclusive). - **Facet filters.** `<facet>:<value>`, where `<facet>` is a facet attribute (case-sensitive) and `<value>` a facet value. - **Tag filters.** `_tags:<value>` or just `<value>` (case-sensitive). - **Boolean filters.** `<facet>: true | false`.  You can combine filters with `AND`, `OR`, and `NOT` operators with the following restrictions:  - You can only combine filters of the same type with `OR`.   **Not supported:** `facet:value OR num > 3`. - You can't use `NOT` with combinations of filters.   **Not supported:** `NOT(facet:value OR facet:value)` - You can't combine conjunctions (`AND`) with `OR`.   **Not supported:** `facet:value OR (facet:value AND facet:value)`  Use quotes if the facet attribute name or facet value contains spaces, keywords (`OR`, `AND`, `NOT`), or quotes. If a facet attribute is an array, the filter matches if it matches at least one element of the array.  For more information, see [Filters](https://www.algolia.com/doc/guides/managing-results/refine-results/filtering).
	Filters *string `json:"filters,omitempty"`
	// Whether the search response should include detailed ranking information.
	GetRankingInfo *bool `json:"getRankingInfo,omitempty"`
	// HTML tag to insert after the highlighted parts in all highlighted results and snippets.
	HighlightPostTag *string `json:"highlightPostTag,omitempty"`
	// HTML tag to insert before the highlighted parts in all highlighted results and snippets.
	HighlightPreTag *string        `json:"highlightPreTag,omitempty"`
	IgnorePlurals   *IgnorePlurals `json:"ignorePlurals,omitempty"`
	// Minimum proximity score for two matching words This adjusts the [Proximity ranking criterion](https://www.algolia.com/doc/guides/managing-results/relevance-overview/in-depth/ranking-criteria/#proximity) by equally scoring matches that are farther apart For example, if `minProximity` is 2, neighboring matches and matches with one word between them would have the same score.
	MinProximity *int32 `json:"minProximity,omitempty"`
	// Minimum number of characters a word in the search query must contain to accept matches with [one typo](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/typo-tolerance/in-depth/configuring-typo-tolerance/#configuring-word-length-for-typos).
	MinWordSizefor1Typo *int32 `json:"minWordSizefor1Typo,omitempty"`
	// Minimum number of characters a word in the search query must contain to accept matches with [two typos](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/typo-tolerance/in-depth/configuring-typo-tolerance/#configuring-word-length-for-typos).
	MinWordSizefor2Typos *int32 `json:"minWordSizefor2Typos,omitempty"`
	// ISO language codes that adjust settings that are useful for processing natural language queries (as opposed to keyword searches) - Sets `removeStopWords` and `ignorePlurals` to the list of provided languages. - Sets `removeWordsIfNoResults` to `allOptional`. - Adds a `natural_language` attribute to `ruleContexts` and `analyticsTags`.
	NaturalLanguages []SupportedLanguage           `json:"naturalLanguages,omitempty"`
	NumericFilters   *NumericFilters               `json:"numericFilters,omitempty"`
	OptionalFilters  *OptionalFilters              `json:"optionalFilters,omitempty"`
	OptionalWords    utils.Nullable[OptionalWords] `json:"optionalWords,omitempty"`
	// Whether to include this search when calculating processing-time percentiles.
	PercentileComputation *bool `json:"percentileComputation,omitempty"`
	// Impact that Personalization should have on this search The higher this value is, the more Personalization determines the ranking compared to other factors. For more information, see [Understanding Personalization impact](https://www.algolia.com/doc/guides/personalization/personalizing-results/in-depth/configuring-personalization/#understanding-personalization-impact).
	PersonalizationImpact *int32 `json:"personalizationImpact,omitempty"`
	// Languages for language-specific query processing steps such as plurals, stop-word removal, and word-detection dictionaries. This setting sets a default list of languages used by the `removeStopWords` and `ignorePlurals` settings. This setting also sets a dictionary for word detection in the logogram-based [CJK](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/handling-natural-languages-nlp/in-depth/normalization/#normalization-for-logogram-based-languages-cjk) languages. To support this, place the CJK language **first**. **Always specify a query language.** If you don't specify an indexing language, the search engine uses all [supported languages](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/handling-natural-languages-nlp/in-depth/supported-languages), or the languages you specified with the `ignorePlurals` or `removeStopWords` parameters. This can lead to unexpected search results. For more information, see [Language-specific configuration](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/handling-natural-languages-nlp/in-depth/language-specific-configurations).
	QueryLanguages         []SupportedLanguage     `json:"queryLanguages,omitempty"`
	QueryType              *QueryType              `json:"queryType,omitempty"`
	RemoveStopWords        *RemoveStopWords        `json:"removeStopWords,omitempty"`
	RemoveWordsIfNoResults *RemoveWordsIfNoResults `json:"removeWordsIfNoResults,omitempty"`
	// Whether to replace a highlighted word with the matched synonym By default, the original words are highlighted even if a synonym matches. For example, with `home` as a synonym for `house` and a search for `home`, records matching either \"home\" or \"house\" are included in the search results, and either \"home\" or \"house\" are highlighted With `replaceSynonymsInHighlight` set to `true`, a search for `home` still matches the same records, but all occurrences of \"house\" are replaced by \"home\" in the highlighted response.
	ReplaceSynonymsInHighlight *bool `json:"replaceSynonymsInHighlight,omitempty"`
	// Properties to include in the API response of search and browse requests By default, all response properties are included. To reduce the response size, you can select which properties should be included An empty list may lead to an empty API response (except properties you can't exclude) You can't exclude these properties: `message`, `warning`, `cursor`, `abTestVariantID`, or any property added by setting `getRankingInfo` to true Your search depends on the `hits` field. If you omit this field, searches won't return any results. Your UI might also depend on other properties, for example, for pagination. Before restricting the response size, check the impact on your search experience.
	ResponseFields []string `json:"responseFields,omitempty"`
	// Whether to restrict highlighting and snippeting to items that at least partially matched the search query. By default, all items are highlighted and snippeted.
	RestrictHighlightAndSnippetArrays *bool `json:"restrictHighlightAndSnippetArrays,omitempty"`
	// Restricts a search to a subset of your searchable attributes. Attribute names are case-sensitive.
	RestrictSearchableAttributes []string `json:"restrictSearchableAttributes,omitempty"`
	// Assigns a rule context to the search query [Rule contexts](https://www.algolia.com/doc/guides/managing-results/rules/rules-overview/how-to/customize-search-results-by-platform/#whats-a-context) are strings that you can use to trigger matching rules.
	RuleContexts []string `json:"ruleContexts,omitempty"`
	// String used as an ellipsis indicator when a snippet is truncated.
	SnippetEllipsisText *string `json:"snippetEllipsisText,omitempty"`
	// Whether to take into account an index's synonyms for this search.
	Synonyms      *bool          `json:"synonyms,omitempty"`
	TypoTolerance *TypoTolerance `json:"typoTolerance,omitempty"`
}

BaseInjectionQueryParameters struct for BaseInjectionQueryParameters.

func NewBaseInjectionQueryParameters added in v4.26.0 

func NewBaseInjectionQueryParameters(opts ...BaseInjectionQueryParametersOption) *BaseInjectionQueryParameters

NewBaseInjectionQueryParameters instantiates a new BaseInjectionQueryParameters object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed.

func NewEmptyBaseInjectionQueryParameters added in v4.26.0 

func NewEmptyBaseInjectionQueryParameters() *BaseInjectionQueryParameters

NewEmptyBaseInjectionQueryParameters return a pointer to an empty BaseInjectionQueryParameters object.

func (*BaseInjectionQueryParameters) GetAdvancedSyntax added in v4.26.0 

func (o *BaseInjectionQueryParameters) GetAdvancedSyntax() bool

GetAdvancedSyntax returns the AdvancedSyntax field value if set, zero value otherwise.

func (*BaseInjectionQueryParameters) GetAdvancedSyntaxFeatures added in v4.26.0 

func (o *BaseInjectionQueryParameters) GetAdvancedSyntaxFeatures() []AdvancedSyntaxFeatures

GetAdvancedSyntaxFeatures returns the AdvancedSyntaxFeatures field value if set, zero value otherwise.

func (*BaseInjectionQueryParameters) GetAdvancedSyntaxFeaturesOk added in v4.26.0 

func (o *BaseInjectionQueryParameters) GetAdvancedSyntaxFeaturesOk() ([]AdvancedSyntaxFeatures, bool)

GetAdvancedSyntaxFeaturesOk returns a tuple with the AdvancedSyntaxFeatures field value if set, nil otherwise and a boolean to check if the value has been set.

func (*BaseInjectionQueryParameters) GetAdvancedSyntaxOk added in v4.26.0 

func (o *BaseInjectionQueryParameters) GetAdvancedSyntaxOk() (*bool, bool)

GetAdvancedSyntaxOk returns a tuple with the AdvancedSyntax field value if set, nil otherwise and a boolean to check if the value has been set.

func (*BaseInjectionQueryParameters) GetAllowTyposOnNumericTokens added in v4.26.0 

func (o *BaseInjectionQueryParameters) GetAllowTyposOnNumericTokens() bool

GetAllowTyposOnNumericTokens returns the AllowTyposOnNumericTokens field value if set, zero value otherwise.

func (*BaseInjectionQueryParameters) GetAllowTyposOnNumericTokensOk added in v4.26.0 

func (o *BaseInjectionQueryParameters) GetAllowTyposOnNumericTokensOk() (*bool, bool)

GetAllowTyposOnNumericTokensOk returns a tuple with the AllowTyposOnNumericTokens field value if set, nil otherwise and a boolean to check if the value has been set.

func (*BaseInjectionQueryParameters) GetAlternativesAsExact added in v4.26.0 

func (o *BaseInjectionQueryParameters) GetAlternativesAsExact() []AlternativesAsExact

GetAlternativesAsExact returns the AlternativesAsExact field value if set, zero value otherwise.

func (*BaseInjectionQueryParameters) GetAlternativesAsExactOk added in v4.26.0 

func (o *BaseInjectionQueryParameters) GetAlternativesAsExactOk() ([]AlternativesAsExact, bool)

GetAlternativesAsExactOk returns a tuple with the AlternativesAsExact field value if set, nil otherwise and a boolean to check if the value has been set.

func (*BaseInjectionQueryParameters) GetAttributeCriteriaComputedByMinProximity added in v4.26.0 

func (o *BaseInjectionQueryParameters) GetAttributeCriteriaComputedByMinProximity() bool

GetAttributeCriteriaComputedByMinProximity returns the AttributeCriteriaComputedByMinProximity field value if set, zero value otherwise.

func (*BaseInjectionQueryParameters) GetAttributeCriteriaComputedByMinProximityOk added in v4.26.0 

func (o *BaseInjectionQueryParameters) GetAttributeCriteriaComputedByMinProximityOk() (*bool, bool)

GetAttributeCriteriaComputedByMinProximityOk returns a tuple with the AttributeCriteriaComputedByMinProximity field value if set, nil otherwise and a boolean to check if the value has been set.

func (*BaseInjectionQueryParameters) GetAttributesToHighlight added in v4.26.0 

func (o *BaseInjectionQueryParameters) GetAttributesToHighlight() []string

GetAttributesToHighlight returns the AttributesToHighlight field value if set, zero value otherwise.

func (*BaseInjectionQueryParameters) GetAttributesToHighlightOk added in v4.26.0 

func (o *BaseInjectionQueryParameters) GetAttributesToHighlightOk() ([]string, bool)

GetAttributesToHighlightOk returns a tuple with the AttributesToHighlight field value if set, nil otherwise and a boolean to check if the value has been set.

func (*BaseInjectionQueryParameters) GetAttributesToRetrieve added in v4.26.0 

func (o *BaseInjectionQueryParameters) GetAttributesToRetrieve() []string

GetAttributesToRetrieve returns the AttributesToRetrieve field value if set, zero value otherwise.

func (*BaseInjectionQueryParameters) GetAttributesToRetrieveOk added in v4.26.0 

func (o *BaseInjectionQueryParameters) GetAttributesToRetrieveOk() ([]string, bool)

GetAttributesToRetrieveOk returns a tuple with the AttributesToRetrieve field value if set, nil otherwise and a boolean to check if the value has been set.

func (*BaseInjectionQueryParameters) GetAttributesToSnippet added in v4.26.0 

func (o *BaseInjectionQueryParameters) GetAttributesToSnippet() []string

GetAttributesToSnippet returns the AttributesToSnippet field value if set, zero value otherwise.

func (*BaseInjectionQueryParameters) GetAttributesToSnippetOk added in v4.26.0 

func (o *BaseInjectionQueryParameters) GetAttributesToSnippetOk() ([]string, bool)

GetAttributesToSnippetOk returns a tuple with the AttributesToSnippet field value if set, nil otherwise and a boolean to check if the value has been set.

func (*BaseInjectionQueryParameters) GetClickAnalytics added in v4.26.0 

func (o *BaseInjectionQueryParameters) GetClickAnalytics() bool

GetClickAnalytics returns the ClickAnalytics field value if set, zero value otherwise.

func (*BaseInjectionQueryParameters) GetClickAnalyticsOk added in v4.26.0 

func (o *BaseInjectionQueryParameters) GetClickAnalyticsOk() (*bool, bool)

GetClickAnalyticsOk returns a tuple with the ClickAnalytics field value if set, nil otherwise and a boolean to check if the value has been set.

func (*BaseInjectionQueryParameters) GetDisableExactOnAttributes added in v4.26.0 

func (o *BaseInjectionQueryParameters) GetDisableExactOnAttributes() []string

GetDisableExactOnAttributes returns the DisableExactOnAttributes field value if set, zero value otherwise.

func (*BaseInjectionQueryParameters) GetDisableExactOnAttributesOk added in v4.26.0 

func (o *BaseInjectionQueryParameters) GetDisableExactOnAttributesOk() ([]string, bool)

GetDisableExactOnAttributesOk returns a tuple with the DisableExactOnAttributes field value if set, nil otherwise and a boolean to check if the value has been set.

func (*BaseInjectionQueryParameters) GetDisableTypoToleranceOnAttributes added in v4.26.0 

func (o *BaseInjectionQueryParameters) GetDisableTypoToleranceOnAttributes() []string

GetDisableTypoToleranceOnAttributes returns the DisableTypoToleranceOnAttributes field value if set, zero value otherwise.

func (*BaseInjectionQueryParameters) GetDisableTypoToleranceOnAttributesOk added in v4.26.0 

func (o *BaseInjectionQueryParameters) GetDisableTypoToleranceOnAttributesOk() ([]string, bool)

GetDisableTypoToleranceOnAttributesOk returns a tuple with the DisableTypoToleranceOnAttributes field value if set, nil otherwise and a boolean to check if the value has been set.

func (*BaseInjectionQueryParameters) GetDistinct added in v4.26.0 

func (o *BaseInjectionQueryParameters) GetDistinct() Distinct

GetDistinct returns the Distinct field value if set, zero value otherwise.

func (*BaseInjectionQueryParameters) GetDistinctOk added in v4.26.0 

func (o *BaseInjectionQueryParameters) GetDistinctOk() (*Distinct, bool)

GetDistinctOk returns a tuple with the Distinct field value if set, nil otherwise and a boolean to check if the value has been set.

func (*BaseInjectionQueryParameters) GetEnableABTest added in v4.26.0 

func (o *BaseInjectionQueryParameters) GetEnableABTest() bool

GetEnableABTest returns the EnableABTest field value if set, zero value otherwise.

func (*BaseInjectionQueryParameters) GetEnableABTestOk added in v4.26.0 

func (o *BaseInjectionQueryParameters) GetEnableABTestOk() (*bool, bool)

GetEnableABTestOk returns a tuple with the EnableABTest field value if set, nil otherwise and a boolean to check if the value has been set.

func (*BaseInjectionQueryParameters) GetEnablePersonalization added in v4.26.0 

func (o *BaseInjectionQueryParameters) GetEnablePersonalization() bool

GetEnablePersonalization returns the EnablePersonalization field value if set, zero value otherwise.

func (*BaseInjectionQueryParameters) GetEnablePersonalizationOk added in v4.26.0 

func (o *BaseInjectionQueryParameters) GetEnablePersonalizationOk() (*bool, bool)

GetEnablePersonalizationOk returns a tuple with the EnablePersonalization field value if set, nil otherwise and a boolean to check if the value has been set.

func (*BaseInjectionQueryParameters) GetEnableReRanking added in v4.26.0 

func (o *BaseInjectionQueryParameters) GetEnableReRanking() bool

GetEnableReRanking returns the EnableReRanking field value if set, zero value otherwise.

func (*BaseInjectionQueryParameters) GetEnableReRankingOk added in v4.26.0 

func (o *BaseInjectionQueryParameters) GetEnableReRankingOk() (*bool, bool)

GetEnableReRankingOk returns a tuple with the EnableReRanking field value if set, nil otherwise and a boolean to check if the value has been set.

func (*BaseInjectionQueryParameters) GetEnableRules added in v4.26.0 

func (o *BaseInjectionQueryParameters) GetEnableRules() bool

GetEnableRules returns the EnableRules field value if set, zero value otherwise.

func (*BaseInjectionQueryParameters) GetEnableRulesOk added in v4.26.0 

func (o *BaseInjectionQueryParameters) GetEnableRulesOk() (*bool, bool)

GetEnableRulesOk returns a tuple with the EnableRules field value if set, nil otherwise and a boolean to check if the value has been set.

func (*BaseInjectionQueryParameters) GetExactOnSingleWordQuery added in v4.26.0 

func (o *BaseInjectionQueryParameters) GetExactOnSingleWordQuery() ExactOnSingleWordQuery

GetExactOnSingleWordQuery returns the ExactOnSingleWordQuery field value if set, zero value otherwise.

func (*BaseInjectionQueryParameters) GetExactOnSingleWordQueryOk added in v4.26.0 

func (o *BaseInjectionQueryParameters) GetExactOnSingleWordQueryOk() (*ExactOnSingleWordQuery, bool)

GetExactOnSingleWordQueryOk returns a tuple with the ExactOnSingleWordQuery field value if set, nil otherwise and a boolean to check if the value has been set.

func (*BaseInjectionQueryParameters) GetFacetFilters added in v4.26.0 

func (o *BaseInjectionQueryParameters) GetFacetFilters() FacetFilters

GetFacetFilters returns the FacetFilters field value if set, zero value otherwise.

func (*BaseInjectionQueryParameters) GetFacetFiltersOk added in v4.26.0 

func (o *BaseInjectionQueryParameters) GetFacetFiltersOk() (*FacetFilters, bool)

GetFacetFiltersOk returns a tuple with the FacetFilters field value if set, nil otherwise and a boolean to check if the value has been set.

func (*BaseInjectionQueryParameters) GetFilters added in v4.26.0 

func (o *BaseInjectionQueryParameters) GetFilters() string

GetFilters returns the Filters field value if set, zero value otherwise.

func (*BaseInjectionQueryParameters) GetFiltersOk added in v4.26.0 

func (o *BaseInjectionQueryParameters) GetFiltersOk() (*string, bool)

GetFiltersOk returns a tuple with the Filters field value if set, nil otherwise and a boolean to check if the value has been set.

func (*BaseInjectionQueryParameters) GetGetRankingInfo added in v4.26.0 

func (o *BaseInjectionQueryParameters) GetGetRankingInfo() bool

GetGetRankingInfo returns the GetRankingInfo field value if set, zero value otherwise.

func (*BaseInjectionQueryParameters) GetGetRankingInfoOk added in v4.26.0 

func (o *BaseInjectionQueryParameters) GetGetRankingInfoOk() (*bool, bool)

GetGetRankingInfoOk returns a tuple with the GetRankingInfo field value if set, nil otherwise and a boolean to check if the value has been set.

func (*BaseInjectionQueryParameters) GetHighlightPostTag added in v4.26.0 

func (o *BaseInjectionQueryParameters) GetHighlightPostTag() string

GetHighlightPostTag returns the HighlightPostTag field value if set, zero value otherwise.

func (*BaseInjectionQueryParameters) GetHighlightPostTagOk added in v4.26.0 

func (o *BaseInjectionQueryParameters) GetHighlightPostTagOk() (*string, bool)

GetHighlightPostTagOk returns a tuple with the HighlightPostTag field value if set, nil otherwise and a boolean to check if the value has been set.

func (*BaseInjectionQueryParameters) GetHighlightPreTag added in v4.26.0 

func (o *BaseInjectionQueryParameters) GetHighlightPreTag() string

GetHighlightPreTag returns the HighlightPreTag field value if set, zero value otherwise.

func (*BaseInjectionQueryParameters) GetHighlightPreTagOk added in v4.26.0 

func (o *BaseInjectionQueryParameters) GetHighlightPreTagOk() (*string, bool)

GetHighlightPreTagOk returns a tuple with the HighlightPreTag field value if set, nil otherwise and a boolean to check if the value has been set.

func (*BaseInjectionQueryParameters) GetIgnorePlurals added in v4.26.0 

func (o *BaseInjectionQueryParameters) GetIgnorePlurals() IgnorePlurals

GetIgnorePlurals returns the IgnorePlurals field value if set, zero value otherwise.

func (*BaseInjectionQueryParameters) GetIgnorePluralsOk added in v4.26.0 

func (o *BaseInjectionQueryParameters) GetIgnorePluralsOk() (*IgnorePlurals, bool)

GetIgnorePluralsOk returns a tuple with the IgnorePlurals field value if set, nil otherwise and a boolean to check if the value has been set.

func (*BaseInjectionQueryParameters) GetMinProximity added in v4.26.0 

func (o *BaseInjectionQueryParameters) GetMinProximity() int32

GetMinProximity returns the MinProximity field value if set, zero value otherwise.

func (*BaseInjectionQueryParameters) GetMinProximityOk added in v4.26.0 

func (o *BaseInjectionQueryParameters) GetMinProximityOk() (*int32, bool)

GetMinProximityOk returns a tuple with the MinProximity field value if set, nil otherwise and a boolean to check if the value has been set.

func (*BaseInjectionQueryParameters) GetMinWordSizefor1Typo added in v4.26.0 

func (o *BaseInjectionQueryParameters) GetMinWordSizefor1Typo() int32

GetMinWordSizefor1Typo returns the MinWordSizefor1Typo field value if set, zero value otherwise.

func (*BaseInjectionQueryParameters) GetMinWordSizefor1TypoOk added in v4.26.0 

func (o *BaseInjectionQueryParameters) GetMinWordSizefor1TypoOk() (*int32, bool)

GetMinWordSizefor1TypoOk returns a tuple with the MinWordSizefor1Typo field value if set, nil otherwise and a boolean to check if the value has been set.

func (*BaseInjectionQueryParameters) GetMinWordSizefor2Typos added in v4.26.0 

func (o *BaseInjectionQueryParameters) GetMinWordSizefor2Typos() int32

GetMinWordSizefor2Typos returns the MinWordSizefor2Typos field value if set, zero value otherwise.

func (*BaseInjectionQueryParameters) GetMinWordSizefor2TyposOk added in v4.26.0 

func (o *BaseInjectionQueryParameters) GetMinWordSizefor2TyposOk() (*int32, bool)

GetMinWordSizefor2TyposOk returns a tuple with the MinWordSizefor2Typos field value if set, nil otherwise and a boolean to check if the value has been set.

func (*BaseInjectionQueryParameters) GetNaturalLanguages added in v4.26.0 

func (o *BaseInjectionQueryParameters) GetNaturalLanguages() []SupportedLanguage

GetNaturalLanguages returns the NaturalLanguages field value if set, zero value otherwise.

func (*BaseInjectionQueryParameters) GetNaturalLanguagesOk added in v4.26.0 

func (o *BaseInjectionQueryParameters) GetNaturalLanguagesOk() ([]SupportedLanguage, bool)

GetNaturalLanguagesOk returns a tuple with the NaturalLanguages field value if set, nil otherwise and a boolean to check if the value has been set.

func (*BaseInjectionQueryParameters) GetNumericFilters added in v4.26.0 

func (o *BaseInjectionQueryParameters) GetNumericFilters() NumericFilters

GetNumericFilters returns the NumericFilters field value if set, zero value otherwise.

func (*BaseInjectionQueryParameters) GetNumericFiltersOk added in v4.26.0 

func (o *BaseInjectionQueryParameters) GetNumericFiltersOk() (*NumericFilters, bool)

GetNumericFiltersOk returns a tuple with the NumericFilters field value if set, nil otherwise and a boolean to check if the value has been set.

func (*BaseInjectionQueryParameters) GetOptionalFilters added in v4.26.0 

func (o *BaseInjectionQueryParameters) GetOptionalFilters() OptionalFilters

GetOptionalFilters returns the OptionalFilters field value if set, zero value otherwise.

func (*BaseInjectionQueryParameters) GetOptionalFiltersOk added in v4.26.0 

func (o *BaseInjectionQueryParameters) GetOptionalFiltersOk() (*OptionalFilters, bool)

GetOptionalFiltersOk returns a tuple with the OptionalFilters field value if set, nil otherwise and a boolean to check if the value has been set.

func (*BaseInjectionQueryParameters) GetOptionalWords added in v4.26.0 

func (o *BaseInjectionQueryParameters) GetOptionalWords() OptionalWords

GetOptionalWords returns the OptionalWords field value if set, zero value otherwise (both if not set or set to explicit null).

func (*BaseInjectionQueryParameters) GetOptionalWordsOk added in v4.26.0 

func (o *BaseInjectionQueryParameters) GetOptionalWordsOk() (*OptionalWords, bool)

GetOptionalWordsOk returns a tuple with the OptionalWords field value if set, nil otherwise and a boolean to check if the value has been set. NOTE: If the value is an explicit nil, `nil, true` will be returned.

func (*BaseInjectionQueryParameters) GetPercentileComputation added in v4.26.0 

func (o *BaseInjectionQueryParameters) GetPercentileComputation() bool

GetPercentileComputation returns the PercentileComputation field value if set, zero value otherwise.

func (*BaseInjectionQueryParameters) GetPercentileComputationOk added in v4.26.0 

func (o *BaseInjectionQueryParameters) GetPercentileComputationOk() (*bool, bool)

GetPercentileComputationOk returns a tuple with the PercentileComputation field value if set, nil otherwise and a boolean to check if the value has been set.

func (*BaseInjectionQueryParameters) GetPersonalizationImpact added in v4.26.0 

func (o *BaseInjectionQueryParameters) GetPersonalizationImpact() int32

GetPersonalizationImpact returns the PersonalizationImpact field value if set, zero value otherwise.

func (*BaseInjectionQueryParameters) GetPersonalizationImpactOk added in v4.26.0 

func (o *BaseInjectionQueryParameters) GetPersonalizationImpactOk() (*int32, bool)

GetPersonalizationImpactOk returns a tuple with the PersonalizationImpact field value if set, nil otherwise and a boolean to check if the value has been set.

func (*BaseInjectionQueryParameters) GetQueryLanguages added in v4.26.0 

func (o *BaseInjectionQueryParameters) GetQueryLanguages() []SupportedLanguage

GetQueryLanguages returns the QueryLanguages field value if set, zero value otherwise.

func (*BaseInjectionQueryParameters) GetQueryLanguagesOk added in v4.26.0 

func (o *BaseInjectionQueryParameters) GetQueryLanguagesOk() ([]SupportedLanguage, bool)

GetQueryLanguagesOk returns a tuple with the QueryLanguages field value if set, nil otherwise and a boolean to check if the value has been set.

func (*BaseInjectionQueryParameters) GetQueryType added in v4.26.0 

func (o *BaseInjectionQueryParameters) GetQueryType() QueryType

GetQueryType returns the QueryType field value if set, zero value otherwise.

func (*BaseInjectionQueryParameters) GetQueryTypeOk added in v4.26.0 

func (o *BaseInjectionQueryParameters) GetQueryTypeOk() (*QueryType, bool)

GetQueryTypeOk returns a tuple with the QueryType field value if set, nil otherwise and a boolean to check if the value has been set.

func (*BaseInjectionQueryParameters) GetRemoveStopWords added in v4.26.0 

func (o *BaseInjectionQueryParameters) GetRemoveStopWords() RemoveStopWords

GetRemoveStopWords returns the RemoveStopWords field value if set, zero value otherwise.

func (*BaseInjectionQueryParameters) GetRemoveStopWordsOk added in v4.26.0 

func (o *BaseInjectionQueryParameters) GetRemoveStopWordsOk() (*RemoveStopWords, bool)

GetRemoveStopWordsOk returns a tuple with the RemoveStopWords field value if set, nil otherwise and a boolean to check if the value has been set.

func (*BaseInjectionQueryParameters) GetRemoveWordsIfNoResults added in v4.26.0 

func (o *BaseInjectionQueryParameters) GetRemoveWordsIfNoResults() RemoveWordsIfNoResults

GetRemoveWordsIfNoResults returns the RemoveWordsIfNoResults field value if set, zero value otherwise.

func (*BaseInjectionQueryParameters) GetRemoveWordsIfNoResultsOk added in v4.26.0 

func (o *BaseInjectionQueryParameters) GetRemoveWordsIfNoResultsOk() (*RemoveWordsIfNoResults, bool)

GetRemoveWordsIfNoResultsOk returns a tuple with the RemoveWordsIfNoResults field value if set, nil otherwise and a boolean to check if the value has been set.

func (*BaseInjectionQueryParameters) GetReplaceSynonymsInHighlight added in v4.26.0 

func (o *BaseInjectionQueryParameters) GetReplaceSynonymsInHighlight() bool

GetReplaceSynonymsInHighlight returns the ReplaceSynonymsInHighlight field value if set, zero value otherwise.

func (*BaseInjectionQueryParameters) GetReplaceSynonymsInHighlightOk added in v4.26.0 

func (o *BaseInjectionQueryParameters) GetReplaceSynonymsInHighlightOk() (*bool, bool)

GetReplaceSynonymsInHighlightOk returns a tuple with the ReplaceSynonymsInHighlight field value if set, nil otherwise and a boolean to check if the value has been set.

func (*BaseInjectionQueryParameters) GetResponseFields added in v4.26.0 

func (o *BaseInjectionQueryParameters) GetResponseFields() []string

GetResponseFields returns the ResponseFields field value if set, zero value otherwise.

func (*BaseInjectionQueryParameters) GetResponseFieldsOk added in v4.26.0 

func (o *BaseInjectionQueryParameters) GetResponseFieldsOk() ([]string, bool)

GetResponseFieldsOk returns a tuple with the ResponseFields field value if set, nil otherwise and a boolean to check if the value has been set.

func (*BaseInjectionQueryParameters) GetRestrictHighlightAndSnippetArrays added in v4.26.0 

func (o *BaseInjectionQueryParameters) GetRestrictHighlightAndSnippetArrays() bool

GetRestrictHighlightAndSnippetArrays returns the RestrictHighlightAndSnippetArrays field value if set, zero value otherwise.

func (*BaseInjectionQueryParameters) GetRestrictHighlightAndSnippetArraysOk added in v4.26.0 

func (o *BaseInjectionQueryParameters) GetRestrictHighlightAndSnippetArraysOk() (*bool, bool)

GetRestrictHighlightAndSnippetArraysOk returns a tuple with the RestrictHighlightAndSnippetArrays field value if set, nil otherwise and a boolean to check if the value has been set.

func (*BaseInjectionQueryParameters) GetRestrictSearchableAttributes added in v4.26.0 

func (o *BaseInjectionQueryParameters) GetRestrictSearchableAttributes() []string

GetRestrictSearchableAttributes returns the RestrictSearchableAttributes field value if set, zero value otherwise.

func (*BaseInjectionQueryParameters) GetRestrictSearchableAttributesOk added in v4.26.0 

func (o *BaseInjectionQueryParameters) GetRestrictSearchableAttributesOk() ([]string, bool)

GetRestrictSearchableAttributesOk returns a tuple with the RestrictSearchableAttributes field value if set, nil otherwise and a boolean to check if the value has been set.

func (*BaseInjectionQueryParameters) GetRuleContexts added in v4.26.0 

func (o *BaseInjectionQueryParameters) GetRuleContexts() []string

GetRuleContexts returns the RuleContexts field value if set, zero value otherwise.

func (*BaseInjectionQueryParameters) GetRuleContextsOk added in v4.26.0 

func (o *BaseInjectionQueryParameters) GetRuleContextsOk() ([]string, bool)

GetRuleContextsOk returns a tuple with the RuleContexts field value if set, nil otherwise and a boolean to check if the value has been set.

func (*BaseInjectionQueryParameters) GetSnippetEllipsisText added in v4.26.0 

func (o *BaseInjectionQueryParameters) GetSnippetEllipsisText() string

GetSnippetEllipsisText returns the SnippetEllipsisText field value if set, zero value otherwise.

func (*BaseInjectionQueryParameters) GetSnippetEllipsisTextOk added in v4.26.0 

func (o *BaseInjectionQueryParameters) GetSnippetEllipsisTextOk() (*string, bool)

GetSnippetEllipsisTextOk returns a tuple with the SnippetEllipsisText field value if set, nil otherwise and a boolean to check if the value has been set.

func (*BaseInjectionQueryParameters) GetSynonyms added in v4.26.0 

func (o *BaseInjectionQueryParameters) GetSynonyms() bool

GetSynonyms returns the Synonyms field value if set, zero value otherwise.

func (*BaseInjectionQueryParameters) GetSynonymsOk added in v4.26.0 

func (o *BaseInjectionQueryParameters) GetSynonymsOk() (*bool, bool)

GetSynonymsOk returns a tuple with the Synonyms field value if set, nil otherwise and a boolean to check if the value has been set.

func (*BaseInjectionQueryParameters) GetTypoTolerance added in v4.26.0 

func (o *BaseInjectionQueryParameters) GetTypoTolerance() TypoTolerance

GetTypoTolerance returns the TypoTolerance field value if set, zero value otherwise.

func (*BaseInjectionQueryParameters) GetTypoToleranceOk added in v4.26.0 

func (o *BaseInjectionQueryParameters) GetTypoToleranceOk() (*TypoTolerance, bool)

GetTypoToleranceOk returns a tuple with the TypoTolerance field value if set, nil otherwise and a boolean to check if the value has been set.

func (*BaseInjectionQueryParameters) HasAdvancedSyntax added in v4.26.0 

func (o *BaseInjectionQueryParameters) HasAdvancedSyntax() bool

HasAdvancedSyntax returns a boolean if a field has been set.

func (*BaseInjectionQueryParameters) HasAdvancedSyntaxFeatures added in v4.26.0 

func (o *BaseInjectionQueryParameters) HasAdvancedSyntaxFeatures() bool

HasAdvancedSyntaxFeatures returns a boolean if a field has been set.

func (*BaseInjectionQueryParameters) HasAllowTyposOnNumericTokens added in v4.26.0 

func (o *BaseInjectionQueryParameters) HasAllowTyposOnNumericTokens() bool

HasAllowTyposOnNumericTokens returns a boolean if a field has been set.

func (*BaseInjectionQueryParameters) HasAlternativesAsExact added in v4.26.0 

func (o *BaseInjectionQueryParameters) HasAlternativesAsExact() bool

HasAlternativesAsExact returns a boolean if a field has been set.

func (*BaseInjectionQueryParameters) HasAttributeCriteriaComputedByMinProximity added in v4.26.0 

func (o *BaseInjectionQueryParameters) HasAttributeCriteriaComputedByMinProximity() bool

HasAttributeCriteriaComputedByMinProximity returns a boolean if a field has been set.

func (*BaseInjectionQueryParameters) HasAttributesToHighlight added in v4.26.0 

func (o *BaseInjectionQueryParameters) HasAttributesToHighlight() bool

HasAttributesToHighlight returns a boolean if a field has been set.

func (*BaseInjectionQueryParameters) HasAttributesToRetrieve added in v4.26.0 

func (o *BaseInjectionQueryParameters) HasAttributesToRetrieve() bool

HasAttributesToRetrieve returns a boolean if a field has been set.

func (*BaseInjectionQueryParameters) HasAttributesToSnippet added in v4.26.0 

func (o *BaseInjectionQueryParameters) HasAttributesToSnippet() bool

HasAttributesToSnippet returns a boolean if a field has been set.

func (*BaseInjectionQueryParameters) HasClickAnalytics added in v4.26.0 

func (o *BaseInjectionQueryParameters) HasClickAnalytics() bool

HasClickAnalytics returns a boolean if a field has been set.

func (*BaseInjectionQueryParameters) HasDisableExactOnAttributes added in v4.26.0 

func (o *BaseInjectionQueryParameters) HasDisableExactOnAttributes() bool

HasDisableExactOnAttributes returns a boolean if a field has been set.

func (*BaseInjectionQueryParameters) HasDisableTypoToleranceOnAttributes added in v4.26.0 

func (o *BaseInjectionQueryParameters) HasDisableTypoToleranceOnAttributes() bool

HasDisableTypoToleranceOnAttributes returns a boolean if a field has been set.

func (*BaseInjectionQueryParameters) HasDistinct added in v4.26.0 

func (o *BaseInjectionQueryParameters) HasDistinct() bool

HasDistinct returns a boolean if a field has been set.

func (*BaseInjectionQueryParameters) HasEnableABTest added in v4.26.0 

func (o *BaseInjectionQueryParameters) HasEnableABTest() bool

HasEnableABTest returns a boolean if a field has been set.

func (*BaseInjectionQueryParameters) HasEnablePersonalization added in v4.26.0 

func (o *BaseInjectionQueryParameters) HasEnablePersonalization() bool

HasEnablePersonalization returns a boolean if a field has been set.

func (*BaseInjectionQueryParameters) HasEnableReRanking added in v4.26.0 

func (o *BaseInjectionQueryParameters) HasEnableReRanking() bool

HasEnableReRanking returns a boolean if a field has been set.

func (*BaseInjectionQueryParameters) HasEnableRules added in v4.26.0 

func (o *BaseInjectionQueryParameters) HasEnableRules() bool

HasEnableRules returns a boolean if a field has been set.

func (*BaseInjectionQueryParameters) HasExactOnSingleWordQuery added in v4.26.0 

func (o *BaseInjectionQueryParameters) HasExactOnSingleWordQuery() bool

HasExactOnSingleWordQuery returns a boolean if a field has been set.

func (*BaseInjectionQueryParameters) HasFacetFilters added in v4.26.0 

func (o *BaseInjectionQueryParameters) HasFacetFilters() bool

HasFacetFilters returns a boolean if a field has been set.

func (*BaseInjectionQueryParameters) HasFilters added in v4.26.0 

func (o *BaseInjectionQueryParameters) HasFilters() bool

HasFilters returns a boolean if a field has been set.

func (*BaseInjectionQueryParameters) HasGetRankingInfo added in v4.26.0 

func (o *BaseInjectionQueryParameters) HasGetRankingInfo() bool

HasGetRankingInfo returns a boolean if a field has been set.

func (*BaseInjectionQueryParameters) HasHighlightPostTag added in v4.26.0 

func (o *BaseInjectionQueryParameters) HasHighlightPostTag() bool

HasHighlightPostTag returns a boolean if a field has been set.

func (*BaseInjectionQueryParameters) HasHighlightPreTag added in v4.26.0 

func (o *BaseInjectionQueryParameters) HasHighlightPreTag() bool

HasHighlightPreTag returns a boolean if a field has been set.

func (*BaseInjectionQueryParameters) HasIgnorePlurals added in v4.26.0 

func (o *BaseInjectionQueryParameters) HasIgnorePlurals() bool

HasIgnorePlurals returns a boolean if a field has been set.

func (*BaseInjectionQueryParameters) HasMinProximity added in v4.26.0 

func (o *BaseInjectionQueryParameters) HasMinProximity() bool

HasMinProximity returns a boolean if a field has been set.

func (*BaseInjectionQueryParameters) HasMinWordSizefor1Typo added in v4.26.0 

func (o *BaseInjectionQueryParameters) HasMinWordSizefor1Typo() bool

HasMinWordSizefor1Typo returns a boolean if a field has been set.

func (*BaseInjectionQueryParameters) HasMinWordSizefor2Typos added in v4.26.0 

func (o *BaseInjectionQueryParameters) HasMinWordSizefor2Typos() bool

HasMinWordSizefor2Typos returns a boolean if a field has been set.

func (*BaseInjectionQueryParameters) HasNaturalLanguages added in v4.26.0 

func (o *BaseInjectionQueryParameters) HasNaturalLanguages() bool

HasNaturalLanguages returns a boolean if a field has been set.

func (*BaseInjectionQueryParameters) HasNumericFilters added in v4.26.0 

func (o *BaseInjectionQueryParameters) HasNumericFilters() bool

HasNumericFilters returns a boolean if a field has been set.

func (*BaseInjectionQueryParameters) HasOptionalFilters added in v4.26.0 

func (o *BaseInjectionQueryParameters) HasOptionalFilters() bool

HasOptionalFilters returns a boolean if a field has been set.

func (*BaseInjectionQueryParameters) HasOptionalWords added in v4.26.0 

func (o *BaseInjectionQueryParameters) HasOptionalWords() bool

HasOptionalWords returns a boolean if a field has been set.

func (*BaseInjectionQueryParameters) HasPercentileComputation added in v4.26.0 

func (o *BaseInjectionQueryParameters) HasPercentileComputation() bool

HasPercentileComputation returns a boolean if a field has been set.

func (*BaseInjectionQueryParameters) HasPersonalizationImpact added in v4.26.0 

func (o *BaseInjectionQueryParameters) HasPersonalizationImpact() bool

HasPersonalizationImpact returns a boolean if a field has been set.

func (*BaseInjectionQueryParameters) HasQueryLanguages added in v4.26.0 

func (o *BaseInjectionQueryParameters) HasQueryLanguages() bool

HasQueryLanguages returns a boolean if a field has been set.

func (*BaseInjectionQueryParameters) HasQueryType added in v4.26.0 

func (o *BaseInjectionQueryParameters) HasQueryType() bool

HasQueryType returns a boolean if a field has been set.

func (*BaseInjectionQueryParameters) HasRemoveStopWords added in v4.26.0 

func (o *BaseInjectionQueryParameters) HasRemoveStopWords() bool

HasRemoveStopWords returns a boolean if a field has been set.

func (*BaseInjectionQueryParameters) HasRemoveWordsIfNoResults added in v4.26.0 

func (o *BaseInjectionQueryParameters) HasRemoveWordsIfNoResults() bool

HasRemoveWordsIfNoResults returns a boolean if a field has been set.

func (*BaseInjectionQueryParameters) HasReplaceSynonymsInHighlight added in v4.26.0 

func (o *BaseInjectionQueryParameters) HasReplaceSynonymsInHighlight() bool

HasReplaceSynonymsInHighlight returns a boolean if a field has been set.

func (*BaseInjectionQueryParameters) HasResponseFields added in v4.26.0 

func (o *BaseInjectionQueryParameters) HasResponseFields() bool

HasResponseFields returns a boolean if a field has been set.

func (*BaseInjectionQueryParameters) HasRestrictHighlightAndSnippetArrays added in v4.26.0 

func (o *BaseInjectionQueryParameters) HasRestrictHighlightAndSnippetArrays() bool

HasRestrictHighlightAndSnippetArrays returns a boolean if a field has been set.

func (*BaseInjectionQueryParameters) HasRestrictSearchableAttributes added in v4.26.0 

func (o *BaseInjectionQueryParameters) HasRestrictSearchableAttributes() bool

HasRestrictSearchableAttributes returns a boolean if a field has been set.

func (*BaseInjectionQueryParameters) HasRuleContexts added in v4.26.0 

func (o *BaseInjectionQueryParameters) HasRuleContexts() bool

HasRuleContexts returns a boolean if a field has been set.

func (*BaseInjectionQueryParameters) HasSnippetEllipsisText added in v4.26.0 

func (o *BaseInjectionQueryParameters) HasSnippetEllipsisText() bool

HasSnippetEllipsisText returns a boolean if a field has been set.

func (*BaseInjectionQueryParameters) HasSynonyms added in v4.26.0 

func (o *BaseInjectionQueryParameters) HasSynonyms() bool

HasSynonyms returns a boolean if a field has been set.

func (*BaseInjectionQueryParameters) HasTypoTolerance added in v4.26.0 

func (o *BaseInjectionQueryParameters) HasTypoTolerance() bool

HasTypoTolerance returns a boolean if a field has been set.

func (BaseInjectionQueryParameters) MarshalJSON added in v4.26.0 

func (o BaseInjectionQueryParameters) MarshalJSON() ([]byte, error)

func (*BaseInjectionQueryParameters) SetAdvancedSyntax added in v4.26.0 

func (o *BaseInjectionQueryParameters) SetAdvancedSyntax(v bool) *BaseInjectionQueryParameters

SetAdvancedSyntax gets a reference to the given bool and assigns it to the AdvancedSyntax field.

func (*BaseInjectionQueryParameters) SetAdvancedSyntaxFeatures added in v4.26.0 

func (o *BaseInjectionQueryParameters) SetAdvancedSyntaxFeatures(v []AdvancedSyntaxFeatures) *BaseInjectionQueryParameters

SetAdvancedSyntaxFeatures gets a reference to the given []AdvancedSyntaxFeatures and assigns it to the AdvancedSyntaxFeatures field.

func (*BaseInjectionQueryParameters) SetAllowTyposOnNumericTokens added in v4.26.0 

func (o *BaseInjectionQueryParameters) SetAllowTyposOnNumericTokens(v bool) *BaseInjectionQueryParameters

SetAllowTyposOnNumericTokens gets a reference to the given bool and assigns it to the AllowTyposOnNumericTokens field.

func (*BaseInjectionQueryParameters) SetAlternativesAsExact added in v4.26.0 

func (o *BaseInjectionQueryParameters) SetAlternativesAsExact(v []AlternativesAsExact) *BaseInjectionQueryParameters

SetAlternativesAsExact gets a reference to the given []AlternativesAsExact and assigns it to the AlternativesAsExact field.

func (*BaseInjectionQueryParameters) SetAttributeCriteriaComputedByMinProximity added in v4.26.0 

func (o *BaseInjectionQueryParameters) SetAttributeCriteriaComputedByMinProximity(v bool) *BaseInjectionQueryParameters

SetAttributeCriteriaComputedByMinProximity gets a reference to the given bool and assigns it to the AttributeCriteriaComputedByMinProximity field.

func (*BaseInjectionQueryParameters) SetAttributesToHighlight added in v4.26.0 

func (o *BaseInjectionQueryParameters) SetAttributesToHighlight(v []string) *BaseInjectionQueryParameters

SetAttributesToHighlight gets a reference to the given []string and assigns it to the AttributesToHighlight field.

func (*BaseInjectionQueryParameters) SetAttributesToRetrieve added in v4.26.0 

func (o *BaseInjectionQueryParameters) SetAttributesToRetrieve(v []string) *BaseInjectionQueryParameters

SetAttributesToRetrieve gets a reference to the given []string and assigns it to the AttributesToRetrieve field.

func (*BaseInjectionQueryParameters) SetAttributesToSnippet added in v4.26.0 

func (o *BaseInjectionQueryParameters) SetAttributesToSnippet(v []string) *BaseInjectionQueryParameters

SetAttributesToSnippet gets a reference to the given []string and assigns it to the AttributesToSnippet field.

func (*BaseInjectionQueryParameters) SetClickAnalytics added in v4.26.0 

func (o *BaseInjectionQueryParameters) SetClickAnalytics(v bool) *BaseInjectionQueryParameters

SetClickAnalytics gets a reference to the given bool and assigns it to the ClickAnalytics field.

func (*BaseInjectionQueryParameters) SetDisableExactOnAttributes added in v4.26.0 

func (o *BaseInjectionQueryParameters) SetDisableExactOnAttributes(v []string) *BaseInjectionQueryParameters

SetDisableExactOnAttributes gets a reference to the given []string and assigns it to the DisableExactOnAttributes field.

func (*BaseInjectionQueryParameters) SetDisableTypoToleranceOnAttributes added in v4.26.0 

func (o *BaseInjectionQueryParameters) SetDisableTypoToleranceOnAttributes(v []string) *BaseInjectionQueryParameters

SetDisableTypoToleranceOnAttributes gets a reference to the given []string and assigns it to the DisableTypoToleranceOnAttributes field.

func (*BaseInjectionQueryParameters) SetDistinct added in v4.26.0 

func (o *BaseInjectionQueryParameters) SetDistinct(v *Distinct) *BaseInjectionQueryParameters

SetDistinct gets a reference to the given Distinct and assigns it to the Distinct field.

func (*BaseInjectionQueryParameters) SetEnableABTest added in v4.26.0 

func (o *BaseInjectionQueryParameters) SetEnableABTest(v bool) *BaseInjectionQueryParameters

SetEnableABTest gets a reference to the given bool and assigns it to the EnableABTest field.

func (*BaseInjectionQueryParameters) SetEnablePersonalization added in v4.26.0 

func (o *BaseInjectionQueryParameters) SetEnablePersonalization(v bool) *BaseInjectionQueryParameters

SetEnablePersonalization gets a reference to the given bool and assigns it to the EnablePersonalization field.

func (*BaseInjectionQueryParameters) SetEnableReRanking added in v4.26.0 

func (o *BaseInjectionQueryParameters) SetEnableReRanking(v bool) *BaseInjectionQueryParameters

SetEnableReRanking gets a reference to the given bool and assigns it to the EnableReRanking field.

func (*BaseInjectionQueryParameters) SetEnableRules added in v4.26.0 

func (o *BaseInjectionQueryParameters) SetEnableRules(v bool) *BaseInjectionQueryParameters

SetEnableRules gets a reference to the given bool and assigns it to the EnableRules field.

func (*BaseInjectionQueryParameters) SetExactOnSingleWordQuery added in v4.26.0 

func (o *BaseInjectionQueryParameters) SetExactOnSingleWordQuery(v ExactOnSingleWordQuery) *BaseInjectionQueryParameters

SetExactOnSingleWordQuery gets a reference to the given ExactOnSingleWordQuery and assigns it to the ExactOnSingleWordQuery field.

func (*BaseInjectionQueryParameters) SetFacetFilters added in v4.26.0 

func (o *BaseInjectionQueryParameters) SetFacetFilters(v *FacetFilters) *BaseInjectionQueryParameters

SetFacetFilters gets a reference to the given FacetFilters and assigns it to the FacetFilters field.

func (*BaseInjectionQueryParameters) SetFilters added in v4.26.0 

func (o *BaseInjectionQueryParameters) SetFilters(v string) *BaseInjectionQueryParameters

SetFilters gets a reference to the given string and assigns it to the Filters field.

func (*BaseInjectionQueryParameters) SetGetRankingInfo added in v4.26.0 

func (o *BaseInjectionQueryParameters) SetGetRankingInfo(v bool) *BaseInjectionQueryParameters

SetGetRankingInfo gets a reference to the given bool and assigns it to the GetRankingInfo field.

func (*BaseInjectionQueryParameters) SetHighlightPostTag added in v4.26.0 

func (o *BaseInjectionQueryParameters) SetHighlightPostTag(v string) *BaseInjectionQueryParameters

SetHighlightPostTag gets a reference to the given string and assigns it to the HighlightPostTag field.

func (*BaseInjectionQueryParameters) SetHighlightPreTag added in v4.26.0 

func (o *BaseInjectionQueryParameters) SetHighlightPreTag(v string) *BaseInjectionQueryParameters

SetHighlightPreTag gets a reference to the given string and assigns it to the HighlightPreTag field.

func (*BaseInjectionQueryParameters) SetIgnorePlurals added in v4.26.0 

func (o *BaseInjectionQueryParameters) SetIgnorePlurals(v *IgnorePlurals) *BaseInjectionQueryParameters

SetIgnorePlurals gets a reference to the given IgnorePlurals and assigns it to the IgnorePlurals field.

func (*BaseInjectionQueryParameters) SetMinProximity added in v4.26.0 

func (o *BaseInjectionQueryParameters) SetMinProximity(v int32) *BaseInjectionQueryParameters

SetMinProximity gets a reference to the given int32 and assigns it to the MinProximity field.

func (*BaseInjectionQueryParameters) SetMinWordSizefor1Typo added in v4.26.0 

func (o *BaseInjectionQueryParameters) SetMinWordSizefor1Typo(v int32) *BaseInjectionQueryParameters

SetMinWordSizefor1Typo gets a reference to the given int32 and assigns it to the MinWordSizefor1Typo field.

func (*BaseInjectionQueryParameters) SetMinWordSizefor2Typos added in v4.26.0 

func (o *BaseInjectionQueryParameters) SetMinWordSizefor2Typos(v int32) *BaseInjectionQueryParameters

SetMinWordSizefor2Typos gets a reference to the given int32 and assigns it to the MinWordSizefor2Typos field.

func (*BaseInjectionQueryParameters) SetNaturalLanguages added in v4.26.0 

func (o *BaseInjectionQueryParameters) SetNaturalLanguages(v []SupportedLanguage) *BaseInjectionQueryParameters

SetNaturalLanguages gets a reference to the given []SupportedLanguage and assigns it to the NaturalLanguages field.

func (*BaseInjectionQueryParameters) SetNumericFilters added in v4.26.0 

func (o *BaseInjectionQueryParameters) SetNumericFilters(v *NumericFilters) *BaseInjectionQueryParameters

SetNumericFilters gets a reference to the given NumericFilters and assigns it to the NumericFilters field.

func (*BaseInjectionQueryParameters) SetOptionalFilters added in v4.26.0 

func (o *BaseInjectionQueryParameters) SetOptionalFilters(v *OptionalFilters) *BaseInjectionQueryParameters

SetOptionalFilters gets a reference to the given OptionalFilters and assigns it to the OptionalFilters field.

func (*BaseInjectionQueryParameters) SetOptionalWords added in v4.26.0 

func (o *BaseInjectionQueryParameters) SetOptionalWords(v *OptionalWords) *BaseInjectionQueryParameters

SetOptionalWords gets a reference to the given utils.Nullable[OptionalWords] and assigns it to the OptionalWords field.

func (*BaseInjectionQueryParameters) SetOptionalWordsNil added in v4.26.0 

func (o *BaseInjectionQueryParameters) SetOptionalWordsNil()

SetOptionalWordsNil sets the value for OptionalWords to be an explicit nil.

func (*BaseInjectionQueryParameters) SetPercentileComputation added in v4.26.0 

func (o *BaseInjectionQueryParameters) SetPercentileComputation(v bool) *BaseInjectionQueryParameters

SetPercentileComputation gets a reference to the given bool and assigns it to the PercentileComputation field.

func (*BaseInjectionQueryParameters) SetPersonalizationImpact added in v4.26.0 

func (o *BaseInjectionQueryParameters) SetPersonalizationImpact(v int32) *BaseInjectionQueryParameters

SetPersonalizationImpact gets a reference to the given int32 and assigns it to the PersonalizationImpact field.

func (*BaseInjectionQueryParameters) SetQueryLanguages added in v4.26.0 

func (o *BaseInjectionQueryParameters) SetQueryLanguages(v []SupportedLanguage) *BaseInjectionQueryParameters

SetQueryLanguages gets a reference to the given []SupportedLanguage and assigns it to the QueryLanguages field.

func (*BaseInjectionQueryParameters) SetQueryType added in v4.26.0 

func (o *BaseInjectionQueryParameters) SetQueryType(v QueryType) *BaseInjectionQueryParameters

SetQueryType gets a reference to the given QueryType and assigns it to the QueryType field.

func (*BaseInjectionQueryParameters) SetRemoveStopWords added in v4.26.0 

func (o *BaseInjectionQueryParameters) SetRemoveStopWords(v *RemoveStopWords) *BaseInjectionQueryParameters

SetRemoveStopWords gets a reference to the given RemoveStopWords and assigns it to the RemoveStopWords field.

func (*BaseInjectionQueryParameters) SetRemoveWordsIfNoResults added in v4.26.0 

func (o *BaseInjectionQueryParameters) SetRemoveWordsIfNoResults(v RemoveWordsIfNoResults) *BaseInjectionQueryParameters

SetRemoveWordsIfNoResults gets a reference to the given RemoveWordsIfNoResults and assigns it to the RemoveWordsIfNoResults field.

func (*BaseInjectionQueryParameters) SetReplaceSynonymsInHighlight added in v4.26.0 

func (o *BaseInjectionQueryParameters) SetReplaceSynonymsInHighlight(v bool) *BaseInjectionQueryParameters

SetReplaceSynonymsInHighlight gets a reference to the given bool and assigns it to the ReplaceSynonymsInHighlight field.

func (*BaseInjectionQueryParameters) SetResponseFields added in v4.26.0 

func (o *BaseInjectionQueryParameters) SetResponseFields(v []string) *BaseInjectionQueryParameters

SetResponseFields gets a reference to the given []string and assigns it to the ResponseFields field.

func (*BaseInjectionQueryParameters) SetRestrictHighlightAndSnippetArrays added in v4.26.0 

func (o *BaseInjectionQueryParameters) SetRestrictHighlightAndSnippetArrays(v bool) *BaseInjectionQueryParameters

SetRestrictHighlightAndSnippetArrays gets a reference to the given bool and assigns it to the RestrictHighlightAndSnippetArrays field.

func (*BaseInjectionQueryParameters) SetRestrictSearchableAttributes added in v4.26.0 

func (o *BaseInjectionQueryParameters) SetRestrictSearchableAttributes(v []string) *BaseInjectionQueryParameters

SetRestrictSearchableAttributes gets a reference to the given []string and assigns it to the RestrictSearchableAttributes field.

func (*BaseInjectionQueryParameters) SetRuleContexts added in v4.26.0 

func (o *BaseInjectionQueryParameters) SetRuleContexts(v []string) *BaseInjectionQueryParameters

SetRuleContexts gets a reference to the given []string and assigns it to the RuleContexts field.

func (*BaseInjectionQueryParameters) SetSnippetEllipsisText added in v4.26.0 

func (o *BaseInjectionQueryParameters) SetSnippetEllipsisText(v string) *BaseInjectionQueryParameters

SetSnippetEllipsisText gets a reference to the given string and assigns it to the SnippetEllipsisText field.

func (*BaseInjectionQueryParameters) SetSynonyms added in v4.26.0 

func (o *BaseInjectionQueryParameters) SetSynonyms(v bool) *BaseInjectionQueryParameters

SetSynonyms gets a reference to the given bool and assigns it to the Synonyms field.

func (*BaseInjectionQueryParameters) SetTypoTolerance added in v4.26.0 

func (o *BaseInjectionQueryParameters) SetTypoTolerance(v *TypoTolerance) *BaseInjectionQueryParameters

SetTypoTolerance gets a reference to the given TypoTolerance and assigns it to the TypoTolerance field.

func (BaseInjectionQueryParameters) String added in v4.26.0 

func (o BaseInjectionQueryParameters) String() string

func (*BaseInjectionQueryParameters) UnsetOptionalWords added in v4.26.0 

func (o *BaseInjectionQueryParameters) UnsetOptionalWords()

UnsetOptionalWords ensures that no value is present for OptionalWords, not even an explicit nil.

type BaseInjectionQueryParametersOption added in v4.26.0 

type BaseInjectionQueryParametersOption func(f *BaseInjectionQueryParameters)

func WithBaseInjectionQueryParametersAdvancedSyntax added in v4.26.0 

func WithBaseInjectionQueryParametersAdvancedSyntax(val bool) BaseInjectionQueryParametersOption

func WithBaseInjectionQueryParametersAdvancedSyntaxFeatures added in v4.26.0 

func WithBaseInjectionQueryParametersAdvancedSyntaxFeatures(val []AdvancedSyntaxFeatures) BaseInjectionQueryParametersOption

func WithBaseInjectionQueryParametersAllowTyposOnNumericTokens added in v4.26.0 

func WithBaseInjectionQueryParametersAllowTyposOnNumericTokens(val bool) BaseInjectionQueryParametersOption

func WithBaseInjectionQueryParametersAlternativesAsExact added in v4.26.0 

func WithBaseInjectionQueryParametersAlternativesAsExact(val []AlternativesAsExact) BaseInjectionQueryParametersOption

func WithBaseInjectionQueryParametersAttributeCriteriaComputedByMinProximity added in v4.26.0 

func WithBaseInjectionQueryParametersAttributeCriteriaComputedByMinProximity(val bool) BaseInjectionQueryParametersOption

func WithBaseInjectionQueryParametersAttributesToHighlight added in v4.26.0 

func WithBaseInjectionQueryParametersAttributesToHighlight(val []string) BaseInjectionQueryParametersOption

func WithBaseInjectionQueryParametersAttributesToRetrieve added in v4.26.0 

func WithBaseInjectionQueryParametersAttributesToRetrieve(val []string) BaseInjectionQueryParametersOption

func WithBaseInjectionQueryParametersAttributesToSnippet added in v4.26.0 

func WithBaseInjectionQueryParametersAttributesToSnippet(val []string) BaseInjectionQueryParametersOption

func WithBaseInjectionQueryParametersClickAnalytics added in v4.26.0 

func WithBaseInjectionQueryParametersClickAnalytics(val bool) BaseInjectionQueryParametersOption

func WithBaseInjectionQueryParametersDisableExactOnAttributes added in v4.26.0 

func WithBaseInjectionQueryParametersDisableExactOnAttributes(val []string) BaseInjectionQueryParametersOption

func WithBaseInjectionQueryParametersDisableTypoToleranceOnAttributes added in v4.26.0 

func WithBaseInjectionQueryParametersDisableTypoToleranceOnAttributes(val []string) BaseInjectionQueryParametersOption

func WithBaseInjectionQueryParametersDistinct added in v4.26.0 

func WithBaseInjectionQueryParametersDistinct(val Distinct) BaseInjectionQueryParametersOption

func WithBaseInjectionQueryParametersEnableABTest added in v4.26.0 

func WithBaseInjectionQueryParametersEnableABTest(val bool) BaseInjectionQueryParametersOption

func WithBaseInjectionQueryParametersEnablePersonalization added in v4.26.0 

func WithBaseInjectionQueryParametersEnablePersonalization(val bool) BaseInjectionQueryParametersOption

func WithBaseInjectionQueryParametersEnableReRanking added in v4.26.0 

func WithBaseInjectionQueryParametersEnableReRanking(val bool) BaseInjectionQueryParametersOption

func WithBaseInjectionQueryParametersEnableRules added in v4.26.0 

func WithBaseInjectionQueryParametersEnableRules(val bool) BaseInjectionQueryParametersOption

func WithBaseInjectionQueryParametersExactOnSingleWordQuery added in v4.26.0 

func WithBaseInjectionQueryParametersExactOnSingleWordQuery(val ExactOnSingleWordQuery) BaseInjectionQueryParametersOption

func WithBaseInjectionQueryParametersFacetFilters added in v4.26.0 

func WithBaseInjectionQueryParametersFacetFilters(val FacetFilters) BaseInjectionQueryParametersOption

func WithBaseInjectionQueryParametersFilters added in v4.26.0 

func WithBaseInjectionQueryParametersFilters(val string) BaseInjectionQueryParametersOption

func WithBaseInjectionQueryParametersGetRankingInfo added in v4.26.0 

func WithBaseInjectionQueryParametersGetRankingInfo(val bool) BaseInjectionQueryParametersOption

func WithBaseInjectionQueryParametersHighlightPostTag added in v4.26.0 

func WithBaseInjectionQueryParametersHighlightPostTag(val string) BaseInjectionQueryParametersOption

func WithBaseInjectionQueryParametersHighlightPreTag added in v4.26.0 

func WithBaseInjectionQueryParametersHighlightPreTag(val string) BaseInjectionQueryParametersOption

func WithBaseInjectionQueryParametersIgnorePlurals added in v4.26.0 

func WithBaseInjectionQueryParametersIgnorePlurals(val IgnorePlurals) BaseInjectionQueryParametersOption

func WithBaseInjectionQueryParametersMinProximity added in v4.26.0 

func WithBaseInjectionQueryParametersMinProximity(val int32) BaseInjectionQueryParametersOption

func WithBaseInjectionQueryParametersMinWordSizefor1Typo added in v4.26.0 

func WithBaseInjectionQueryParametersMinWordSizefor1Typo(val int32) BaseInjectionQueryParametersOption

func WithBaseInjectionQueryParametersMinWordSizefor2Typos added in v4.26.0 

func WithBaseInjectionQueryParametersMinWordSizefor2Typos(val int32) BaseInjectionQueryParametersOption

func WithBaseInjectionQueryParametersNaturalLanguages added in v4.26.0 

func WithBaseInjectionQueryParametersNaturalLanguages(val []SupportedLanguage) BaseInjectionQueryParametersOption

func WithBaseInjectionQueryParametersNumericFilters added in v4.26.0 

func WithBaseInjectionQueryParametersNumericFilters(val NumericFilters) BaseInjectionQueryParametersOption

func WithBaseInjectionQueryParametersOptionalFilters added in v4.26.0 

func WithBaseInjectionQueryParametersOptionalFilters(val OptionalFilters) BaseInjectionQueryParametersOption

func WithBaseInjectionQueryParametersOptionalWords added in v4.26.0 

func WithBaseInjectionQueryParametersOptionalWords(val utils.Nullable[OptionalWords]) BaseInjectionQueryParametersOption

func WithBaseInjectionQueryParametersPercentileComputation added in v4.26.0 

func WithBaseInjectionQueryParametersPercentileComputation(val bool) BaseInjectionQueryParametersOption

func WithBaseInjectionQueryParametersPersonalizationImpact added in v4.26.0 

func WithBaseInjectionQueryParametersPersonalizationImpact(val int32) BaseInjectionQueryParametersOption

func WithBaseInjectionQueryParametersQueryLanguages added in v4.26.0 

func WithBaseInjectionQueryParametersQueryLanguages(val []SupportedLanguage) BaseInjectionQueryParametersOption

func WithBaseInjectionQueryParametersQueryType added in v4.26.0 

func WithBaseInjectionQueryParametersQueryType(val QueryType) BaseInjectionQueryParametersOption

func WithBaseInjectionQueryParametersRemoveStopWords added in v4.26.0 

func WithBaseInjectionQueryParametersRemoveStopWords(val RemoveStopWords) BaseInjectionQueryParametersOption

func WithBaseInjectionQueryParametersRemoveWordsIfNoResults added in v4.26.0 

func WithBaseInjectionQueryParametersRemoveWordsIfNoResults(val RemoveWordsIfNoResults) BaseInjectionQueryParametersOption

func WithBaseInjectionQueryParametersReplaceSynonymsInHighlight added in v4.26.0 

func WithBaseInjectionQueryParametersReplaceSynonymsInHighlight(val bool) BaseInjectionQueryParametersOption

func WithBaseInjectionQueryParametersResponseFields added in v4.26.0 

func WithBaseInjectionQueryParametersResponseFields(val []string) BaseInjectionQueryParametersOption

func WithBaseInjectionQueryParametersRestrictHighlightAndSnippetArrays added in v4.26.0 

func WithBaseInjectionQueryParametersRestrictHighlightAndSnippetArrays(val bool) BaseInjectionQueryParametersOption

func WithBaseInjectionQueryParametersRestrictSearchableAttributes added in v4.26.0 

func WithBaseInjectionQueryParametersRestrictSearchableAttributes(val []string) BaseInjectionQueryParametersOption

func WithBaseInjectionQueryParametersRuleContexts added in v4.26.0 

func WithBaseInjectionQueryParametersRuleContexts(val []string) BaseInjectionQueryParametersOption

func WithBaseInjectionQueryParametersSnippetEllipsisText added in v4.26.0 

func WithBaseInjectionQueryParametersSnippetEllipsisText(val string) BaseInjectionQueryParametersOption

func WithBaseInjectionQueryParametersSynonyms added in v4.26.0 

func WithBaseInjectionQueryParametersSynonyms(val bool) BaseInjectionQueryParametersOption

func WithBaseInjectionQueryParametersTypoTolerance added in v4.26.0 

func WithBaseInjectionQueryParametersTypoTolerance(val TypoTolerance) BaseInjectionQueryParametersOption

type BatchCompositionAction added in v4.26.0 

type BatchCompositionAction struct {
	Composition             *Composition
	DeleteCompositionAction *DeleteCompositionAction
}

BatchCompositionAction - struct for BatchCompositionAction.

func CompositionAsBatchCompositionAction added in v4.26.0 

func CompositionAsBatchCompositionAction(v *Composition) *BatchCompositionAction

CompositionAsBatchCompositionAction is a convenience function that returns Composition wrapped in BatchCompositionAction.

func DeleteCompositionActionAsBatchCompositionAction added in v4.26.0 

func DeleteCompositionActionAsBatchCompositionAction(v *DeleteCompositionAction) *BatchCompositionAction

DeleteCompositionActionAsBatchCompositionAction is a convenience function that returns DeleteCompositionAction wrapped in BatchCompositionAction.

func (BatchCompositionAction) GetActualInstance added in v4.26.0 

func (obj BatchCompositionAction) GetActualInstance() any

Get the actual instance.

func (BatchCompositionAction) MarshalJSON added in v4.26.0 

func (src BatchCompositionAction) MarshalJSON() ([]byte, error)

Marshal data from the first non-nil pointers in the struct to JSON.

func (*BatchCompositionAction) UnmarshalJSON added in v4.26.0 

func (dst *BatchCompositionAction) UnmarshalJSON(data []byte) error

Unmarshal JSON data into one or more of the pointers in the struct.

type BatchParams added in v4.26.0 

type BatchParams struct {
	Requests []MultipleBatchRequest `json:"requests"`
}

BatchParams Batch parameters.

func NewBatchParams added in v4.26.0 

func NewBatchParams(requests []MultipleBatchRequest) *BatchParams

NewBatchParams instantiates a new BatchParams object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed.

func NewEmptyBatchParams added in v4.26.0 

func NewEmptyBatchParams() *BatchParams

NewEmptyBatchParams return a pointer to an empty BatchParams object.

func (*BatchParams) GetRequests added in v4.26.0 

func (o *BatchParams) GetRequests() []MultipleBatchRequest

GetRequests returns the Requests field value.

func (*BatchParams) GetRequestsOk added in v4.26.0 

func (o *BatchParams) GetRequestsOk() ([]MultipleBatchRequest, bool)

GetRequestsOk returns a tuple with the Requests field value and a boolean to check if the value has been set.

func (BatchParams) MarshalJSON added in v4.26.0 

func (o BatchParams) MarshalJSON() ([]byte, error)

func (*BatchParams) SetRequests added in v4.26.0 

func (o *BatchParams) SetRequests(v []MultipleBatchRequest) *BatchParams

SetRequests sets field value.

func (BatchParams) String added in v4.26.0 

func (o BatchParams) String() string

type BooleanString added in v4.26.0 

type BooleanString string

BooleanString the model 'BooleanString'. 

const (
	BOOLEAN_STRING_TRUE  BooleanString = "true"
	BOOLEAN_STRING_FALSE BooleanString = "false"
)

List of booleanString.

func NewBooleanStringFromValue added in v4.26.0 

func NewBooleanStringFromValue(v string) (*BooleanString, error)

NewBooleanStringFromValue returns a pointer to a valid BooleanString. for the value passed as argument, or an error if the value passed is not allowed by the enum.

func (BooleanString) IsValid added in v4.26.0 

func (v BooleanString) IsValid() bool

IsValid return true if the value is valid for the enum, false otherwise.

func (BooleanString) Ptr added in v4.26.0 

func (v BooleanString) Ptr() *BooleanString

Ptr returns reference to booleanString value.

func (*BooleanString) UnmarshalJSON added in v4.26.0 

func (v *BooleanString) UnmarshalJSON(src []byte) error

type Composition added in v4.26.0 

type Composition struct {
	// Composition unique identifier.
	ObjectID string `json:"objectID"`
	// Composition name.
	Name string `json:"name"`
	// Composition description.
	Description *string             `json:"description,omitempty"`
	Behavior    CompositionBehavior `json:"behavior"`
	// A mapping of sorting labels to the indices (or replicas) that implement those sorting rules. The sorting indices MUST be related to the associated main targeted index in the composition. Each key is the label your frontend sends at runtime (for example, \"Price (asc)\"), and each value is the name of the index that should be queried when that label is selected.  When a request includes a \"sortBy\" parameter, the platform looks up the corresponding index in this mapping and uses it to execute the query. The main targeted index is replaced with the sorting strategy index it is mapped to.  Up to 20 sorting strategies can be defined.
	SortingStrategy *map[string]string `json:"sortingStrategy,omitempty"`
}

Composition struct for Composition.

func NewComposition added in v4.26.0 

func NewComposition(objectID string, name string, behavior CompositionBehavior, opts ...CompositionOption) *Composition

NewComposition instantiates a new Composition object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed.

func NewEmptyComposition added in v4.26.0 

func NewEmptyComposition() *Composition

NewEmptyComposition return a pointer to an empty Composition object.

func (*Composition) GetBehavior added in v4.26.0 

func (o *Composition) GetBehavior() CompositionBehavior

GetBehavior returns the Behavior field value.

func (*Composition) GetBehaviorOk added in v4.26.0 

func (o *Composition) GetBehaviorOk() (*CompositionBehavior, bool)

GetBehaviorOk returns a tuple with the Behavior field value and a boolean to check if the value has been set.

func (*Composition) GetDescription added in v4.26.0 

func (o *Composition) GetDescription() string

GetDescription returns the Description field value if set, zero value otherwise.

func (*Composition) GetDescriptionOk added in v4.26.0 

func (o *Composition) GetDescriptionOk() (*string, bool)

GetDescriptionOk returns a tuple with the Description field value if set, nil otherwise and a boolean to check if the value has been set.

func (*Composition) GetName added in v4.26.0 

func (o *Composition) GetName() string

GetName returns the Name field value.

func (*Composition) GetNameOk added in v4.26.0 

func (o *Composition) GetNameOk() (*string, bool)

GetNameOk returns a tuple with the Name field value and a boolean to check if the value has been set.

func (*Composition) GetObjectID added in v4.26.0 

func (o *Composition) GetObjectID() string

GetObjectID returns the ObjectID field value.

func (*Composition) GetObjectIDOk added in v4.26.0 

func (o *Composition) GetObjectIDOk() (*string, bool)

GetObjectIDOk returns a tuple with the ObjectID field value and a boolean to check if the value has been set.

func (*Composition) GetSortingStrategy added in v4.34.0 

func (o *Composition) GetSortingStrategy() map[string]string

GetSortingStrategy returns the SortingStrategy field value if set, zero value otherwise.

func (*Composition) GetSortingStrategyOk added in v4.34.0 

func (o *Composition) GetSortingStrategyOk() (*map[string]string, bool)

GetSortingStrategyOk returns a tuple with the SortingStrategy field value if set, nil otherwise and a boolean to check if the value has been set.

func (*Composition) HasDescription added in v4.26.0 

func (o *Composition) HasDescription() bool

HasDescription returns a boolean if a field has been set.

func (*Composition) HasSortingStrategy added in v4.34.0 

func (o *Composition) HasSortingStrategy() bool

HasSortingStrategy returns a boolean if a field has been set.

func (Composition) MarshalJSON added in v4.26.0 

func (o Composition) MarshalJSON() ([]byte, error)

func (*Composition) SetBehavior added in v4.26.0 

func (o *Composition) SetBehavior(v *CompositionBehavior) *Composition

SetBehavior sets field value.

func (*Composition) SetDescription added in v4.26.0 

func (o *Composition) SetDescription(v string) *Composition

SetDescription gets a reference to the given string and assigns it to the Description field.

func (*Composition) SetName added in v4.26.0 

func (o *Composition) SetName(v string) *Composition

SetName sets field value.

func (*Composition) SetObjectID added in v4.26.0 

func (o *Composition) SetObjectID(v string) *Composition

SetObjectID sets field value.

func (*Composition) SetSortingStrategy added in v4.34.0 

func (o *Composition) SetSortingStrategy(v map[string]string) *Composition

SetSortingStrategy gets a reference to the given map[string]string and assigns it to the SortingStrategy field.

func (Composition) String added in v4.26.0 

func (o Composition) String() string

type CompositionBehavior added in v4.26.0 

type CompositionBehavior struct {
	CompositionInjectionBehavior *CompositionInjectionBehavior
	CompositionMultifeedBehavior *CompositionMultifeedBehavior
}

CompositionBehavior - An object containing either an `injection` or `multifeed` behavior schema, but not both.

func CompositionInjectionBehaviorAsCompositionBehavior added in v4.36.0 

func CompositionInjectionBehaviorAsCompositionBehavior(v *CompositionInjectionBehavior) *CompositionBehavior

CompositionInjectionBehaviorAsCompositionBehavior is a convenience function that returns CompositionInjectionBehavior wrapped in CompositionBehavior.

func CompositionMultifeedBehaviorAsCompositionBehavior added in v4.36.0 

func CompositionMultifeedBehaviorAsCompositionBehavior(v *CompositionMultifeedBehavior) *CompositionBehavior

CompositionMultifeedBehaviorAsCompositionBehavior is a convenience function that returns CompositionMultifeedBehavior wrapped in CompositionBehavior.

func (CompositionBehavior) GetActualInstance added in v4.36.0 

func (obj CompositionBehavior) GetActualInstance() any

Get the actual instance.

func (CompositionBehavior) MarshalJSON added in v4.26.0 

func (src CompositionBehavior) MarshalJSON() ([]byte, error)

Marshal data from the first non-nil pointers in the struct to JSON.

func (*CompositionBehavior) UnmarshalJSON added in v4.36.0 

func (dst *CompositionBehavior) UnmarshalJSON(data []byte) error

Unmarshal JSON data into one or more of the pointers in the struct.

type CompositionConfiguration 

type CompositionConfiguration struct {
	transport.Configuration
}

CompositionConfiguration stores the configuration of the API client.

type CompositionIdRankingInfo 

type CompositionIdRankingInfo struct {
	Index           string `json:"index"`
	InjectedItemKey string `json:"injectedItemKey"`
}

CompositionIdRankingInfo struct for CompositionIdRankingInfo.

func NewCompositionIdRankingInfo 

func NewCompositionIdRankingInfo(index string, injectedItemKey string) *CompositionIdRankingInfo

NewCompositionIdRankingInfo instantiates a new CompositionIdRankingInfo object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed.

func NewEmptyCompositionIdRankingInfo 

func NewEmptyCompositionIdRankingInfo() *CompositionIdRankingInfo

NewEmptyCompositionIdRankingInfo return a pointer to an empty CompositionIdRankingInfo object.

func (*CompositionIdRankingInfo) GetIndex 

func (o *CompositionIdRankingInfo) GetIndex() string

GetIndex returns the Index field value.

func (*CompositionIdRankingInfo) GetIndexOk 

func (o *CompositionIdRankingInfo) GetIndexOk() (*string, bool)

GetIndexOk returns a tuple with the Index field value and a boolean to check if the value has been set.

func (*CompositionIdRankingInfo) GetInjectedItemKey 

func (o *CompositionIdRankingInfo) GetInjectedItemKey() string

GetInjectedItemKey returns the InjectedItemKey field value.

func (*CompositionIdRankingInfo) GetInjectedItemKeyOk 

func (o *CompositionIdRankingInfo) GetInjectedItemKeyOk() (*string, bool)

GetInjectedItemKeyOk returns a tuple with the InjectedItemKey field value and a boolean to check if the value has been set.

func (CompositionIdRankingInfo) MarshalJSON 

func (o CompositionIdRankingInfo) MarshalJSON() ([]byte, error)

func (*CompositionIdRankingInfo) SetIndex 

func (o *CompositionIdRankingInfo) SetIndex(v string) *CompositionIdRankingInfo

SetIndex sets field value.

func (*CompositionIdRankingInfo) SetInjectedItemKey 

func (o *CompositionIdRankingInfo) SetInjectedItemKey(v string) *CompositionIdRankingInfo

SetInjectedItemKey sets field value.

func (CompositionIdRankingInfo) String 

func (o CompositionIdRankingInfo) String() string

type CompositionInjectionBehavior added in v4.36.0 

type CompositionInjectionBehavior struct {
	Injection Injection `json:"injection"`
}

CompositionInjectionBehavior An object containing an `injection` behavior.

func NewCompositionInjectionBehavior added in v4.36.0 

func NewCompositionInjectionBehavior(injection Injection) *CompositionInjectionBehavior

NewCompositionInjectionBehavior instantiates a new CompositionInjectionBehavior object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed.

func NewEmptyCompositionInjectionBehavior added in v4.36.0 

func NewEmptyCompositionInjectionBehavior() *CompositionInjectionBehavior

NewEmptyCompositionInjectionBehavior return a pointer to an empty CompositionInjectionBehavior object.

func (*CompositionInjectionBehavior) GetInjection added in v4.36.0 

func (o *CompositionInjectionBehavior) GetInjection() Injection

GetInjection returns the Injection field value.

func (*CompositionInjectionBehavior) GetInjectionOk added in v4.36.0 

func (o *CompositionInjectionBehavior) GetInjectionOk() (*Injection, bool)

GetInjectionOk returns a tuple with the Injection field value and a boolean to check if the value has been set.

func (CompositionInjectionBehavior) MarshalJSON added in v4.36.0 

func (o CompositionInjectionBehavior) MarshalJSON() ([]byte, error)

func (*CompositionInjectionBehavior) SetInjection added in v4.36.0 

func (o *CompositionInjectionBehavior) SetInjection(v *Injection) *CompositionInjectionBehavior

SetInjection sets field value.

func (CompositionInjectionBehavior) String added in v4.36.0 

func (o CompositionInjectionBehavior) String() string

type CompositionMultifeedBehavior added in v4.36.0 

type CompositionMultifeedBehavior struct {
	Multifeed Multifeed `json:"multifeed"`
}

CompositionMultifeedBehavior An object containing a `multifeed` behavior.

func NewCompositionMultifeedBehavior added in v4.36.0 

func NewCompositionMultifeedBehavior(multifeed Multifeed) *CompositionMultifeedBehavior

NewCompositionMultifeedBehavior instantiates a new CompositionMultifeedBehavior object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed.

func NewEmptyCompositionMultifeedBehavior added in v4.36.0 

func NewEmptyCompositionMultifeedBehavior() *CompositionMultifeedBehavior

NewEmptyCompositionMultifeedBehavior return a pointer to an empty CompositionMultifeedBehavior object.

func (*CompositionMultifeedBehavior) GetMultifeed added in v4.36.0 

func (o *CompositionMultifeedBehavior) GetMultifeed() Multifeed

GetMultifeed returns the Multifeed field value.

func (*CompositionMultifeedBehavior) GetMultifeedOk added in v4.36.0 

func (o *CompositionMultifeedBehavior) GetMultifeedOk() (*Multifeed, bool)

GetMultifeedOk returns a tuple with the Multifeed field value and a boolean to check if the value has been set.

func (CompositionMultifeedBehavior) MarshalJSON added in v4.36.0 

func (o CompositionMultifeedBehavior) MarshalJSON() ([]byte, error)

func (*CompositionMultifeedBehavior) SetMultifeed added in v4.36.0 

func (o *CompositionMultifeedBehavior) SetMultifeed(v *Multifeed) *CompositionMultifeedBehavior

SetMultifeed sets field value.

func (CompositionMultifeedBehavior) String added in v4.36.0 

func (o CompositionMultifeedBehavior) String() string

type CompositionOption added in v4.26.0 

type CompositionOption func(f *Composition)

func WithCompositionDescription added in v4.26.0 

func WithCompositionDescription(val string) CompositionOption

func WithCompositionSortingStrategy added in v4.34.0 

func WithCompositionSortingStrategy(val map[string]string) CompositionOption

type CompositionRule added in v4.26.0 

type CompositionRule struct {
	// Composition rule unique identifier.
	ObjectID string `json:"objectID"`
	// Conditions that trigger a composition rule.
	Conditions  []Condition                `json:"conditions,omitempty"`
	Consequence CompositionRuleConsequence `json:"consequence"`
	// Description of the rule's purpose to help you distinguish between different rules.
	Description *string `json:"description,omitempty"`
	// Whether the rule is active.
	Enabled *bool `json:"enabled,omitempty"`
	// Time periods when the rule is active.
	Validity []TimeRange `json:"validity,omitempty"`
	// A list of tags.
	Tags []string `json:"tags,omitempty"`
}

CompositionRule struct for CompositionRule.

func NewCompositionRule added in v4.26.0 

func NewCompositionRule(objectID string, consequence CompositionRuleConsequence, opts ...CompositionRuleOption) *CompositionRule

NewCompositionRule instantiates a new CompositionRule object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed.

func NewEmptyCompositionRule added in v4.26.0 

func NewEmptyCompositionRule() *CompositionRule

NewEmptyCompositionRule return a pointer to an empty CompositionRule object.

func (*CompositionRule) GetConditions added in v4.26.0 

func (o *CompositionRule) GetConditions() []Condition

GetConditions returns the Conditions field value if set, zero value otherwise.

func (*CompositionRule) GetConditionsOk added in v4.26.0 

func (o *CompositionRule) GetConditionsOk() ([]Condition, bool)

GetConditionsOk returns a tuple with the Conditions field value if set, nil otherwise and a boolean to check if the value has been set.

func (*CompositionRule) GetConsequence added in v4.26.0 

func (o *CompositionRule) GetConsequence() CompositionRuleConsequence

GetConsequence returns the Consequence field value.

func (*CompositionRule) GetConsequenceOk added in v4.26.0 

func (o *CompositionRule) GetConsequenceOk() (*CompositionRuleConsequence, bool)

GetConsequenceOk returns a tuple with the Consequence field value and a boolean to check if the value has been set.

func (*CompositionRule) GetDescription added in v4.26.0 

func (o *CompositionRule) GetDescription() string

GetDescription returns the Description field value if set, zero value otherwise.

func (*CompositionRule) GetDescriptionOk added in v4.26.0 

func (o *CompositionRule) GetDescriptionOk() (*string, bool)

GetDescriptionOk returns a tuple with the Description field value if set, nil otherwise and a boolean to check if the value has been set.

func (*CompositionRule) GetEnabled added in v4.26.0 

func (o *CompositionRule) GetEnabled() bool

GetEnabled returns the Enabled field value if set, zero value otherwise.

func (*CompositionRule) GetEnabledOk added in v4.26.0 

func (o *CompositionRule) GetEnabledOk() (*bool, bool)

GetEnabledOk returns a tuple with the Enabled field value if set, nil otherwise and a boolean to check if the value has been set.

func (*CompositionRule) GetObjectID added in v4.26.0 

func (o *CompositionRule) GetObjectID() string

GetObjectID returns the ObjectID field value.

func (*CompositionRule) GetObjectIDOk added in v4.26.0 

func (o *CompositionRule) GetObjectIDOk() (*string, bool)

GetObjectIDOk returns a tuple with the ObjectID field value and a boolean to check if the value has been set.

func (*CompositionRule) GetTags added in v4.26.0 

func (o *CompositionRule) GetTags() []string

GetTags returns the Tags field value if set, zero value otherwise.

func (*CompositionRule) GetTagsOk added in v4.26.0 

func (o *CompositionRule) GetTagsOk() ([]string, bool)

GetTagsOk returns a tuple with the Tags field value if set, nil otherwise and a boolean to check if the value has been set.

func (*CompositionRule) GetValidity added in v4.26.0 

func (o *CompositionRule) GetValidity() []TimeRange

GetValidity returns the Validity field value if set, zero value otherwise.

func (*CompositionRule) GetValidityOk added in v4.26.0 

func (o *CompositionRule) GetValidityOk() ([]TimeRange, bool)

GetValidityOk returns a tuple with the Validity field value if set, nil otherwise and a boolean to check if the value has been set.

func (*CompositionRule) HasConditions added in v4.36.0 

func (o *CompositionRule) HasConditions() bool

HasConditions returns a boolean if a field has been set.

func (*CompositionRule) HasDescription added in v4.26.0 

func (o *CompositionRule) HasDescription() bool

HasDescription returns a boolean if a field has been set.

func (*CompositionRule) HasEnabled added in v4.26.0 

func (o *CompositionRule) HasEnabled() bool

HasEnabled returns a boolean if a field has been set.

func (*CompositionRule) HasTags added in v4.26.0 

func (o *CompositionRule) HasTags() bool

HasTags returns a boolean if a field has been set.

func (*CompositionRule) HasValidity added in v4.26.0 

func (o *CompositionRule) HasValidity() bool

HasValidity returns a boolean if a field has been set.

func (CompositionRule) MarshalJSON added in v4.26.0 

func (o CompositionRule) MarshalJSON() ([]byte, error)

func (*CompositionRule) SetConditions added in v4.26.0 

func (o *CompositionRule) SetConditions(v []Condition) *CompositionRule

SetConditions gets a reference to the given []Condition and assigns it to the Conditions field.

func (*CompositionRule) SetConsequence added in v4.26.0 

func (o *CompositionRule) SetConsequence(v *CompositionRuleConsequence) *CompositionRule

SetConsequence sets field value.

func (*CompositionRule) SetDescription added in v4.26.0 

func (o *CompositionRule) SetDescription(v string) *CompositionRule

SetDescription gets a reference to the given string and assigns it to the Description field.

func (*CompositionRule) SetEnabled added in v4.26.0 

func (o *CompositionRule) SetEnabled(v bool) *CompositionRule

SetEnabled gets a reference to the given bool and assigns it to the Enabled field.

func (*CompositionRule) SetObjectID added in v4.26.0 

func (o *CompositionRule) SetObjectID(v string) *CompositionRule

SetObjectID sets field value.

func (*CompositionRule) SetTags added in v4.26.0 

func (o *CompositionRule) SetTags(v []string) *CompositionRule

SetTags gets a reference to the given []string and assigns it to the Tags field.

func (*CompositionRule) SetValidity added in v4.26.0 

func (o *CompositionRule) SetValidity(v []TimeRange) *CompositionRule

SetValidity gets a reference to the given []TimeRange and assigns it to the Validity field.

func (CompositionRule) String added in v4.26.0 

func (o CompositionRule) String() string

type CompositionRuleConsequence added in v4.26.0 

type CompositionRuleConsequence struct {
	Behavior CompositionBehavior `json:"behavior"`
}

CompositionRuleConsequence Effect of the rule.

func NewCompositionRuleConsequence added in v4.26.0 

func NewCompositionRuleConsequence(behavior CompositionBehavior) *CompositionRuleConsequence

NewCompositionRuleConsequence instantiates a new CompositionRuleConsequence object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed.

func NewEmptyCompositionRuleConsequence added in v4.26.0 

func NewEmptyCompositionRuleConsequence() *CompositionRuleConsequence

NewEmptyCompositionRuleConsequence return a pointer to an empty CompositionRuleConsequence object.

func (*CompositionRuleConsequence) GetBehavior added in v4.26.0 

func (o *CompositionRuleConsequence) GetBehavior() CompositionBehavior

GetBehavior returns the Behavior field value.

func (*CompositionRuleConsequence) GetBehaviorOk added in v4.26.0 

func (o *CompositionRuleConsequence) GetBehaviorOk() (*CompositionBehavior, bool)

GetBehaviorOk returns a tuple with the Behavior field value and a boolean to check if the value has been set.

func (CompositionRuleConsequence) MarshalJSON added in v4.26.0 

func (o CompositionRuleConsequence) MarshalJSON() ([]byte, error)

func (*CompositionRuleConsequence) SetBehavior added in v4.26.0 

func (o *CompositionRuleConsequence) SetBehavior(v *CompositionBehavior) *CompositionRuleConsequence

SetBehavior sets field value.

func (CompositionRuleConsequence) String added in v4.26.0 

func (o CompositionRuleConsequence) String() string

type CompositionRuleOption added in v4.26.0 

type CompositionRuleOption func(f *CompositionRule)

func WithCompositionRuleConditions added in v4.36.0 

func WithCompositionRuleConditions(val []Condition) CompositionRuleOption

func WithCompositionRuleDescription added in v4.26.0 

func WithCompositionRuleDescription(val string) CompositionRuleOption

func WithCompositionRuleEnabled added in v4.26.0 

func WithCompositionRuleEnabled(val bool) CompositionRuleOption

func WithCompositionRuleTags added in v4.26.0 

func WithCompositionRuleTags(val []string) CompositionRuleOption

func WithCompositionRuleValidity added in v4.26.0 

func WithCompositionRuleValidity(val []TimeRange) CompositionRuleOption

type CompositionRulesBatchParams added in v4.26.0 

type CompositionRulesBatchParams struct {
	Requests []RulesMultipleBatchRequest `json:"requests,omitempty"`
}

CompositionRulesBatchParams Composition rules batch parameters.

func NewCompositionRulesBatchParams added in v4.26.0 

func NewCompositionRulesBatchParams(opts ...CompositionRulesBatchParamsOption) *CompositionRulesBatchParams

NewCompositionRulesBatchParams instantiates a new CompositionRulesBatchParams object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed.

func NewEmptyCompositionRulesBatchParams added in v4.26.0 

func NewEmptyCompositionRulesBatchParams() *CompositionRulesBatchParams

NewEmptyCompositionRulesBatchParams return a pointer to an empty CompositionRulesBatchParams object.

func (*CompositionRulesBatchParams) GetRequests added in v4.26.0 

func (o *CompositionRulesBatchParams) GetRequests() []RulesMultipleBatchRequest

GetRequests returns the Requests field value if set, zero value otherwise.

func (*CompositionRulesBatchParams) GetRequestsOk added in v4.26.0 

func (o *CompositionRulesBatchParams) GetRequestsOk() ([]RulesMultipleBatchRequest, bool)

GetRequestsOk returns a tuple with the Requests field value if set, nil otherwise and a boolean to check if the value has been set.

func (*CompositionRulesBatchParams) HasRequests added in v4.26.0 

func (o *CompositionRulesBatchParams) HasRequests() bool

HasRequests returns a boolean if a field has been set.

func (CompositionRulesBatchParams) MarshalJSON added in v4.26.0 

func (o CompositionRulesBatchParams) MarshalJSON() ([]byte, error)

func (*CompositionRulesBatchParams) SetRequests added in v4.26.0 

func (o *CompositionRulesBatchParams) SetRequests(v []RulesMultipleBatchRequest) *CompositionRulesBatchParams

SetRequests gets a reference to the given []RulesMultipleBatchRequest and assigns it to the Requests field.

func (CompositionRulesBatchParams) String added in v4.26.0 

func (o CompositionRulesBatchParams) String() string

type CompositionRulesBatchParamsOption added in v4.26.0 

type CompositionRulesBatchParamsOption func(f *CompositionRulesBatchParams)

func WithCompositionRulesBatchParamsRequests added in v4.26.0 

func WithCompositionRulesBatchParamsRequests(val []RulesMultipleBatchRequest) CompositionRulesBatchParamsOption

type CompositionRunAppliedRules 

type CompositionRunAppliedRules struct {
	// The objectID of the applied composition rule on this query.
	ObjectID string `json:"objectID"`
}

CompositionRunAppliedRules struct for CompositionRunAppliedRules.

func NewCompositionRunAppliedRules 

func NewCompositionRunAppliedRules(objectID string) *CompositionRunAppliedRules

NewCompositionRunAppliedRules instantiates a new CompositionRunAppliedRules object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed.

func NewEmptyCompositionRunAppliedRules 

func NewEmptyCompositionRunAppliedRules() *CompositionRunAppliedRules

NewEmptyCompositionRunAppliedRules return a pointer to an empty CompositionRunAppliedRules object.

func (*CompositionRunAppliedRules) GetObjectID 

func (o *CompositionRunAppliedRules) GetObjectID() string

GetObjectID returns the ObjectID field value.

func (*CompositionRunAppliedRules) GetObjectIDOk 

func (o *CompositionRunAppliedRules) GetObjectIDOk() (*string, bool)

GetObjectIDOk returns a tuple with the ObjectID field value and a boolean to check if the value has been set.

func (CompositionRunAppliedRules) MarshalJSON 

func (o CompositionRunAppliedRules) MarshalJSON() ([]byte, error)

func (*CompositionRunAppliedRules) SetObjectID 

func (o *CompositionRunAppliedRules) SetObjectID(v string) *CompositionRunAppliedRules

SetObjectID sets field value.

func (CompositionRunAppliedRules) String 

func (o CompositionRunAppliedRules) String() string

type CompositionRunSearchResponse 

type CompositionRunSearchResponse struct {
	// The objectID of the composition which generated this result set.
	ObjectID             string                       `json:"objectID"`
	AppliedRules         []CompositionRunAppliedRules `json:"appliedRules,omitempty"`
	AdditionalProperties map[string]any               `json:"-"`
}

CompositionRunSearchResponse struct for CompositionRunSearchResponse.

func NewCompositionRunSearchResponse 

func NewCompositionRunSearchResponse(objectID string, opts ...CompositionRunSearchResponseOption) *CompositionRunSearchResponse

NewCompositionRunSearchResponse instantiates a new CompositionRunSearchResponse object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed.

func NewEmptyCompositionRunSearchResponse 

func NewEmptyCompositionRunSearchResponse() *CompositionRunSearchResponse

NewEmptyCompositionRunSearchResponse return a pointer to an empty CompositionRunSearchResponse object.

func (*CompositionRunSearchResponse) GetAppliedRules 

func (o *CompositionRunSearchResponse) GetAppliedRules() []CompositionRunAppliedRules

GetAppliedRules returns the AppliedRules field value if set, zero value otherwise.

func (*CompositionRunSearchResponse) GetAppliedRulesOk 

func (o *CompositionRunSearchResponse) GetAppliedRulesOk() ([]CompositionRunAppliedRules, bool)

GetAppliedRulesOk returns a tuple with the AppliedRules field value if set, nil otherwise and a boolean to check if the value has been set.

func (*CompositionRunSearchResponse) GetObjectID 

func (o *CompositionRunSearchResponse) GetObjectID() string

GetObjectID returns the ObjectID field value.

func (*CompositionRunSearchResponse) GetObjectIDOk 

func (o *CompositionRunSearchResponse) GetObjectIDOk() (*string, bool)

GetObjectIDOk returns a tuple with the ObjectID field value and a boolean to check if the value has been set.

func (*CompositionRunSearchResponse) HasAppliedRules 

func (o *CompositionRunSearchResponse) HasAppliedRules() bool

HasAppliedRules returns a boolean if a field has been set.

func (CompositionRunSearchResponse) MarshalJSON 

func (o CompositionRunSearchResponse) MarshalJSON() ([]byte, error)

func (*CompositionRunSearchResponse) SetAdditionalProperty 

func (o *CompositionRunSearchResponse) SetAdditionalProperty(key string, value any) *CompositionRunSearchResponse

func (*CompositionRunSearchResponse) SetAppliedRules 

func (o *CompositionRunSearchResponse) SetAppliedRules(v []CompositionRunAppliedRules) *CompositionRunSearchResponse

SetAppliedRules gets a reference to the given []CompositionRunAppliedRules and assigns it to the AppliedRules field.

func (*CompositionRunSearchResponse) SetObjectID 

func (o *CompositionRunSearchResponse) SetObjectID(v string) *CompositionRunSearchResponse

SetObjectID sets field value.

func (CompositionRunSearchResponse) String 

func (o CompositionRunSearchResponse) String() string

func (*CompositionRunSearchResponse) UnmarshalJSON 

func (o *CompositionRunSearchResponse) UnmarshalJSON(bytes []byte) error

type CompositionRunSearchResponseOption 

type CompositionRunSearchResponseOption func(f *CompositionRunSearchResponse)

func WithCompositionRunSearchResponseAppliedRules 

func WithCompositionRunSearchResponseAppliedRules(val []CompositionRunAppliedRules) CompositionRunSearchResponseOption

type CompositionsSearchResponse 

type CompositionsSearchResponse struct {
	Run                  []CompositionRunSearchResponse `json:"run"`
	AdditionalProperties map[string]any                 `json:"-"`
}

CompositionsSearchResponse struct for CompositionsSearchResponse.

func NewCompositionsSearchResponse 

func NewCompositionsSearchResponse(run []CompositionRunSearchResponse) *CompositionsSearchResponse

NewCompositionsSearchResponse instantiates a new CompositionsSearchResponse object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed.

func NewEmptyCompositionsSearchResponse 

func NewEmptyCompositionsSearchResponse() *CompositionsSearchResponse

NewEmptyCompositionsSearchResponse return a pointer to an empty CompositionsSearchResponse object.

func (*CompositionsSearchResponse) GetRun 

func (o *CompositionsSearchResponse) GetRun() []CompositionRunSearchResponse

GetRun returns the Run field value.

func (*CompositionsSearchResponse) GetRunOk 

func (o *CompositionsSearchResponse) GetRunOk() ([]CompositionRunSearchResponse, bool)

GetRunOk returns a tuple with the Run field value and a boolean to check if the value has been set.

func (CompositionsSearchResponse) MarshalJSON 

func (o CompositionsSearchResponse) MarshalJSON() ([]byte, error)

func (*CompositionsSearchResponse) SetAdditionalProperty 

func (o *CompositionsSearchResponse) SetAdditionalProperty(key string, value any) *CompositionsSearchResponse

func (*CompositionsSearchResponse) SetRun 

func (o *CompositionsSearchResponse) SetRun(v []CompositionRunSearchResponse) *CompositionsSearchResponse

SetRun sets field value.

func (CompositionsSearchResponse) String 

func (o CompositionsSearchResponse) String() string

func (*CompositionsSearchResponse) UnmarshalJSON 

func (o *CompositionsSearchResponse) UnmarshalJSON(bytes []byte) error

type Condition added in v4.26.0 

type Condition struct {
	// Query pattern that triggers the rule.  You can use either a literal string, or a special pattern `{facet:ATTRIBUTE}`, where `ATTRIBUTE` is a facet name. The rule is triggered if the query matches the literal string or a value of the specified facet. For example, with `pattern: {facet:genre}`, the rule is triggered when users search for a genre, such as \"comedy\".
	Pattern   *string    `json:"pattern,omitempty"`
	Anchoring *Anchoring `json:"anchoring,omitempty"`
	// An additional restriction that only triggers the rule, when the search has the same value as `ruleContexts` parameter. For example, if `context: mobile`, the rule is only triggered when the search request has a matching `ruleContexts: mobile`. A rule context must only contain alphanumeric characters.
	Context *string `json:"context,omitempty"`
	// Filters that trigger the rule.  You can add add filters using the syntax `facet:value` so that the rule is triggered, when the specific filter is selected. You can use `filters` on its own or combine it with the `pattern` parameter.
	Filters *string `json:"filters,omitempty"`
	// Sort criteria that trigger the rule.  You can trigger composition rules based on the selected sorting strategy set by the parameter `sortBy`. The rule will trigger if the value passed to `sortBy` matches the one defined in the condition.
	SortBy *string `json:"sortBy,omitempty"`
}

Condition struct for Condition.

func NewCondition added in v4.26.0 

func NewCondition(opts ...ConditionOption) *Condition

NewCondition instantiates a new Condition object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed.

func NewEmptyCondition added in v4.26.0 

func NewEmptyCondition() *Condition

NewEmptyCondition return a pointer to an empty Condition object.

func (*Condition) GetAnchoring added in v4.26.0 

func (o *Condition) GetAnchoring() Anchoring

GetAnchoring returns the Anchoring field value if set, zero value otherwise.

func (*Condition) GetAnchoringOk added in v4.26.0 

func (o *Condition) GetAnchoringOk() (*Anchoring, bool)

GetAnchoringOk returns a tuple with the Anchoring field value if set, nil otherwise and a boolean to check if the value has been set.

func (*Condition) GetContext added in v4.26.0 

func (o *Condition) GetContext() string

GetContext returns the Context field value if set, zero value otherwise.

func (*Condition) GetContextOk added in v4.26.0 

func (o *Condition) GetContextOk() (*string, bool)

GetContextOk returns a tuple with the Context field value if set, nil otherwise and a boolean to check if the value has been set.

func (*Condition) GetFilters added in v4.26.0 

func (o *Condition) GetFilters() string

GetFilters returns the Filters field value if set, zero value otherwise.

func (*Condition) GetFiltersOk added in v4.26.0 

func (o *Condition) GetFiltersOk() (*string, bool)

GetFiltersOk returns a tuple with the Filters field value if set, nil otherwise and a boolean to check if the value has been set.

func (*Condition) GetPattern added in v4.26.0 

func (o *Condition) GetPattern() string

GetPattern returns the Pattern field value if set, zero value otherwise.

func (*Condition) GetPatternOk added in v4.26.0 

func (o *Condition) GetPatternOk() (*string, bool)

GetPatternOk returns a tuple with the Pattern field value if set, nil otherwise and a boolean to check if the value has been set.

func (*Condition) GetSortBy added in v4.34.0 

func (o *Condition) GetSortBy() string

GetSortBy returns the SortBy field value if set, zero value otherwise.

func (*Condition) GetSortByOk added in v4.34.0 

func (o *Condition) GetSortByOk() (*string, bool)

GetSortByOk returns a tuple with the SortBy field value if set, nil otherwise and a boolean to check if the value has been set.

func (*Condition) HasAnchoring added in v4.26.0 

func (o *Condition) HasAnchoring() bool

HasAnchoring returns a boolean if a field has been set.

func (*Condition) HasContext added in v4.26.0 

func (o *Condition) HasContext() bool

HasContext returns a boolean if a field has been set.

func (*Condition) HasFilters added in v4.26.0 

func (o *Condition) HasFilters() bool

HasFilters returns a boolean if a field has been set.

func (*Condition) HasPattern added in v4.26.0 

func (o *Condition) HasPattern() bool

HasPattern returns a boolean if a field has been set.

func (*Condition) HasSortBy added in v4.34.0 

func (o *Condition) HasSortBy() bool

HasSortBy returns a boolean if a field has been set.

func (Condition) MarshalJSON added in v4.26.0 

func (o Condition) MarshalJSON() ([]byte, error)

func (*Condition) SetAnchoring added in v4.26.0 

func (o *Condition) SetAnchoring(v Anchoring) *Condition

SetAnchoring gets a reference to the given Anchoring and assigns it to the Anchoring field.

func (*Condition) SetContext added in v4.26.0 

func (o *Condition) SetContext(v string) *Condition

SetContext gets a reference to the given string and assigns it to the Context field.

func (*Condition) SetFilters added in v4.26.0 

func (o *Condition) SetFilters(v string) *Condition

SetFilters gets a reference to the given string and assigns it to the Filters field.

func (*Condition) SetPattern added in v4.26.0 

func (o *Condition) SetPattern(v string) *Condition

SetPattern gets a reference to the given string and assigns it to the Pattern field.

func (*Condition) SetSortBy added in v4.34.0 

func (o *Condition) SetSortBy(v string) *Condition

SetSortBy gets a reference to the given string and assigns it to the SortBy field.

func (Condition) String added in v4.26.0 

func (o Condition) String() string

type ConditionOption added in v4.26.0 

type ConditionOption func(f *Condition)

func WithConditionAnchoring added in v4.26.0 

func WithConditionAnchoring(val Anchoring) ConditionOption

func WithConditionContext added in v4.26.0 

func WithConditionContext(val string) ConditionOption

func WithConditionFilters added in v4.26.0 

func WithConditionFilters(val string) ConditionOption

func WithConditionPattern added in v4.26.0 

func WithConditionPattern(val string) ConditionOption

func WithConditionSortBy added in v4.34.0 

func WithConditionSortBy(val string) ConditionOption

type DedupPositioning added in v4.28.0 

type DedupPositioning string

DedupPositioning Deduplication positioning configures how a duplicate result should be resolved between an injected item and main search results. Current configuration supports: - 'highest': always select the item in the highest position, and remove duplicates that appear lower in the results. - 'highestInjected': duplicate result will be moved to its highest possible injected position, but not higher. If a duplicate appears higher in main search results, it will be removed to stay it's intended group position (which could be lower than main). 

const (
	DEDUP_POSITIONING_HIGHEST          DedupPositioning = "highest"
	DEDUP_POSITIONING_HIGHEST_INJECTED DedupPositioning = "highestInjected"
)

List of dedupPositioning.

func NewDedupPositioningFromValue added in v4.28.0 

func NewDedupPositioningFromValue(v string) (*DedupPositioning, error)

NewDedupPositioningFromValue returns a pointer to a valid DedupPositioning. for the value passed as argument, or an error if the value passed is not allowed by the enum.

func (DedupPositioning) IsValid added in v4.28.0 

func (v DedupPositioning) IsValid() bool

IsValid return true if the value is valid for the enum, false otherwise.

func (DedupPositioning) Ptr added in v4.28.0 

func (v DedupPositioning) Ptr() *DedupPositioning

Ptr returns reference to dedupPositioning value.

func (*DedupPositioning) UnmarshalJSON added in v4.28.0 

func (v *DedupPositioning) UnmarshalJSON(src []byte) error

type Deduplication added in v4.28.0 

type Deduplication struct {
	Positioning DedupPositioning `json:"positioning"`
}

Deduplication Deduplication configures the methods used to resolve duplicate items between main search results and injected group results.

func NewDeduplication added in v4.28.0 

func NewDeduplication(positioning DedupPositioning) *Deduplication

NewDeduplication instantiates a new Deduplication object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed.

func NewEmptyDeduplication added in v4.28.0 

func NewEmptyDeduplication() *Deduplication

NewEmptyDeduplication return a pointer to an empty Deduplication object.

func (*Deduplication) GetPositioning added in v4.28.0 

func (o *Deduplication) GetPositioning() DedupPositioning

GetPositioning returns the Positioning field value.

func (*Deduplication) GetPositioningOk added in v4.28.0 

func (o *Deduplication) GetPositioningOk() (*DedupPositioning, bool)

GetPositioningOk returns a tuple with the Positioning field value and a boolean to check if the value has been set.

func (Deduplication) MarshalJSON added in v4.28.0 

func (o Deduplication) MarshalJSON() ([]byte, error)

func (*Deduplication) SetPositioning added in v4.28.0 

func (o *Deduplication) SetPositioning(v DedupPositioning) *Deduplication

SetPositioning sets field value.

func (Deduplication) String added in v4.28.0 

func (o Deduplication) String() string

type DeleteCompositionAction added in v4.26.0 

type DeleteCompositionAction struct {
	// Composition unique identifier.
	ObjectID string `json:"objectID"`
}

DeleteCompositionAction Operation arguments when deleting.

func NewDeleteCompositionAction added in v4.26.0 

func NewDeleteCompositionAction(objectID string) *DeleteCompositionAction

NewDeleteCompositionAction instantiates a new DeleteCompositionAction object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed.

func NewEmptyDeleteCompositionAction added in v4.26.0 

func NewEmptyDeleteCompositionAction() *DeleteCompositionAction

NewEmptyDeleteCompositionAction return a pointer to an empty DeleteCompositionAction object.

func (*DeleteCompositionAction) GetObjectID added in v4.26.0 

func (o *DeleteCompositionAction) GetObjectID() string

GetObjectID returns the ObjectID field value.

func (*DeleteCompositionAction) GetObjectIDOk added in v4.26.0 

func (o *DeleteCompositionAction) GetObjectIDOk() (*string, bool)

GetObjectIDOk returns a tuple with the ObjectID field value and a boolean to check if the value has been set.

func (DeleteCompositionAction) MarshalJSON added in v4.26.0 

func (o DeleteCompositionAction) MarshalJSON() ([]byte, error)

func (*DeleteCompositionAction) SetObjectID added in v4.26.0 

func (o *DeleteCompositionAction) SetObjectID(v string) *DeleteCompositionAction

SetObjectID sets field value.

func (DeleteCompositionAction) String added in v4.26.0 

func (o DeleteCompositionAction) String() string

type DeleteCompositionRuleAction added in v4.26.0 

type DeleteCompositionRuleAction struct {
	// Composition rule unique identifier.
	ObjectID string `json:"objectID"`
}

DeleteCompositionRuleAction Operation arguments when deleting.

func NewDeleteCompositionRuleAction added in v4.26.0 

func NewDeleteCompositionRuleAction(objectID string) *DeleteCompositionRuleAction

NewDeleteCompositionRuleAction instantiates a new DeleteCompositionRuleAction object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed.

func NewEmptyDeleteCompositionRuleAction added in v4.26.0 

func NewEmptyDeleteCompositionRuleAction() *DeleteCompositionRuleAction

NewEmptyDeleteCompositionRuleAction return a pointer to an empty DeleteCompositionRuleAction object.

func (*DeleteCompositionRuleAction) GetObjectID added in v4.26.0 

func (o *DeleteCompositionRuleAction) GetObjectID() string

GetObjectID returns the ObjectID field value.

func (*DeleteCompositionRuleAction) GetObjectIDOk added in v4.26.0 

func (o *DeleteCompositionRuleAction) GetObjectIDOk() (*string, bool)

GetObjectIDOk returns a tuple with the ObjectID field value and a boolean to check if the value has been set.

func (DeleteCompositionRuleAction) MarshalJSON added in v4.26.0 

func (o DeleteCompositionRuleAction) MarshalJSON() ([]byte, error)

func (*DeleteCompositionRuleAction) SetObjectID added in v4.26.0 

func (o *DeleteCompositionRuleAction) SetObjectID(v string) *DeleteCompositionRuleAction

SetObjectID sets field value.

func (DeleteCompositionRuleAction) String added in v4.26.0 

func (o DeleteCompositionRuleAction) String() string

type Distinct added in v4.26.0 

type Distinct struct {
	Bool  *bool
	Int32 *int32
}

Distinct - Determines how many records of a group are included in the search results. Records with the same value for the `attributeForDistinct` attribute are considered a group. The `distinct` setting controls how many members of the group are returned. This is useful for [deduplication and grouping](https://www.algolia.com/doc/guides/managing-results/refine-results/grouping/#introducing-algolias-distinct-feature). The `distinct` setting is ignored if `attributeForDistinct` is not set.

func BoolAsDistinct added in v4.26.0 

func BoolAsDistinct(v bool) *Distinct

boolAsDistinct is a convenience function that returns bool wrapped in Distinct.

func Int32AsDistinct added in v4.26.0 

func Int32AsDistinct(v int32) *Distinct

int32AsDistinct is a convenience function that returns int32 wrapped in Distinct.

func (Distinct) GetActualInstance added in v4.26.0 

func (obj Distinct) GetActualInstance() any

Get the actual instance.

func (Distinct) MarshalJSON added in v4.26.0 

func (src Distinct) MarshalJSON() ([]byte, error)

Marshal data from the first non-nil pointers in the struct to JSON.

func (*Distinct) UnmarshalJSON added in v4.26.0 

func (dst *Distinct) UnmarshalJSON(data []byte) error

Unmarshal JSON data into one or more of the pointers in the struct.

type ErrorBase 

type ErrorBase struct {
	Message              *string        `json:"message,omitempty"`
	AdditionalProperties map[string]any `json:"-"`
}

ErrorBase Error.

func NewEmptyErrorBase 

func NewEmptyErrorBase() *ErrorBase

NewEmptyErrorBase return a pointer to an empty ErrorBase object.

func NewErrorBase 

func NewErrorBase(opts ...ErrorBaseOption) *ErrorBase

NewErrorBase instantiates a new ErrorBase object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed.

func (*ErrorBase) GetMessage 

func (o *ErrorBase) GetMessage() string

GetMessage returns the Message field value if set, zero value otherwise.

func (*ErrorBase) GetMessageOk 

func (o *ErrorBase) GetMessageOk() (*string, bool)

GetMessageOk returns a tuple with the Message field value if set, nil otherwise and a boolean to check if the value has been set.

func (*ErrorBase) HasMessage 

func (o *ErrorBase) HasMessage() bool

HasMessage returns a boolean if a field has been set.

func (ErrorBase) MarshalJSON 

func (o ErrorBase) MarshalJSON() ([]byte, error)

func (*ErrorBase) SetAdditionalProperty 

func (o *ErrorBase) SetAdditionalProperty(key string, value any) *ErrorBase

func (*ErrorBase) SetMessage 

func (o *ErrorBase) SetMessage(v string) *ErrorBase

SetMessage gets a reference to the given string and assigns it to the Message field.

func (ErrorBase) String 

func (o ErrorBase) String() string

func (*ErrorBase) UnmarshalJSON 

func (o *ErrorBase) UnmarshalJSON(bytes []byte) error

type ErrorBaseOption 

type ErrorBaseOption func(f *ErrorBase)

func WithErrorBaseMessage 

func WithErrorBaseMessage(val string) ErrorBaseOption

type ExactOnSingleWordQuery added in v4.26.0 

type ExactOnSingleWordQuery string

ExactOnSingleWordQuery Determines how the [Exact ranking criterion](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/override-search-engine-defaults/in-depth/adjust-exact-settings/#turn-off-exact-for-some-attributes) is computed when the search query has only one word. - `attribute`. The Exact ranking criterion is 1 if the query word and attribute value are the same. For example, a search for \"road\" will match the value \"road\", but not \"road trip\". - `none`. The Exact ranking criterion is ignored on single-word searches. - `word`. The Exact ranking criterion is 1 if the query word is found in the attribute value. The query word must have at least 3 characters and must not be a stop word. Only exact matches will be highlighted, partial and prefix matches won't. 

const (
	EXACT_ON_SINGLE_WORD_QUERY_ATTRIBUTE ExactOnSingleWordQuery = "attribute"
	EXACT_ON_SINGLE_WORD_QUERY_NONE      ExactOnSingleWordQuery = "none"
	EXACT_ON_SINGLE_WORD_QUERY_WORD      ExactOnSingleWordQuery = "word"
)

List of exactOnSingleWordQuery.

func NewExactOnSingleWordQueryFromValue added in v4.26.0 

func NewExactOnSingleWordQueryFromValue(v string) (*ExactOnSingleWordQuery, error)

NewExactOnSingleWordQueryFromValue returns a pointer to a valid ExactOnSingleWordQuery. for the value passed as argument, or an error if the value passed is not allowed by the enum.

func (ExactOnSingleWordQuery) IsValid added in v4.26.0 

func (v ExactOnSingleWordQuery) IsValid() bool

IsValid return true if the value is valid for the enum, false otherwise.

func (ExactOnSingleWordQuery) Ptr added in v4.26.0 

func (v ExactOnSingleWordQuery) Ptr() *ExactOnSingleWordQuery

Ptr returns reference to exactOnSingleWordQuery value.

func (*ExactOnSingleWordQuery) UnmarshalJSON added in v4.26.0 

func (v *ExactOnSingleWordQuery) UnmarshalJSON(src []byte) error

type Exhaustive 

type Exhaustive struct {
	// Whether the facet count is exhaustive (`true`) or approximate (`false`). See the [related discussion](https://support.algolia.com/hc/articles/4406975248145-Why-are-my-facet-and-hit-counts-not-accurate).
	FacetsCount *bool `json:"facetsCount,omitempty"`
	// The value is `false` if not all facet values are retrieved.
	FacetValues *bool `json:"facetValues,omitempty"`
	// Whether the `nbHits` is exhaustive (`true`) or approximate (`false`). When the query takes more than 50ms to be processed, the engine makes an approximation. This can happen when using complex filters on millions of records, when typo-tolerance was not exhaustive, or when enough hits have been retrieved (for example, after the engine finds 10,000 exact matches). `nbHits` is reported as non-exhaustive whenever an approximation is made, even if the approximation didn’t, in the end, impact the exhaustivity of the query.
	NbHits *bool `json:"nbHits,omitempty"`
	// Rules matching exhaustivity. The value is `false` if rules were enable for this query, and could not be fully processed due a timeout. This is generally caused by the number of alternatives (such as typos) which is too large.
	RulesMatch *bool `json:"rulesMatch,omitempty"`
	// Whether the typo search was exhaustive (`true`) or approximate (`false`). An approximation is done when the typo search query part takes more than 10% of the query budget (ie. 5ms by default) to be processed (this can happen when a lot of typo alternatives exist for the query). This field will not be included when typo-tolerance is entirely disabled.
	Typo *bool `json:"typo,omitempty"`
}

Exhaustive Whether certain properties of the search response are calculated exhaustive (exact) or approximated.

func NewEmptyExhaustive 

func NewEmptyExhaustive() *Exhaustive

NewEmptyExhaustive return a pointer to an empty Exhaustive object.

func NewExhaustive 

func NewExhaustive(opts ...ExhaustiveOption) *Exhaustive

NewExhaustive instantiates a new Exhaustive object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed.

func (*Exhaustive) GetFacetValues 

func (o *Exhaustive) GetFacetValues() bool

GetFacetValues returns the FacetValues field value if set, zero value otherwise.

func (*Exhaustive) GetFacetValuesOk 

func (o *Exhaustive) GetFacetValuesOk() (*bool, bool)

GetFacetValuesOk returns a tuple with the FacetValues field value if set, nil otherwise and a boolean to check if the value has been set.

func (*Exhaustive) GetFacetsCount 

func (o *Exhaustive) GetFacetsCount() bool

GetFacetsCount returns the FacetsCount field value if set, zero value otherwise.

func (*Exhaustive) GetFacetsCountOk 

func (o *Exhaustive) GetFacetsCountOk() (*bool, bool)

GetFacetsCountOk returns a tuple with the FacetsCount field value if set, nil otherwise and a boolean to check if the value has been set.

func (*Exhaustive) GetNbHits 

func (o *Exhaustive) GetNbHits() bool

GetNbHits returns the NbHits field value if set, zero value otherwise.

func (*Exhaustive) GetNbHitsOk 

func (o *Exhaustive) GetNbHitsOk() (*bool, bool)

GetNbHitsOk returns a tuple with the NbHits field value if set, nil otherwise and a boolean to check if the value has been set.

func (*Exhaustive) GetRulesMatch 

func (o *Exhaustive) GetRulesMatch() bool

GetRulesMatch returns the RulesMatch field value if set, zero value otherwise.

func (*Exhaustive) GetRulesMatchOk 

func (o *Exhaustive) GetRulesMatchOk() (*bool, bool)

GetRulesMatchOk returns a tuple with the RulesMatch field value if set, nil otherwise and a boolean to check if the value has been set.

func (*Exhaustive) GetTypo 

func (o *Exhaustive) GetTypo() bool

GetTypo returns the Typo field value if set, zero value otherwise.

func (*Exhaustive) GetTypoOk 

func (o *Exhaustive) GetTypoOk() (*bool, bool)

GetTypoOk returns a tuple with the Typo field value if set, nil otherwise and a boolean to check if the value has been set.

func (*Exhaustive) HasFacetValues 

func (o *Exhaustive) HasFacetValues() bool

HasFacetValues returns a boolean if a field has been set.

func (*Exhaustive) HasFacetsCount 

func (o *Exhaustive) HasFacetsCount() bool

HasFacetsCount returns a boolean if a field has been set.

func (*Exhaustive) HasNbHits 

func (o *Exhaustive) HasNbHits() bool

HasNbHits returns a boolean if a field has been set.

func (*Exhaustive) HasRulesMatch 

func (o *Exhaustive) HasRulesMatch() bool

HasRulesMatch returns a boolean if a field has been set.

func (*Exhaustive) HasTypo 

func (o *Exhaustive) HasTypo() bool

HasTypo returns a boolean if a field has been set.

func (Exhaustive) MarshalJSON 

func (o Exhaustive) MarshalJSON() ([]byte, error)

func (*Exhaustive) SetFacetValues 

func (o *Exhaustive) SetFacetValues(v bool) *Exhaustive

SetFacetValues gets a reference to the given bool and assigns it to the FacetValues field.

func (*Exhaustive) SetFacetsCount 

func (o *Exhaustive) SetFacetsCount(v bool) *Exhaustive

SetFacetsCount gets a reference to the given bool and assigns it to the FacetsCount field.

func (*Exhaustive) SetNbHits 

func (o *Exhaustive) SetNbHits(v bool) *Exhaustive

SetNbHits gets a reference to the given bool and assigns it to the NbHits field.

func (*Exhaustive) SetRulesMatch 

func (o *Exhaustive) SetRulesMatch(v bool) *Exhaustive

SetRulesMatch gets a reference to the given bool and assigns it to the RulesMatch field.

func (*Exhaustive) SetTypo 

func (o *Exhaustive) SetTypo(v bool) *Exhaustive

SetTypo gets a reference to the given bool and assigns it to the Typo field.

func (Exhaustive) String 

func (o Exhaustive) String() string

type ExhaustiveOption 

type ExhaustiveOption func(f *Exhaustive)

func WithExhaustiveFacetValues 

func WithExhaustiveFacetValues(val bool) ExhaustiveOption

func WithExhaustiveFacetsCount 

func WithExhaustiveFacetsCount(val bool) ExhaustiveOption

func WithExhaustiveNbHits 

func WithExhaustiveNbHits(val bool) ExhaustiveOption

func WithExhaustiveRulesMatch 

func WithExhaustiveRulesMatch(val bool) ExhaustiveOption

func WithExhaustiveTypo 

func WithExhaustiveTypo(val bool) ExhaustiveOption

type ExternalInjectedItem added in v4.25.0 

type ExternalInjectedItem struct {
	Items []ExternalInjection `json:"items"`
}

ExternalInjectedItem Contains a list of objects to inject from an external source.

func NewEmptyExternalInjectedItem added in v4.25.0 

func NewEmptyExternalInjectedItem() *ExternalInjectedItem

NewEmptyExternalInjectedItem return a pointer to an empty ExternalInjectedItem object.

func NewExternalInjectedItem added in v4.25.0 

func NewExternalInjectedItem(items []ExternalInjection) *ExternalInjectedItem

NewExternalInjectedItem instantiates a new ExternalInjectedItem object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed.

func (*ExternalInjectedItem) GetItems added in v4.25.0 

func (o *ExternalInjectedItem) GetItems() []ExternalInjection

GetItems returns the Items field value.

func (*ExternalInjectedItem) GetItemsOk added in v4.25.0 

func (o *ExternalInjectedItem) GetItemsOk() ([]ExternalInjection, bool)

GetItemsOk returns a tuple with the Items field value and a boolean to check if the value has been set.

func (ExternalInjectedItem) MarshalJSON added in v4.25.0 

func (o ExternalInjectedItem) MarshalJSON() ([]byte, error)

func (*ExternalInjectedItem) SetItems added in v4.25.0 

func (o *ExternalInjectedItem) SetItems(v []ExternalInjection) *ExternalInjectedItem

SetItems sets field value.

func (ExternalInjectedItem) String added in v4.25.0 

func (o ExternalInjectedItem) String() string

type ExternalInjection added in v4.25.0 

type ExternalInjection struct {
	// An objectID injected from an external source and also present in the targeted index.
	ObjectID string `json:"objectID"`
	// User-defined key-values that will be added to the injected item in the response. This is identical to Hits metadata defined in Composition or Composition Rule, with the benefit of being set at runtime.
	Metadata map[string]any `json:"metadata,omitempty"`
}

ExternalInjection struct for ExternalInjection.

func NewEmptyExternalInjection added in v4.25.0 

func NewEmptyExternalInjection() *ExternalInjection

NewEmptyExternalInjection return a pointer to an empty ExternalInjection object.

func NewExternalInjection added in v4.25.0 

func NewExternalInjection(objectID string, opts ...ExternalInjectionOption) *ExternalInjection

NewExternalInjection instantiates a new ExternalInjection object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed.

func (*ExternalInjection) GetMetadata added in v4.25.0 

func (o *ExternalInjection) GetMetadata() map[string]any

GetMetadata returns the Metadata field value if set, zero value otherwise.

func (*ExternalInjection) GetMetadataOk added in v4.25.0 

func (o *ExternalInjection) GetMetadataOk() (map[string]any, bool)

GetMetadataOk returns a tuple with the Metadata field value if set, nil otherwise and a boolean to check if the value has been set.

func (*ExternalInjection) GetObjectID added in v4.25.0 

func (o *ExternalInjection) GetObjectID() string

GetObjectID returns the ObjectID field value.

func (*ExternalInjection) GetObjectIDOk added in v4.25.0 

func (o *ExternalInjection) GetObjectIDOk() (*string, bool)

GetObjectIDOk returns a tuple with the ObjectID field value and a boolean to check if the value has been set.

func (*ExternalInjection) HasMetadata added in v4.25.0 

func (o *ExternalInjection) HasMetadata() bool

HasMetadata returns a boolean if a field has been set.

func (ExternalInjection) MarshalJSON added in v4.25.0 

func (o ExternalInjection) MarshalJSON() ([]byte, error)

func (*ExternalInjection) SetMetadata added in v4.25.0 

func (o *ExternalInjection) SetMetadata(v map[string]any) *ExternalInjection

SetMetadata gets a reference to the given map[string]any and assigns it to the Metadata field.

func (*ExternalInjection) SetObjectID added in v4.25.0 

func (o *ExternalInjection) SetObjectID(v string) *ExternalInjection

SetObjectID sets field value.

func (ExternalInjection) String added in v4.25.0 

func (o ExternalInjection) String() string

type ExternalInjectionOption added in v4.25.0 

type ExternalInjectionOption func(f *ExternalInjection)

func WithExternalInjectionMetadata added in v4.25.0 

func WithExternalInjectionMetadata(val map[string]any) ExternalInjectionOption

type ExternalOrdering added in v4.26.0 

type ExternalOrdering string

ExternalOrdering Ordering to apply on the injected items coming from the external source. 'default' means the items will be ordered as they are in the index (natural relevance) in the smart group. 'userDefined' means the order in which the objectIDs are provided in the run request payload will be preserved in the smart group. 

const (
	EXTERNAL_ORDERING_DEFAULT      ExternalOrdering = "default"
	EXTERNAL_ORDERING_USER_DEFINED ExternalOrdering = "userDefined"
)

List of externalOrdering.

func NewExternalOrderingFromValue added in v4.26.0 

func NewExternalOrderingFromValue(v string) (*ExternalOrdering, error)

NewExternalOrderingFromValue returns a pointer to a valid ExternalOrdering. for the value passed as argument, or an error if the value passed is not allowed by the enum.

func (ExternalOrdering) IsValid added in v4.26.0 

func (v ExternalOrdering) IsValid() bool

IsValid return true if the value is valid for the enum, false otherwise.

func (ExternalOrdering) Ptr added in v4.26.0 

func (v ExternalOrdering) Ptr() *ExternalOrdering

Ptr returns reference to externalOrdering value.

func (*ExternalOrdering) UnmarshalJSON added in v4.26.0 

func (v *ExternalOrdering) UnmarshalJSON(src []byte) error

type FacetFilters 

type FacetFilters struct {
	ArrayOfFacetFilters *[]FacetFilters
	String              *string
}

FacetFilters - Filter the search by facet values, so that only records with the same facet values are retrieved. **Prefer using the `filters` parameter, which supports all filter types and combinations with boolean operators.** - `[filter1, filter2]` is interpreted as `filter1 AND filter2`. - `[[filter1, filter2], filter3]` is interpreted as `filter1 OR filter2 AND filter3`. - `facet:-value` is interpreted as `NOT facet:value`. While it's best to avoid attributes that start with a `-`, you can still filter them by escaping with a backslash: `facet:\\-value`.

func ArrayOfFacetFiltersAsFacetFilters 

func ArrayOfFacetFiltersAsFacetFilters(v []FacetFilters) *FacetFilters

[]FacetFiltersAsFacetFilters is a convenience function that returns []FacetFilters wrapped in FacetFilters.

func StringAsFacetFilters 

func StringAsFacetFilters(v string) *FacetFilters

stringAsFacetFilters is a convenience function that returns string wrapped in FacetFilters.

func (FacetFilters) GetActualInstance 

func (obj FacetFilters) GetActualInstance() any

Get the actual instance.

func (FacetFilters) MarshalJSON 

func (src FacetFilters) MarshalJSON() ([]byte, error)

Marshal data from the first non-nil pointers in the struct to JSON.

func (*FacetFilters) UnmarshalJSON 

func (dst *FacetFilters) UnmarshalJSON(data []byte) error

Unmarshal JSON data into one or more of the pointers in the struct.

type FacetHits 

type FacetHits struct {
	// Facet value.
	Value string `json:"value"`
	// Highlighted attribute value, including HTML tags.
	Highlighted string `json:"highlighted"`
	// Number of records with this facet value. [The count may be approximated](https://support.algolia.com/hc/articles/4406975248145-Why-are-my-facet-and-hit-counts-not-accurate).
	Count int32 `json:"count"`
}

FacetHits struct for FacetHits.

func NewEmptyFacetHits 

func NewEmptyFacetHits() *FacetHits

NewEmptyFacetHits return a pointer to an empty FacetHits object.

func NewFacetHits 

func NewFacetHits(value string, highlighted string, count int32) *FacetHits

NewFacetHits instantiates a new FacetHits object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed.

func (*FacetHits) GetCount 

func (o *FacetHits) GetCount() int32

GetCount returns the Count field value.

func (*FacetHits) GetCountOk 

func (o *FacetHits) GetCountOk() (*int32, bool)

GetCountOk returns a tuple with the Count field value and a boolean to check if the value has been set.

func (*FacetHits) GetHighlighted 

func (o *FacetHits) GetHighlighted() string

GetHighlighted returns the Highlighted field value.

func (*FacetHits) GetHighlightedOk 

func (o *FacetHits) GetHighlightedOk() (*string, bool)

GetHighlightedOk returns a tuple with the Highlighted field value and a boolean to check if the value has been set.

func (*FacetHits) GetValue 

func (o *FacetHits) GetValue() string

GetValue returns the Value field value.

func (*FacetHits) GetValueOk 

func (o *FacetHits) GetValueOk() (*string, bool)

GetValueOk returns a tuple with the Value field value and a boolean to check if the value has been set.

func (FacetHits) MarshalJSON 

func (o FacetHits) MarshalJSON() ([]byte, error)

func (*FacetHits) SetCount 

func (o *FacetHits) SetCount(v int32) *FacetHits

SetCount sets field value.

func (*FacetHits) SetHighlighted 

func (o *FacetHits) SetHighlighted(v string) *FacetHits

SetHighlighted sets field value.

func (*FacetHits) SetValue 

func (o *FacetHits) SetValue(v string) *FacetHits

SetValue sets field value.

func (FacetHits) String 

func (o FacetHits) String() string

type FacetOrdering 

type FacetOrdering struct {
	Facets *IndexSettingsFacets `json:"facets,omitempty"`
	// Order of facet values. One object for each facet.
	Values *map[string]Value `json:"values,omitempty"`
}

FacetOrdering Order of facet names and facet values in your UI.

func NewEmptyFacetOrdering 

func NewEmptyFacetOrdering() *FacetOrdering

NewEmptyFacetOrdering return a pointer to an empty FacetOrdering object.

func NewFacetOrdering 

func NewFacetOrdering(opts ...FacetOrderingOption) *FacetOrdering

NewFacetOrdering instantiates a new FacetOrdering object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed.

func (*FacetOrdering) GetFacets 

func (o *FacetOrdering) GetFacets() IndexSettingsFacets

GetFacets returns the Facets field value if set, zero value otherwise.

func (*FacetOrdering) GetFacetsOk 

func (o *FacetOrdering) GetFacetsOk() (*IndexSettingsFacets, bool)

GetFacetsOk returns a tuple with the Facets field value if set, nil otherwise and a boolean to check if the value has been set.

func (*FacetOrdering) GetValues 

func (o *FacetOrdering) GetValues() map[string]Value

GetValues returns the Values field value if set, zero value otherwise.

func (*FacetOrdering) GetValuesOk 

func (o *FacetOrdering) GetValuesOk() (*map[string]Value, bool)

GetValuesOk returns a tuple with the Values field value if set, nil otherwise and a boolean to check if the value has been set.

func (*FacetOrdering) HasFacets 

func (o *FacetOrdering) HasFacets() bool

HasFacets returns a boolean if a field has been set.

func (*FacetOrdering) HasValues 

func (o *FacetOrdering) HasValues() bool

HasValues returns a boolean if a field has been set.

func (FacetOrdering) MarshalJSON 

func (o FacetOrdering) MarshalJSON() ([]byte, error)

func (*FacetOrdering) SetFacets 

func (o *FacetOrdering) SetFacets(v *IndexSettingsFacets) *FacetOrdering

SetFacets gets a reference to the given IndexSettingsFacets and assigns it to the Facets field.

func (*FacetOrdering) SetValues 

func (o *FacetOrdering) SetValues(v map[string]Value) *FacetOrdering

SetValues gets a reference to the given map[string]Value and assigns it to the Values field.

func (FacetOrdering) String 

func (o FacetOrdering) String() string

type FacetOrderingOption 

type FacetOrderingOption func(f *FacetOrdering)

func WithFacetOrderingFacets 

func WithFacetOrderingFacets(val IndexSettingsFacets) FacetOrderingOption

func WithFacetOrderingValues 

func WithFacetOrderingValues(val map[string]Value) FacetOrderingOption

type FacetStats 

type FacetStats struct {
	// Minimum value in the results.
	Min *float64 `json:"min,omitempty"`
	// Maximum value in the results.
	Max *float64 `json:"max,omitempty"`
	// Average facet value in the results.
	Avg *float64 `json:"avg,omitempty"`
	// Sum of all values in the results.
	Sum *float64 `json:"sum,omitempty"`
}

FacetStats struct for FacetStats.

func NewEmptyFacetStats 

func NewEmptyFacetStats() *FacetStats

NewEmptyFacetStats return a pointer to an empty FacetStats object.

func NewFacetStats 

func NewFacetStats(opts ...FacetStatsOption) *FacetStats

NewFacetStats instantiates a new FacetStats object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed.

func (*FacetStats) GetAvg 

func (o *FacetStats) GetAvg() float64

GetAvg returns the Avg field value if set, zero value otherwise.

func (*FacetStats) GetAvgOk 

func (o *FacetStats) GetAvgOk() (*float64, bool)

GetAvgOk returns a tuple with the Avg field value if set, nil otherwise and a boolean to check if the value has been set.

func (*FacetStats) GetMax 

func (o *FacetStats) GetMax() float64

GetMax returns the Max field value if set, zero value otherwise.

func (*FacetStats) GetMaxOk 

func (o *FacetStats) GetMaxOk() (*float64, bool)

GetMaxOk returns a tuple with the Max field value if set, nil otherwise and a boolean to check if the value has been set.

func (*FacetStats) GetMin 

func (o *FacetStats) GetMin() float64

GetMin returns the Min field value if set, zero value otherwise.

func (*FacetStats) GetMinOk 

func (o *FacetStats) GetMinOk() (*float64, bool)

GetMinOk returns a tuple with the Min field value if set, nil otherwise and a boolean to check if the value has been set.

func (*FacetStats) GetSum 

func (o *FacetStats) GetSum() float64

GetSum returns the Sum field value if set, zero value otherwise.

func (*FacetStats) GetSumOk 

func (o *FacetStats) GetSumOk() (*float64, bool)

GetSumOk returns a tuple with the Sum field value if set, nil otherwise and a boolean to check if the value has been set.

func (*FacetStats) HasAvg 

func (o *FacetStats) HasAvg() bool

HasAvg returns a boolean if a field has been set.

func (*FacetStats) HasMax 

func (o *FacetStats) HasMax() bool

HasMax returns a boolean if a field has been set.

func (*FacetStats) HasMin 

func (o *FacetStats) HasMin() bool

HasMin returns a boolean if a field has been set.

func (*FacetStats) HasSum 

func (o *FacetStats) HasSum() bool

HasSum returns a boolean if a field has been set.

func (FacetStats) MarshalJSON 

func (o FacetStats) MarshalJSON() ([]byte, error)

func (*FacetStats) SetAvg 

func (o *FacetStats) SetAvg(v float64) *FacetStats

SetAvg gets a reference to the given float64 and assigns it to the Avg field.

func (*FacetStats) SetMax 

func (o *FacetStats) SetMax(v float64) *FacetStats

SetMax gets a reference to the given float64 and assigns it to the Max field.

func (*FacetStats) SetMin 

func (o *FacetStats) SetMin(v float64) *FacetStats

SetMin gets a reference to the given float64 and assigns it to the Min field.

func (*FacetStats) SetSum 

func (o *FacetStats) SetSum(v float64) *FacetStats

SetSum gets a reference to the given float64 and assigns it to the Sum field.

func (FacetStats) String 

func (o FacetStats) String() string

type FacetStatsOption 

type FacetStatsOption func(f *FacetStats)

func WithFacetStatsAvg 

func WithFacetStatsAvg(val float64) FacetStatsOption

func WithFacetStatsMax 

func WithFacetStatsMax(val float64) FacetStatsOption

func WithFacetStatsMin 

func WithFacetStatsMin(val float64) FacetStatsOption

func WithFacetStatsSum 

func WithFacetStatsSum(val float64) FacetStatsOption

type FeedInjection added in v4.37.0 

type FeedInjection struct {
	Injection Injection `json:"injection"`
}

FeedInjection Feed formatted as an injection.

func NewEmptyFeedInjection added in v4.37.0 

func NewEmptyFeedInjection() *FeedInjection

NewEmptyFeedInjection return a pointer to an empty FeedInjection object.

func NewFeedInjection added in v4.37.0 

func NewFeedInjection(injection Injection) *FeedInjection

NewFeedInjection instantiates a new FeedInjection object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed.

func (*FeedInjection) GetInjection added in v4.37.0 

func (o *FeedInjection) GetInjection() Injection

GetInjection returns the Injection field value.

func (*FeedInjection) GetInjectionOk added in v4.37.0 

func (o *FeedInjection) GetInjectionOk() (*Injection, bool)

GetInjectionOk returns a tuple with the Injection field value and a boolean to check if the value has been set.

func (FeedInjection) MarshalJSON added in v4.37.0 

func (o FeedInjection) MarshalJSON() ([]byte, error)

func (*FeedInjection) SetInjection added in v4.37.0 

func (o *FeedInjection) SetInjection(v *Injection) *FeedInjection

SetInjection sets field value.

func (FeedInjection) String added in v4.37.0 

func (o FeedInjection) String() string

type GetTaskResponse added in v4.26.0 

type GetTaskResponse struct {
	Status TaskStatus `json:"status"`
}

GetTaskResponse struct for GetTaskResponse.

func NewEmptyGetTaskResponse added in v4.26.0 

func NewEmptyGetTaskResponse() *GetTaskResponse

NewEmptyGetTaskResponse return a pointer to an empty GetTaskResponse object.

func NewGetTaskResponse added in v4.26.0 

func NewGetTaskResponse(status TaskStatus) *GetTaskResponse

NewGetTaskResponse instantiates a new GetTaskResponse object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed.

func (*GetTaskResponse) GetStatus added in v4.26.0 

func (o *GetTaskResponse) GetStatus() TaskStatus

GetStatus returns the Status field value.

func (*GetTaskResponse) GetStatusOk added in v4.26.0 

func (o *GetTaskResponse) GetStatusOk() (*TaskStatus, bool)

GetStatusOk returns a tuple with the Status field value and a boolean to check if the value has been set.

func (GetTaskResponse) MarshalJSON added in v4.26.0 

func (o GetTaskResponse) MarshalJSON() ([]byte, error)

func (*GetTaskResponse) SetStatus added in v4.26.0 

func (o *GetTaskResponse) SetStatus(v TaskStatus) *GetTaskResponse

SetStatus sets field value.

func (GetTaskResponse) String added in v4.26.0 

func (o GetTaskResponse) String() string

type HighlightResult 

type HighlightResult struct {
	HighlightResultOption         *HighlightResultOption
	ArrayOfHighlightResult        *[]HighlightResult
	MapmapOfStringHighlightResult *map[string]HighlightResult
}

HighlightResult - struct for HighlightResult.

func ArrayOfHighlightResultAsHighlightResult 

func ArrayOfHighlightResultAsHighlightResult(v []HighlightResult) *HighlightResult

[]HighlightResultAsHighlightResult is a convenience function that returns []HighlightResult wrapped in HighlightResult.

func HighlightResultOptionAsHighlightResult 

func HighlightResultOptionAsHighlightResult(v *HighlightResultOption) *HighlightResult

HighlightResultOptionAsHighlightResult is a convenience function that returns HighlightResultOption wrapped in HighlightResult.

func MapmapOfStringHighlightResultAsHighlightResult 

func MapmapOfStringHighlightResultAsHighlightResult(v map[string]HighlightResult) *HighlightResult

map[string]HighlightResultAsHighlightResult is a convenience function that returns map[string]HighlightResult wrapped in HighlightResult.

func (HighlightResult) GetActualInstance 

func (obj HighlightResult) GetActualInstance() any

Get the actual instance.

func (HighlightResult) MarshalJSON 

func (src HighlightResult) MarshalJSON() ([]byte, error)

Marshal data from the first non-nil pointers in the struct to JSON.

func (*HighlightResult) UnmarshalJSON 

func (dst *HighlightResult) UnmarshalJSON(data []byte) error

Unmarshal JSON data into one or more of the pointers in the struct.

type HighlightResultOption 

type HighlightResultOption struct {
	// Highlighted attribute value, including HTML tags.
	Value      string     `json:"value"`
	MatchLevel MatchLevel `json:"matchLevel"`
	// List of matched words from the search query.
	MatchedWords []string `json:"matchedWords"`
	// Whether the entire attribute value is highlighted.
	FullyHighlighted *bool `json:"fullyHighlighted,omitempty"`
}

HighlightResultOption Surround words that match the query with HTML tags for highlighting.

func NewEmptyHighlightResultOption 

func NewEmptyHighlightResultOption() *HighlightResultOption

NewEmptyHighlightResultOption return a pointer to an empty HighlightResultOption object.

func NewHighlightResultOption 

func NewHighlightResultOption(
	value string,
	matchLevel MatchLevel,
	matchedWords []string,
	opts ...HighlightResultOptionOption,
) *HighlightResultOption

NewHighlightResultOption instantiates a new HighlightResultOption object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed.

func (*HighlightResultOption) GetFullyHighlighted 

func (o *HighlightResultOption) GetFullyHighlighted() bool

GetFullyHighlighted returns the FullyHighlighted field value if set, zero value otherwise.

func (*HighlightResultOption) GetFullyHighlightedOk 

func (o *HighlightResultOption) GetFullyHighlightedOk() (*bool, bool)

GetFullyHighlightedOk returns a tuple with the FullyHighlighted field value if set, nil otherwise and a boolean to check if the value has been set.

func (*HighlightResultOption) GetMatchLevel 

func (o *HighlightResultOption) GetMatchLevel() MatchLevel

GetMatchLevel returns the MatchLevel field value.

func (*HighlightResultOption) GetMatchLevelOk 

func (o *HighlightResultOption) GetMatchLevelOk() (*MatchLevel, bool)

GetMatchLevelOk returns a tuple with the MatchLevel field value and a boolean to check if the value has been set.

func (*HighlightResultOption) GetMatchedWords 

func (o *HighlightResultOption) GetMatchedWords() []string

GetMatchedWords returns the MatchedWords field value.

func (*HighlightResultOption) GetMatchedWordsOk 

func (o *HighlightResultOption) GetMatchedWordsOk() ([]string, bool)

GetMatchedWordsOk returns a tuple with the MatchedWords field value and a boolean to check if the value has been set.

func (*HighlightResultOption) GetValue 

func (o *HighlightResultOption) GetValue() string

GetValue returns the Value field value.

func (*HighlightResultOption) GetValueOk 

func (o *HighlightResultOption) GetValueOk() (*string, bool)

GetValueOk returns a tuple with the Value field value and a boolean to check if the value has been set.

func (*HighlightResultOption) HasFullyHighlighted 

func (o *HighlightResultOption) HasFullyHighlighted() bool

HasFullyHighlighted returns a boolean if a field has been set.

func (HighlightResultOption) MarshalJSON 

func (o HighlightResultOption) MarshalJSON() ([]byte, error)

func (*HighlightResultOption) SetFullyHighlighted 

func (o *HighlightResultOption) SetFullyHighlighted(v bool) *HighlightResultOption

SetFullyHighlighted gets a reference to the given bool and assigns it to the FullyHighlighted field.

func (*HighlightResultOption) SetMatchLevel 

func (o *HighlightResultOption) SetMatchLevel(v MatchLevel) *HighlightResultOption

SetMatchLevel sets field value.

func (*HighlightResultOption) SetMatchedWords 

func (o *HighlightResultOption) SetMatchedWords(v []string) *HighlightResultOption

SetMatchedWords sets field value.

func (*HighlightResultOption) SetValue 

func (o *HighlightResultOption) SetValue(v string) *HighlightResultOption

SetValue sets field value.

func (HighlightResultOption) String 

func (o HighlightResultOption) String() string

type HighlightResultOptionOption 

type HighlightResultOptionOption func(f *HighlightResultOption)

func WithHighlightResultOptionFullyHighlighted 

func WithHighlightResultOptionFullyHighlighted(val bool) HighlightResultOptionOption

type Hit 

type Hit struct {
	// Unique record identifier.
	ObjectID string `json:"objectID"`
	// Surround words that match the query with HTML tags for highlighting.
	HighlightResult *map[string]HighlightResult `json:"_highlightResult,omitempty"`
	// Snippets that show the context around a matching search query.
	SnippetResult        *map[string]SnippetResult `json:"_snippetResult,omitempty"`
	RankingInfo          *HitRankingInfo           `json:"_rankingInfo,omitempty"`
	DistinctSeqID        *int32                    `json:"_distinctSeqID,omitempty"`
	Extra                *HitMetadata              `json:"_extra,omitempty"`
	AdditionalProperties map[string]any            `json:"-"`
}

Hit Search result. A hit is a record from your index, augmented with special attributes for highlighting, snippeting, and ranking.

func NewEmptyHit 

func NewEmptyHit() *Hit

NewEmptyHit return a pointer to an empty Hit object.

func NewHit 

func NewHit(objectID string, opts ...HitOption) *Hit

NewHit instantiates a new Hit object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed.

func (*Hit) GetDistinctSeqID 

func (o *Hit) GetDistinctSeqID() int32

GetDistinctSeqID returns the DistinctSeqID field value if set, zero value otherwise.

func (*Hit) GetDistinctSeqIDOk 

func (o *Hit) GetDistinctSeqIDOk() (*int32, bool)

GetDistinctSeqIDOk returns a tuple with the DistinctSeqID field value if set, nil otherwise and a boolean to check if the value has been set.

func (*Hit) GetExtra added in v4.24.0 

func (o *Hit) GetExtra() HitMetadata

GetExtra returns the Extra field value if set, zero value otherwise.

func (*Hit) GetExtraOk added in v4.24.0 

func (o *Hit) GetExtraOk() (*HitMetadata, bool)

GetExtraOk returns a tuple with the Extra field value if set, nil otherwise and a boolean to check if the value has been set.

func (*Hit) GetHighlightResult 

func (o *Hit) GetHighlightResult() map[string]HighlightResult

GetHighlightResult returns the HighlightResult field value if set, zero value otherwise.

func (*Hit) GetHighlightResultOk 

func (o *Hit) GetHighlightResultOk() (*map[string]HighlightResult, bool)

GetHighlightResultOk returns a tuple with the HighlightResult field value if set, nil otherwise and a boolean to check if the value has been set.

func (*Hit) GetObjectID 

func (o *Hit) GetObjectID() string

GetObjectID returns the ObjectID field value.

func (*Hit) GetObjectIDOk 

func (o *Hit) GetObjectIDOk() (*string, bool)

GetObjectIDOk returns a tuple with the ObjectID field value and a boolean to check if the value has been set.

func (*Hit) GetRankingInfo 

func (o *Hit) GetRankingInfo() HitRankingInfo

GetRankingInfo returns the RankingInfo field value if set, zero value otherwise.

func (*Hit) GetRankingInfoOk 

func (o *Hit) GetRankingInfoOk() (*HitRankingInfo, bool)

GetRankingInfoOk returns a tuple with the RankingInfo field value if set, nil otherwise and a boolean to check if the value has been set.

func (*Hit) GetSnippetResult 

func (o *Hit) GetSnippetResult() map[string]SnippetResult

GetSnippetResult returns the SnippetResult field value if set, zero value otherwise.

func (*Hit) GetSnippetResultOk 

func (o *Hit) GetSnippetResultOk() (*map[string]SnippetResult, bool)

GetSnippetResultOk returns a tuple with the SnippetResult field value if set, nil otherwise and a boolean to check if the value has been set.

func (*Hit) HasDistinctSeqID 

func (o *Hit) HasDistinctSeqID() bool

HasDistinctSeqID returns a boolean if a field has been set.

func (*Hit) HasExtra added in v4.24.0 

func (o *Hit) HasExtra() bool

HasExtra returns a boolean if a field has been set.

func (*Hit) HasHighlightResult 

func (o *Hit) HasHighlightResult() bool

HasHighlightResult returns a boolean if a field has been set.

func (*Hit) HasRankingInfo 

func (o *Hit) HasRankingInfo() bool

HasRankingInfo returns a boolean if a field has been set.

func (*Hit) HasSnippetResult 

func (o *Hit) HasSnippetResult() bool

HasSnippetResult returns a boolean if a field has been set.

func (Hit) MarshalJSON 

func (o Hit) MarshalJSON() ([]byte, error)

func (*Hit) SetAdditionalProperty 

func (o *Hit) SetAdditionalProperty(key string, value any) *Hit

func (*Hit) SetDistinctSeqID 

func (o *Hit) SetDistinctSeqID(v int32) *Hit

SetDistinctSeqID gets a reference to the given int32 and assigns it to the DistinctSeqID field.

func (*Hit) SetExtra added in v4.24.0 

func (o *Hit) SetExtra(v *HitMetadata) *Hit

SetExtra gets a reference to the given HitMetadata and assigns it to the Extra field.

func (*Hit) SetHighlightResult 

func (o *Hit) SetHighlightResult(v map[string]HighlightResult) *Hit

SetHighlightResult gets a reference to the given map[string]HighlightResult and assigns it to the HighlightResult field.

func (*Hit) SetObjectID 

func (o *Hit) SetObjectID(v string) *Hit

SetObjectID sets field value.

func (*Hit) SetRankingInfo 

func (o *Hit) SetRankingInfo(v *HitRankingInfo) *Hit

SetRankingInfo gets a reference to the given HitRankingInfo and assigns it to the RankingInfo field.

func (*Hit) SetSnippetResult 

func (o *Hit) SetSnippetResult(v map[string]SnippetResult) *Hit

SetSnippetResult gets a reference to the given map[string]SnippetResult and assigns it to the SnippetResult field.

func (Hit) String 

func (o Hit) String() string

func (*Hit) UnmarshalJSON 

func (o *Hit) UnmarshalJSON(bytes []byte) error

type HitMetadata added in v4.24.0 

type HitMetadata struct {
	// The key of the injectedItem that inserted this metadata.
	InjectedItemKey      *string        `json:"_injectedItemKey,omitempty"`
	AdditionalProperties map[string]any `json:"-"`
}

HitMetadata An object that contains the extra key-value pairs provided in the injectedItem definition.

func NewEmptyHitMetadata added in v4.24.0 

func NewEmptyHitMetadata() *HitMetadata

NewEmptyHitMetadata return a pointer to an empty HitMetadata object.

func NewHitMetadata added in v4.24.0 

func NewHitMetadata(opts ...HitMetadataOption) *HitMetadata

NewHitMetadata instantiates a new HitMetadata object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed.

func (*HitMetadata) GetInjectedItemKey added in v4.24.0 

func (o *HitMetadata) GetInjectedItemKey() string

GetInjectedItemKey returns the InjectedItemKey field value if set, zero value otherwise.

func (*HitMetadata) GetInjectedItemKeyOk added in v4.24.0 

func (o *HitMetadata) GetInjectedItemKeyOk() (*string, bool)

GetInjectedItemKeyOk returns a tuple with the InjectedItemKey field value if set, nil otherwise and a boolean to check if the value has been set.

func (*HitMetadata) HasInjectedItemKey added in v4.24.0 

func (o *HitMetadata) HasInjectedItemKey() bool

HasInjectedItemKey returns a boolean if a field has been set.

func (HitMetadata) MarshalJSON added in v4.24.0 

func (o HitMetadata) MarshalJSON() ([]byte, error)

func (*HitMetadata) SetAdditionalProperty added in v4.24.0 

func (o *HitMetadata) SetAdditionalProperty(key string, value any) *HitMetadata

func (*HitMetadata) SetInjectedItemKey added in v4.24.0 

func (o *HitMetadata) SetInjectedItemKey(v string) *HitMetadata

SetInjectedItemKey gets a reference to the given string and assigns it to the InjectedItemKey field.

func (HitMetadata) String added in v4.24.0 

func (o HitMetadata) String() string

func (*HitMetadata) UnmarshalJSON added in v4.24.0 

func (o *HitMetadata) UnmarshalJSON(bytes []byte) error

type HitMetadataOption added in v4.24.0 

type HitMetadataOption func(f *HitMetadata)

func WithHitMetadataInjectedItemKey added in v4.24.0 

func WithHitMetadataInjectedItemKey(val string) HitMetadataOption

type HitOption 

type HitOption func(f *Hit)

func WithHitDistinctSeqID 

func WithHitDistinctSeqID(val int32) HitOption

func WithHitExtra added in v4.24.0 

func WithHitExtra(val HitMetadata) HitOption

func WithHitHighlightResult 

func WithHitHighlightResult(val map[string]HighlightResult) HitOption

func WithHitRankingInfo 

func WithHitRankingInfo(val HitRankingInfo) HitOption

func WithHitSnippetResult 

func WithHitSnippetResult(val map[string]SnippetResult) HitOption

type HitRankingInfo 

type HitRankingInfo struct {
	// Whether a filter matched the query.
	Filters *int32 `json:"filters,omitempty"`
	// Position of the first matched word in the best matching attribute of the record.
	FirstMatchedWord int32 `json:"firstMatchedWord"`
	// Distance between the geo location in the search query and the best matching geo location in the record, divided by the geo precision (in meters).
	GeoDistance int32 `json:"geoDistance"`
	// Precision used when computing the geo distance, in meters.
	GeoPrecision       *int32              `json:"geoPrecision,omitempty"`
	MatchedGeoLocation *MatchedGeoLocation `json:"matchedGeoLocation,omitempty"`
	Personalization    *Personalization    `json:"personalization,omitempty"`
	// Number of exactly matched words.
	NbExactWords int32 `json:"nbExactWords"`
	// Number of typos encountered when matching the record.
	NbTypos int32 `json:"nbTypos"`
	// Whether the record was promoted by a rule.
	Promoted *bool `json:"promoted,omitempty"`
	// Number of words between multiple matches in the query plus 1. For single word queries, `proximityDistance` is 0.
	ProximityDistance *int32 `json:"proximityDistance,omitempty"`
	// Overall ranking of the record, expressed as a single integer. This attribute is internal.
	UserScore int32 `json:"userScore"`
	// Number of matched words.
	Words *int32 `json:"words,omitempty"`
	// Whether the record is re-ranked.
	PromotedByReRanking *bool                                `json:"promotedByReRanking,omitempty"`
	Composed            *map[string]CompositionIdRankingInfo `json:"composed,omitempty"`
}

HitRankingInfo struct for HitRankingInfo.

func NewEmptyHitRankingInfo 

func NewEmptyHitRankingInfo() *HitRankingInfo

NewEmptyHitRankingInfo return a pointer to an empty HitRankingInfo object.

func NewHitRankingInfo 

func NewHitRankingInfo(
	firstMatchedWord int32,
	geoDistance int32,
	nbExactWords int32,
	nbTypos int32,
	userScore int32,
	opts ...HitRankingInfoOption,
) *HitRankingInfo

NewHitRankingInfo instantiates a new HitRankingInfo object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed.

func (*HitRankingInfo) GetComposed 

func (o *HitRankingInfo) GetComposed() map[string]CompositionIdRankingInfo

GetComposed returns the Composed field value if set, zero value otherwise.

func (*HitRankingInfo) GetComposedOk 

func (o *HitRankingInfo) GetComposedOk() (*map[string]CompositionIdRankingInfo, bool)

GetComposedOk returns a tuple with the Composed field value if set, nil otherwise and a boolean to check if the value has been set.

func (*HitRankingInfo) GetFilters 

func (o *HitRankingInfo) GetFilters() int32

GetFilters returns the Filters field value if set, zero value otherwise.

func (*HitRankingInfo) GetFiltersOk 

func (o *HitRankingInfo) GetFiltersOk() (*int32, bool)

GetFiltersOk returns a tuple with the Filters field value if set, nil otherwise and a boolean to check if the value has been set.

func (*HitRankingInfo) GetFirstMatchedWord 

func (o *HitRankingInfo) GetFirstMatchedWord() int32

GetFirstMatchedWord returns the FirstMatchedWord field value.

func (*HitRankingInfo) GetFirstMatchedWordOk 

func (o *HitRankingInfo) GetFirstMatchedWordOk() (*int32, bool)

GetFirstMatchedWordOk returns a tuple with the FirstMatchedWord field value and a boolean to check if the value has been set.

func (*HitRankingInfo) GetGeoDistance 

func (o *HitRankingInfo) GetGeoDistance() int32

GetGeoDistance returns the GeoDistance field value.

func (*HitRankingInfo) GetGeoDistanceOk 

func (o *HitRankingInfo) GetGeoDistanceOk() (*int32, bool)

GetGeoDistanceOk returns a tuple with the GeoDistance field value and a boolean to check if the value has been set.

func (*HitRankingInfo) GetGeoPrecision 

func (o *HitRankingInfo) GetGeoPrecision() int32

GetGeoPrecision returns the GeoPrecision field value if set, zero value otherwise.

func (*HitRankingInfo) GetGeoPrecisionOk 

func (o *HitRankingInfo) GetGeoPrecisionOk() (*int32, bool)

GetGeoPrecisionOk returns a tuple with the GeoPrecision field value if set, nil otherwise and a boolean to check if the value has been set.

func (*HitRankingInfo) GetMatchedGeoLocation 

func (o *HitRankingInfo) GetMatchedGeoLocation() MatchedGeoLocation

GetMatchedGeoLocation returns the MatchedGeoLocation field value if set, zero value otherwise.

func (*HitRankingInfo) GetMatchedGeoLocationOk 

func (o *HitRankingInfo) GetMatchedGeoLocationOk() (*MatchedGeoLocation, bool)

GetMatchedGeoLocationOk returns a tuple with the MatchedGeoLocation field value if set, nil otherwise and a boolean to check if the value has been set.

func (*HitRankingInfo) GetNbExactWords 

func (o *HitRankingInfo) GetNbExactWords() int32

GetNbExactWords returns the NbExactWords field value.

func (*HitRankingInfo) GetNbExactWordsOk 

func (o *HitRankingInfo) GetNbExactWordsOk() (*int32, bool)

GetNbExactWordsOk returns a tuple with the NbExactWords field value and a boolean to check if the value has been set.

func (*HitRankingInfo) GetNbTypos 

func (o *HitRankingInfo) GetNbTypos() int32

GetNbTypos returns the NbTypos field value.

func (*HitRankingInfo) GetNbTyposOk 

func (o *HitRankingInfo) GetNbTyposOk() (*int32, bool)

GetNbTyposOk returns a tuple with the NbTypos field value and a boolean to check if the value has been set.

func (*HitRankingInfo) GetPersonalization 

func (o *HitRankingInfo) GetPersonalization() Personalization

GetPersonalization returns the Personalization field value if set, zero value otherwise.

func (*HitRankingInfo) GetPersonalizationOk 

func (o *HitRankingInfo) GetPersonalizationOk() (*Personalization, bool)

GetPersonalizationOk returns a tuple with the Personalization field value if set, nil otherwise and a boolean to check if the value has been set.

func (*HitRankingInfo) GetPromoted 

func (o *HitRankingInfo) GetPromoted() bool

GetPromoted returns the Promoted field value if set, zero value otherwise.

func (*HitRankingInfo) GetPromotedByReRanking 

func (o *HitRankingInfo) GetPromotedByReRanking() bool

GetPromotedByReRanking returns the PromotedByReRanking field value if set, zero value otherwise.

func (*HitRankingInfo) GetPromotedByReRankingOk 

func (o *HitRankingInfo) GetPromotedByReRankingOk() (*bool, bool)

GetPromotedByReRankingOk returns a tuple with the PromotedByReRanking field value if set, nil otherwise and a boolean to check if the value has been set.

func (*HitRankingInfo) GetPromotedOk 

func (o *HitRankingInfo) GetPromotedOk() (*bool, bool)

GetPromotedOk returns a tuple with the Promoted field value if set, nil otherwise and a boolean to check if the value has been set.

func (*HitRankingInfo) GetProximityDistance 

func (o *HitRankingInfo) GetProximityDistance() int32

GetProximityDistance returns the ProximityDistance field value if set, zero value otherwise.

func (*HitRankingInfo) GetProximityDistanceOk 

func (o *HitRankingInfo) GetProximityDistanceOk() (*int32, bool)

GetProximityDistanceOk returns a tuple with the ProximityDistance field value if set, nil otherwise and a boolean to check if the value has been set.

func (*HitRankingInfo) GetUserScore 

func (o *HitRankingInfo) GetUserScore() int32

GetUserScore returns the UserScore field value.

func (*HitRankingInfo) GetUserScoreOk 

func (o *HitRankingInfo) GetUserScoreOk() (*int32, bool)

GetUserScoreOk returns a tuple with the UserScore field value and a boolean to check if the value has been set.

func (*HitRankingInfo) GetWords 

func (o *HitRankingInfo) GetWords() int32

GetWords returns the Words field value if set, zero value otherwise.

func (*HitRankingInfo) GetWordsOk 

func (o *HitRankingInfo) GetWordsOk() (*int32, bool)

GetWordsOk returns a tuple with the Words field value if set, nil otherwise and a boolean to check if the value has been set.

func (*HitRankingInfo) HasComposed 

func (o *HitRankingInfo) HasComposed() bool

HasComposed returns a boolean if a field has been set.

func (*HitRankingInfo) HasFilters 

func (o *HitRankingInfo) HasFilters() bool

HasFilters returns a boolean if a field has been set.

func (*HitRankingInfo) HasGeoPrecision 

func (o *HitRankingInfo) HasGeoPrecision() bool

HasGeoPrecision returns a boolean if a field has been set.

func (*HitRankingInfo) HasMatchedGeoLocation 

func (o *HitRankingInfo) HasMatchedGeoLocation() bool

HasMatchedGeoLocation returns a boolean if a field has been set.

func (*HitRankingInfo) HasPersonalization 

func (o *HitRankingInfo) HasPersonalization() bool

HasPersonalization returns a boolean if a field has been set.

func (*HitRankingInfo) HasPromoted 

func (o *HitRankingInfo) HasPromoted() bool

HasPromoted returns a boolean if a field has been set.

func (*HitRankingInfo) HasPromotedByReRanking 

func (o *HitRankingInfo) HasPromotedByReRanking() bool

HasPromotedByReRanking returns a boolean if a field has been set.

func (*HitRankingInfo) HasProximityDistance 

func (o *HitRankingInfo) HasProximityDistance() bool

HasProximityDistance returns a boolean if a field has been set.

func (*HitRankingInfo) HasWords 

func (o *HitRankingInfo) HasWords() bool

HasWords returns a boolean if a field has been set.

func (HitRankingInfo) MarshalJSON 

func (o HitRankingInfo) MarshalJSON() ([]byte, error)

func (*HitRankingInfo) SetComposed 

func (o *HitRankingInfo) SetComposed(v map[string]CompositionIdRankingInfo) *HitRankingInfo

SetComposed gets a reference to the given map[string]CompositionIdRankingInfo and assigns it to the Composed field.

func (*HitRankingInfo) SetFilters 

func (o *HitRankingInfo) SetFilters(v int32) *HitRankingInfo

SetFilters gets a reference to the given int32 and assigns it to the Filters field.

func (*HitRankingInfo) SetFirstMatchedWord 

func (o *HitRankingInfo) SetFirstMatchedWord(v int32) *HitRankingInfo

SetFirstMatchedWord sets field value.

func (*HitRankingInfo) SetGeoDistance 

func (o *HitRankingInfo) SetGeoDistance(v int32) *HitRankingInfo

SetGeoDistance sets field value.

func (*HitRankingInfo) SetGeoPrecision 

func (o *HitRankingInfo) SetGeoPrecision(v int32) *HitRankingInfo

SetGeoPrecision gets a reference to the given int32 and assigns it to the GeoPrecision field.

func (*HitRankingInfo) SetMatchedGeoLocation 

func (o *HitRankingInfo) SetMatchedGeoLocation(v *MatchedGeoLocation) *HitRankingInfo

SetMatchedGeoLocation gets a reference to the given MatchedGeoLocation and assigns it to the MatchedGeoLocation field.

func (*HitRankingInfo) SetNbExactWords 

func (o *HitRankingInfo) SetNbExactWords(v int32) *HitRankingInfo

SetNbExactWords sets field value.

func (*HitRankingInfo) SetNbTypos 

func (o *HitRankingInfo) SetNbTypos(v int32) *HitRankingInfo

SetNbTypos sets field value.

func (*HitRankingInfo) SetPersonalization 

func (o *HitRankingInfo) SetPersonalization(v *Personalization) *HitRankingInfo

SetPersonalization gets a reference to the given Personalization and assigns it to the Personalization field.

func (*HitRankingInfo) SetPromoted 

func (o *HitRankingInfo) SetPromoted(v bool) *HitRankingInfo

SetPromoted gets a reference to the given bool and assigns it to the Promoted field.

func (*HitRankingInfo) SetPromotedByReRanking 

func (o *HitRankingInfo) SetPromotedByReRanking(v bool) *HitRankingInfo

SetPromotedByReRanking gets a reference to the given bool and assigns it to the PromotedByReRanking field.

func (*HitRankingInfo) SetProximityDistance 

func (o *HitRankingInfo) SetProximityDistance(v int32) *HitRankingInfo

SetProximityDistance gets a reference to the given int32 and assigns it to the ProximityDistance field.

func (*HitRankingInfo) SetUserScore 

func (o *HitRankingInfo) SetUserScore(v int32) *HitRankingInfo

SetUserScore sets field value.

func (*HitRankingInfo) SetWords 

func (o *HitRankingInfo) SetWords(v int32) *HitRankingInfo

SetWords gets a reference to the given int32 and assigns it to the Words field.

func (HitRankingInfo) String 

func (o HitRankingInfo) String() string

type HitRankingInfoOption 

type HitRankingInfoOption func(f *HitRankingInfo)

func WithHitRankingInfoComposed 

func WithHitRankingInfoComposed(val map[string]CompositionIdRankingInfo) HitRankingInfoOption

func WithHitRankingInfoFilters 

func WithHitRankingInfoFilters(val int32) HitRankingInfoOption

func WithHitRankingInfoGeoPrecision 

func WithHitRankingInfoGeoPrecision(val int32) HitRankingInfoOption

func WithHitRankingInfoMatchedGeoLocation 

func WithHitRankingInfoMatchedGeoLocation(val MatchedGeoLocation) HitRankingInfoOption

func WithHitRankingInfoPersonalization 

func WithHitRankingInfoPersonalization(val Personalization) HitRankingInfoOption

func WithHitRankingInfoPromoted 

func WithHitRankingInfoPromoted(val bool) HitRankingInfoOption

func WithHitRankingInfoPromotedByReRanking 

func WithHitRankingInfoPromotedByReRanking(val bool) HitRankingInfoOption

func WithHitRankingInfoProximityDistance 

func WithHitRankingInfoProximityDistance(val int32) HitRankingInfoOption

func WithHitRankingInfoWords 

func WithHitRankingInfoWords(val int32) HitRankingInfoOption

type IgnorePlurals added in v4.26.0 

type IgnorePlurals struct {
	BooleanString            *BooleanString
	ArrayOfSupportedLanguage *[]SupportedLanguage
	Bool                     *bool
}

IgnorePlurals - Treat singular, plurals, and other forms of declensions as equivalent. Only use this feature for the languages used in your index.

func ArrayOfSupportedLanguageAsIgnorePlurals added in v4.26.0 

func ArrayOfSupportedLanguageAsIgnorePlurals(v []SupportedLanguage) *IgnorePlurals

[]SupportedLanguageAsIgnorePlurals is a convenience function that returns []SupportedLanguage wrapped in IgnorePlurals.

func BoolAsIgnorePlurals added in v4.26.0 

func BoolAsIgnorePlurals(v bool) *IgnorePlurals

boolAsIgnorePlurals is a convenience function that returns bool wrapped in IgnorePlurals.

func BooleanStringAsIgnorePlurals added in v4.26.0 

func BooleanStringAsIgnorePlurals(v BooleanString) *IgnorePlurals

BooleanStringAsIgnorePlurals is a convenience function that returns BooleanString wrapped in IgnorePlurals.

func (IgnorePlurals) GetActualInstance added in v4.26.0 

func (obj IgnorePlurals) GetActualInstance() any

Get the actual instance.

func (IgnorePlurals) MarshalJSON added in v4.26.0 

func (src IgnorePlurals) MarshalJSON() ([]byte, error)

Marshal data from the first non-nil pointers in the struct to JSON.

func (*IgnorePlurals) UnmarshalJSON added in v4.26.0 

func (dst *IgnorePlurals) UnmarshalJSON(data []byte) error

Unmarshal JSON data into one or more of the pointers in the struct.

type IndexSettingsFacets added in v4.29.0 

type IndexSettingsFacets struct {
	// Explicit order of facets or facet values.  This setting lets you always show specific facets or facet values at the top of the list.
	Order []string `json:"order,omitempty"`
}

IndexSettingsFacets Order of facet names.

func NewEmptyIndexSettingsFacets added in v4.29.0 

func NewEmptyIndexSettingsFacets() *IndexSettingsFacets

NewEmptyIndexSettingsFacets return a pointer to an empty IndexSettingsFacets object.

func NewIndexSettingsFacets added in v4.29.0 

func NewIndexSettingsFacets(opts ...IndexSettingsFacetsOption) *IndexSettingsFacets

NewIndexSettingsFacets instantiates a new IndexSettingsFacets object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed.

func (*IndexSettingsFacets) GetOrder added in v4.29.0 

func (o *IndexSettingsFacets) GetOrder() []string

GetOrder returns the Order field value if set, zero value otherwise.

func (*IndexSettingsFacets) GetOrderOk added in v4.29.0 

func (o *IndexSettingsFacets) GetOrderOk() ([]string, bool)

GetOrderOk returns a tuple with the Order field value if set, nil otherwise and a boolean to check if the value has been set.

func (*IndexSettingsFacets) HasOrder added in v4.29.0 

func (o *IndexSettingsFacets) HasOrder() bool

HasOrder returns a boolean if a field has been set.

func (IndexSettingsFacets) MarshalJSON added in v4.29.0 

func (o IndexSettingsFacets) MarshalJSON() ([]byte, error)

func (*IndexSettingsFacets) SetOrder added in v4.29.0 

func (o *IndexSettingsFacets) SetOrder(v []string) *IndexSettingsFacets

SetOrder gets a reference to the given []string and assigns it to the Order field.

func (IndexSettingsFacets) String added in v4.29.0 

func (o IndexSettingsFacets) String() string

type IndexSettingsFacetsOption added in v4.29.0 

type IndexSettingsFacetsOption func(f *IndexSettingsFacets)

func WithIndexSettingsFacetsOrder added in v4.29.0 

func WithIndexSettingsFacetsOrder(val []string) IndexSettingsFacetsOption

type InjectedItemExternal added in v4.38.0 

type InjectedItemExternal struct {
	// Composition Index name.
	Index    string                        `json:"index"`
	Params   *BaseInjectionQueryParameters `json:"params,omitempty"`
	Ordering *ExternalOrdering             `json:"ordering,omitempty"`
}

InjectedItemExternal struct for InjectedItemExternal.

func NewEmptyInjectedItemExternal added in v4.38.0 

func NewEmptyInjectedItemExternal() *InjectedItemExternal

NewEmptyInjectedItemExternal return a pointer to an empty InjectedItemExternal object.

func NewInjectedItemExternal added in v4.38.0 

func NewInjectedItemExternal(index string, opts ...InjectedItemExternalOption) *InjectedItemExternal

NewInjectedItemExternal instantiates a new InjectedItemExternal object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed.

func (*InjectedItemExternal) GetIndex added in v4.38.0 

func (o *InjectedItemExternal) GetIndex() string

GetIndex returns the Index field value.

func (*InjectedItemExternal) GetIndexOk added in v4.38.0 

func (o *InjectedItemExternal) GetIndexOk() (*string, bool)

GetIndexOk returns a tuple with the Index field value and a boolean to check if the value has been set.

func (*InjectedItemExternal) GetOrdering added in v4.38.0 

func (o *InjectedItemExternal) GetOrdering() ExternalOrdering

GetOrdering returns the Ordering field value if set, zero value otherwise.

func (*InjectedItemExternal) GetOrderingOk added in v4.38.0 

func (o *InjectedItemExternal) GetOrderingOk() (*ExternalOrdering, bool)

GetOrderingOk returns a tuple with the Ordering field value if set, nil otherwise and a boolean to check if the value has been set.

func (*InjectedItemExternal) GetParams added in v4.38.0 

func (o *InjectedItemExternal) GetParams() BaseInjectionQueryParameters

GetParams returns the Params field value if set, zero value otherwise.

func (*InjectedItemExternal) GetParamsOk added in v4.38.0 

func (o *InjectedItemExternal) GetParamsOk() (*BaseInjectionQueryParameters, bool)

GetParamsOk returns a tuple with the Params field value if set, nil otherwise and a boolean to check if the value has been set.

func (*InjectedItemExternal) HasOrdering added in v4.38.0 

func (o *InjectedItemExternal) HasOrdering() bool

HasOrdering returns a boolean if a field has been set.

func (*InjectedItemExternal) HasParams added in v4.38.0 

func (o *InjectedItemExternal) HasParams() bool

HasParams returns a boolean if a field has been set.

func (InjectedItemExternal) MarshalJSON added in v4.38.0 

func (o InjectedItemExternal) MarshalJSON() ([]byte, error)

func (*InjectedItemExternal) SetIndex added in v4.38.0 

func (o *InjectedItemExternal) SetIndex(v string) *InjectedItemExternal

SetIndex sets field value.

func (*InjectedItemExternal) SetOrdering added in v4.38.0 

func (o *InjectedItemExternal) SetOrdering(v ExternalOrdering) *InjectedItemExternal

SetOrdering gets a reference to the given ExternalOrdering and assigns it to the Ordering field.

func (*InjectedItemExternal) SetParams added in v4.38.0 

func (o *InjectedItemExternal) SetParams(v *BaseInjectionQueryParameters) *InjectedItemExternal

SetParams gets a reference to the given BaseInjectionQueryParameters and assigns it to the Params field.

func (InjectedItemExternal) String added in v4.38.0 

func (o InjectedItemExternal) String() string

type InjectedItemExternalOption added in v4.38.0 

type InjectedItemExternalOption func(f *InjectedItemExternal)

func WithInjectedItemExternalOrdering added in v4.38.0 

func WithInjectedItemExternalOrdering(val ExternalOrdering) InjectedItemExternalOption

func WithInjectedItemExternalParams added in v4.38.0 

func WithInjectedItemExternalParams(val BaseInjectionQueryParameters) InjectedItemExternalOption

type InjectedItemExternalSource added in v4.38.0 

type InjectedItemExternalSource struct {
	External InjectedItemExternal `json:"external"`
}

InjectedItemExternalSource Injected items will originate from externally provided objectIDs (that must exist in the index) given at runtime in the run request payload.

func NewEmptyInjectedItemExternalSource added in v4.38.0 

func NewEmptyInjectedItemExternalSource() *InjectedItemExternalSource

NewEmptyInjectedItemExternalSource return a pointer to an empty InjectedItemExternalSource object.

func NewInjectedItemExternalSource added in v4.38.0 

func NewInjectedItemExternalSource(external InjectedItemExternal) *InjectedItemExternalSource

NewInjectedItemExternalSource instantiates a new InjectedItemExternalSource object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed.

func (*InjectedItemExternalSource) GetExternal added in v4.38.0 

func (o *InjectedItemExternalSource) GetExternal() InjectedItemExternal

GetExternal returns the External field value.

func (*InjectedItemExternalSource) GetExternalOk added in v4.38.0 

func (o *InjectedItemExternalSource) GetExternalOk() (*InjectedItemExternal, bool)

GetExternalOk returns a tuple with the External field value and a boolean to check if the value has been set.

func (InjectedItemExternalSource) MarshalJSON added in v4.38.0 

func (o InjectedItemExternalSource) MarshalJSON() ([]byte, error)

func (*InjectedItemExternalSource) SetExternal added in v4.38.0 

func (o *InjectedItemExternalSource) SetExternal(v *InjectedItemExternal) *InjectedItemExternalSource

SetExternal sets field value.

func (InjectedItemExternalSource) String added in v4.38.0 

func (o InjectedItemExternalSource) String() string

type InjectedItemHitsMetadata added in v4.26.0 

type InjectedItemHitsMetadata struct {
	// When true, the `_injectedItemKey` field is set in the `_extra` object of each affected hit.
	AddItemKey *bool `json:"addItemKey,omitempty"`
	// The user-defined key-value pairs that will be placed in the `_extra` field of each affected hit.
	Extra map[string]any `json:"extra,omitempty"`
}

InjectedItemHitsMetadata Adds the provided metadata to each injected hit via an `_extra` attribute.

func NewEmptyInjectedItemHitsMetadata added in v4.26.0 

func NewEmptyInjectedItemHitsMetadata() *InjectedItemHitsMetadata

NewEmptyInjectedItemHitsMetadata return a pointer to an empty InjectedItemHitsMetadata object.

func NewInjectedItemHitsMetadata added in v4.26.0 

func NewInjectedItemHitsMetadata(opts ...InjectedItemHitsMetadataOption) *InjectedItemHitsMetadata

NewInjectedItemHitsMetadata instantiates a new InjectedItemHitsMetadata object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed.

func (*InjectedItemHitsMetadata) GetAddItemKey added in v4.26.0 

func (o *InjectedItemHitsMetadata) GetAddItemKey() bool

GetAddItemKey returns the AddItemKey field value if set, zero value otherwise.

func (*InjectedItemHitsMetadata) GetAddItemKeyOk added in v4.26.0 

func (o *InjectedItemHitsMetadata) GetAddItemKeyOk() (*bool, bool)

GetAddItemKeyOk returns a tuple with the AddItemKey field value if set, nil otherwise and a boolean to check if the value has been set.

func (*InjectedItemHitsMetadata) GetExtra added in v4.26.0 

func (o *InjectedItemHitsMetadata) GetExtra() map[string]any

GetExtra returns the Extra field value if set, zero value otherwise.

func (*InjectedItemHitsMetadata) GetExtraOk added in v4.26.0 

func (o *InjectedItemHitsMetadata) GetExtraOk() (map[string]any, bool)

GetExtraOk returns a tuple with the Extra field value if set, nil otherwise and a boolean to check if the value has been set.

func (*InjectedItemHitsMetadata) HasAddItemKey added in v4.26.0 

func (o *InjectedItemHitsMetadata) HasAddItemKey() bool

HasAddItemKey returns a boolean if a field has been set.

func (*InjectedItemHitsMetadata) HasExtra added in v4.26.0 

func (o *InjectedItemHitsMetadata) HasExtra() bool

HasExtra returns a boolean if a field has been set.

func (InjectedItemHitsMetadata) MarshalJSON added in v4.26.0 

func (o InjectedItemHitsMetadata) MarshalJSON() ([]byte, error)

func (*InjectedItemHitsMetadata) SetAddItemKey added in v4.26.0 

func (o *InjectedItemHitsMetadata) SetAddItemKey(v bool) *InjectedItemHitsMetadata

SetAddItemKey gets a reference to the given bool and assigns it to the AddItemKey field.

func (*InjectedItemHitsMetadata) SetExtra added in v4.26.0 

func (o *InjectedItemHitsMetadata) SetExtra(v map[string]any) *InjectedItemHitsMetadata

SetExtra gets a reference to the given map[string]any and assigns it to the Extra field.

func (InjectedItemHitsMetadata) String added in v4.26.0 

func (o InjectedItemHitsMetadata) String() string

type InjectedItemHitsMetadataOption added in v4.26.0 

type InjectedItemHitsMetadataOption func(f *InjectedItemHitsMetadata)

func WithInjectedItemHitsMetadataAddItemKey added in v4.26.0 

func WithInjectedItemHitsMetadataAddItemKey(val bool) InjectedItemHitsMetadataOption

func WithInjectedItemHitsMetadataExtra added in v4.26.0 

func WithInjectedItemHitsMetadataExtra(val map[string]any) InjectedItemHitsMetadataOption

type InjectedItemMetadata added in v4.26.0 

type InjectedItemMetadata struct {
	Hits *InjectedItemHitsMetadata `json:"hits,omitempty"`
}

InjectedItemMetadata Used to add metadata to the results of the injectedItem.

func NewEmptyInjectedItemMetadata added in v4.26.0 

func NewEmptyInjectedItemMetadata() *InjectedItemMetadata

NewEmptyInjectedItemMetadata return a pointer to an empty InjectedItemMetadata object.

func NewInjectedItemMetadata added in v4.26.0 

func NewInjectedItemMetadata(opts ...InjectedItemMetadataOption) *InjectedItemMetadata

NewInjectedItemMetadata instantiates a new InjectedItemMetadata object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed.

func (*InjectedItemMetadata) GetHits added in v4.26.0 

func (o *InjectedItemMetadata) GetHits() InjectedItemHitsMetadata

GetHits returns the Hits field value if set, zero value otherwise.

func (*InjectedItemMetadata) GetHitsOk added in v4.26.0 

func (o *InjectedItemMetadata) GetHitsOk() (*InjectedItemHitsMetadata, bool)

GetHitsOk returns a tuple with the Hits field value if set, nil otherwise and a boolean to check if the value has been set.

func (*InjectedItemMetadata) HasHits added in v4.26.0 

func (o *InjectedItemMetadata) HasHits() bool

HasHits returns a boolean if a field has been set.

func (InjectedItemMetadata) MarshalJSON added in v4.26.0 

func (o InjectedItemMetadata) MarshalJSON() ([]byte, error)

func (*InjectedItemMetadata) SetHits added in v4.26.0 

func (o *InjectedItemMetadata) SetHits(v *InjectedItemHitsMetadata) *InjectedItemMetadata

SetHits gets a reference to the given InjectedItemHitsMetadata and assigns it to the Hits field.

func (InjectedItemMetadata) String added in v4.26.0 

func (o InjectedItemMetadata) String() string

type InjectedItemMetadataOption added in v4.26.0 

type InjectedItemMetadataOption func(f *InjectedItemMetadata)

func WithInjectedItemMetadataHits added in v4.26.0 

func WithInjectedItemMetadataHits(val InjectedItemHitsMetadata) InjectedItemMetadataOption

type InjectedItemRecommendSource added in v4.38.0 

type InjectedItemRecommendSource struct {
	Recommend Recommend `json:"recommend"`
}

InjectedItemRecommendSource Injected items will originate from a recommendation request performed on the specified index.

func NewEmptyInjectedItemRecommendSource added in v4.38.0 

func NewEmptyInjectedItemRecommendSource() *InjectedItemRecommendSource

NewEmptyInjectedItemRecommendSource return a pointer to an empty InjectedItemRecommendSource object.

func NewInjectedItemRecommendSource added in v4.38.0 

func NewInjectedItemRecommendSource(recommend Recommend) *InjectedItemRecommendSource

NewInjectedItemRecommendSource instantiates a new InjectedItemRecommendSource object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed.

func (*InjectedItemRecommendSource) GetRecommend added in v4.38.0 

func (o *InjectedItemRecommendSource) GetRecommend() Recommend

GetRecommend returns the Recommend field value.

func (*InjectedItemRecommendSource) GetRecommendOk added in v4.38.0 

func (o *InjectedItemRecommendSource) GetRecommendOk() (*Recommend, bool)

GetRecommendOk returns a tuple with the Recommend field value and a boolean to check if the value has been set.

func (InjectedItemRecommendSource) MarshalJSON added in v4.38.0 

func (o InjectedItemRecommendSource) MarshalJSON() ([]byte, error)

func (*InjectedItemRecommendSource) SetRecommend added in v4.38.0 

func (o *InjectedItemRecommendSource) SetRecommend(v *Recommend) *InjectedItemRecommendSource

SetRecommend sets field value.

func (InjectedItemRecommendSource) String added in v4.38.0 

func (o InjectedItemRecommendSource) String() string

type InjectedItemSearch added in v4.38.0 

type InjectedItemSearch struct {
	// Composition Index name.
	Index  string                        `json:"index"`
	Params *BaseInjectionQueryParameters `json:"params,omitempty"`
}

InjectedItemSearch struct for InjectedItemSearch.

func NewEmptyInjectedItemSearch added in v4.38.0 

func NewEmptyInjectedItemSearch() *InjectedItemSearch

NewEmptyInjectedItemSearch return a pointer to an empty InjectedItemSearch object.

func NewInjectedItemSearch added in v4.38.0 

func NewInjectedItemSearch(index string, opts ...InjectedItemSearchOption) *InjectedItemSearch

NewInjectedItemSearch instantiates a new InjectedItemSearch object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed.

func (*InjectedItemSearch) GetIndex added in v4.38.0 

func (o *InjectedItemSearch) GetIndex() string

GetIndex returns the Index field value.

func (*InjectedItemSearch) GetIndexOk added in v4.38.0 

func (o *InjectedItemSearch) GetIndexOk() (*string, bool)

GetIndexOk returns a tuple with the Index field value and a boolean to check if the value has been set.

func (*InjectedItemSearch) GetParams added in v4.38.0 

func (o *InjectedItemSearch) GetParams() BaseInjectionQueryParameters

GetParams returns the Params field value if set, zero value otherwise.

func (*InjectedItemSearch) GetParamsOk added in v4.38.0 

func (o *InjectedItemSearch) GetParamsOk() (*BaseInjectionQueryParameters, bool)

GetParamsOk returns a tuple with the Params field value if set, nil otherwise and a boolean to check if the value has been set.

func (*InjectedItemSearch) HasParams added in v4.38.0 

func (o *InjectedItemSearch) HasParams() bool

HasParams returns a boolean if a field has been set.

func (InjectedItemSearch) MarshalJSON added in v4.38.0 

func (o InjectedItemSearch) MarshalJSON() ([]byte, error)

func (*InjectedItemSearch) SetIndex added in v4.38.0 

func (o *InjectedItemSearch) SetIndex(v string) *InjectedItemSearch

SetIndex sets field value.

func (*InjectedItemSearch) SetParams added in v4.38.0 

func (o *InjectedItemSearch) SetParams(v *BaseInjectionQueryParameters) *InjectedItemSearch

SetParams gets a reference to the given BaseInjectionQueryParameters and assigns it to the Params field.

func (InjectedItemSearch) String added in v4.38.0 

func (o InjectedItemSearch) String() string

type InjectedItemSearchOption added in v4.38.0 

type InjectedItemSearchOption func(f *InjectedItemSearch)

func WithInjectedItemSearchParams added in v4.38.0 

func WithInjectedItemSearchParams(val BaseInjectionQueryParameters) InjectedItemSearchOption

type InjectedItemSearchSource added in v4.38.0 

type InjectedItemSearchSource struct {
	Search InjectedItemSearch `json:"search"`
}

InjectedItemSearchSource Injected items will originate from a search request performed on the specified index.

func NewEmptyInjectedItemSearchSource added in v4.38.0 

func NewEmptyInjectedItemSearchSource() *InjectedItemSearchSource

NewEmptyInjectedItemSearchSource return a pointer to an empty InjectedItemSearchSource object.

func NewInjectedItemSearchSource added in v4.38.0 

func NewInjectedItemSearchSource(search InjectedItemSearch) *InjectedItemSearchSource

NewInjectedItemSearchSource instantiates a new InjectedItemSearchSource object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed.

func (*InjectedItemSearchSource) GetSearch added in v4.38.0 

func (o *InjectedItemSearchSource) GetSearch() InjectedItemSearch

GetSearch returns the Search field value.

func (*InjectedItemSearchSource) GetSearchOk added in v4.38.0 

func (o *InjectedItemSearchSource) GetSearchOk() (*InjectedItemSearch, bool)

GetSearchOk returns a tuple with the Search field value and a boolean to check if the value has been set.

func (InjectedItemSearchSource) MarshalJSON added in v4.38.0 

func (o InjectedItemSearchSource) MarshalJSON() ([]byte, error)

func (*InjectedItemSearchSource) SetSearch added in v4.38.0 

func (o *InjectedItemSearchSource) SetSearch(v *InjectedItemSearch) *InjectedItemSearchSource

SetSearch sets field value.

func (InjectedItemSearchSource) String added in v4.38.0 

func (o InjectedItemSearchSource) String() string

type InjectedItemSource added in v4.26.0 

type InjectedItemSource struct {
	InjectedItemExternalSource  *InjectedItemExternalSource
	InjectedItemRecommendSource *InjectedItemRecommendSource
	InjectedItemSearchSource    *InjectedItemSearchSource
}

InjectedItemSource - struct for InjectedItemSource.

func InjectedItemExternalSourceAsInjectedItemSource added in v4.38.0 

func InjectedItemExternalSourceAsInjectedItemSource(v *InjectedItemExternalSource) *InjectedItemSource

InjectedItemExternalSourceAsInjectedItemSource is a convenience function that returns InjectedItemExternalSource wrapped in InjectedItemSource.

func InjectedItemRecommendSourceAsInjectedItemSource added in v4.38.0 

func InjectedItemRecommendSourceAsInjectedItemSource(v *InjectedItemRecommendSource) *InjectedItemSource

InjectedItemRecommendSourceAsInjectedItemSource is a convenience function that returns InjectedItemRecommendSource wrapped in InjectedItemSource.

func InjectedItemSearchSourceAsInjectedItemSource added in v4.38.0 

func InjectedItemSearchSourceAsInjectedItemSource(v *InjectedItemSearchSource) *InjectedItemSource

InjectedItemSearchSourceAsInjectedItemSource is a convenience function that returns InjectedItemSearchSource wrapped in InjectedItemSource.

func (InjectedItemSource) GetActualInstance added in v4.26.0 

func (obj InjectedItemSource) GetActualInstance() any

Get the actual instance.

func (InjectedItemSource) MarshalJSON added in v4.26.0 

func (src InjectedItemSource) MarshalJSON() ([]byte, error)

Marshal data from the first non-nil pointers in the struct to JSON.

func (*InjectedItemSource) UnmarshalJSON added in v4.26.0 

func (dst *InjectedItemSource) UnmarshalJSON(data []byte) error

Unmarshal JSON data into one or more of the pointers in the struct.

type Injection added in v4.26.0 

type Injection struct {
	Main InjectionMain `json:"main"`
	// list of injected items of the current Composition.
	InjectedItems []InjectionInjectedItem `json:"injectedItems,omitempty"`
	Deduplication *Deduplication          `json:"deduplication,omitempty"`
}

Injection struct for Injection.

func NewEmptyInjection added in v4.26.0 

func NewEmptyInjection() *Injection

NewEmptyInjection return a pointer to an empty Injection object.

func NewInjection added in v4.26.0 

func NewInjection(main InjectionMain, opts ...InjectionOption) *Injection

NewInjection instantiates a new Injection object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed.

func (*Injection) GetDeduplication added in v4.28.0 

func (o *Injection) GetDeduplication() Deduplication

GetDeduplication returns the Deduplication field value if set, zero value otherwise.

func (*Injection) GetDeduplicationOk added in v4.28.0 

func (o *Injection) GetDeduplicationOk() (*Deduplication, bool)

GetDeduplicationOk returns a tuple with the Deduplication field value if set, nil otherwise and a boolean to check if the value has been set.

func (*Injection) GetInjectedItems added in v4.26.0 

func (o *Injection) GetInjectedItems() []InjectionInjectedItem

GetInjectedItems returns the InjectedItems field value if set, zero value otherwise.

func (*Injection) GetInjectedItemsOk added in v4.26.0 

func (o *Injection) GetInjectedItemsOk() ([]InjectionInjectedItem, bool)

GetInjectedItemsOk returns a tuple with the InjectedItems field value if set, nil otherwise and a boolean to check if the value has been set.

func (*Injection) GetMain added in v4.26.0 

func (o *Injection) GetMain() InjectionMain

GetMain returns the Main field value.

func (*Injection) GetMainOk added in v4.26.0 

func (o *Injection) GetMainOk() (*InjectionMain, bool)

GetMainOk returns a tuple with the Main field value and a boolean to check if the value has been set.

func (*Injection) HasDeduplication added in v4.28.0 

func (o *Injection) HasDeduplication() bool

HasDeduplication returns a boolean if a field has been set.

func (*Injection) HasInjectedItems added in v4.26.0 

func (o *Injection) HasInjectedItems() bool

HasInjectedItems returns a boolean if a field has been set.

func (Injection) MarshalJSON added in v4.26.0 

func (o Injection) MarshalJSON() ([]byte, error)

func (*Injection) SetDeduplication added in v4.28.0 

func (o *Injection) SetDeduplication(v *Deduplication) *Injection

SetDeduplication gets a reference to the given Deduplication and assigns it to the Deduplication field.

func (*Injection) SetInjectedItems added in v4.26.0 

func (o *Injection) SetInjectedItems(v []InjectionInjectedItem) *Injection

SetInjectedItems gets a reference to the given []InjectionInjectedItem and assigns it to the InjectedItems field.

func (*Injection) SetMain added in v4.26.0 

func (o *Injection) SetMain(v *InjectionMain) *Injection

SetMain sets field value.

func (Injection) String added in v4.26.0 

func (o Injection) String() string

type InjectionInjectedItem added in v4.38.0 

type InjectionInjectedItem struct {
	// injected Item unique identifier.
	Key      string                `json:"key"`
	Source   InjectedItemSource    `json:"source"`
	Position int32                 `json:"position"`
	Length   int32                 `json:"length"`
	Metadata *InjectedItemMetadata `json:"metadata,omitempty"`
}

InjectionInjectedItem struct for InjectionInjectedItem.

func NewEmptyInjectionInjectedItem added in v4.38.0 

func NewEmptyInjectionInjectedItem() *InjectionInjectedItem

NewEmptyInjectionInjectedItem return a pointer to an empty InjectionInjectedItem object.

func NewInjectionInjectedItem added in v4.38.0 

func NewInjectionInjectedItem(
	key string,
	source InjectedItemSource,
	position int32,
	length int32,
	opts ...InjectionInjectedItemOption,
) *InjectionInjectedItem

NewInjectionInjectedItem instantiates a new InjectionInjectedItem object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed.

func (*InjectionInjectedItem) GetKey added in v4.38.0 

func (o *InjectionInjectedItem) GetKey() string

GetKey returns the Key field value.

func (*InjectionInjectedItem) GetKeyOk added in v4.38.0 

func (o *InjectionInjectedItem) GetKeyOk() (*string, bool)

GetKeyOk returns a tuple with the Key field value and a boolean to check if the value has been set.

func (*InjectionInjectedItem) GetLength added in v4.38.0 

func (o *InjectionInjectedItem) GetLength() int32

GetLength returns the Length field value.

func (*InjectionInjectedItem) GetLengthOk added in v4.38.0 

func (o *InjectionInjectedItem) GetLengthOk() (*int32, bool)

GetLengthOk returns a tuple with the Length field value and a boolean to check if the value has been set.

func (*InjectionInjectedItem) GetMetadata added in v4.38.0 

func (o *InjectionInjectedItem) GetMetadata() InjectedItemMetadata

GetMetadata returns the Metadata field value if set, zero value otherwise.

func (*InjectionInjectedItem) GetMetadataOk added in v4.38.0 

func (o *InjectionInjectedItem) GetMetadataOk() (*InjectedItemMetadata, bool)

GetMetadataOk returns a tuple with the Metadata field value if set, nil otherwise and a boolean to check if the value has been set.

func (*InjectionInjectedItem) GetPosition added in v4.38.0 

func (o *InjectionInjectedItem) GetPosition() int32

GetPosition returns the Position field value.

func (*InjectionInjectedItem) GetPositionOk added in v4.38.0 

func (o *InjectionInjectedItem) GetPositionOk() (*int32, bool)

GetPositionOk returns a tuple with the Position field value and a boolean to check if the value has been set.

func (*InjectionInjectedItem) GetSource added in v4.38.0 

func (o *InjectionInjectedItem) GetSource() InjectedItemSource

GetSource returns the Source field value.

func (*InjectionInjectedItem) GetSourceOk added in v4.38.0 

func (o *InjectionInjectedItem) GetSourceOk() (*InjectedItemSource, bool)

GetSourceOk returns a tuple with the Source field value and a boolean to check if the value has been set.

func (*InjectionInjectedItem) HasMetadata added in v4.38.0 

func (o *InjectionInjectedItem) HasMetadata() bool

HasMetadata returns a boolean if a field has been set.

func (InjectionInjectedItem) MarshalJSON added in v4.38.0 

func (o InjectionInjectedItem) MarshalJSON() ([]byte, error)

func (*InjectionInjectedItem) SetKey added in v4.38.0 

func (o *InjectionInjectedItem) SetKey(v string) *InjectionInjectedItem

SetKey sets field value.

func (*InjectionInjectedItem) SetLength added in v4.38.0 

func (o *InjectionInjectedItem) SetLength(v int32) *InjectionInjectedItem

SetLength sets field value.

func (*InjectionInjectedItem) SetMetadata added in v4.38.0 

func (o *InjectionInjectedItem) SetMetadata(v *InjectedItemMetadata) *InjectionInjectedItem

SetMetadata gets a reference to the given InjectedItemMetadata and assigns it to the Metadata field.

func (*InjectionInjectedItem) SetPosition added in v4.38.0 

func (o *InjectionInjectedItem) SetPosition(v int32) *InjectionInjectedItem

SetPosition sets field value.

func (*InjectionInjectedItem) SetSource added in v4.38.0 

func (o *InjectionInjectedItem) SetSource(v *InjectedItemSource) *InjectionInjectedItem

SetSource sets field value.

func (InjectionInjectedItem) String added in v4.38.0 

func (o InjectionInjectedItem) String() string

type InjectionInjectedItemOption added in v4.38.0 

type InjectionInjectedItemOption func(f *InjectionInjectedItem)

func WithInjectionInjectedItemMetadata added in v4.38.0 

func WithInjectionInjectedItemMetadata(val InjectedItemMetadata) InjectionInjectedItemOption

type InjectionMain added in v4.38.0 

type InjectionMain struct {
	Source *InjectionMainSource `json:"source,omitempty"`
}

InjectionMain Main defines the organic result set of the injection.

func NewEmptyInjectionMain added in v4.38.0 

func NewEmptyInjectionMain() *InjectionMain

NewEmptyInjectionMain return a pointer to an empty InjectionMain object.

func NewInjectionMain added in v4.38.0 

func NewInjectionMain(opts ...InjectionMainOption) *InjectionMain

NewInjectionMain instantiates a new InjectionMain object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed.

func (*InjectionMain) GetSource added in v4.38.0 

func (o *InjectionMain) GetSource() InjectionMainSource

GetSource returns the Source field value if set, zero value otherwise.

func (*InjectionMain) GetSourceOk added in v4.38.0 

func (o *InjectionMain) GetSourceOk() (*InjectionMainSource, bool)

GetSourceOk returns a tuple with the Source field value if set, nil otherwise and a boolean to check if the value has been set.

func (*InjectionMain) HasSource added in v4.38.0 

func (o *InjectionMain) HasSource() bool

HasSource returns a boolean if a field has been set.

func (InjectionMain) MarshalJSON added in v4.38.0 

func (o InjectionMain) MarshalJSON() ([]byte, error)

func (*InjectionMain) SetSource added in v4.38.0 

func (o *InjectionMain) SetSource(v *InjectionMainSource) *InjectionMain

SetSource gets a reference to the given InjectionMainSource and assigns it to the Source field.

func (InjectionMain) String added in v4.38.0 

func (o InjectionMain) String() string

type InjectionMainOption added in v4.38.0 

type InjectionMainOption func(f *InjectionMain)

func WithInjectionMainSource added in v4.38.0 

func WithInjectionMainSource(val InjectionMainSource) InjectionMainOption

type InjectionMainRecommendSource added in v4.38.0 

type InjectionMainRecommendSource struct {
	Recommend MainRecommend `json:"recommend"`
}

InjectionMainRecommendSource Organic result set will originate from a recommend request.

func NewEmptyInjectionMainRecommendSource added in v4.38.0 

func NewEmptyInjectionMainRecommendSource() *InjectionMainRecommendSource

NewEmptyInjectionMainRecommendSource return a pointer to an empty InjectionMainRecommendSource object.

func NewInjectionMainRecommendSource added in v4.38.0 

func NewInjectionMainRecommendSource(recommend MainRecommend) *InjectionMainRecommendSource

NewInjectionMainRecommendSource instantiates a new InjectionMainRecommendSource object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed.

func (*InjectionMainRecommendSource) GetRecommend added in v4.38.0 

func (o *InjectionMainRecommendSource) GetRecommend() MainRecommend

GetRecommend returns the Recommend field value.

func (*InjectionMainRecommendSource) GetRecommendOk added in v4.38.0 

func (o *InjectionMainRecommendSource) GetRecommendOk() (*MainRecommend, bool)

GetRecommendOk returns a tuple with the Recommend field value and a boolean to check if the value has been set.

func (InjectionMainRecommendSource) MarshalJSON added in v4.38.0 

func (o InjectionMainRecommendSource) MarshalJSON() ([]byte, error)

func (*InjectionMainRecommendSource) SetRecommend added in v4.38.0 

func (o *InjectionMainRecommendSource) SetRecommend(v *MainRecommend) *InjectionMainRecommendSource

SetRecommend sets field value.

func (InjectionMainRecommendSource) String added in v4.38.0 

func (o InjectionMainRecommendSource) String() string

type InjectionMainSearchSource added in v4.38.0 

type InjectionMainSearchSource struct {
	Search MainSearch `json:"search"`
}

InjectionMainSearchSource Organic result set will originate from a search request performed on the specified index.

func NewEmptyInjectionMainSearchSource added in v4.38.0 

func NewEmptyInjectionMainSearchSource() *InjectionMainSearchSource

NewEmptyInjectionMainSearchSource return a pointer to an empty InjectionMainSearchSource object.

func NewInjectionMainSearchSource added in v4.38.0 

func NewInjectionMainSearchSource(search MainSearch) *InjectionMainSearchSource

NewInjectionMainSearchSource instantiates a new InjectionMainSearchSource object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed.

func (*InjectionMainSearchSource) GetSearch added in v4.38.0 

func (o *InjectionMainSearchSource) GetSearch() MainSearch

GetSearch returns the Search field value.

func (*InjectionMainSearchSource) GetSearchOk added in v4.38.0 

func (o *InjectionMainSearchSource) GetSearchOk() (*MainSearch, bool)

GetSearchOk returns a tuple with the Search field value and a boolean to check if the value has been set.

func (InjectionMainSearchSource) MarshalJSON added in v4.38.0 

func (o InjectionMainSearchSource) MarshalJSON() ([]byte, error)

func (*InjectionMainSearchSource) SetSearch added in v4.38.0 

func (o *InjectionMainSearchSource) SetSearch(v *MainSearch) *InjectionMainSearchSource

SetSearch sets field value.

func (InjectionMainSearchSource) String added in v4.38.0 

func (o InjectionMainSearchSource) String() string

type InjectionMainSource added in v4.38.0 

type InjectionMainSource struct {
	InjectionMainRecommendSource *InjectionMainRecommendSource
	InjectionMainSearchSource    *InjectionMainSearchSource
}

InjectionMainSource - Source to be used to retrieve organic result set.

func InjectionMainRecommendSourceAsInjectionMainSource added in v4.38.0 

func InjectionMainRecommendSourceAsInjectionMainSource(v *InjectionMainRecommendSource) *InjectionMainSource

InjectionMainRecommendSourceAsInjectionMainSource is a convenience function that returns InjectionMainRecommendSource wrapped in InjectionMainSource.

func InjectionMainSearchSourceAsInjectionMainSource added in v4.38.0 

func InjectionMainSearchSourceAsInjectionMainSource(v *InjectionMainSearchSource) *InjectionMainSource

InjectionMainSearchSourceAsInjectionMainSource is a convenience function that returns InjectionMainSearchSource wrapped in InjectionMainSource.

func (InjectionMainSource) GetActualInstance added in v4.38.0 

func (obj InjectionMainSource) GetActualInstance() any

Get the actual instance.

func (InjectionMainSource) MarshalJSON added in v4.38.0 

func (src InjectionMainSource) MarshalJSON() ([]byte, error)

Marshal data from the first non-nil pointers in the struct to JSON.

func (*InjectionMainSource) UnmarshalJSON added in v4.38.0 

func (dst *InjectionMainSource) UnmarshalJSON(data []byte) error

Unmarshal JSON data into one or more of the pointers in the struct.

type InjectionOption added in v4.26.0 

type InjectionOption func(f *Injection)

func WithInjectionDeduplication added in v4.28.0 

func WithInjectionDeduplication(val Deduplication) InjectionOption

func WithInjectionInjectedItems added in v4.26.0 

func WithInjectionInjectedItems(val []InjectionInjectedItem) InjectionOption

type InsideBoundingBox 

type InsideBoundingBox struct {
	ArrayOfArrayOfFloat64 *[][]float64
	String                *string
}

InsideBoundingBox - struct for InsideBoundingBox.

func ArrayOfArrayOfFloat64AsInsideBoundingBox 

func ArrayOfArrayOfFloat64AsInsideBoundingBox(v [][]float64) *InsideBoundingBox

[][]float64AsInsideBoundingBox is a convenience function that returns [][]float64 wrapped in InsideBoundingBox.

func StringAsInsideBoundingBox 

func StringAsInsideBoundingBox(v string) *InsideBoundingBox

stringAsInsideBoundingBox is a convenience function that returns string wrapped in InsideBoundingBox.

func (InsideBoundingBox) GetActualInstance 

func (obj InsideBoundingBox) GetActualInstance() any

Get the actual instance.

func (InsideBoundingBox) MarshalJSON 

func (src InsideBoundingBox) MarshalJSON() ([]byte, error)

Marshal data from the first non-nil pointers in the struct to JSON.

func (*InsideBoundingBox) UnmarshalJSON 

func (dst *InsideBoundingBox) UnmarshalJSON(data []byte) error

Unmarshal JSON data into one or more of the pointers in the struct.

type ListCompositionsResponse added in v4.26.0 

type ListCompositionsResponse struct {
	// All compositions in your Algolia application.
	Items []Composition `json:"items"`
	// Number of pages.
	NbPages int32 `json:"nbPages"`
	// Current page.
	Page int32 `json:"page"`
	// Number of items per page.
	HitsPerPage int32 `json:"hitsPerPage"`
	// Number of items.
	NbHits int32 `json:"nbHits"`
}

ListCompositionsResponse struct for ListCompositionsResponse.

func NewEmptyListCompositionsResponse added in v4.26.0 

func NewEmptyListCompositionsResponse() *ListCompositionsResponse

NewEmptyListCompositionsResponse return a pointer to an empty ListCompositionsResponse object.

func NewListCompositionsResponse added in v4.26.0 

func NewListCompositionsResponse(items []Composition, nbPages int32, page int32, hitsPerPage int32, nbHits int32) *ListCompositionsResponse

NewListCompositionsResponse instantiates a new ListCompositionsResponse object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed.

func (*ListCompositionsResponse) GetHitsPerPage added in v4.26.0 

func (o *ListCompositionsResponse) GetHitsPerPage() int32

GetHitsPerPage returns the HitsPerPage field value.

func (*ListCompositionsResponse) GetHitsPerPageOk added in v4.26.0 

func (o *ListCompositionsResponse) GetHitsPerPageOk() (*int32, bool)

GetHitsPerPageOk returns a tuple with the HitsPerPage field value and a boolean to check if the value has been set.

func (*ListCompositionsResponse) GetItems added in v4.26.0 

func (o *ListCompositionsResponse) GetItems() []Composition

GetItems returns the Items field value.

func (*ListCompositionsResponse) GetItemsOk added in v4.26.0 

func (o *ListCompositionsResponse) GetItemsOk() ([]Composition, bool)

GetItemsOk returns a tuple with the Items field value and a boolean to check if the value has been set.

func (*ListCompositionsResponse) GetNbHits added in v4.26.0 

func (o *ListCompositionsResponse) GetNbHits() int32

GetNbHits returns the NbHits field value.

func (*ListCompositionsResponse) GetNbHitsOk added in v4.26.0 

func (o *ListCompositionsResponse) GetNbHitsOk() (*int32, bool)

GetNbHitsOk returns a tuple with the NbHits field value and a boolean to check if the value has been set.

func (*ListCompositionsResponse) GetNbPages added in v4.26.0 

func (o *ListCompositionsResponse) GetNbPages() int32

GetNbPages returns the NbPages field value.

func (*ListCompositionsResponse) GetNbPagesOk added in v4.26.0 

func (o *ListCompositionsResponse) GetNbPagesOk() (*int32, bool)

GetNbPagesOk returns a tuple with the NbPages field value and a boolean to check if the value has been set.

func (*ListCompositionsResponse) GetPage added in v4.26.0 

func (o *ListCompositionsResponse) GetPage() int32

GetPage returns the Page field value.

func (*ListCompositionsResponse) GetPageOk added in v4.26.0 

func (o *ListCompositionsResponse) GetPageOk() (*int32, bool)

GetPageOk returns a tuple with the Page field value and a boolean to check if the value has been set.

func (ListCompositionsResponse) MarshalJSON added in v4.26.0 

func (o ListCompositionsResponse) MarshalJSON() ([]byte, error)

func (*ListCompositionsResponse) SetHitsPerPage added in v4.26.0 

func (o *ListCompositionsResponse) SetHitsPerPage(v int32) *ListCompositionsResponse

SetHitsPerPage sets field value.

func (*ListCompositionsResponse) SetItems added in v4.26.0 

func (o *ListCompositionsResponse) SetItems(v []Composition) *ListCompositionsResponse

SetItems sets field value.

func (*ListCompositionsResponse) SetNbHits added in v4.26.0 

func (o *ListCompositionsResponse) SetNbHits(v int32) *ListCompositionsResponse

SetNbHits sets field value.

func (*ListCompositionsResponse) SetNbPages added in v4.26.0 

func (o *ListCompositionsResponse) SetNbPages(v int32) *ListCompositionsResponse

SetNbPages sets field value.

func (*ListCompositionsResponse) SetPage added in v4.26.0 

func (o *ListCompositionsResponse) SetPage(v int32) *ListCompositionsResponse

SetPage sets field value.

func (ListCompositionsResponse) String added in v4.26.0 

func (o ListCompositionsResponse) String() string

type MainInjectionQueryParameters added in v4.26.0 

type MainInjectionQueryParameters struct {
	// Whether to support phrase matching and excluding words from search queries Use the `advancedSyntaxFeatures` parameter to control which feature is supported.
	AdvancedSyntax *bool `json:"advancedSyntax,omitempty"`
	// Advanced search syntax features you want to support - `exactPhrase`.   Phrases in quotes must match exactly.   For example, `sparkly blue \"iPhone case\"` only returns records with the exact string \"iPhone case\" - `excludeWords`.   Query words prefixed with a `-` must not occur in a record.   For example, `search -engine` matches records that contain \"search\" but not \"engine\" This setting only has an effect if `advancedSyntax` is true.
	AdvancedSyntaxFeatures []AdvancedSyntaxFeatures `json:"advancedSyntaxFeatures,omitempty"`
	// Whether to allow typos on numbers in the search query Turn off this setting to reduce the number of irrelevant matches when searching in large sets of similar numbers.
	AllowTyposOnNumericTokens *bool `json:"allowTyposOnNumericTokens,omitempty"`
	// Determine which plurals and synonyms should be considered an exact matches By default, Algolia treats singular and plural forms of a word, and single-word synonyms, as [exact](https://www.algolia.com/doc/guides/managing-results/relevance-overview/in-depth/ranking-criteria/#exact) matches when searching. For example - \"swimsuit\" and \"swimsuits\" are treated the same - \"swimsuit\" and \"swimwear\" are treated the same (if they are [synonyms](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/adding-synonyms/#regular-synonyms)) - `ignorePlurals`.   Plurals and similar declensions added by the `ignorePlurals` setting are considered exact matches - `singleWordSynonym`.   Single-word synonyms, such as \"NY\" = \"NYC\", are considered exact matches - `multiWordsSynonym`.   Multi-word synonyms, such as \"NY\" = \"New York\", are considered exact matches.
	AlternativesAsExact []AlternativesAsExact `json:"alternativesAsExact,omitempty"`
	// Whether the best matching attribute should be determined by minimum proximity This setting only affects ranking if the Attribute ranking criterion comes before Proximity in the `ranking` setting. If true, the best matching attribute is selected based on the minimum proximity of multiple matches. Otherwise, the best matching attribute is determined by the order in the `searchableAttributes` setting.
	AttributeCriteriaComputedByMinProximity *bool `json:"attributeCriteriaComputedByMinProximity,omitempty"`
	// Attributes to highlight By default, all searchable attributes are highlighted. Use `*` to highlight all attributes or use an empty array `[]` to turn off highlighting. Attribute names are case-sensitive With highlighting, strings that match the search query are surrounded by HTML tags defined by `highlightPreTag` and `highlightPostTag`. You can use this to visually highlight matching parts of a search query in your UI For more information, see [Highlighting and snippeting](https://www.algolia.com/doc/guides/building-search-ui/ui-and-ux-patterns/highlighting-snippeting/js).
	AttributesToHighlight []string `json:"attributesToHighlight,omitempty"`
	// Attributes to include in the API response To reduce the size of your response, you can retrieve only some of the attributes. Attribute names are case-sensitive - `*` retrieves all attributes, except attributes included in the `customRanking` and `unretrievableAttributes` settings. - To retrieve all attributes except a specific one, prefix the attribute with a dash and combine it with the `*`: `[\"*\", \"-ATTRIBUTE\"]`. - The `objectID` attribute is always included.
	AttributesToRetrieve []string `json:"attributesToRetrieve,omitempty"`
	// Attributes for which to enable snippets. Attribute names are case-sensitive Snippets provide additional context to matched words. If you enable snippets, they include 10 words, including the matched word. The matched word will also be wrapped by HTML tags for highlighting. You can adjust the number of words with the following notation: `ATTRIBUTE:NUMBER`, where `NUMBER` is the number of words to be extracted.
	AttributesToSnippet []string `json:"attributesToSnippet,omitempty"`
	// Whether to include a `queryID` attribute in the response The query ID is a unique identifier for a search query and is required for tracking [click and conversion events](https://www.algolia.com/doc/guides/sending-events/getting-started).
	ClickAnalytics *bool `json:"clickAnalytics,omitempty"`
	// Searchable attributes for which you want to [turn off the Exact ranking criterion](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/override-search-engine-defaults/in-depth/adjust-exact-settings/#turn-off-exact-for-some-attributes). Attribute names are case-sensitive This can be useful for attributes with long values, where the likelihood of an exact match is high, such as product descriptions. Turning off the Exact ranking criterion for these attributes favors exact matching on other attributes. This reduces the impact of individual attributes with a lot of content on ranking.
	DisableExactOnAttributes []string `json:"disableExactOnAttributes,omitempty"`
	// Attributes for which you want to turn off [typo tolerance](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/typo-tolerance). Attribute names are case-sensitive Returning only exact matches can help when - [Searching in hyphenated attributes](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/typo-tolerance/how-to/how-to-search-in-hyphenated-attributes). - Reducing the number of matches when you have too many.   This can happen with attributes that are long blocks of text, such as product descriptions Consider alternatives such as `disableTypoToleranceOnWords` or adding synonyms if your attributes have intentional unusual spellings that might look like typos.
	DisableTypoToleranceOnAttributes []string  `json:"disableTypoToleranceOnAttributes,omitempty"`
	Distinct                         *Distinct `json:"distinct,omitempty"`
	// Whether to enable A/B testing for this search.
	EnableABTest *bool `json:"enableABTest,omitempty"`
	// Whether to enable Personalization.
	EnablePersonalization *bool `json:"enablePersonalization,omitempty"`
	// Whether this search will use [Dynamic Re-Ranking](https://www.algolia.com/doc/guides/algolia-ai/re-ranking) This setting only has an effect if you activated Dynamic Re-Ranking for this index in the Algolia dashboard.
	EnableReRanking *bool `json:"enableReRanking,omitempty"`
	// Whether to enable rules.
	EnableRules            *bool                   `json:"enableRules,omitempty"`
	ExactOnSingleWordQuery *ExactOnSingleWordQuery `json:"exactOnSingleWordQuery,omitempty"`
	FacetFilters           *FacetFilters           `json:"facetFilters,omitempty"`
	// Filter expression to only include items that match the filter criteria in the response.  You can use these filter expressions:  - **Numeric filters.** `<facet> <op> <number>`, where `<op>` is one of `<`, `<=`, `=`, `!=`, `>`, `>=`. - **Ranges.** `<facet>:<lower> TO <upper>`, where `<lower>` and `<upper>` are the lower and upper limits of the range (inclusive). - **Facet filters.** `<facet>:<value>`, where `<facet>` is a facet attribute (case-sensitive) and `<value>` a facet value. - **Tag filters.** `_tags:<value>` or just `<value>` (case-sensitive). - **Boolean filters.** `<facet>: true | false`.  You can combine filters with `AND`, `OR`, and `NOT` operators with the following restrictions:  - You can only combine filters of the same type with `OR`.   **Not supported:** `facet:value OR num > 3`. - You can't use `NOT` with combinations of filters.   **Not supported:** `NOT(facet:value OR facet:value)` - You can't combine conjunctions (`AND`) with `OR`.   **Not supported:** `facet:value OR (facet:value AND facet:value)`  Use quotes if the facet attribute name or facet value contains spaces, keywords (`OR`, `AND`, `NOT`), or quotes. If a facet attribute is an array, the filter matches if it matches at least one element of the array.  For more information, see [Filters](https://www.algolia.com/doc/guides/managing-results/refine-results/filtering).
	Filters *string `json:"filters,omitempty"`
	// Whether the search response should include detailed ranking information.
	GetRankingInfo *bool `json:"getRankingInfo,omitempty"`
	// HTML tag to insert after the highlighted parts in all highlighted results and snippets.
	HighlightPostTag *string `json:"highlightPostTag,omitempty"`
	// HTML tag to insert before the highlighted parts in all highlighted results and snippets.
	HighlightPreTag *string        `json:"highlightPreTag,omitempty"`
	IgnorePlurals   *IgnorePlurals `json:"ignorePlurals,omitempty"`
	// Minimum proximity score for two matching words This adjusts the [Proximity ranking criterion](https://www.algolia.com/doc/guides/managing-results/relevance-overview/in-depth/ranking-criteria/#proximity) by equally scoring matches that are farther apart For example, if `minProximity` is 2, neighboring matches and matches with one word between them would have the same score.
	MinProximity *int32 `json:"minProximity,omitempty"`
	// Minimum number of characters a word in the search query must contain to accept matches with [one typo](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/typo-tolerance/in-depth/configuring-typo-tolerance/#configuring-word-length-for-typos).
	MinWordSizefor1Typo *int32 `json:"minWordSizefor1Typo,omitempty"`
	// Minimum number of characters a word in the search query must contain to accept matches with [two typos](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/typo-tolerance/in-depth/configuring-typo-tolerance/#configuring-word-length-for-typos).
	MinWordSizefor2Typos *int32 `json:"minWordSizefor2Typos,omitempty"`
	// ISO language codes that adjust settings that are useful for processing natural language queries (as opposed to keyword searches) - Sets `removeStopWords` and `ignorePlurals` to the list of provided languages. - Sets `removeWordsIfNoResults` to `allOptional`. - Adds a `natural_language` attribute to `ruleContexts` and `analyticsTags`.
	NaturalLanguages []SupportedLanguage           `json:"naturalLanguages,omitempty"`
	NumericFilters   *NumericFilters               `json:"numericFilters,omitempty"`
	OptionalFilters  *OptionalFilters              `json:"optionalFilters,omitempty"`
	OptionalWords    utils.Nullable[OptionalWords] `json:"optionalWords,omitempty"`
	// Whether to include this search when calculating processing-time percentiles.
	PercentileComputation *bool `json:"percentileComputation,omitempty"`
	// Impact that Personalization should have on this search The higher this value is, the more Personalization determines the ranking compared to other factors. For more information, see [Understanding Personalization impact](https://www.algolia.com/doc/guides/personalization/personalizing-results/in-depth/configuring-personalization/#understanding-personalization-impact).
	PersonalizationImpact *int32 `json:"personalizationImpact,omitempty"`
	// Languages for language-specific query processing steps such as plurals, stop-word removal, and word-detection dictionaries. This setting sets a default list of languages used by the `removeStopWords` and `ignorePlurals` settings. This setting also sets a dictionary for word detection in the logogram-based [CJK](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/handling-natural-languages-nlp/in-depth/normalization/#normalization-for-logogram-based-languages-cjk) languages. To support this, place the CJK language **first**. **Always specify a query language.** If you don't specify an indexing language, the search engine uses all [supported languages](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/handling-natural-languages-nlp/in-depth/supported-languages), or the languages you specified with the `ignorePlurals` or `removeStopWords` parameters. This can lead to unexpected search results. For more information, see [Language-specific configuration](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/handling-natural-languages-nlp/in-depth/language-specific-configurations).
	QueryLanguages         []SupportedLanguage     `json:"queryLanguages,omitempty"`
	QueryType              *QueryType              `json:"queryType,omitempty"`
	RemoveStopWords        *RemoveStopWords        `json:"removeStopWords,omitempty"`
	RemoveWordsIfNoResults *RemoveWordsIfNoResults `json:"removeWordsIfNoResults,omitempty"`
	// Whether to replace a highlighted word with the matched synonym By default, the original words are highlighted even if a synonym matches. For example, with `home` as a synonym for `house` and a search for `home`, records matching either \"home\" or \"house\" are included in the search results, and either \"home\" or \"house\" are highlighted With `replaceSynonymsInHighlight` set to `true`, a search for `home` still matches the same records, but all occurrences of \"house\" are replaced by \"home\" in the highlighted response.
	ReplaceSynonymsInHighlight *bool `json:"replaceSynonymsInHighlight,omitempty"`
	// Properties to include in the API response of search and browse requests By default, all response properties are included. To reduce the response size, you can select which properties should be included An empty list may lead to an empty API response (except properties you can't exclude) You can't exclude these properties: `message`, `warning`, `cursor`, `abTestVariantID`, or any property added by setting `getRankingInfo` to true Your search depends on the `hits` field. If you omit this field, searches won't return any results. Your UI might also depend on other properties, for example, for pagination. Before restricting the response size, check the impact on your search experience.
	ResponseFields []string `json:"responseFields,omitempty"`
	// Whether to restrict highlighting and snippeting to items that at least partially matched the search query. By default, all items are highlighted and snippeted.
	RestrictHighlightAndSnippetArrays *bool `json:"restrictHighlightAndSnippetArrays,omitempty"`
	// Restricts a search to a subset of your searchable attributes. Attribute names are case-sensitive.
	RestrictSearchableAttributes []string `json:"restrictSearchableAttributes,omitempty"`
	// Assigns a rule context to the search query [Rule contexts](https://www.algolia.com/doc/guides/managing-results/rules/rules-overview/how-to/customize-search-results-by-platform/#whats-a-context) are strings that you can use to trigger matching rules.
	RuleContexts []string `json:"ruleContexts,omitempty"`
	// String used as an ellipsis indicator when a snippet is truncated.
	SnippetEllipsisText *string `json:"snippetEllipsisText,omitempty"`
	// Whether to take into account an index's synonyms for this search.
	Synonyms      *bool          `json:"synonyms,omitempty"`
	TypoTolerance *TypoTolerance `json:"typoTolerance,omitempty"`
	// Whether faceting should be applied after deduplication with `distinct` This leads to accurate facet counts when using faceting in combination with `distinct`. It's usually better to use `afterDistinct` modifiers in the `attributesForFaceting` setting, as `facetingAfterDistinct` only computes correct facet counts if all records have the same facet values for the `attributeForDistinct`.
	FacetingAfterDistinct *bool `json:"facetingAfterDistinct,omitempty"`
	// Facets for which to retrieve facet values that match the search criteria and the number of matching facet values To retrieve all facets, use the wildcard character `*`. To retrieve disjunctive facets lists, annotate any facets with the `disjunctive` modifier. For more information, see [facets](https://www.algolia.com/doc/guides/managing-results/refine-results/faceting/#contextual-facet-values-and-counts) and [disjunctive faceting for Smart Groups](https://www.algolia.com/doc/guides/managing-results/compositions/search-based-groups#facets-including-disjunctive-faceting).
	Facets []string `json:"facets,omitempty"`
	// Number of hits per page.
	HitsPerPage *int32 `json:"hitsPerPage,omitempty"`
	// Maximum number of facet values to return for each facet.
	MaxValuesPerFacet *int32            `json:"maxValuesPerFacet,omitempty"`
	RenderingContent  *RenderingContent `json:"renderingContent,omitempty"`
	// Order in which to retrieve facet values - `count`.   Facet values are retrieved by decreasing count.   The count is the number of matching records containing this facet value - `alpha`.   Retrieve facet values alphabetically This setting doesn't influence how facet values are displayed in your UI (see `renderingContent`). For more information, see [facet value display](https://www.algolia.com/doc/guides/building-search-ui/ui-and-ux-patterns/facet-display/js).
	SortFacetValuesBy *string `json:"sortFacetValuesBy,omitempty"`
	// Whether to sum all filter scores If true, all filter scores are summed. Otherwise, the maximum filter score is kept. For more information, see [filter scores](https://www.algolia.com/doc/guides/managing-results/refine-results/filtering/in-depth/filter-scoring/#accumulating-scores-with-sumorfiltersscores).
	SumOrFiltersScores *bool `json:"sumOrFiltersScores,omitempty"`
}

MainInjectionQueryParameters struct for MainInjectionQueryParameters.

func NewEmptyMainInjectionQueryParameters added in v4.26.0 

func NewEmptyMainInjectionQueryParameters() *MainInjectionQueryParameters

NewEmptyMainInjectionQueryParameters return a pointer to an empty MainInjectionQueryParameters object.

func NewMainInjectionQueryParameters added in v4.26.0 

func NewMainInjectionQueryParameters(opts ...MainInjectionQueryParametersOption) *MainInjectionQueryParameters

NewMainInjectionQueryParameters instantiates a new MainInjectionQueryParameters object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed.

func (*MainInjectionQueryParameters) GetAdvancedSyntax added in v4.26.0 

func (o *MainInjectionQueryParameters) GetAdvancedSyntax() bool

GetAdvancedSyntax returns the AdvancedSyntax field value if set, zero value otherwise.

func (*MainInjectionQueryParameters) GetAdvancedSyntaxFeatures added in v4.26.0 

func (o *MainInjectionQueryParameters) GetAdvancedSyntaxFeatures() []AdvancedSyntaxFeatures

GetAdvancedSyntaxFeatures returns the AdvancedSyntaxFeatures field value if set, zero value otherwise.

func (*MainInjectionQueryParameters) GetAdvancedSyntaxFeaturesOk added in v4.26.0 

func (o *MainInjectionQueryParameters) GetAdvancedSyntaxFeaturesOk() ([]AdvancedSyntaxFeatures, bool)

GetAdvancedSyntaxFeaturesOk returns a tuple with the AdvancedSyntaxFeatures field value if set, nil otherwise and a boolean to check if the value has been set.

func (*MainInjectionQueryParameters) GetAdvancedSyntaxOk added in v4.26.0 

func (o *MainInjectionQueryParameters) GetAdvancedSyntaxOk() (*bool, bool)

GetAdvancedSyntaxOk returns a tuple with the AdvancedSyntax field value if set, nil otherwise and a boolean to check if the value has been set.

func (*MainInjectionQueryParameters) GetAllowTyposOnNumericTokens added in v4.26.0 

func (o *MainInjectionQueryParameters) GetAllowTyposOnNumericTokens() bool

GetAllowTyposOnNumericTokens returns the AllowTyposOnNumericTokens field value if set, zero value otherwise.

func (*MainInjectionQueryParameters) GetAllowTyposOnNumericTokensOk added in v4.26.0 

func (o *MainInjectionQueryParameters) GetAllowTyposOnNumericTokensOk() (*bool, bool)

GetAllowTyposOnNumericTokensOk returns a tuple with the AllowTyposOnNumericTokens field value if set, nil otherwise and a boolean to check if the value has been set.

func (*MainInjectionQueryParameters) GetAlternativesAsExact added in v4.26.0 

func (o *MainInjectionQueryParameters) GetAlternativesAsExact() []AlternativesAsExact

GetAlternativesAsExact returns the AlternativesAsExact field value if set, zero value otherwise.

func (*MainInjectionQueryParameters) GetAlternativesAsExactOk added in v4.26.0 

func (o *MainInjectionQueryParameters) GetAlternativesAsExactOk() ([]AlternativesAsExact, bool)

GetAlternativesAsExactOk returns a tuple with the AlternativesAsExact field value if set, nil otherwise and a boolean to check if the value has been set.

func (*MainInjectionQueryParameters) GetAttributeCriteriaComputedByMinProximity added in v4.26.0 

func (o *MainInjectionQueryParameters) GetAttributeCriteriaComputedByMinProximity() bool

GetAttributeCriteriaComputedByMinProximity returns the AttributeCriteriaComputedByMinProximity field value if set, zero value otherwise.

func (*MainInjectionQueryParameters) GetAttributeCriteriaComputedByMinProximityOk added in v4.26.0 

func (o *MainInjectionQueryParameters) GetAttributeCriteriaComputedByMinProximityOk() (*bool, bool)

GetAttributeCriteriaComputedByMinProximityOk returns a tuple with the AttributeCriteriaComputedByMinProximity field value if set, nil otherwise and a boolean to check if the value has been set.

func (*MainInjectionQueryParameters) GetAttributesToHighlight added in v4.26.0 

func (o *MainInjectionQueryParameters) GetAttributesToHighlight() []string

GetAttributesToHighlight returns the AttributesToHighlight field value if set, zero value otherwise.

func (*MainInjectionQueryParameters) GetAttributesToHighlightOk added in v4.26.0 

func (o *MainInjectionQueryParameters) GetAttributesToHighlightOk() ([]string, bool)

GetAttributesToHighlightOk returns a tuple with the AttributesToHighlight field value if set, nil otherwise and a boolean to check if the value has been set.

func (*MainInjectionQueryParameters) GetAttributesToRetrieve added in v4.26.0 

func (o *MainInjectionQueryParameters) GetAttributesToRetrieve() []string

GetAttributesToRetrieve returns the AttributesToRetrieve field value if set, zero value otherwise.

func (*MainInjectionQueryParameters) GetAttributesToRetrieveOk added in v4.26.0 

func (o *MainInjectionQueryParameters) GetAttributesToRetrieveOk() ([]string, bool)

GetAttributesToRetrieveOk returns a tuple with the AttributesToRetrieve field value if set, nil otherwise and a boolean to check if the value has been set.

func (*MainInjectionQueryParameters) GetAttributesToSnippet added in v4.26.0 

func (o *MainInjectionQueryParameters) GetAttributesToSnippet() []string

GetAttributesToSnippet returns the AttributesToSnippet field value if set, zero value otherwise.

func (*MainInjectionQueryParameters) GetAttributesToSnippetOk added in v4.26.0 

func (o *MainInjectionQueryParameters) GetAttributesToSnippetOk() ([]string, bool)

GetAttributesToSnippetOk returns a tuple with the AttributesToSnippet field value if set, nil otherwise and a boolean to check if the value has been set.

func (*MainInjectionQueryParameters) GetClickAnalytics added in v4.26.0 

func (o *MainInjectionQueryParameters) GetClickAnalytics() bool

GetClickAnalytics returns the ClickAnalytics field value if set, zero value otherwise.

func (*MainInjectionQueryParameters) GetClickAnalyticsOk added in v4.26.0 

func (o *MainInjectionQueryParameters) GetClickAnalyticsOk() (*bool, bool)

GetClickAnalyticsOk returns a tuple with the ClickAnalytics field value if set, nil otherwise and a boolean to check if the value has been set.

func (*MainInjectionQueryParameters) GetDisableExactOnAttributes added in v4.26.0 

func (o *MainInjectionQueryParameters) GetDisableExactOnAttributes() []string

GetDisableExactOnAttributes returns the DisableExactOnAttributes field value if set, zero value otherwise.

func (*MainInjectionQueryParameters) GetDisableExactOnAttributesOk added in v4.26.0 

func (o *MainInjectionQueryParameters) GetDisableExactOnAttributesOk() ([]string, bool)

GetDisableExactOnAttributesOk returns a tuple with the DisableExactOnAttributes field value if set, nil otherwise and a boolean to check if the value has been set.

func (*MainInjectionQueryParameters) GetDisableTypoToleranceOnAttributes added in v4.26.0 

func (o *MainInjectionQueryParameters) GetDisableTypoToleranceOnAttributes() []string

GetDisableTypoToleranceOnAttributes returns the DisableTypoToleranceOnAttributes field value if set, zero value otherwise.

func (*MainInjectionQueryParameters) GetDisableTypoToleranceOnAttributesOk added in v4.26.0 

func (o *MainInjectionQueryParameters) GetDisableTypoToleranceOnAttributesOk() ([]string, bool)

GetDisableTypoToleranceOnAttributesOk returns a tuple with the DisableTypoToleranceOnAttributes field value if set, nil otherwise and a boolean to check if the value has been set.

func (*MainInjectionQueryParameters) GetDistinct added in v4.26.0 

func (o *MainInjectionQueryParameters) GetDistinct() Distinct

GetDistinct returns the Distinct field value if set, zero value otherwise.

func (*MainInjectionQueryParameters) GetDistinctOk added in v4.26.0 

func (o *MainInjectionQueryParameters) GetDistinctOk() (*Distinct, bool)

GetDistinctOk returns a tuple with the Distinct field value if set, nil otherwise and a boolean to check if the value has been set.

func (*MainInjectionQueryParameters) GetEnableABTest added in v4.26.0 

func (o *MainInjectionQueryParameters) GetEnableABTest() bool

GetEnableABTest returns the EnableABTest field value if set, zero value otherwise.

func (*MainInjectionQueryParameters) GetEnableABTestOk added in v4.26.0 

func (o *MainInjectionQueryParameters) GetEnableABTestOk() (*bool, bool)

GetEnableABTestOk returns a tuple with the EnableABTest field value if set, nil otherwise and a boolean to check if the value has been set.

func (*MainInjectionQueryParameters) GetEnablePersonalization added in v4.26.0 

func (o *MainInjectionQueryParameters) GetEnablePersonalization() bool

GetEnablePersonalization returns the EnablePersonalization field value if set, zero value otherwise.

func (*MainInjectionQueryParameters) GetEnablePersonalizationOk added in v4.26.0 

func (o *MainInjectionQueryParameters) GetEnablePersonalizationOk() (*bool, bool)

GetEnablePersonalizationOk returns a tuple with the EnablePersonalization field value if set, nil otherwise and a boolean to check if the value has been set.

func (*MainInjectionQueryParameters) GetEnableReRanking added in v4.26.0 

func (o *MainInjectionQueryParameters) GetEnableReRanking() bool

GetEnableReRanking returns the EnableReRanking field value if set, zero value otherwise.

func (*MainInjectionQueryParameters) GetEnableReRankingOk added in v4.26.0 

func (o *MainInjectionQueryParameters) GetEnableReRankingOk() (*bool, bool)

GetEnableReRankingOk returns a tuple with the EnableReRanking field value if set, nil otherwise and a boolean to check if the value has been set.

func (*MainInjectionQueryParameters) GetEnableRules added in v4.26.0 

func (o *MainInjectionQueryParameters) GetEnableRules() bool

GetEnableRules returns the EnableRules field value if set, zero value otherwise.

func (*MainInjectionQueryParameters) GetEnableRulesOk added in v4.26.0 

func (o *MainInjectionQueryParameters) GetEnableRulesOk() (*bool, bool)

GetEnableRulesOk returns a tuple with the EnableRules field value if set, nil otherwise and a boolean to check if the value has been set.

func (*MainInjectionQueryParameters) GetExactOnSingleWordQuery added in v4.26.0 

func (o *MainInjectionQueryParameters) GetExactOnSingleWordQuery() ExactOnSingleWordQuery

GetExactOnSingleWordQuery returns the ExactOnSingleWordQuery field value if set, zero value otherwise.

func (*MainInjectionQueryParameters) GetExactOnSingleWordQueryOk added in v4.26.0 

func (o *MainInjectionQueryParameters) GetExactOnSingleWordQueryOk() (*ExactOnSingleWordQuery, bool)

GetExactOnSingleWordQueryOk returns a tuple with the ExactOnSingleWordQuery field value if set, nil otherwise and a boolean to check if the value has been set.

func (*MainInjectionQueryParameters) GetFacetFilters added in v4.26.0 

func (o *MainInjectionQueryParameters) GetFacetFilters() FacetFilters

GetFacetFilters returns the FacetFilters field value if set, zero value otherwise.

func (*MainInjectionQueryParameters) GetFacetFiltersOk added in v4.26.0 

func (o *MainInjectionQueryParameters) GetFacetFiltersOk() (*FacetFilters, bool)

GetFacetFiltersOk returns a tuple with the FacetFilters field value if set, nil otherwise and a boolean to check if the value has been set.

func (*MainInjectionQueryParameters) GetFacetingAfterDistinct added in v4.26.0 

func (o *MainInjectionQueryParameters) GetFacetingAfterDistinct() bool

GetFacetingAfterDistinct returns the FacetingAfterDistinct field value if set, zero value otherwise.

func (*MainInjectionQueryParameters) GetFacetingAfterDistinctOk added in v4.26.0 

func (o *MainInjectionQueryParameters) GetFacetingAfterDistinctOk() (*bool, bool)

GetFacetingAfterDistinctOk returns a tuple with the FacetingAfterDistinct field value if set, nil otherwise and a boolean to check if the value has been set.

func (*MainInjectionQueryParameters) GetFacets added in v4.26.0 

func (o *MainInjectionQueryParameters) GetFacets() []string

GetFacets returns the Facets field value if set, zero value otherwise.

func (*MainInjectionQueryParameters) GetFacetsOk added in v4.26.0 

func (o *MainInjectionQueryParameters) GetFacetsOk() ([]string, bool)

GetFacetsOk returns a tuple with the Facets field value if set, nil otherwise and a boolean to check if the value has been set.

func (*MainInjectionQueryParameters) GetFilters added in v4.26.0 

func (o *MainInjectionQueryParameters) GetFilters() string

GetFilters returns the Filters field value if set, zero value otherwise.

func (*MainInjectionQueryParameters) GetFiltersOk added in v4.26.0 

func (o *MainInjectionQueryParameters) GetFiltersOk() (*string, bool)

GetFiltersOk returns a tuple with the Filters field value if set, nil otherwise and a boolean to check if the value has been set.

func (*MainInjectionQueryParameters) GetGetRankingInfo added in v4.26.0 

func (o *MainInjectionQueryParameters) GetGetRankingInfo() bool

GetGetRankingInfo returns the GetRankingInfo field value if set, zero value otherwise.

func (*MainInjectionQueryParameters) GetGetRankingInfoOk added in v4.26.0 

func (o *MainInjectionQueryParameters) GetGetRankingInfoOk() (*bool, bool)

GetGetRankingInfoOk returns a tuple with the GetRankingInfo field value if set, nil otherwise and a boolean to check if the value has been set.

func (*MainInjectionQueryParameters) GetHighlightPostTag added in v4.26.0 

func (o *MainInjectionQueryParameters) GetHighlightPostTag() string

GetHighlightPostTag returns the HighlightPostTag field value if set, zero value otherwise.

func (*MainInjectionQueryParameters) GetHighlightPostTagOk added in v4.26.0 

func (o *MainInjectionQueryParameters) GetHighlightPostTagOk() (*string, bool)

GetHighlightPostTagOk returns a tuple with the HighlightPostTag field value if set, nil otherwise and a boolean to check if the value has been set.

func (*MainInjectionQueryParameters) GetHighlightPreTag added in v4.26.0 

func (o *MainInjectionQueryParameters) GetHighlightPreTag() string

GetHighlightPreTag returns the HighlightPreTag field value if set, zero value otherwise.

func (*MainInjectionQueryParameters) GetHighlightPreTagOk added in v4.26.0 

func (o *MainInjectionQueryParameters) GetHighlightPreTagOk() (*string, bool)

GetHighlightPreTagOk returns a tuple with the HighlightPreTag field value if set, nil otherwise and a boolean to check if the value has been set.

func (*MainInjectionQueryParameters) GetHitsPerPage added in v4.26.0 

func (o *MainInjectionQueryParameters) GetHitsPerPage() int32

GetHitsPerPage returns the HitsPerPage field value if set, zero value otherwise.

func (*MainInjectionQueryParameters) GetHitsPerPageOk added in v4.26.0 

func (o *MainInjectionQueryParameters) GetHitsPerPageOk() (*int32, bool)

GetHitsPerPageOk returns a tuple with the HitsPerPage field value if set, nil otherwise and a boolean to check if the value has been set.

func (*MainInjectionQueryParameters) GetIgnorePlurals added in v4.26.0 

func (o *MainInjectionQueryParameters) GetIgnorePlurals() IgnorePlurals

GetIgnorePlurals returns the IgnorePlurals field value if set, zero value otherwise.

func (*MainInjectionQueryParameters) GetIgnorePluralsOk added in v4.26.0 

func (o *MainInjectionQueryParameters) GetIgnorePluralsOk() (*IgnorePlurals, bool)

GetIgnorePluralsOk returns a tuple with the IgnorePlurals field value if set, nil otherwise and a boolean to check if the value has been set.

func (*MainInjectionQueryParameters) GetMaxValuesPerFacet added in v4.26.0 

func (o *MainInjectionQueryParameters) GetMaxValuesPerFacet() int32

GetMaxValuesPerFacet returns the MaxValuesPerFacet field value if set, zero value otherwise.

func (*MainInjectionQueryParameters) GetMaxValuesPerFacetOk added in v4.26.0 

func (o *MainInjectionQueryParameters) GetMaxValuesPerFacetOk() (*int32, bool)

GetMaxValuesPerFacetOk returns a tuple with the MaxValuesPerFacet field value if set, nil otherwise and a boolean to check if the value has been set.

func (*MainInjectionQueryParameters) GetMinProximity added in v4.26.0 

func (o *MainInjectionQueryParameters) GetMinProximity() int32

GetMinProximity returns the MinProximity field value if set, zero value otherwise.

func (*MainInjectionQueryParameters) GetMinProximityOk added in v4.26.0 

func (o *MainInjectionQueryParameters) GetMinProximityOk() (*int32, bool)

GetMinProximityOk returns a tuple with the MinProximity field value if set, nil otherwise and a boolean to check if the value has been set.

func (*MainInjectionQueryParameters) GetMinWordSizefor1Typo added in v4.26.0 

func (o *MainInjectionQueryParameters) GetMinWordSizefor1Typo() int32

GetMinWordSizefor1Typo returns the MinWordSizefor1Typo field value if set, zero value otherwise.

func (*MainInjectionQueryParameters) GetMinWordSizefor1TypoOk added in v4.26.0 

func (o *MainInjectionQueryParameters) GetMinWordSizefor1TypoOk() (*int32, bool)

GetMinWordSizefor1TypoOk returns a tuple with the MinWordSizefor1Typo field value if set, nil otherwise and a boolean to check if the value has been set.

func (*MainInjectionQueryParameters) GetMinWordSizefor2Typos added in v4.26.0 

func (o *MainInjectionQueryParameters) GetMinWordSizefor2Typos() int32

GetMinWordSizefor2Typos returns the MinWordSizefor2Typos field value if set, zero value otherwise.

func (*MainInjectionQueryParameters) GetMinWordSizefor2TyposOk added in v4.26.0 

func (o *MainInjectionQueryParameters) GetMinWordSizefor2TyposOk() (*int32, bool)

GetMinWordSizefor2TyposOk returns a tuple with the MinWordSizefor2Typos field value if set, nil otherwise and a boolean to check if the value has been set.

func (*MainInjectionQueryParameters) GetNaturalLanguages added in v4.26.0 

func (o *MainInjectionQueryParameters) GetNaturalLanguages() []SupportedLanguage

GetNaturalLanguages returns the NaturalLanguages field value if set, zero value otherwise.

func (*MainInjectionQueryParameters) GetNaturalLanguagesOk added in v4.26.0 

func (o *MainInjectionQueryParameters) GetNaturalLanguagesOk() ([]SupportedLanguage, bool)

GetNaturalLanguagesOk returns a tuple with the NaturalLanguages field value if set, nil otherwise and a boolean to check if the value has been set.

func (*MainInjectionQueryParameters) GetNumericFilters added in v4.26.0 

func (o *MainInjectionQueryParameters) GetNumericFilters() NumericFilters

GetNumericFilters returns the NumericFilters field value if set, zero value otherwise.

func (*MainInjectionQueryParameters) GetNumericFiltersOk added in v4.26.0 

func (o *MainInjectionQueryParameters) GetNumericFiltersOk() (*NumericFilters, bool)

GetNumericFiltersOk returns a tuple with the NumericFilters field value if set, nil otherwise and a boolean to check if the value has been set.

func (*MainInjectionQueryParameters) GetOptionalFilters added in v4.26.0 

func (o *MainInjectionQueryParameters) GetOptionalFilters() OptionalFilters

GetOptionalFilters returns the OptionalFilters field value if set, zero value otherwise.

func (*MainInjectionQueryParameters) GetOptionalFiltersOk added in v4.26.0 

func (o *MainInjectionQueryParameters) GetOptionalFiltersOk() (*OptionalFilters, bool)

GetOptionalFiltersOk returns a tuple with the OptionalFilters field value if set, nil otherwise and a boolean to check if the value has been set.

func (*MainInjectionQueryParameters) GetOptionalWords added in v4.26.0 

func (o *MainInjectionQueryParameters) GetOptionalWords() OptionalWords

GetOptionalWords returns the OptionalWords field value if set, zero value otherwise (both if not set or set to explicit null).

func (*MainInjectionQueryParameters) GetOptionalWordsOk added in v4.26.0 

func (o *MainInjectionQueryParameters) GetOptionalWordsOk() (*OptionalWords, bool)

GetOptionalWordsOk returns a tuple with the OptionalWords field value if set, nil otherwise and a boolean to check if the value has been set. NOTE: If the value is an explicit nil, `nil, true` will be returned.

func (*MainInjectionQueryParameters) GetPercentileComputation added in v4.26.0 

func (o *MainInjectionQueryParameters) GetPercentileComputation() bool

GetPercentileComputation returns the PercentileComputation field value if set, zero value otherwise.

func (*MainInjectionQueryParameters) GetPercentileComputationOk added in v4.26.0 

func (o *MainInjectionQueryParameters) GetPercentileComputationOk() (*bool, bool)

GetPercentileComputationOk returns a tuple with the PercentileComputation field value if set, nil otherwise and a boolean to check if the value has been set.

func (*MainInjectionQueryParameters) GetPersonalizationImpact added in v4.26.0 

func (o *MainInjectionQueryParameters) GetPersonalizationImpact() int32

GetPersonalizationImpact returns the PersonalizationImpact field value if set, zero value otherwise.

func (*MainInjectionQueryParameters) GetPersonalizationImpactOk added in v4.26.0 

func (o *MainInjectionQueryParameters) GetPersonalizationImpactOk() (*int32, bool)

GetPersonalizationImpactOk returns a tuple with the PersonalizationImpact field value if set, nil otherwise and a boolean to check if the value has been set.

func (*MainInjectionQueryParameters) GetQueryLanguages added in v4.26.0 

func (o *MainInjectionQueryParameters) GetQueryLanguages() []SupportedLanguage

GetQueryLanguages returns the QueryLanguages field value if set, zero value otherwise.

func (*MainInjectionQueryParameters) GetQueryLanguagesOk added in v4.26.0 

func (o *MainInjectionQueryParameters) GetQueryLanguagesOk() ([]SupportedLanguage, bool)

GetQueryLanguagesOk returns a tuple with the QueryLanguages field value if set, nil otherwise and a boolean to check if the value has been set.

func (*MainInjectionQueryParameters) GetQueryType added in v4.26.0 

func (o *MainInjectionQueryParameters) GetQueryType() QueryType

GetQueryType returns the QueryType field value if set, zero value otherwise.

func (*MainInjectionQueryParameters) GetQueryTypeOk added in v4.26.0 

func (o *MainInjectionQueryParameters) GetQueryTypeOk() (*QueryType, bool)

GetQueryTypeOk returns a tuple with the QueryType field value if set, nil otherwise and a boolean to check if the value has been set.

func (*MainInjectionQueryParameters) GetRemoveStopWords added in v4.26.0 

func (o *MainInjectionQueryParameters) GetRemoveStopWords() RemoveStopWords

GetRemoveStopWords returns the RemoveStopWords field value if set, zero value otherwise.

func (*MainInjectionQueryParameters) GetRemoveStopWordsOk added in v4.26.0 

func (o *MainInjectionQueryParameters) GetRemoveStopWordsOk() (*RemoveStopWords, bool)

GetRemoveStopWordsOk returns a tuple with the RemoveStopWords field value if set, nil otherwise and a boolean to check if the value has been set.

func (*MainInjectionQueryParameters) GetRemoveWordsIfNoResults added in v4.26.0 

func (o *MainInjectionQueryParameters) GetRemoveWordsIfNoResults() RemoveWordsIfNoResults

GetRemoveWordsIfNoResults returns the RemoveWordsIfNoResults field value if set, zero value otherwise.

func (*MainInjectionQueryParameters) GetRemoveWordsIfNoResultsOk added in v4.26.0 

func (o *MainInjectionQueryParameters) GetRemoveWordsIfNoResultsOk() (*RemoveWordsIfNoResults, bool)

GetRemoveWordsIfNoResultsOk returns a tuple with the RemoveWordsIfNoResults field value if set, nil otherwise and a boolean to check if the value has been set.

func (*MainInjectionQueryParameters) GetRenderingContent added in v4.30.0 

func (o *MainInjectionQueryParameters) GetRenderingContent() RenderingContent

GetRenderingContent returns the RenderingContent field value if set, zero value otherwise.

func (*MainInjectionQueryParameters) GetRenderingContentOk added in v4.30.0 

func (o *MainInjectionQueryParameters) GetRenderingContentOk() (*RenderingContent, bool)

GetRenderingContentOk returns a tuple with the RenderingContent field value if set, nil otherwise and a boolean to check if the value has been set.

func (*MainInjectionQueryParameters) GetReplaceSynonymsInHighlight added in v4.26.0 

func (o *MainInjectionQueryParameters) GetReplaceSynonymsInHighlight() bool

GetReplaceSynonymsInHighlight returns the ReplaceSynonymsInHighlight field value if set, zero value otherwise.

func (*MainInjectionQueryParameters) GetReplaceSynonymsInHighlightOk added in v4.26.0 

func (o *MainInjectionQueryParameters) GetReplaceSynonymsInHighlightOk() (*bool, bool)

GetReplaceSynonymsInHighlightOk returns a tuple with the ReplaceSynonymsInHighlight field value if set, nil otherwise and a boolean to check if the value has been set.

func (*MainInjectionQueryParameters) GetResponseFields added in v4.26.0 

func (o *MainInjectionQueryParameters) GetResponseFields() []string

GetResponseFields returns the ResponseFields field value if set, zero value otherwise.

func (*MainInjectionQueryParameters) GetResponseFieldsOk added in v4.26.0 

func (o *MainInjectionQueryParameters) GetResponseFieldsOk() ([]string, bool)

GetResponseFieldsOk returns a tuple with the ResponseFields field value if set, nil otherwise and a boolean to check if the value has been set.

func (*MainInjectionQueryParameters) GetRestrictHighlightAndSnippetArrays added in v4.26.0 

func (o *MainInjectionQueryParameters) GetRestrictHighlightAndSnippetArrays() bool

GetRestrictHighlightAndSnippetArrays returns the RestrictHighlightAndSnippetArrays field value if set, zero value otherwise.

func (*MainInjectionQueryParameters) GetRestrictHighlightAndSnippetArraysOk added in v4.26.0 

func (o *MainInjectionQueryParameters) GetRestrictHighlightAndSnippetArraysOk() (*bool, bool)

GetRestrictHighlightAndSnippetArraysOk returns a tuple with the RestrictHighlightAndSnippetArrays field value if set, nil otherwise and a boolean to check if the value has been set.

func (*MainInjectionQueryParameters) GetRestrictSearchableAttributes added in v4.26.0 

func (o *MainInjectionQueryParameters) GetRestrictSearchableAttributes() []string

GetRestrictSearchableAttributes returns the RestrictSearchableAttributes field value if set, zero value otherwise.

func (*MainInjectionQueryParameters) GetRestrictSearchableAttributesOk added in v4.26.0 

func (o *MainInjectionQueryParameters) GetRestrictSearchableAttributesOk() ([]string, bool)

GetRestrictSearchableAttributesOk returns a tuple with the RestrictSearchableAttributes field value if set, nil otherwise and a boolean to check if the value has been set.

func (*MainInjectionQueryParameters) GetRuleContexts added in v4.26.0 

func (o *MainInjectionQueryParameters) GetRuleContexts() []string

GetRuleContexts returns the RuleContexts field value if set, zero value otherwise.

func (*MainInjectionQueryParameters) GetRuleContextsOk added in v4.26.0 

func (o *MainInjectionQueryParameters) GetRuleContextsOk() ([]string, bool)

GetRuleContextsOk returns a tuple with the RuleContexts field value if set, nil otherwise and a boolean to check if the value has been set.

func (*MainInjectionQueryParameters) GetSnippetEllipsisText added in v4.26.0 

func (o *MainInjectionQueryParameters) GetSnippetEllipsisText() string

GetSnippetEllipsisText returns the SnippetEllipsisText field value if set, zero value otherwise.

func (*MainInjectionQueryParameters) GetSnippetEllipsisTextOk added in v4.26.0 

func (o *MainInjectionQueryParameters) GetSnippetEllipsisTextOk() (*string, bool)

GetSnippetEllipsisTextOk returns a tuple with the SnippetEllipsisText field value if set, nil otherwise and a boolean to check if the value has been set.

func (*MainInjectionQueryParameters) GetSortFacetValuesBy added in v4.26.0 

func (o *MainInjectionQueryParameters) GetSortFacetValuesBy() string

GetSortFacetValuesBy returns the SortFacetValuesBy field value if set, zero value otherwise.

func (*MainInjectionQueryParameters) GetSortFacetValuesByOk added in v4.26.0 

func (o *MainInjectionQueryParameters) GetSortFacetValuesByOk() (*string, bool)

GetSortFacetValuesByOk returns a tuple with the SortFacetValuesBy field value if set, nil otherwise and a boolean to check if the value has been set.

func (*MainInjectionQueryParameters) GetSumOrFiltersScores added in v4.26.0 

func (o *MainInjectionQueryParameters) GetSumOrFiltersScores() bool

GetSumOrFiltersScores returns the SumOrFiltersScores field value if set, zero value otherwise.

func (*MainInjectionQueryParameters) GetSumOrFiltersScoresOk added in v4.26.0 

func (o *MainInjectionQueryParameters) GetSumOrFiltersScoresOk() (*bool, bool)

GetSumOrFiltersScoresOk returns a tuple with the SumOrFiltersScores field value if set, nil otherwise and a boolean to check if the value has been set.

func (*MainInjectionQueryParameters) GetSynonyms added in v4.26.0 

func (o *MainInjectionQueryParameters) GetSynonyms() bool

GetSynonyms returns the Synonyms field value if set, zero value otherwise.

func (*MainInjectionQueryParameters) GetSynonymsOk added in v4.26.0 

func (o *MainInjectionQueryParameters) GetSynonymsOk() (*bool, bool)

GetSynonymsOk returns a tuple with the Synonyms field value if set, nil otherwise and a boolean to check if the value has been set.

func (*MainInjectionQueryParameters) GetTypoTolerance added in v4.26.0 

func (o *MainInjectionQueryParameters) GetTypoTolerance() TypoTolerance

GetTypoTolerance returns the TypoTolerance field value if set, zero value otherwise.

func (*MainInjectionQueryParameters) GetTypoToleranceOk added in v4.26.0 

func (o *MainInjectionQueryParameters) GetTypoToleranceOk() (*TypoTolerance, bool)

GetTypoToleranceOk returns a tuple with the TypoTolerance field value if set, nil otherwise and a boolean to check if the value has been set.

func (*MainInjectionQueryParameters) HasAdvancedSyntax added in v4.26.0 

func (o *MainInjectionQueryParameters) HasAdvancedSyntax() bool

HasAdvancedSyntax returns a boolean if a field has been set.

func (*MainInjectionQueryParameters) HasAdvancedSyntaxFeatures added in v4.26.0 

func (o *MainInjectionQueryParameters) HasAdvancedSyntaxFeatures() bool

HasAdvancedSyntaxFeatures returns a boolean if a field has been set.

func (*MainInjectionQueryParameters) HasAllowTyposOnNumericTokens added in v4.26.0 

func (o *MainInjectionQueryParameters) HasAllowTyposOnNumericTokens() bool

HasAllowTyposOnNumericTokens returns a boolean if a field has been set.

func (*MainInjectionQueryParameters) HasAlternativesAsExact added in v4.26.0 

func (o *MainInjectionQueryParameters) HasAlternativesAsExact() bool

HasAlternativesAsExact returns a boolean if a field has been set.

func (*MainInjectionQueryParameters) HasAttributeCriteriaComputedByMinProximity added in v4.26.0 

func (o *MainInjectionQueryParameters) HasAttributeCriteriaComputedByMinProximity() bool

HasAttributeCriteriaComputedByMinProximity returns a boolean if a field has been set.

func (*MainInjectionQueryParameters) HasAttributesToHighlight added in v4.26.0 

func (o *MainInjectionQueryParameters) HasAttributesToHighlight() bool

HasAttributesToHighlight returns a boolean if a field has been set.

func (*MainInjectionQueryParameters) HasAttributesToRetrieve added in v4.26.0 

func (o *MainInjectionQueryParameters) HasAttributesToRetrieve() bool

HasAttributesToRetrieve returns a boolean if a field has been set.

func (*MainInjectionQueryParameters) HasAttributesToSnippet added in v4.26.0 

func (o *MainInjectionQueryParameters) HasAttributesToSnippet() bool

HasAttributesToSnippet returns a boolean if a field has been set.

func (*MainInjectionQueryParameters) HasClickAnalytics added in v4.26.0 

func (o *MainInjectionQueryParameters) HasClickAnalytics() bool

HasClickAnalytics returns a boolean if a field has been set.

func (*MainInjectionQueryParameters) HasDisableExactOnAttributes added in v4.26.0 

func (o *MainInjectionQueryParameters) HasDisableExactOnAttributes() bool

HasDisableExactOnAttributes returns a boolean if a field has been set.

func (*MainInjectionQueryParameters) HasDisableTypoToleranceOnAttributes added in v4.26.0 

func (o *MainInjectionQueryParameters) HasDisableTypoToleranceOnAttributes() bool

HasDisableTypoToleranceOnAttributes returns a boolean if a field has been set.

func (*MainInjectionQueryParameters) HasDistinct added in v4.26.0 

func (o *MainInjectionQueryParameters) HasDistinct() bool

HasDistinct returns a boolean if a field has been set.

func (*MainInjectionQueryParameters) HasEnableABTest added in v4.26.0 

func (o *MainInjectionQueryParameters) HasEnableABTest() bool

HasEnableABTest returns a boolean if a field has been set.

func (*MainInjectionQueryParameters) HasEnablePersonalization added in v4.26.0 

func (o *MainInjectionQueryParameters) HasEnablePersonalization() bool

HasEnablePersonalization returns a boolean if a field has been set.

func (*MainInjectionQueryParameters) HasEnableReRanking added in v4.26.0 

func (o *MainInjectionQueryParameters) HasEnableReRanking() bool

HasEnableReRanking returns a boolean if a field has been set.

func (*MainInjectionQueryParameters) HasEnableRules added in v4.26.0 

func (o *MainInjectionQueryParameters) HasEnableRules() bool

HasEnableRules returns a boolean if a field has been set.

func (*MainInjectionQueryParameters) HasExactOnSingleWordQuery added in v4.26.0 

func (o *MainInjectionQueryParameters) HasExactOnSingleWordQuery() bool

HasExactOnSingleWordQuery returns a boolean if a field has been set.

func (*MainInjectionQueryParameters) HasFacetFilters added in v4.26.0 

func (o *MainInjectionQueryParameters) HasFacetFilters() bool

HasFacetFilters returns a boolean if a field has been set.

func (*MainInjectionQueryParameters) HasFacetingAfterDistinct added in v4.26.0 

func (o *MainInjectionQueryParameters) HasFacetingAfterDistinct() bool

HasFacetingAfterDistinct returns a boolean if a field has been set.

func (*MainInjectionQueryParameters) HasFacets added in v4.26.0 

func (o *MainInjectionQueryParameters) HasFacets() bool

HasFacets returns a boolean if a field has been set.

func (*MainInjectionQueryParameters) HasFilters added in v4.26.0 

func (o *MainInjectionQueryParameters) HasFilters() bool

HasFilters returns a boolean if a field has been set.

func (*MainInjectionQueryParameters) HasGetRankingInfo added in v4.26.0 

func (o *MainInjectionQueryParameters) HasGetRankingInfo() bool

HasGetRankingInfo returns a boolean if a field has been set.

func (*MainInjectionQueryParameters) HasHighlightPostTag added in v4.26.0 

func (o *MainInjectionQueryParameters) HasHighlightPostTag() bool

HasHighlightPostTag returns a boolean if a field has been set.

func (*MainInjectionQueryParameters) HasHighlightPreTag added in v4.26.0 

func (o *MainInjectionQueryParameters) HasHighlightPreTag() bool

HasHighlightPreTag returns a boolean if a field has been set.

func (*MainInjectionQueryParameters) HasHitsPerPage added in v4.26.0 

func (o *MainInjectionQueryParameters) HasHitsPerPage() bool

HasHitsPerPage returns a boolean if a field has been set.

func (*MainInjectionQueryParameters) HasIgnorePlurals added in v4.26.0 

func (o *MainInjectionQueryParameters) HasIgnorePlurals() bool

HasIgnorePlurals returns a boolean if a field has been set.

func (*MainInjectionQueryParameters) HasMaxValuesPerFacet added in v4.26.0 

func (o *MainInjectionQueryParameters) HasMaxValuesPerFacet() bool

HasMaxValuesPerFacet returns a boolean if a field has been set.

func (*MainInjectionQueryParameters) HasMinProximity added in v4.26.0 

func (o *MainInjectionQueryParameters) HasMinProximity() bool

HasMinProximity returns a boolean if a field has been set.

func (*MainInjectionQueryParameters) HasMinWordSizefor1Typo added in v4.26.0 

func (o *MainInjectionQueryParameters) HasMinWordSizefor1Typo() bool

HasMinWordSizefor1Typo returns a boolean if a field has been set.

func (*MainInjectionQueryParameters) HasMinWordSizefor2Typos added in v4.26.0 

func (o *MainInjectionQueryParameters) HasMinWordSizefor2Typos() bool

HasMinWordSizefor2Typos returns a boolean if a field has been set.

func (*MainInjectionQueryParameters) HasNaturalLanguages added in v4.26.0 

func (o *MainInjectionQueryParameters) HasNaturalLanguages() bool

HasNaturalLanguages returns a boolean if a field has been set.

func (*MainInjectionQueryParameters) HasNumericFilters added in v4.26.0 

func (o *MainInjectionQueryParameters) HasNumericFilters() bool

HasNumericFilters returns a boolean if a field has been set.

func (*MainInjectionQueryParameters) HasOptionalFilters added in v4.26.0 

func (o *MainInjectionQueryParameters) HasOptionalFilters() bool

HasOptionalFilters returns a boolean if a field has been set.

func (*MainInjectionQueryParameters) HasOptionalWords added in v4.26.0 

func (o *MainInjectionQueryParameters) HasOptionalWords() bool

HasOptionalWords returns a boolean if a field has been set.

func (*MainInjectionQueryParameters) HasPercentileComputation added in v4.26.0 

func (o *MainInjectionQueryParameters) HasPercentileComputation() bool

HasPercentileComputation returns a boolean if a field has been set.

func (*MainInjectionQueryParameters) HasPersonalizationImpact added in v4.26.0 

func (o *MainInjectionQueryParameters) HasPersonalizationImpact() bool

HasPersonalizationImpact returns a boolean if a field has been set.

func (*MainInjectionQueryParameters) HasQueryLanguages added in v4.26.0 

func (o *MainInjectionQueryParameters) HasQueryLanguages() bool

HasQueryLanguages returns a boolean if a field has been set.

func (*MainInjectionQueryParameters) HasQueryType added in v4.26.0 

func (o *MainInjectionQueryParameters) HasQueryType() bool

HasQueryType returns a boolean if a field has been set.

func (*MainInjectionQueryParameters) HasRemoveStopWords added in v4.26.0 

func (o *MainInjectionQueryParameters) HasRemoveStopWords() bool

HasRemoveStopWords returns a boolean if a field has been set.

func (*MainInjectionQueryParameters) HasRemoveWordsIfNoResults added in v4.26.0 

func (o *MainInjectionQueryParameters) HasRemoveWordsIfNoResults() bool

HasRemoveWordsIfNoResults returns a boolean if a field has been set.

func (*MainInjectionQueryParameters) HasRenderingContent added in v4.30.0 

func (o *MainInjectionQueryParameters) HasRenderingContent() bool

HasRenderingContent returns a boolean if a field has been set.

func (*MainInjectionQueryParameters) HasReplaceSynonymsInHighlight added in v4.26.0 

func (o *MainInjectionQueryParameters) HasReplaceSynonymsInHighlight() bool

HasReplaceSynonymsInHighlight returns a boolean if a field has been set.

func (*MainInjectionQueryParameters) HasResponseFields added in v4.26.0 

func (o *MainInjectionQueryParameters) HasResponseFields() bool

HasResponseFields returns a boolean if a field has been set.

func (*MainInjectionQueryParameters) HasRestrictHighlightAndSnippetArrays added in v4.26.0 

func (o *MainInjectionQueryParameters) HasRestrictHighlightAndSnippetArrays() bool

HasRestrictHighlightAndSnippetArrays returns a boolean if a field has been set.

func (*MainInjectionQueryParameters) HasRestrictSearchableAttributes added in v4.26.0 

func (o *MainInjectionQueryParameters) HasRestrictSearchableAttributes() bool

HasRestrictSearchableAttributes returns a boolean if a field has been set.

func (*MainInjectionQueryParameters) HasRuleContexts added in v4.26.0 

func (o *MainInjectionQueryParameters) HasRuleContexts() bool

HasRuleContexts returns a boolean if a field has been set.

func (*MainInjectionQueryParameters) HasSnippetEllipsisText added in v4.26.0 

func (o *MainInjectionQueryParameters) HasSnippetEllipsisText() bool

HasSnippetEllipsisText returns a boolean if a field has been set.

func (*MainInjectionQueryParameters) HasSortFacetValuesBy added in v4.26.0 

func (o *MainInjectionQueryParameters) HasSortFacetValuesBy() bool

HasSortFacetValuesBy returns a boolean if a field has been set.

func (*MainInjectionQueryParameters) HasSumOrFiltersScores added in v4.26.0 

func (o *MainInjectionQueryParameters) HasSumOrFiltersScores() bool

HasSumOrFiltersScores returns a boolean if a field has been set.

func (*MainInjectionQueryParameters) HasSynonyms added in v4.26.0 

func (o *MainInjectionQueryParameters) HasSynonyms() bool

HasSynonyms returns a boolean if a field has been set.

func (*MainInjectionQueryParameters) HasTypoTolerance added in v4.26.0 

func (o *MainInjectionQueryParameters) HasTypoTolerance() bool

HasTypoTolerance returns a boolean if a field has been set.

func (MainInjectionQueryParameters) MarshalJSON added in v4.26.0 

func (o MainInjectionQueryParameters) MarshalJSON() ([]byte, error)

func (*MainInjectionQueryParameters) SetAdvancedSyntax added in v4.26.0 

func (o *MainInjectionQueryParameters) SetAdvancedSyntax(v bool) *MainInjectionQueryParameters

SetAdvancedSyntax gets a reference to the given bool and assigns it to the AdvancedSyntax field.

func (*MainInjectionQueryParameters) SetAdvancedSyntaxFeatures added in v4.26.0 

func (o *MainInjectionQueryParameters) SetAdvancedSyntaxFeatures(v []AdvancedSyntaxFeatures) *MainInjectionQueryParameters

SetAdvancedSyntaxFeatures gets a reference to the given []AdvancedSyntaxFeatures and assigns it to the AdvancedSyntaxFeatures field.

func (*MainInjectionQueryParameters) SetAllowTyposOnNumericTokens added in v4.26.0 

func (o *MainInjectionQueryParameters) SetAllowTyposOnNumericTokens(v bool) *MainInjectionQueryParameters

SetAllowTyposOnNumericTokens gets a reference to the given bool and assigns it to the AllowTyposOnNumericTokens field.

func (*MainInjectionQueryParameters) SetAlternativesAsExact added in v4.26.0 

func (o *MainInjectionQueryParameters) SetAlternativesAsExact(v []AlternativesAsExact) *MainInjectionQueryParameters

SetAlternativesAsExact gets a reference to the given []AlternativesAsExact and assigns it to the AlternativesAsExact field.

func (*MainInjectionQueryParameters) SetAttributeCriteriaComputedByMinProximity added in v4.26.0 

func (o *MainInjectionQueryParameters) SetAttributeCriteriaComputedByMinProximity(v bool) *MainInjectionQueryParameters

SetAttributeCriteriaComputedByMinProximity gets a reference to the given bool and assigns it to the AttributeCriteriaComputedByMinProximity field.

func (*MainInjectionQueryParameters) SetAttributesToHighlight added in v4.26.0 

func (o *MainInjectionQueryParameters) SetAttributesToHighlight(v []string) *MainInjectionQueryParameters

SetAttributesToHighlight gets a reference to the given []string and assigns it to the AttributesToHighlight field.

func (*MainInjectionQueryParameters) SetAttributesToRetrieve added in v4.26.0 

func (o *MainInjectionQueryParameters) SetAttributesToRetrieve(v []string) *MainInjectionQueryParameters

SetAttributesToRetrieve gets a reference to the given []string and assigns it to the AttributesToRetrieve field.

func (*MainInjectionQueryParameters) SetAttributesToSnippet added in v4.26.0 

func (o *MainInjectionQueryParameters) SetAttributesToSnippet(v []string) *MainInjectionQueryParameters

SetAttributesToSnippet gets a reference to the given []string and assigns it to the AttributesToSnippet field.

func (*MainInjectionQueryParameters) SetClickAnalytics added in v4.26.0 

func (o *MainInjectionQueryParameters) SetClickAnalytics(v bool) *MainInjectionQueryParameters

SetClickAnalytics gets a reference to the given bool and assigns it to the ClickAnalytics field.

func (*MainInjectionQueryParameters) SetDisableExactOnAttributes added in v4.26.0 

func (o *MainInjectionQueryParameters) SetDisableExactOnAttributes(v []string) *MainInjectionQueryParameters

SetDisableExactOnAttributes gets a reference to the given []string and assigns it to the DisableExactOnAttributes field.

func (*MainInjectionQueryParameters) SetDisableTypoToleranceOnAttributes added in v4.26.0 

func (o *MainInjectionQueryParameters) SetDisableTypoToleranceOnAttributes(v []string) *MainInjectionQueryParameters

SetDisableTypoToleranceOnAttributes gets a reference to the given []string and assigns it to the DisableTypoToleranceOnAttributes field.

func (*MainInjectionQueryParameters) SetDistinct added in v4.26.0 

func (o *MainInjectionQueryParameters) SetDistinct(v *Distinct) *MainInjectionQueryParameters

SetDistinct gets a reference to the given Distinct and assigns it to the Distinct field.

func (*MainInjectionQueryParameters) SetEnableABTest added in v4.26.0 

func (o *MainInjectionQueryParameters) SetEnableABTest(v bool) *MainInjectionQueryParameters

SetEnableABTest gets a reference to the given bool and assigns it to the EnableABTest field.

func (*MainInjectionQueryParameters) SetEnablePersonalization added in v4.26.0 

func (o *MainInjectionQueryParameters) SetEnablePersonalization(v bool) *MainInjectionQueryParameters

SetEnablePersonalization gets a reference to the given bool and assigns it to the EnablePersonalization field.

func (*MainInjectionQueryParameters) SetEnableReRanking added in v4.26.0 

func (o *MainInjectionQueryParameters) SetEnableReRanking(v bool) *MainInjectionQueryParameters

SetEnableReRanking gets a reference to the given bool and assigns it to the EnableReRanking field.

func (*MainInjectionQueryParameters) SetEnableRules added in v4.26.0 

func (o *MainInjectionQueryParameters) SetEnableRules(v bool) *MainInjectionQueryParameters

SetEnableRules gets a reference to the given bool and assigns it to the EnableRules field.

func (*MainInjectionQueryParameters) SetExactOnSingleWordQuery added in v4.26.0 

func (o *MainInjectionQueryParameters) SetExactOnSingleWordQuery(v ExactOnSingleWordQuery) *MainInjectionQueryParameters

SetExactOnSingleWordQuery gets a reference to the given ExactOnSingleWordQuery and assigns it to the ExactOnSingleWordQuery field.

func (*MainInjectionQueryParameters) SetFacetFilters added in v4.26.0 

func (o *MainInjectionQueryParameters) SetFacetFilters(v *FacetFilters) *MainInjectionQueryParameters

SetFacetFilters gets a reference to the given FacetFilters and assigns it to the FacetFilters field.

func (*MainInjectionQueryParameters) SetFacetingAfterDistinct added in v4.26.0 

func (o *MainInjectionQueryParameters) SetFacetingAfterDistinct(v bool) *MainInjectionQueryParameters

SetFacetingAfterDistinct gets a reference to the given bool and assigns it to the FacetingAfterDistinct field.

func (*MainInjectionQueryParameters) SetFacets added in v4.26.0 

func (o *MainInjectionQueryParameters) SetFacets(v []string) *MainInjectionQueryParameters

SetFacets gets a reference to the given []string and assigns it to the Facets field.

func (*MainInjectionQueryParameters) SetFilters added in v4.26.0 

func (o *MainInjectionQueryParameters) SetFilters(v string) *MainInjectionQueryParameters

SetFilters gets a reference to the given string and assigns it to the Filters field.

func (*MainInjectionQueryParameters) SetGetRankingInfo added in v4.26.0 

func (o *MainInjectionQueryParameters) SetGetRankingInfo(v bool) *MainInjectionQueryParameters

SetGetRankingInfo gets a reference to the given bool and assigns it to the GetRankingInfo field.

func (*MainInjectionQueryParameters) SetHighlightPostTag added in v4.26.0 

func (o *MainInjectionQueryParameters) SetHighlightPostTag(v string) *MainInjectionQueryParameters

SetHighlightPostTag gets a reference to the given string and assigns it to the HighlightPostTag field.

func (*MainInjectionQueryParameters) SetHighlightPreTag added in v4.26.0 

func (o *MainInjectionQueryParameters) SetHighlightPreTag(v string) *MainInjectionQueryParameters

SetHighlightPreTag gets a reference to the given string and assigns it to the HighlightPreTag field.

func (*MainInjectionQueryParameters) SetHitsPerPage added in v4.26.0 

func (o *MainInjectionQueryParameters) SetHitsPerPage(v int32) *MainInjectionQueryParameters

SetHitsPerPage gets a reference to the given int32 and assigns it to the HitsPerPage field.

func (*MainInjectionQueryParameters) SetIgnorePlurals added in v4.26.0 

func (o *MainInjectionQueryParameters) SetIgnorePlurals(v *IgnorePlurals) *MainInjectionQueryParameters

SetIgnorePlurals gets a reference to the given IgnorePlurals and assigns it to the IgnorePlurals field.

func (*MainInjectionQueryParameters) SetMaxValuesPerFacet added in v4.26.0 

func (o *MainInjectionQueryParameters) SetMaxValuesPerFacet(v int32) *MainInjectionQueryParameters

SetMaxValuesPerFacet gets a reference to the given int32 and assigns it to the MaxValuesPerFacet field.

func (*MainInjectionQueryParameters) SetMinProximity added in v4.26.0 

func (o *MainInjectionQueryParameters) SetMinProximity(v int32) *MainInjectionQueryParameters

SetMinProximity gets a reference to the given int32 and assigns it to the MinProximity field.

func (*MainInjectionQueryParameters) SetMinWordSizefor1Typo added in v4.26.0 

func (o *MainInjectionQueryParameters) SetMinWordSizefor1Typo(v int32) *MainInjectionQueryParameters

SetMinWordSizefor1Typo gets a reference to the given int32 and assigns it to the MinWordSizefor1Typo field.

func (*MainInjectionQueryParameters) SetMinWordSizefor2Typos added in v4.26.0 

func (o *MainInjectionQueryParameters) SetMinWordSizefor2Typos(v int32) *MainInjectionQueryParameters

SetMinWordSizefor2Typos gets a reference to the given int32 and assigns it to the MinWordSizefor2Typos field.

func (*MainInjectionQueryParameters) SetNaturalLanguages added in v4.26.0 

func (o *MainInjectionQueryParameters) SetNaturalLanguages(v []SupportedLanguage) *MainInjectionQueryParameters

SetNaturalLanguages gets a reference to the given []SupportedLanguage and assigns it to the NaturalLanguages field.

func (*MainInjectionQueryParameters) SetNumericFilters added in v4.26.0 

func (o *MainInjectionQueryParameters) SetNumericFilters(v *NumericFilters) *MainInjectionQueryParameters

SetNumericFilters gets a reference to the given NumericFilters and assigns it to the NumericFilters field.

func (*MainInjectionQueryParameters) SetOptionalFilters added in v4.26.0 

func (o *MainInjectionQueryParameters) SetOptionalFilters(v *OptionalFilters) *MainInjectionQueryParameters

SetOptionalFilters gets a reference to the given OptionalFilters and assigns it to the OptionalFilters field.

func (*MainInjectionQueryParameters) SetOptionalWords added in v4.26.0 

func (o *MainInjectionQueryParameters) SetOptionalWords(v *OptionalWords) *MainInjectionQueryParameters

SetOptionalWords gets a reference to the given utils.Nullable[OptionalWords] and assigns it to the OptionalWords field.

func (*MainInjectionQueryParameters) SetOptionalWordsNil added in v4.26.0 

func (o *MainInjectionQueryParameters) SetOptionalWordsNil()

SetOptionalWordsNil sets the value for OptionalWords to be an explicit nil.

func (*MainInjectionQueryParameters) SetPercentileComputation added in v4.26.0 

func (o *MainInjectionQueryParameters) SetPercentileComputation(v bool) *MainInjectionQueryParameters

SetPercentileComputation gets a reference to the given bool and assigns it to the PercentileComputation field.

func (*MainInjectionQueryParameters) SetPersonalizationImpact added in v4.26.0 

func (o *MainInjectionQueryParameters) SetPersonalizationImpact(v int32) *MainInjectionQueryParameters

SetPersonalizationImpact gets a reference to the given int32 and assigns it to the PersonalizationImpact field.

func (*MainInjectionQueryParameters) SetQueryLanguages added in v4.26.0 

func (o *MainInjectionQueryParameters) SetQueryLanguages(v []SupportedLanguage) *MainInjectionQueryParameters

SetQueryLanguages gets a reference to the given []SupportedLanguage and assigns it to the QueryLanguages field.

func (*MainInjectionQueryParameters) SetQueryType added in v4.26.0 

func (o *MainInjectionQueryParameters) SetQueryType(v QueryType) *MainInjectionQueryParameters

SetQueryType gets a reference to the given QueryType and assigns it to the QueryType field.

func (*MainInjectionQueryParameters) SetRemoveStopWords added in v4.26.0 

func (o *MainInjectionQueryParameters) SetRemoveStopWords(v *RemoveStopWords) *MainInjectionQueryParameters

SetRemoveStopWords gets a reference to the given RemoveStopWords and assigns it to the RemoveStopWords field.

func (*MainInjectionQueryParameters) SetRemoveWordsIfNoResults added in v4.26.0 

func (o *MainInjectionQueryParameters) SetRemoveWordsIfNoResults(v RemoveWordsIfNoResults) *MainInjectionQueryParameters

SetRemoveWordsIfNoResults gets a reference to the given RemoveWordsIfNoResults and assigns it to the RemoveWordsIfNoResults field.

func (*MainInjectionQueryParameters) SetRenderingContent added in v4.30.0 

func (o *MainInjectionQueryParameters) SetRenderingContent(v *RenderingContent) *MainInjectionQueryParameters

SetRenderingContent gets a reference to the given RenderingContent and assigns it to the RenderingContent field.

func (*MainInjectionQueryParameters) SetReplaceSynonymsInHighlight added in v4.26.0 

func (o *MainInjectionQueryParameters) SetReplaceSynonymsInHighlight(v bool) *MainInjectionQueryParameters

SetReplaceSynonymsInHighlight gets a reference to the given bool and assigns it to the ReplaceSynonymsInHighlight field.

func (*MainInjectionQueryParameters) SetResponseFields added in v4.26.0 

func (o *MainInjectionQueryParameters) SetResponseFields(v []string) *MainInjectionQueryParameters

SetResponseFields gets a reference to the given []string and assigns it to the ResponseFields field.

func (*MainInjectionQueryParameters) SetRestrictHighlightAndSnippetArrays added in v4.26.0 

func (o *MainInjectionQueryParameters) SetRestrictHighlightAndSnippetArrays(v bool) *MainInjectionQueryParameters

SetRestrictHighlightAndSnippetArrays gets a reference to the given bool and assigns it to the RestrictHighlightAndSnippetArrays field.

func (*MainInjectionQueryParameters) SetRestrictSearchableAttributes added in v4.26.0 

func (o *MainInjectionQueryParameters) SetRestrictSearchableAttributes(v []string) *MainInjectionQueryParameters

SetRestrictSearchableAttributes gets a reference to the given []string and assigns it to the RestrictSearchableAttributes field.

func (*MainInjectionQueryParameters) SetRuleContexts added in v4.26.0 

func (o *MainInjectionQueryParameters) SetRuleContexts(v []string) *MainInjectionQueryParameters

SetRuleContexts gets a reference to the given []string and assigns it to the RuleContexts field.

func (*MainInjectionQueryParameters) SetSnippetEllipsisText added in v4.26.0 

func (o *MainInjectionQueryParameters) SetSnippetEllipsisText(v string) *MainInjectionQueryParameters

SetSnippetEllipsisText gets a reference to the given string and assigns it to the SnippetEllipsisText field.

func (*MainInjectionQueryParameters) SetSortFacetValuesBy added in v4.26.0 

func (o *MainInjectionQueryParameters) SetSortFacetValuesBy(v string) *MainInjectionQueryParameters

SetSortFacetValuesBy gets a reference to the given string and assigns it to the SortFacetValuesBy field.

func (*MainInjectionQueryParameters) SetSumOrFiltersScores added in v4.26.0 

func (o *MainInjectionQueryParameters) SetSumOrFiltersScores(v bool) *MainInjectionQueryParameters

SetSumOrFiltersScores gets a reference to the given bool and assigns it to the SumOrFiltersScores field.

func (*MainInjectionQueryParameters) SetSynonyms added in v4.26.0 

func (o *MainInjectionQueryParameters) SetSynonyms(v bool) *MainInjectionQueryParameters

SetSynonyms gets a reference to the given bool and assigns it to the Synonyms field.

func (*MainInjectionQueryParameters) SetTypoTolerance added in v4.26.0 

func (o *MainInjectionQueryParameters) SetTypoTolerance(v *TypoTolerance) *MainInjectionQueryParameters

SetTypoTolerance gets a reference to the given TypoTolerance and assigns it to the TypoTolerance field.

func (MainInjectionQueryParameters) String added in v4.26.0 

func (o MainInjectionQueryParameters) String() string

func (*MainInjectionQueryParameters) UnsetOptionalWords added in v4.26.0 

func (o *MainInjectionQueryParameters) UnsetOptionalWords()

UnsetOptionalWords ensures that no value is present for OptionalWords, not even an explicit nil.

type MainInjectionQueryParametersOption added in v4.26.0 

type MainInjectionQueryParametersOption func(f *MainInjectionQueryParameters)

func WithMainInjectionQueryParametersAdvancedSyntax added in v4.26.0 

func WithMainInjectionQueryParametersAdvancedSyntax(val bool) MainInjectionQueryParametersOption

func WithMainInjectionQueryParametersAdvancedSyntaxFeatures added in v4.26.0 

func WithMainInjectionQueryParametersAdvancedSyntaxFeatures(val []AdvancedSyntaxFeatures) MainInjectionQueryParametersOption

func WithMainInjectionQueryParametersAllowTyposOnNumericTokens added in v4.26.0 

func WithMainInjectionQueryParametersAllowTyposOnNumericTokens(val bool) MainInjectionQueryParametersOption

func WithMainInjectionQueryParametersAlternativesAsExact added in v4.26.0 

func WithMainInjectionQueryParametersAlternativesAsExact(val []AlternativesAsExact) MainInjectionQueryParametersOption

func WithMainInjectionQueryParametersAttributeCriteriaComputedByMinProximity added in v4.26.0 

func WithMainInjectionQueryParametersAttributeCriteriaComputedByMinProximity(val bool) MainInjectionQueryParametersOption

func WithMainInjectionQueryParametersAttributesToHighlight added in v4.26.0 

func WithMainInjectionQueryParametersAttributesToHighlight(val []string) MainInjectionQueryParametersOption

func WithMainInjectionQueryParametersAttributesToRetrieve added in v4.26.0 

func WithMainInjectionQueryParametersAttributesToRetrieve(val []string) MainInjectionQueryParametersOption

func WithMainInjectionQueryParametersAttributesToSnippet added in v4.26.0 

func WithMainInjectionQueryParametersAttributesToSnippet(val []string) MainInjectionQueryParametersOption

func WithMainInjectionQueryParametersClickAnalytics added in v4.26.0 

func WithMainInjectionQueryParametersClickAnalytics(val bool) MainInjectionQueryParametersOption

func WithMainInjectionQueryParametersDisableExactOnAttributes added in v4.26.0 

func WithMainInjectionQueryParametersDisableExactOnAttributes(val []string) MainInjectionQueryParametersOption

func WithMainInjectionQueryParametersDisableTypoToleranceOnAttributes added in v4.26.0 

func WithMainInjectionQueryParametersDisableTypoToleranceOnAttributes(val []string) MainInjectionQueryParametersOption

func WithMainInjectionQueryParametersDistinct added in v4.26.0 

func WithMainInjectionQueryParametersDistinct(val Distinct) MainInjectionQueryParametersOption

func WithMainInjectionQueryParametersEnableABTest added in v4.26.0 

func WithMainInjectionQueryParametersEnableABTest(val bool) MainInjectionQueryParametersOption

func WithMainInjectionQueryParametersEnablePersonalization added in v4.26.0 

func WithMainInjectionQueryParametersEnablePersonalization(val bool) MainInjectionQueryParametersOption

func WithMainInjectionQueryParametersEnableReRanking added in v4.26.0 

func WithMainInjectionQueryParametersEnableReRanking(val bool) MainInjectionQueryParametersOption

func WithMainInjectionQueryParametersEnableRules added in v4.26.0 

func WithMainInjectionQueryParametersEnableRules(val bool) MainInjectionQueryParametersOption

func WithMainInjectionQueryParametersExactOnSingleWordQuery added in v4.26.0 

func WithMainInjectionQueryParametersExactOnSingleWordQuery(val ExactOnSingleWordQuery) MainInjectionQueryParametersOption

func WithMainInjectionQueryParametersFacetFilters added in v4.26.0 

func WithMainInjectionQueryParametersFacetFilters(val FacetFilters) MainInjectionQueryParametersOption

func WithMainInjectionQueryParametersFacetingAfterDistinct added in v4.26.0 

func WithMainInjectionQueryParametersFacetingAfterDistinct(val bool) MainInjectionQueryParametersOption

func WithMainInjectionQueryParametersFacets added in v4.26.0 

func WithMainInjectionQueryParametersFacets(val []string) MainInjectionQueryParametersOption

func WithMainInjectionQueryParametersFilters added in v4.26.0 

func WithMainInjectionQueryParametersFilters(val string) MainInjectionQueryParametersOption

func WithMainInjectionQueryParametersGetRankingInfo added in v4.26.0 

func WithMainInjectionQueryParametersGetRankingInfo(val bool) MainInjectionQueryParametersOption

func WithMainInjectionQueryParametersHighlightPostTag added in v4.26.0 

func WithMainInjectionQueryParametersHighlightPostTag(val string) MainInjectionQueryParametersOption

func WithMainInjectionQueryParametersHighlightPreTag added in v4.26.0 

func WithMainInjectionQueryParametersHighlightPreTag(val string) MainInjectionQueryParametersOption

func WithMainInjectionQueryParametersHitsPerPage added in v4.26.0 

func WithMainInjectionQueryParametersHitsPerPage(val int32) MainInjectionQueryParametersOption

func WithMainInjectionQueryParametersIgnorePlurals added in v4.26.0 

func WithMainInjectionQueryParametersIgnorePlurals(val IgnorePlurals) MainInjectionQueryParametersOption

func WithMainInjectionQueryParametersMaxValuesPerFacet added in v4.26.0 

func WithMainInjectionQueryParametersMaxValuesPerFacet(val int32) MainInjectionQueryParametersOption

func WithMainInjectionQueryParametersMinProximity added in v4.26.0 

func WithMainInjectionQueryParametersMinProximity(val int32) MainInjectionQueryParametersOption

func WithMainInjectionQueryParametersMinWordSizefor1Typo added in v4.26.0 

func WithMainInjectionQueryParametersMinWordSizefor1Typo(val int32) MainInjectionQueryParametersOption

func WithMainInjectionQueryParametersMinWordSizefor2Typos added in v4.26.0 

func WithMainInjectionQueryParametersMinWordSizefor2Typos(val int32) MainInjectionQueryParametersOption

func WithMainInjectionQueryParametersNaturalLanguages added in v4.26.0 

func WithMainInjectionQueryParametersNaturalLanguages(val []SupportedLanguage) MainInjectionQueryParametersOption

func WithMainInjectionQueryParametersNumericFilters added in v4.26.0 

func WithMainInjectionQueryParametersNumericFilters(val NumericFilters) MainInjectionQueryParametersOption

func WithMainInjectionQueryParametersOptionalFilters added in v4.26.0 

func WithMainInjectionQueryParametersOptionalFilters(val OptionalFilters) MainInjectionQueryParametersOption

func WithMainInjectionQueryParametersOptionalWords added in v4.26.0 

func WithMainInjectionQueryParametersOptionalWords(val utils.Nullable[OptionalWords]) MainInjectionQueryParametersOption

func WithMainInjectionQueryParametersPercentileComputation added in v4.26.0 

func WithMainInjectionQueryParametersPercentileComputation(val bool) MainInjectionQueryParametersOption

func WithMainInjectionQueryParametersPersonalizationImpact added in v4.26.0 

func WithMainInjectionQueryParametersPersonalizationImpact(val int32) MainInjectionQueryParametersOption

func WithMainInjectionQueryParametersQueryLanguages added in v4.26.0 

func WithMainInjectionQueryParametersQueryLanguages(val []SupportedLanguage) MainInjectionQueryParametersOption

func WithMainInjectionQueryParametersQueryType added in v4.26.0 

func WithMainInjectionQueryParametersQueryType(val QueryType) MainInjectionQueryParametersOption

func WithMainInjectionQueryParametersRemoveStopWords added in v4.26.0 

func WithMainInjectionQueryParametersRemoveStopWords(val RemoveStopWords) MainInjectionQueryParametersOption

func WithMainInjectionQueryParametersRemoveWordsIfNoResults added in v4.26.0 

func WithMainInjectionQueryParametersRemoveWordsIfNoResults(val RemoveWordsIfNoResults) MainInjectionQueryParametersOption

func WithMainInjectionQueryParametersRenderingContent added in v4.30.0 

func WithMainInjectionQueryParametersRenderingContent(val RenderingContent) MainInjectionQueryParametersOption

func WithMainInjectionQueryParametersReplaceSynonymsInHighlight added in v4.26.0 

func WithMainInjectionQueryParametersReplaceSynonymsInHighlight(val bool) MainInjectionQueryParametersOption

func WithMainInjectionQueryParametersResponseFields added in v4.26.0 

func WithMainInjectionQueryParametersResponseFields(val []string) MainInjectionQueryParametersOption

func WithMainInjectionQueryParametersRestrictHighlightAndSnippetArrays added in v4.26.0 

func WithMainInjectionQueryParametersRestrictHighlightAndSnippetArrays(val bool) MainInjectionQueryParametersOption

func WithMainInjectionQueryParametersRestrictSearchableAttributes added in v4.26.0 

func WithMainInjectionQueryParametersRestrictSearchableAttributes(val []string) MainInjectionQueryParametersOption

func WithMainInjectionQueryParametersRuleContexts added in v4.26.0 

func WithMainInjectionQueryParametersRuleContexts(val []string) MainInjectionQueryParametersOption

func WithMainInjectionQueryParametersSnippetEllipsisText added in v4.26.0 

func WithMainInjectionQueryParametersSnippetEllipsisText(val string) MainInjectionQueryParametersOption

func WithMainInjectionQueryParametersSortFacetValuesBy added in v4.26.0 

func WithMainInjectionQueryParametersSortFacetValuesBy(val string) MainInjectionQueryParametersOption

func WithMainInjectionQueryParametersSumOrFiltersScores added in v4.26.0 

func WithMainInjectionQueryParametersSumOrFiltersScores(val bool) MainInjectionQueryParametersOption

func WithMainInjectionQueryParametersSynonyms added in v4.26.0 

func WithMainInjectionQueryParametersSynonyms(val bool) MainInjectionQueryParametersOption

func WithMainInjectionQueryParametersTypoTolerance added in v4.26.0 

func WithMainInjectionQueryParametersTypoTolerance(val TypoTolerance) MainInjectionQueryParametersOption

type MainRecommend added in v4.38.0 

type MainRecommend struct {
	// Index to retrieve recommendations from.
	IndexName string `json:"indexName"`
	Model     Model  `json:"model"`
	// Minimum score a recommendation must have to be included.
	Threshold          int32                         `json:"threshold"`
	QueryParameters    *MainInjectionQueryParameters `json:"queryParameters,omitempty"`
	FallbackParameters *MainInjectionQueryParameters `json:"fallbackParameters,omitempty"`
}

MainRecommend struct for MainRecommend.

func NewEmptyMainRecommend added in v4.38.0 

func NewEmptyMainRecommend() *MainRecommend

NewEmptyMainRecommend return a pointer to an empty MainRecommend object.

func NewMainRecommend added in v4.38.0 

func NewMainRecommend(indexName string, model Model, threshold int32, opts ...MainRecommendOption) *MainRecommend

NewMainRecommend instantiates a new MainRecommend object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed.

func (*MainRecommend) GetFallbackParameters added in v4.38.0 

func (o *MainRecommend) GetFallbackParameters() MainInjectionQueryParameters

GetFallbackParameters returns the FallbackParameters field value if set, zero value otherwise.

func (*MainRecommend) GetFallbackParametersOk added in v4.38.0 

func (o *MainRecommend) GetFallbackParametersOk() (*MainInjectionQueryParameters, bool)

GetFallbackParametersOk returns a tuple with the FallbackParameters field value if set, nil otherwise and a boolean to check if the value has been set.

func (*MainRecommend) GetIndexName added in v4.38.0 

func (o *MainRecommend) GetIndexName() string

GetIndexName returns the IndexName field value.

func (*MainRecommend) GetIndexNameOk added in v4.38.0 

func (o *MainRecommend) GetIndexNameOk() (*string, bool)

GetIndexNameOk returns a tuple with the IndexName field value and a boolean to check if the value has been set.

func (*MainRecommend) GetModel added in v4.38.0 

func (o *MainRecommend) GetModel() Model

GetModel returns the Model field value.

func (*MainRecommend) GetModelOk added in v4.38.0 

func (o *MainRecommend) GetModelOk() (*Model, bool)

GetModelOk returns a tuple with the Model field value and a boolean to check if the value has been set.

func (*MainRecommend) GetQueryParameters added in v4.38.0 

func (o *MainRecommend) GetQueryParameters() MainInjectionQueryParameters

GetQueryParameters returns the QueryParameters field value if set, zero value otherwise.

func (*MainRecommend) GetQueryParametersOk added in v4.38.0 

func (o *MainRecommend) GetQueryParametersOk() (*MainInjectionQueryParameters, bool)

GetQueryParametersOk returns a tuple with the QueryParameters field value if set, nil otherwise and a boolean to check if the value has been set.

func (*MainRecommend) GetThreshold added in v4.38.0 

func (o *MainRecommend) GetThreshold() int32

GetThreshold returns the Threshold field value.

func (*MainRecommend) GetThresholdOk added in v4.38.0 

func (o *MainRecommend) GetThresholdOk() (*int32, bool)

GetThresholdOk returns a tuple with the Threshold field value and a boolean to check if the value has been set.

func (*MainRecommend) HasFallbackParameters added in v4.38.0 

func (o *MainRecommend) HasFallbackParameters() bool

HasFallbackParameters returns a boolean if a field has been set.

func (*MainRecommend) HasQueryParameters added in v4.38.0 

func (o *MainRecommend) HasQueryParameters() bool

HasQueryParameters returns a boolean if a field has been set.

func (MainRecommend) MarshalJSON added in v4.38.0 

func (o MainRecommend) MarshalJSON() ([]byte, error)

func (*MainRecommend) SetFallbackParameters added in v4.38.0 

func (o *MainRecommend) SetFallbackParameters(v *MainInjectionQueryParameters) *MainRecommend

SetFallbackParameters gets a reference to the given MainInjectionQueryParameters and assigns it to the FallbackParameters field.

func (*MainRecommend) SetIndexName added in v4.38.0 

func (o *MainRecommend) SetIndexName(v string) *MainRecommend

SetIndexName sets field value.

func (*MainRecommend) SetModel added in v4.38.0 

func (o *MainRecommend) SetModel(v Model) *MainRecommend

SetModel sets field value.

func (*MainRecommend) SetQueryParameters added in v4.38.0 

func (o *MainRecommend) SetQueryParameters(v *MainInjectionQueryParameters) *MainRecommend

SetQueryParameters gets a reference to the given MainInjectionQueryParameters and assigns it to the QueryParameters field.

func (*MainRecommend) SetThreshold added in v4.38.0 

func (o *MainRecommend) SetThreshold(v int32) *MainRecommend

SetThreshold sets field value.

func (MainRecommend) String added in v4.38.0 

func (o MainRecommend) String() string

type MainRecommendOption added in v4.38.0 

type MainRecommendOption func(f *MainRecommend)

func WithMainRecommendFallbackParameters added in v4.38.0 

func WithMainRecommendFallbackParameters(val MainInjectionQueryParameters) MainRecommendOption

func WithMainRecommendQueryParameters added in v4.38.0 

func WithMainRecommendQueryParameters(val MainInjectionQueryParameters) MainRecommendOption

type MainSearch added in v4.38.0 

type MainSearch struct {
	// Index to retrieve search results from.
	Index  string                        `json:"index"`
	Params *MainInjectionQueryParameters `json:"params,omitempty"`
}

MainSearch struct for MainSearch.

func NewEmptyMainSearch added in v4.38.0 

func NewEmptyMainSearch() *MainSearch

NewEmptyMainSearch return a pointer to an empty MainSearch object.

func NewMainSearch added in v4.38.0 

func NewMainSearch(index string, opts ...MainSearchOption) *MainSearch

NewMainSearch instantiates a new MainSearch object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed.

func (*MainSearch) GetIndex added in v4.38.0 

func (o *MainSearch) GetIndex() string

GetIndex returns the Index field value.

func (*MainSearch) GetIndexOk added in v4.38.0 

func (o *MainSearch) GetIndexOk() (*string, bool)

GetIndexOk returns a tuple with the Index field value and a boolean to check if the value has been set.

func (*MainSearch) GetParams added in v4.38.0 

func (o *MainSearch) GetParams() MainInjectionQueryParameters

GetParams returns the Params field value if set, zero value otherwise.

func (*MainSearch) GetParamsOk added in v4.38.0 

func (o *MainSearch) GetParamsOk() (*MainInjectionQueryParameters, bool)

GetParamsOk returns a tuple with the Params field value if set, nil otherwise and a boolean to check if the value has been set.

func (*MainSearch) HasParams added in v4.38.0 

func (o *MainSearch) HasParams() bool

HasParams returns a boolean if a field has been set.

func (MainSearch) MarshalJSON added in v4.38.0 

func (o MainSearch) MarshalJSON() ([]byte, error)

func (*MainSearch) SetIndex added in v4.38.0 

func (o *MainSearch) SetIndex(v string) *MainSearch

SetIndex sets field value.

func (*MainSearch) SetParams added in v4.38.0 

func (o *MainSearch) SetParams(v *MainInjectionQueryParameters) *MainSearch

SetParams gets a reference to the given MainInjectionQueryParameters and assigns it to the Params field.

func (MainSearch) String added in v4.38.0 

func (o MainSearch) String() string

type MainSearchOption added in v4.38.0 

type MainSearchOption func(f *MainSearch)

func WithMainSearchParams added in v4.38.0 

func WithMainSearchParams(val MainInjectionQueryParameters) MainSearchOption

type MatchLevel 

type MatchLevel string

MatchLevel Whether the whole query string matches or only a part. 

const (
	MATCH_LEVEL_NONE    MatchLevel = "none"
	MATCH_LEVEL_PARTIAL MatchLevel = "partial"
	MATCH_LEVEL_FULL    MatchLevel = "full"
)

List of matchLevel.

func NewMatchLevelFromValue 

func NewMatchLevelFromValue(v string) (*MatchLevel, error)

NewMatchLevelFromValue returns a pointer to a valid MatchLevel. for the value passed as argument, or an error if the value passed is not allowed by the enum.

func (MatchLevel) IsValid 

func (v MatchLevel) IsValid() bool

IsValid return true if the value is valid for the enum, false otherwise.

func (MatchLevel) Ptr 

func (v MatchLevel) Ptr() *MatchLevel

Ptr returns reference to matchLevel value.

func (*MatchLevel) UnmarshalJSON 

func (v *MatchLevel) UnmarshalJSON(src []byte) error

type MatchedGeoLocation 

type MatchedGeoLocation struct {
	// Latitude of the matched location.
	Lat *float64 `json:"lat,omitempty"`
	// Longitude of the matched location.
	Lng *float64 `json:"lng,omitempty"`
	// Distance between the matched location and the search location (in meters).
	Distance *int32 `json:"distance,omitempty"`
}

MatchedGeoLocation struct for MatchedGeoLocation.

func NewEmptyMatchedGeoLocation 

func NewEmptyMatchedGeoLocation() *MatchedGeoLocation

NewEmptyMatchedGeoLocation return a pointer to an empty MatchedGeoLocation object.

func NewMatchedGeoLocation 

func NewMatchedGeoLocation(opts ...MatchedGeoLocationOption) *MatchedGeoLocation

NewMatchedGeoLocation instantiates a new MatchedGeoLocation object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed.

func (*MatchedGeoLocation) GetDistance 

func (o *MatchedGeoLocation) GetDistance() int32

GetDistance returns the Distance field value if set, zero value otherwise.

func (*MatchedGeoLocation) GetDistanceOk 

func (o *MatchedGeoLocation) GetDistanceOk() (*int32, bool)

GetDistanceOk returns a tuple with the Distance field value if set, nil otherwise and a boolean to check if the value has been set.

func (*MatchedGeoLocation) GetLat 

func (o *MatchedGeoLocation) GetLat() float64

GetLat returns the Lat field value if set, zero value otherwise.

func (*MatchedGeoLocation) GetLatOk 

func (o *MatchedGeoLocation) GetLatOk() (*float64, bool)

GetLatOk returns a tuple with the Lat field value if set, nil otherwise and a boolean to check if the value has been set.

func (*MatchedGeoLocation) GetLng 

func (o *MatchedGeoLocation) GetLng() float64

GetLng returns the Lng field value if set, zero value otherwise.

func (*MatchedGeoLocation) GetLngOk 

func (o *MatchedGeoLocation) GetLngOk() (*float64, bool)

GetLngOk returns a tuple with the Lng field value if set, nil otherwise and a boolean to check if the value has been set.

func (*MatchedGeoLocation) HasDistance 

func (o *MatchedGeoLocation) HasDistance() bool

HasDistance returns a boolean if a field has been set.

func (*MatchedGeoLocation) HasLat 

func (o *MatchedGeoLocation) HasLat() bool

HasLat returns a boolean if a field has been set.

func (*MatchedGeoLocation) HasLng 

func (o *MatchedGeoLocation) HasLng() bool

HasLng returns a boolean if a field has been set.

func (MatchedGeoLocation) MarshalJSON 

func (o MatchedGeoLocation) MarshalJSON() ([]byte, error)

func (*MatchedGeoLocation) SetDistance 

func (o *MatchedGeoLocation) SetDistance(v int32) *MatchedGeoLocation

SetDistance gets a reference to the given int32 and assigns it to the Distance field.

func (*MatchedGeoLocation) SetLat 

func (o *MatchedGeoLocation) SetLat(v float64) *MatchedGeoLocation

SetLat gets a reference to the given float64 and assigns it to the Lat field.

func (*MatchedGeoLocation) SetLng 

func (o *MatchedGeoLocation) SetLng(v float64) *MatchedGeoLocation

SetLng gets a reference to the given float64 and assigns it to the Lng field.

func (MatchedGeoLocation) String 

func (o MatchedGeoLocation) String() string

type MatchedGeoLocationOption 

type MatchedGeoLocationOption func(f *MatchedGeoLocation)

func WithMatchedGeoLocationDistance 

func WithMatchedGeoLocationDistance(val int32) MatchedGeoLocationOption

func WithMatchedGeoLocationLat 

func WithMatchedGeoLocationLat(val float64) MatchedGeoLocationOption

func WithMatchedGeoLocationLng 

func WithMatchedGeoLocationLng(val float64) MatchedGeoLocationOption

type Model added in v4.38.0 

type Model string

Model Recommendation model to use for retrieving recommendations. 

const (
	MODEL_TRENDING_ITEMS Model = "trending-items"
)

List of model.

func NewModelFromValue added in v4.38.0 

func NewModelFromValue(v string) (*Model, error)

NewModelFromValue returns a pointer to a valid Model. for the value passed as argument, or an error if the value passed is not allowed by the enum.

func (Model) IsValid added in v4.38.0 

func (v Model) IsValid() bool

IsValid return true if the value is valid for the enum, false otherwise.

func (Model) Ptr added in v4.38.0 

func (v Model) Ptr() *Model

Ptr returns reference to model value.

func (*Model) UnmarshalJSON added in v4.38.0 

func (v *Model) UnmarshalJSON(src []byte) error

type ModelRange 

type ModelRange struct {
	// Lower boundary of a range in meters. The Geo ranking criterion considers all records within the range to be equal.
	From *int32 `json:"from,omitempty"`
	// Upper boundary of a range in meters. The Geo ranking criterion considers all records within the range to be equal.
	Value *int32 `json:"value,omitempty"`
}

ModelRange Range object with lower and upper values in meters to define custom ranges.

func NewEmptyModelRange 

func NewEmptyModelRange() *ModelRange

NewEmptyModelRange return a pointer to an empty ModelRange object.

func NewModelRange 

func NewModelRange(opts ...ModelRangeOption) *ModelRange

NewModelRange instantiates a new ModelRange object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed.

func (*ModelRange) GetFrom 

func (o *ModelRange) GetFrom() int32

GetFrom returns the From field value if set, zero value otherwise.

func (*ModelRange) GetFromOk 

func (o *ModelRange) GetFromOk() (*int32, bool)

GetFromOk returns a tuple with the From field value if set, nil otherwise and a boolean to check if the value has been set.

func (*ModelRange) GetValue 

func (o *ModelRange) GetValue() int32

GetValue returns the Value field value if set, zero value otherwise.

func (*ModelRange) GetValueOk 

func (o *ModelRange) GetValueOk() (*int32, bool)

GetValueOk returns a tuple with the Value field value if set, nil otherwise and a boolean to check if the value has been set.

func (*ModelRange) HasFrom 

func (o *ModelRange) HasFrom() bool

HasFrom returns a boolean if a field has been set.

func (*ModelRange) HasValue 

func (o *ModelRange) HasValue() bool

HasValue returns a boolean if a field has been set.

func (ModelRange) MarshalJSON 

func (o ModelRange) MarshalJSON() ([]byte, error)

func (*ModelRange) SetFrom 

func (o *ModelRange) SetFrom(v int32) *ModelRange

SetFrom gets a reference to the given int32 and assigns it to the From field.

func (*ModelRange) SetValue 

func (o *ModelRange) SetValue(v int32) *ModelRange

SetValue gets a reference to the given int32 and assigns it to the Value field.

func (ModelRange) String 

func (o ModelRange) String() string

type ModelRangeOption 

type ModelRangeOption func(f *ModelRange)

func WithModelRangeFrom 

func WithModelRangeFrom(val int32) ModelRangeOption

func WithModelRangeValue 

func WithModelRangeValue(val int32) ModelRangeOption

type Multifeed added in v4.36.0 

type Multifeed struct {
	// A key-value store of Feed ID to Feed. Currently, the only supported Feed type is an Injection.
	Feeds map[string]FeedInjection `json:"feeds"`
	// A list of Feed IDs that specifies the order in which to order the results in the response. The IDs should be a subset of those in the Feeds object, and only those specified will be processed. When this field is not set, all Feeds are processed and returned with a default ordering.
	FeedsOrder []string `json:"feedsOrder,omitempty"`
}

Multifeed struct for Multifeed.

func NewEmptyMultifeed added in v4.36.0 

func NewEmptyMultifeed() *Multifeed

NewEmptyMultifeed return a pointer to an empty Multifeed object.

func NewMultifeed added in v4.36.0 

func NewMultifeed(feeds map[string]FeedInjection, opts ...MultifeedOption) *Multifeed

NewMultifeed instantiates a new Multifeed object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed.

func (*Multifeed) GetFeeds added in v4.36.0 

func (o *Multifeed) GetFeeds() map[string]FeedInjection

GetFeeds returns the Feeds field value.

func (*Multifeed) GetFeedsOk added in v4.36.0 

func (o *Multifeed) GetFeedsOk() (*map[string]FeedInjection, bool)

GetFeedsOk returns a tuple with the Feeds field value and a boolean to check if the value has been set.

func (*Multifeed) GetFeedsOrder added in v4.36.0 

func (o *Multifeed) GetFeedsOrder() []string

GetFeedsOrder returns the FeedsOrder field value if set, zero value otherwise.

func (*Multifeed) GetFeedsOrderOk added in v4.36.0 

func (o *Multifeed) GetFeedsOrderOk() ([]string, bool)

GetFeedsOrderOk returns a tuple with the FeedsOrder field value if set, nil otherwise and a boolean to check if the value has been set.

func (*Multifeed) HasFeedsOrder added in v4.36.0 

func (o *Multifeed) HasFeedsOrder() bool

HasFeedsOrder returns a boolean if a field has been set.

func (Multifeed) MarshalJSON added in v4.36.0 

func (o Multifeed) MarshalJSON() ([]byte, error)

func (*Multifeed) SetFeeds added in v4.36.0 

func (o *Multifeed) SetFeeds(v map[string]FeedInjection) *Multifeed

SetFeeds sets field value.

func (*Multifeed) SetFeedsOrder added in v4.36.0 

func (o *Multifeed) SetFeedsOrder(v []string) *Multifeed

SetFeedsOrder gets a reference to the given []string and assigns it to the FeedsOrder field.

func (Multifeed) String added in v4.36.0 

func (o Multifeed) String() string

type MultifeedOption added in v4.36.0 

type MultifeedOption func(f *Multifeed)

func WithMultifeedFeedsOrder added in v4.36.0 

func WithMultifeedFeedsOrder(val []string) MultifeedOption

type MultipleBatchRequest added in v4.26.0 

type MultipleBatchRequest struct {
	Action Action                 `json:"action"`
	Body   BatchCompositionAction `json:"body"`
}

MultipleBatchRequest struct for MultipleBatchRequest.

func NewEmptyMultipleBatchRequest added in v4.26.0 

func NewEmptyMultipleBatchRequest() *MultipleBatchRequest

NewEmptyMultipleBatchRequest return a pointer to an empty MultipleBatchRequest object.

func NewMultipleBatchRequest added in v4.26.0 

func NewMultipleBatchRequest(action Action, body BatchCompositionAction) *MultipleBatchRequest

NewMultipleBatchRequest instantiates a new MultipleBatchRequest object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed.

func (*MultipleBatchRequest) GetAction added in v4.26.0 

func (o *MultipleBatchRequest) GetAction() Action

GetAction returns the Action field value.

func (*MultipleBatchRequest) GetActionOk added in v4.26.0 

func (o *MultipleBatchRequest) GetActionOk() (*Action, bool)

GetActionOk returns a tuple with the Action field value and a boolean to check if the value has been set.

func (*MultipleBatchRequest) GetBody added in v4.26.0 

func (o *MultipleBatchRequest) GetBody() BatchCompositionAction

GetBody returns the Body field value.

func (*MultipleBatchRequest) GetBodyOk added in v4.26.0 

func (o *MultipleBatchRequest) GetBodyOk() (*BatchCompositionAction, bool)

GetBodyOk returns a tuple with the Body field value and a boolean to check if the value has been set.

func (MultipleBatchRequest) MarshalJSON added in v4.26.0 

func (o MultipleBatchRequest) MarshalJSON() ([]byte, error)

func (*MultipleBatchRequest) SetAction added in v4.26.0 

func (o *MultipleBatchRequest) SetAction(v Action) *MultipleBatchRequest

SetAction sets field value.

func (*MultipleBatchRequest) SetBody added in v4.26.0 

func (o *MultipleBatchRequest) SetBody(v *BatchCompositionAction) *MultipleBatchRequest

SetBody sets field value.

func (MultipleBatchRequest) String added in v4.26.0 

func (o MultipleBatchRequest) String() string

type MultipleBatchResponse added in v4.26.0 

type MultipleBatchResponse struct {
	// Task IDs. One for each index.
	TaskID map[string]int64 `json:"taskID"`
}

MultipleBatchResponse struct for MultipleBatchResponse.

func NewEmptyMultipleBatchResponse added in v4.26.0 

func NewEmptyMultipleBatchResponse() *MultipleBatchResponse

NewEmptyMultipleBatchResponse return a pointer to an empty MultipleBatchResponse object.

func NewMultipleBatchResponse added in v4.26.0 

func NewMultipleBatchResponse(taskID map[string]int64) *MultipleBatchResponse

NewMultipleBatchResponse instantiates a new MultipleBatchResponse object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed.

func (*MultipleBatchResponse) GetTaskID added in v4.26.0 

func (o *MultipleBatchResponse) GetTaskID() map[string]int64

GetTaskID returns the TaskID field value.

func (*MultipleBatchResponse) GetTaskIDOk added in v4.26.0 

func (o *MultipleBatchResponse) GetTaskIDOk() (*map[string]int64, bool)

GetTaskIDOk returns a tuple with the TaskID field value and a boolean to check if the value has been set.

func (MultipleBatchResponse) MarshalJSON added in v4.26.0 

func (o MultipleBatchResponse) MarshalJSON() ([]byte, error)

func (*MultipleBatchResponse) SetTaskID added in v4.26.0 

func (o *MultipleBatchResponse) SetTaskID(v map[string]int64) *MultipleBatchResponse

SetTaskID sets field value.

func (MultipleBatchResponse) String added in v4.26.0 

func (o MultipleBatchResponse) String() string

type NumericFilters 

type NumericFilters struct {
	ArrayOfNumericFilters *[]NumericFilters
	String                *string
}

NumericFilters - Filter by numeric facets. **Prefer using the `filters` parameter, which supports all filter types and combinations with boolean operators.** You can use numeric comparison operators: `<`, `<=`, `=`, `!=`, `>`, `>=`. Comparisons are precise up to 3 decimals. You can also provide ranges: `facet:<lower> TO <upper>`. The range includes the lower and upper boundaries. The same combination rules apply as for `facetFilters`.

func ArrayOfNumericFiltersAsNumericFilters 

func ArrayOfNumericFiltersAsNumericFilters(v []NumericFilters) *NumericFilters

[]NumericFiltersAsNumericFilters is a convenience function that returns []NumericFilters wrapped in NumericFilters.

func StringAsNumericFilters 

func StringAsNumericFilters(v string) *NumericFilters

stringAsNumericFilters is a convenience function that returns string wrapped in NumericFilters.

func (NumericFilters) GetActualInstance 

func (obj NumericFilters) GetActualInstance() any

Get the actual instance.

func (NumericFilters) MarshalJSON 

func (src NumericFilters) MarshalJSON() ([]byte, error)

Marshal data from the first non-nil pointers in the struct to JSON.

func (*NumericFilters) UnmarshalJSON 

func (dst *NumericFilters) UnmarshalJSON(data []byte) error

Unmarshal JSON data into one or more of the pointers in the struct.

type OptionalFilters 

type OptionalFilters struct {
	ArrayOfOptionalFilters *[]OptionalFilters
	String                 *string
}

OptionalFilters - Filters to promote or demote records in the search results. Optional filters work like facet filters, but they don't exclude records from the search results. Records that match the optional filter rank before records that don't match. If you're using a negative filter `facet:-value`, matching records rank after records that don't match. - Optional filters are applied _after_ sort-by attributes. - Optional filters are applied _before_ custom ranking attributes (in the default [ranking](https://www.algolia.com/doc/guides/managing-results/relevance-overview/in-depth/ranking-criteria)). - Optional filters don't work with numeric attributes. - On virtual replicas, optional filters are applied _after_ the replica's [relevant sort](https://www.algolia.com/doc/guides/managing-results/refine-results/sorting/in-depth/relevant-sort).

func ArrayOfOptionalFiltersAsOptionalFilters 

func ArrayOfOptionalFiltersAsOptionalFilters(v []OptionalFilters) *OptionalFilters

[]OptionalFiltersAsOptionalFilters is a convenience function that returns []OptionalFilters wrapped in OptionalFilters.

func StringAsOptionalFilters 

func StringAsOptionalFilters(v string) *OptionalFilters

stringAsOptionalFilters is a convenience function that returns string wrapped in OptionalFilters.

func (OptionalFilters) GetActualInstance 

func (obj OptionalFilters) GetActualInstance() any

Get the actual instance.

func (OptionalFilters) MarshalJSON 

func (src OptionalFilters) MarshalJSON() ([]byte, error)

Marshal data from the first non-nil pointers in the struct to JSON.

func (*OptionalFilters) UnmarshalJSON 

func (dst *OptionalFilters) UnmarshalJSON(data []byte) error

Unmarshal JSON data into one or more of the pointers in the struct.

type OptionalWords added in v4.26.0 

type OptionalWords struct {
	ArrayOfString *[]string
	String        *string
}

OptionalWords - Words that should be considered optional when found in the query. By default, records must match all words in the search query to be included in the search results. Adding optional words can increase the number of search results by running an additional search query that doesn't include the optional words. For example, if the search query is \"action video\" and \"video\" is optional, the search engine runs two queries: one for \"action video\" and one for \"action\". Records that match all words are ranked higher. For a search query with 4 or more words **and** all its words are optional, the number of matched words required for a record to be included in the search results increases for every 1,000 records: - If `optionalWords` has fewer than 10 words, the required number of matched words increases by 1: results 1 to 1,000 require 1 matched word; results 1,001 to 2,000 need 2 matched words. - If `optionalWords` has 10 or more words, the required number of matched words increases by the number of optional words divided by 5 (rounded down). Example: with 18 optional words, results 1 to 1,000 require 1 matched word; results 1,001 to 2,000 need 4 matched words. For more information, see [Optional words](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/empty-or-insufficient-results/#creating-a-list-of-optional-words).

func ArrayOfStringAsOptionalWords added in v4.26.0 

func ArrayOfStringAsOptionalWords(v []string) *OptionalWords

[]stringAsOptionalWords is a convenience function that returns []string wrapped in OptionalWords.

func StringAsOptionalWords added in v4.26.0 

func StringAsOptionalWords(v string) *OptionalWords

stringAsOptionalWords is a convenience function that returns string wrapped in OptionalWords.

func (OptionalWords) GetActualInstance added in v4.26.0 

func (obj OptionalWords) GetActualInstance() any

Get the actual instance.

func (OptionalWords) MarshalJSON added in v4.26.0 

func (src OptionalWords) MarshalJSON() ([]byte, error)

Marshal data from the first non-nil pointers in the struct to JSON.

func (*OptionalWords) UnmarshalJSON added in v4.26.0 

func (dst *OptionalWords) UnmarshalJSON(data []byte) error

Unmarshal JSON data into one or more of the pointers in the struct.

type Params 

type Params struct {
	// Whether this search will be included in Analytics.
	Analytics *bool `json:"analytics,omitempty"`
	// Tags to apply to the query for [segmenting analytics data](https://www.algolia.com/doc/guides/search-analytics/guides/segments).
	AnalyticsTags []string `json:"analyticsTags,omitempty"`
	// Coordinates for the center of a circle, expressed as a comma-separated string of latitude and longitude.  Only records included within a circle around this central location are included in the results. The radius of the circle is determined by the `aroundRadius` and `minimumAroundRadius` settings. This parameter is ignored if you also specify `insidePolygon` or `insideBoundingBox`.
	AroundLatLng *string `json:"aroundLatLng,omitempty"`
	// Whether to obtain the coordinates from the request's IP address.
	AroundLatLngViaIP *bool            `json:"aroundLatLngViaIP,omitempty"`
	AroundRadius      *AroundRadius    `json:"aroundRadius,omitempty"`
	AroundPrecision   *AroundPrecision `json:"aroundPrecision,omitempty"`
	// Whether to include a `queryID` attribute in the response The query ID is a unique identifier for a search query and is required for tracking [click and conversion events](https://www.algolia.com/doc/guides/sending-events/getting-started).
	ClickAnalytics *bool `json:"clickAnalytics,omitempty"`
	// Whether to enable index level A/B testing for this run request. If the composition mixes multiple indices, the A/B test is ignored.
	EnableABTest *bool `json:"enableABTest,omitempty"`
	// Whether to enable Personalization.
	EnablePersonalization *bool `json:"enablePersonalization,omitempty"`
	// Whether this search will use [Dynamic Re-Ranking](https://www.algolia.com/doc/guides/algolia-ai/re-ranking) This setting only has an effect if you activated Dynamic Re-Ranking for this index in the Algolia dashboard.
	EnableReRanking *bool `json:"enableReRanking,omitempty"`
	// Whether to enable composition rules.
	EnableRules  *bool         `json:"enableRules,omitempty"`
	FacetFilters *FacetFilters `json:"facetFilters,omitempty"`
	// Facets for which to retrieve facet values that match the search criteria and the number of matching facet values To retrieve all facets, use the wildcard character `*`. To retrieve disjunctive facets lists, annotate any facets with the `disjunctive` modifier. For more information, see [facets](https://www.algolia.com/doc/guides/managing-results/refine-results/faceting/#contextual-facet-values-and-counts) and [disjunctive faceting for Smart Groups](https://www.algolia.com/doc/guides/managing-results/compositions/search-based-groups#facets-including-disjunctive-faceting).
	Facets []string `json:"facets,omitempty"`
	// Filter expression to only include items that match the filter criteria in the response.  You can use these filter expressions:  - **Numeric filters.** `<facet> <op> <number>`, where `<op>` is one of `<`, `<=`, `=`, `!=`, `>`, `>=`. - **Ranges.** `<facet>:<lower> TO <upper>`, where `<lower>` and `<upper>` are the lower and upper limits of the range (inclusive). - **Facet filters.** `<facet>:<value>`, where `<facet>` is a facet attribute (case-sensitive) and `<value>` a facet value. - **Tag filters.** `_tags:<value>` or just `<value>` (case-sensitive). - **Boolean filters.** `<facet>: true | false`.  You can combine filters with `AND`, `OR`, and `NOT` operators with the following restrictions:  - You can only combine filters of the same type with `OR`.   **Not supported:** `facet:value OR num > 3`. - You can't use `NOT` with combinations of filters.   **Not supported:** `NOT(facet:value OR facet:value)` - You can't combine conjunctions (`AND`) with `OR`.   **Not supported:** `facet:value OR (facet:value AND facet:value)`  Use quotes if the facet attribute name or facet value contains spaces, keywords (`OR`, `AND`, `NOT`), or quotes. If a facet attribute is an array, the filter matches if it matches at least one element of the array.  For more information, see [Filters](https://www.algolia.com/doc/guides/managing-results/refine-results/filtering).
	Filters *string `json:"filters,omitempty"`
	// Whether the run response should include detailed ranking information.
	GetRankingInfo *bool `json:"getRankingInfo,omitempty"`
	// Number of hits per page.
	HitsPerPage *int32 `json:"hitsPerPage,omitempty"`
	// An object containing keys corresponding to the `key`s from an injection's `injectedItems` and values containing a list of hits to inject.
	InjectedItems     *map[string]ExternalInjectedItem  `json:"injectedItems,omitempty"`
	InsideBoundingBox utils.Nullable[InsideBoundingBox] `json:"insideBoundingBox,omitempty"`
	// Coordinates of a polygon in which to search.  Polygons are defined by 3 to 10,000 points. Each point is represented by its latitude and longitude. Provide multiple polygons as nested arrays. For more information, see [filtering inside polygons](https://www.algolia.com/doc/guides/managing-results/refine-results/geolocation/#filtering-inside-rectangular-or-polygonal-areas). This parameter is ignored if you also specify `insideBoundingBox`.
	InsidePolygon [][]float64 `json:"insidePolygon,omitempty"`
	// Minimum radius (in meters) for a search around a location when `aroundRadius` isn't set.
	MinimumAroundRadius *int32 `json:"minimumAroundRadius,omitempty"`
	// ISO language codes that adjust settings that are useful for processing natural language queries (as opposed to keyword searches) - Sets `removeStopWords` and `ignorePlurals` to the list of provided languages. - Sets `removeWordsIfNoResults` to `allOptional`. - Adds a `natural_language` attribute to `ruleContexts` and `analyticsTags`.
	NaturalLanguages []SupportedLanguage `json:"naturalLanguages,omitempty"`
	NumericFilters   *NumericFilters     `json:"numericFilters,omitempty"`
	OptionalFilters  *OptionalFilters    `json:"optionalFilters,omitempty"`
	// Page of search results to retrieve.
	Page *int32 `json:"page,omitempty"`
	// Search query.
	Query *string `json:"query,omitempty"`
	// Languages for language-specific query processing steps such as plurals, stop-word removal, and word-detection dictionaries. This setting sets a default list of languages used by the `removeStopWords` and `ignorePlurals` settings. This setting also sets a dictionary for word detection in the logogram-based [CJK](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/handling-natural-languages-nlp/in-depth/normalization/#normalization-for-logogram-based-languages-cjk) languages. To support this, place the CJK language **first**. **Always specify a query language.** If you don't specify an indexing language, the search engine uses all [supported languages](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/handling-natural-languages-nlp/in-depth/supported-languages), or the languages you specified with the `ignorePlurals` or `removeStopWords` parameters. This can lead to unexpected search results. For more information, see [Language-specific configuration](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/handling-natural-languages-nlp/in-depth/language-specific-configurations).
	QueryLanguages []SupportedLanguage `json:"queryLanguages,omitempty"`
	// Relevancy threshold below which less relevant results aren't included in the results You can only set `relevancyStrictness` on [virtual replica indices](https://www.algolia.com/doc/guides/managing-results/refine-results/sorting/in-depth/replicas/#what-are-virtual-replicas). Use this setting to strike a balance between the relevance and number of returned results.
	RelevancyStrictness *int32 `json:"relevancyStrictness,omitempty"`
	// Assigns a rule context to the run query [Rule contexts](https://www.algolia.com/doc/guides/managing-results/rules/rules-overview/how-to/customize-search-results-by-platform/#whats-a-context) are strings that you can use to trigger matching rules.
	RuleContexts []string `json:"ruleContexts,omitempty"`
	// Indicates which sorting strategy to apply for the request. The value must match one of the labels defined in the \"sortingStrategy\" mapping. For example, \"Price (asc)\", see Upsert Composition. At runtime, this label is used to look up the corresponding index or replica configured in \"sortingStrategy\", and the query is executed using that index instead of main's.  In addition to \"sortingStrategy\", this parameter is also used to apply a matching Composition Rule that contains a condition defined to trigger on \"sortBy\", see Composition Rules.  If no value is provided or an invalid value, no sorting strategy is applied.
	SortBy *string `json:"sortBy,omitempty"`
	// Unique pseudonymous or anonymous user identifier.  This helps with analytics and click and conversion events. For more information, see [user token](https://www.algolia.com/doc/guides/sending-events/concepts/usertoken).
	UserToken *string `json:"userToken,omitempty"`
}

Params struct for Params.

func NewEmptyParams 

func NewEmptyParams() *Params

NewEmptyParams return a pointer to an empty Params object.

func NewParams 

func NewParams(opts ...ParamsOption) *Params

NewParams instantiates a new Params object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed.

func (*Params) GetAnalytics 

func (o *Params) GetAnalytics() bool

GetAnalytics returns the Analytics field value if set, zero value otherwise.

func (*Params) GetAnalyticsOk 

func (o *Params) GetAnalyticsOk() (*bool, bool)

GetAnalyticsOk returns a tuple with the Analytics field value if set, nil otherwise and a boolean to check if the value has been set.

func (*Params) GetAnalyticsTags 

func (o *Params) GetAnalyticsTags() []string

GetAnalyticsTags returns the AnalyticsTags field value if set, zero value otherwise.

func (*Params) GetAnalyticsTagsOk 

func (o *Params) GetAnalyticsTagsOk() ([]string, bool)

GetAnalyticsTagsOk returns a tuple with the AnalyticsTags field value if set, nil otherwise and a boolean to check if the value has been set.

func (*Params) GetAroundLatLng 

func (o *Params) GetAroundLatLng() string

GetAroundLatLng returns the AroundLatLng field value if set, zero value otherwise.

func (*Params) GetAroundLatLngOk 

func (o *Params) GetAroundLatLngOk() (*string, bool)

GetAroundLatLngOk returns a tuple with the AroundLatLng field value if set, nil otherwise and a boolean to check if the value has been set.

func (*Params) GetAroundLatLngViaIP 

func (o *Params) GetAroundLatLngViaIP() bool

GetAroundLatLngViaIP returns the AroundLatLngViaIP field value if set, zero value otherwise.

func (*Params) GetAroundLatLngViaIPOk 

func (o *Params) GetAroundLatLngViaIPOk() (*bool, bool)

GetAroundLatLngViaIPOk returns a tuple with the AroundLatLngViaIP field value if set, nil otherwise and a boolean to check if the value has been set.

func (*Params) GetAroundPrecision 

func (o *Params) GetAroundPrecision() AroundPrecision

GetAroundPrecision returns the AroundPrecision field value if set, zero value otherwise.

func (*Params) GetAroundPrecisionOk 

func (o *Params) GetAroundPrecisionOk() (*AroundPrecision, bool)

GetAroundPrecisionOk returns a tuple with the AroundPrecision field value if set, nil otherwise and a boolean to check if the value has been set.

func (*Params) GetAroundRadius 

func (o *Params) GetAroundRadius() AroundRadius

GetAroundRadius returns the AroundRadius field value if set, zero value otherwise.

func (*Params) GetAroundRadiusOk 

func (o *Params) GetAroundRadiusOk() (*AroundRadius, bool)

GetAroundRadiusOk returns a tuple with the AroundRadius field value if set, nil otherwise and a boolean to check if the value has been set.

func (*Params) GetClickAnalytics 

func (o *Params) GetClickAnalytics() bool

GetClickAnalytics returns the ClickAnalytics field value if set, zero value otherwise.

func (*Params) GetClickAnalyticsOk 

func (o *Params) GetClickAnalyticsOk() (*bool, bool)

GetClickAnalyticsOk returns a tuple with the ClickAnalytics field value if set, nil otherwise and a boolean to check if the value has been set.

func (*Params) GetEnableABTest 

func (o *Params) GetEnableABTest() bool

GetEnableABTest returns the EnableABTest field value if set, zero value otherwise.

func (*Params) GetEnableABTestOk 

func (o *Params) GetEnableABTestOk() (*bool, bool)

GetEnableABTestOk returns a tuple with the EnableABTest field value if set, nil otherwise and a boolean to check if the value has been set.

func (*Params) GetEnablePersonalization added in v4.33.0 

func (o *Params) GetEnablePersonalization() bool

GetEnablePersonalization returns the EnablePersonalization field value if set, zero value otherwise.

func (*Params) GetEnablePersonalizationOk added in v4.33.0 

func (o *Params) GetEnablePersonalizationOk() (*bool, bool)

GetEnablePersonalizationOk returns a tuple with the EnablePersonalization field value if set, nil otherwise and a boolean to check if the value has been set.

func (*Params) GetEnableReRanking 

func (o *Params) GetEnableReRanking() bool

GetEnableReRanking returns the EnableReRanking field value if set, zero value otherwise.

func (*Params) GetEnableReRankingOk 

func (o *Params) GetEnableReRankingOk() (*bool, bool)

GetEnableReRankingOk returns a tuple with the EnableReRanking field value if set, nil otherwise and a boolean to check if the value has been set.

func (*Params) GetEnableRules 

func (o *Params) GetEnableRules() bool

GetEnableRules returns the EnableRules field value if set, zero value otherwise.

func (*Params) GetEnableRulesOk 

func (o *Params) GetEnableRulesOk() (*bool, bool)

GetEnableRulesOk returns a tuple with the EnableRules field value if set, nil otherwise and a boolean to check if the value has been set.

func (*Params) GetFacetFilters 

func (o *Params) GetFacetFilters() FacetFilters

GetFacetFilters returns the FacetFilters field value if set, zero value otherwise.

func (*Params) GetFacetFiltersOk 

func (o *Params) GetFacetFiltersOk() (*FacetFilters, bool)

GetFacetFiltersOk returns a tuple with the FacetFilters field value if set, nil otherwise and a boolean to check if the value has been set.

func (*Params) GetFacets added in v4.29.0 

func (o *Params) GetFacets() []string

GetFacets returns the Facets field value if set, zero value otherwise.

func (*Params) GetFacetsOk added in v4.29.0 

func (o *Params) GetFacetsOk() ([]string, bool)

GetFacetsOk returns a tuple with the Facets field value if set, nil otherwise and a boolean to check if the value has been set.

func (*Params) GetFilters 

func (o *Params) GetFilters() string

GetFilters returns the Filters field value if set, zero value otherwise.

func (*Params) GetFiltersOk 

func (o *Params) GetFiltersOk() (*string, bool)

GetFiltersOk returns a tuple with the Filters field value if set, nil otherwise and a boolean to check if the value has been set.

func (*Params) GetGetRankingInfo 

func (o *Params) GetGetRankingInfo() bool

GetGetRankingInfo returns the GetRankingInfo field value if set, zero value otherwise.

func (*Params) GetGetRankingInfoOk 

func (o *Params) GetGetRankingInfoOk() (*bool, bool)

GetGetRankingInfoOk returns a tuple with the GetRankingInfo field value if set, nil otherwise and a boolean to check if the value has been set.

func (*Params) GetHitsPerPage 

func (o *Params) GetHitsPerPage() int32

GetHitsPerPage returns the HitsPerPage field value if set, zero value otherwise.

func (*Params) GetHitsPerPageOk 

func (o *Params) GetHitsPerPageOk() (*int32, bool)

GetHitsPerPageOk returns a tuple with the HitsPerPage field value if set, nil otherwise and a boolean to check if the value has been set.

func (*Params) GetInjectedItems added in v4.25.0 

func (o *Params) GetInjectedItems() map[string]ExternalInjectedItem

GetInjectedItems returns the InjectedItems field value if set, zero value otherwise.

func (*Params) GetInjectedItemsOk added in v4.25.0 

func (o *Params) GetInjectedItemsOk() (*map[string]ExternalInjectedItem, bool)

GetInjectedItemsOk returns a tuple with the InjectedItems field value if set, nil otherwise and a boolean to check if the value has been set.

func (*Params) GetInsideBoundingBox 

func (o *Params) GetInsideBoundingBox() InsideBoundingBox

GetInsideBoundingBox returns the InsideBoundingBox field value if set, zero value otherwise (both if not set or set to explicit null).

func (*Params) GetInsideBoundingBoxOk 

func (o *Params) GetInsideBoundingBoxOk() (*InsideBoundingBox, bool)

GetInsideBoundingBoxOk returns a tuple with the InsideBoundingBox field value if set, nil otherwise and a boolean to check if the value has been set. NOTE: If the value is an explicit nil, `nil, true` will be returned.

func (*Params) GetInsidePolygon 

func (o *Params) GetInsidePolygon() [][]float64

GetInsidePolygon returns the InsidePolygon field value if set, zero value otherwise.

func (*Params) GetInsidePolygonOk 

func (o *Params) GetInsidePolygonOk() ([][]float64, bool)

GetInsidePolygonOk returns a tuple with the InsidePolygon field value if set, nil otherwise and a boolean to check if the value has been set.

func (*Params) GetMinimumAroundRadius 

func (o *Params) GetMinimumAroundRadius() int32

GetMinimumAroundRadius returns the MinimumAroundRadius field value if set, zero value otherwise.

func (*Params) GetMinimumAroundRadiusOk 

func (o *Params) GetMinimumAroundRadiusOk() (*int32, bool)

GetMinimumAroundRadiusOk returns a tuple with the MinimumAroundRadius field value if set, nil otherwise and a boolean to check if the value has been set.

func (*Params) GetNaturalLanguages 

func (o *Params) GetNaturalLanguages() []SupportedLanguage

GetNaturalLanguages returns the NaturalLanguages field value if set, zero value otherwise.

func (*Params) GetNaturalLanguagesOk 

func (o *Params) GetNaturalLanguagesOk() ([]SupportedLanguage, bool)

GetNaturalLanguagesOk returns a tuple with the NaturalLanguages field value if set, nil otherwise and a boolean to check if the value has been set.

func (*Params) GetNumericFilters 

func (o *Params) GetNumericFilters() NumericFilters

GetNumericFilters returns the NumericFilters field value if set, zero value otherwise.

func (*Params) GetNumericFiltersOk 

func (o *Params) GetNumericFiltersOk() (*NumericFilters, bool)

GetNumericFiltersOk returns a tuple with the NumericFilters field value if set, nil otherwise and a boolean to check if the value has been set.

func (*Params) GetOptionalFilters 

func (o *Params) GetOptionalFilters() OptionalFilters

GetOptionalFilters returns the OptionalFilters field value if set, zero value otherwise.

func (*Params) GetOptionalFiltersOk 

func (o *Params) GetOptionalFiltersOk() (*OptionalFilters, bool)

GetOptionalFiltersOk returns a tuple with the OptionalFilters field value if set, nil otherwise and a boolean to check if the value has been set.

func (*Params) GetPage 

func (o *Params) GetPage() int32

GetPage returns the Page field value if set, zero value otherwise.

func (*Params) GetPageOk 

func (o *Params) GetPageOk() (*int32, bool)

GetPageOk returns a tuple with the Page field value if set, nil otherwise and a boolean to check if the value has been set.

func (*Params) GetQuery 

func (o *Params) GetQuery() string

GetQuery returns the Query field value if set, zero value otherwise.

func (*Params) GetQueryLanguages 

func (o *Params) GetQueryLanguages() []SupportedLanguage

GetQueryLanguages returns the QueryLanguages field value if set, zero value otherwise.

func (*Params) GetQueryLanguagesOk 

func (o *Params) GetQueryLanguagesOk() ([]SupportedLanguage, bool)

GetQueryLanguagesOk returns a tuple with the QueryLanguages field value if set, nil otherwise and a boolean to check if the value has been set.

func (*Params) GetQueryOk 

func (o *Params) GetQueryOk() (*string, bool)

GetQueryOk returns a tuple with the Query field value if set, nil otherwise and a boolean to check if the value has been set.

func (*Params) GetRelevancyStrictness 

func (o *Params) GetRelevancyStrictness() int32

GetRelevancyStrictness returns the RelevancyStrictness field value if set, zero value otherwise.

func (*Params) GetRelevancyStrictnessOk 

func (o *Params) GetRelevancyStrictnessOk() (*int32, bool)

GetRelevancyStrictnessOk returns a tuple with the RelevancyStrictness field value if set, nil otherwise and a boolean to check if the value has been set.

func (*Params) GetRuleContexts 

func (o *Params) GetRuleContexts() []string

GetRuleContexts returns the RuleContexts field value if set, zero value otherwise.

func (*Params) GetRuleContextsOk 

func (o *Params) GetRuleContextsOk() ([]string, bool)

GetRuleContextsOk returns a tuple with the RuleContexts field value if set, nil otherwise and a boolean to check if the value has been set.

func (*Params) GetSortBy added in v4.34.0 

func (o *Params) GetSortBy() string

GetSortBy returns the SortBy field value if set, zero value otherwise.

func (*Params) GetSortByOk added in v4.34.0 

func (o *Params) GetSortByOk() (*string, bool)

GetSortByOk returns a tuple with the SortBy field value if set, nil otherwise and a boolean to check if the value has been set.

func (*Params) GetUserToken 

func (o *Params) GetUserToken() string

GetUserToken returns the UserToken field value if set, zero value otherwise.

func (*Params) GetUserTokenOk 

func (o *Params) GetUserTokenOk() (*string, bool)

GetUserTokenOk returns a tuple with the UserToken field value if set, nil otherwise and a boolean to check if the value has been set.

func (*Params) HasAnalytics 

func (o *Params) HasAnalytics() bool

HasAnalytics returns a boolean if a field has been set.

func (*Params) HasAnalyticsTags 

func (o *Params) HasAnalyticsTags() bool

HasAnalyticsTags returns a boolean if a field has been set.

func (*Params) HasAroundLatLng 

func (o *Params) HasAroundLatLng() bool

HasAroundLatLng returns a boolean if a field has been set.

func (*Params) HasAroundLatLngViaIP 

func (o *Params) HasAroundLatLngViaIP() bool

HasAroundLatLngViaIP returns a boolean if a field has been set.

func (*Params) HasAroundPrecision 

func (o *Params) HasAroundPrecision() bool

HasAroundPrecision returns a boolean if a field has been set.

func (*Params) HasAroundRadius 

func (o *Params) HasAroundRadius() bool

HasAroundRadius returns a boolean if a field has been set.

func (*Params) HasClickAnalytics 

func (o *Params) HasClickAnalytics() bool

HasClickAnalytics returns a boolean if a field has been set.

func (*Params) HasEnableABTest 

func (o *Params) HasEnableABTest() bool

HasEnableABTest returns a boolean if a field has been set.

func (*Params) HasEnablePersonalization added in v4.33.0 

func (o *Params) HasEnablePersonalization() bool

HasEnablePersonalization returns a boolean if a field has been set.

func (*Params) HasEnableReRanking 

func (o *Params) HasEnableReRanking() bool

HasEnableReRanking returns a boolean if a field has been set.

func (*Params) HasEnableRules 

func (o *Params) HasEnableRules() bool

HasEnableRules returns a boolean if a field has been set.

func (*Params) HasFacetFilters 

func (o *Params) HasFacetFilters() bool

HasFacetFilters returns a boolean if a field has been set.

func (*Params) HasFacets added in v4.29.0 

func (o *Params) HasFacets() bool

HasFacets returns a boolean if a field has been set.

func (*Params) HasFilters 

func (o *Params) HasFilters() bool

HasFilters returns a boolean if a field has been set.

func (*Params) HasGetRankingInfo 

func (o *Params) HasGetRankingInfo() bool

HasGetRankingInfo returns a boolean if a field has been set.

func (*Params) HasHitsPerPage 

func (o *Params) HasHitsPerPage() bool

HasHitsPerPage returns a boolean if a field has been set.

func (*Params) HasInjectedItems added in v4.25.0 

func (o *Params) HasInjectedItems() bool

HasInjectedItems returns a boolean if a field has been set.

func (*Params) HasInsideBoundingBox 

func (o *Params) HasInsideBoundingBox() bool

HasInsideBoundingBox returns a boolean if a field has been set.

func (*Params) HasInsidePolygon 

func (o *Params) HasInsidePolygon() bool

HasInsidePolygon returns a boolean if a field has been set.

func (*Params) HasMinimumAroundRadius 

func (o *Params) HasMinimumAroundRadius() bool

HasMinimumAroundRadius returns a boolean if a field has been set.

func (*Params) HasNaturalLanguages 

func (o *Params) HasNaturalLanguages() bool

HasNaturalLanguages returns a boolean if a field has been set.

func (*Params) HasNumericFilters 

func (o *Params) HasNumericFilters() bool

HasNumericFilters returns a boolean if a field has been set.

func (*Params) HasOptionalFilters 

func (o *Params) HasOptionalFilters() bool

HasOptionalFilters returns a boolean if a field has been set.

func (*Params) HasPage 

func (o *Params) HasPage() bool

HasPage returns a boolean if a field has been set.

func (*Params) HasQuery 

func (o *Params) HasQuery() bool

HasQuery returns a boolean if a field has been set.

func (*Params) HasQueryLanguages 

func (o *Params) HasQueryLanguages() bool

HasQueryLanguages returns a boolean if a field has been set.

func (*Params) HasRelevancyStrictness 

func (o *Params) HasRelevancyStrictness() bool

HasRelevancyStrictness returns a boolean if a field has been set.

func (*Params) HasRuleContexts 

func (o *Params) HasRuleContexts() bool

HasRuleContexts returns a boolean if a field has been set.

func (*Params) HasSortBy added in v4.34.0 

func (o *Params) HasSortBy() bool

HasSortBy returns a boolean if a field has been set.

func (*Params) HasUserToken 

func (o *Params) HasUserToken() bool

HasUserToken returns a boolean if a field has been set.

func (Params) MarshalJSON 

func (o Params) MarshalJSON() ([]byte, error)

func (*Params) SetAnalytics 

func (o *Params) SetAnalytics(v bool) *Params

SetAnalytics gets a reference to the given bool and assigns it to the Analytics field.

func (*Params) SetAnalyticsTags 

func (o *Params) SetAnalyticsTags(v []string) *Params

SetAnalyticsTags gets a reference to the given []string and assigns it to the AnalyticsTags field.

func (*Params) SetAroundLatLng 

func (o *Params) SetAroundLatLng(v string) *Params

SetAroundLatLng gets a reference to the given string and assigns it to the AroundLatLng field.

func (*Params) SetAroundLatLngViaIP 

func (o *Params) SetAroundLatLngViaIP(v bool) *Params

SetAroundLatLngViaIP gets a reference to the given bool and assigns it to the AroundLatLngViaIP field.

func (*Params) SetAroundPrecision 

func (o *Params) SetAroundPrecision(v *AroundPrecision) *Params

SetAroundPrecision gets a reference to the given AroundPrecision and assigns it to the AroundPrecision field.

func (*Params) SetAroundRadius 

func (o *Params) SetAroundRadius(v *AroundRadius) *Params

SetAroundRadius gets a reference to the given AroundRadius and assigns it to the AroundRadius field.

func (*Params) SetClickAnalytics 

func (o *Params) SetClickAnalytics(v bool) *Params

SetClickAnalytics gets a reference to the given bool and assigns it to the ClickAnalytics field.

func (*Params) SetEnableABTest 

func (o *Params) SetEnableABTest(v bool) *Params

SetEnableABTest gets a reference to the given bool and assigns it to the EnableABTest field.

func (*Params) SetEnablePersonalization added in v4.33.0 

func (o *Params) SetEnablePersonalization(v bool) *Params

SetEnablePersonalization gets a reference to the given bool and assigns it to the EnablePersonalization field.

func (*Params) SetEnableReRanking 

func (o *Params) SetEnableReRanking(v bool) *Params

SetEnableReRanking gets a reference to the given bool and assigns it to the EnableReRanking field.

func (*Params) SetEnableRules 

func (o *Params) SetEnableRules(v bool) *Params

SetEnableRules gets a reference to the given bool and assigns it to the EnableRules field.

func (*Params) SetFacetFilters 

func (o *Params) SetFacetFilters(v *FacetFilters) *Params

SetFacetFilters gets a reference to the given FacetFilters and assigns it to the FacetFilters field.

func (*Params) SetFacets added in v4.29.0 

func (o *Params) SetFacets(v []string) *Params

SetFacets gets a reference to the given []string and assigns it to the Facets field.

func (*Params) SetFilters 

func (o *Params) SetFilters(v string) *Params

SetFilters gets a reference to the given string and assigns it to the Filters field.

func (*Params) SetGetRankingInfo 

func (o *Params) SetGetRankingInfo(v bool) *Params

SetGetRankingInfo gets a reference to the given bool and assigns it to the GetRankingInfo field.

func (*Params) SetHitsPerPage 

func (o *Params) SetHitsPerPage(v int32) *Params

SetHitsPerPage gets a reference to the given int32 and assigns it to the HitsPerPage field.

func (*Params) SetInjectedItems added in v4.25.0 

func (o *Params) SetInjectedItems(v map[string]ExternalInjectedItem) *Params

SetInjectedItems gets a reference to the given map[string]ExternalInjectedItem and assigns it to the InjectedItems field.

func (*Params) SetInsideBoundingBox 

func (o *Params) SetInsideBoundingBox(v *InsideBoundingBox) *Params

SetInsideBoundingBox gets a reference to the given utils.Nullable[InsideBoundingBox] and assigns it to the InsideBoundingBox field.

func (*Params) SetInsideBoundingBoxNil 

func (o *Params) SetInsideBoundingBoxNil()

SetInsideBoundingBoxNil sets the value for InsideBoundingBox to be an explicit nil.

func (*Params) SetInsidePolygon 

func (o *Params) SetInsidePolygon(v [][]float64) *Params

SetInsidePolygon gets a reference to the given [][]float64 and assigns it to the InsidePolygon field.

func (*Params) SetMinimumAroundRadius 

func (o *Params) SetMinimumAroundRadius(v int32) *Params

SetMinimumAroundRadius gets a reference to the given int32 and assigns it to the MinimumAroundRadius field.

func (*Params) SetNaturalLanguages 

func (o *Params) SetNaturalLanguages(v []SupportedLanguage) *Params

SetNaturalLanguages gets a reference to the given []SupportedLanguage and assigns it to the NaturalLanguages field.

func (*Params) SetNumericFilters 

func (o *Params) SetNumericFilters(v *NumericFilters) *Params

SetNumericFilters gets a reference to the given NumericFilters and assigns it to the NumericFilters field.

func (*Params) SetOptionalFilters 

func (o *Params) SetOptionalFilters(v *OptionalFilters) *Params

SetOptionalFilters gets a reference to the given OptionalFilters and assigns it to the OptionalFilters field.

func (*Params) SetPage 

func (o *Params) SetPage(v int32) *Params

SetPage gets a reference to the given int32 and assigns it to the Page field.

func (*Params) SetQuery 

func (o *Params) SetQuery(v string) *Params

SetQuery gets a reference to the given string and assigns it to the Query field.

func (*Params) SetQueryLanguages 

func (o *Params) SetQueryLanguages(v []SupportedLanguage) *Params

SetQueryLanguages gets a reference to the given []SupportedLanguage and assigns it to the QueryLanguages field.

func (*Params) SetRelevancyStrictness 

func (o *Params) SetRelevancyStrictness(v int32) *Params

SetRelevancyStrictness gets a reference to the given int32 and assigns it to the RelevancyStrictness field.

func (*Params) SetRuleContexts 

func (o *Params) SetRuleContexts(v []string) *Params

SetRuleContexts gets a reference to the given []string and assigns it to the RuleContexts field.

func (*Params) SetSortBy added in v4.34.0 

func (o *Params) SetSortBy(v string) *Params

SetSortBy gets a reference to the given string and assigns it to the SortBy field.

func (*Params) SetUserToken 

func (o *Params) SetUserToken(v string) *Params

SetUserToken gets a reference to the given string and assigns it to the UserToken field.

func (Params) String 

func (o Params) String() string

func (*Params) UnsetInsideBoundingBox 

func (o *Params) UnsetInsideBoundingBox()

UnsetInsideBoundingBox ensures that no value is present for InsideBoundingBox, not even an explicit nil.

type ParamsOption 

type ParamsOption func(f *Params)

func WithParamsAnalytics 

func WithParamsAnalytics(val bool) ParamsOption

func WithParamsAnalyticsTags 

func WithParamsAnalyticsTags(val []string) ParamsOption

func WithParamsAroundLatLng 

func WithParamsAroundLatLng(val string) ParamsOption

func WithParamsAroundLatLngViaIP 

func WithParamsAroundLatLngViaIP(val bool) ParamsOption

func WithParamsAroundPrecision 

func WithParamsAroundPrecision(val AroundPrecision) ParamsOption

func WithParamsAroundRadius 

func WithParamsAroundRadius(val AroundRadius) ParamsOption

func WithParamsClickAnalytics 

func WithParamsClickAnalytics(val bool) ParamsOption

func WithParamsEnableABTest 

func WithParamsEnableABTest(val bool) ParamsOption

func WithParamsEnablePersonalization added in v4.33.0 

func WithParamsEnablePersonalization(val bool) ParamsOption

func WithParamsEnableReRanking 

func WithParamsEnableReRanking(val bool) ParamsOption

func WithParamsEnableRules 

func WithParamsEnableRules(val bool) ParamsOption

func WithParamsFacetFilters 

func WithParamsFacetFilters(val FacetFilters) ParamsOption

func WithParamsFacets added in v4.29.0 

func WithParamsFacets(val []string) ParamsOption

func WithParamsFilters 

func WithParamsFilters(val string) ParamsOption

func WithParamsGetRankingInfo 

func WithParamsGetRankingInfo(val bool) ParamsOption

func WithParamsHitsPerPage 

func WithParamsHitsPerPage(val int32) ParamsOption

func WithParamsInjectedItems added in v4.25.0 

func WithParamsInjectedItems(val map[string]ExternalInjectedItem) ParamsOption

func WithParamsInsideBoundingBox 

func WithParamsInsideBoundingBox(val utils.Nullable[InsideBoundingBox]) ParamsOption

func WithParamsInsidePolygon 

func WithParamsInsidePolygon(val [][]float64) ParamsOption

func WithParamsMinimumAroundRadius 

func WithParamsMinimumAroundRadius(val int32) ParamsOption

func WithParamsNaturalLanguages 

func WithParamsNaturalLanguages(val []SupportedLanguage) ParamsOption

func WithParamsNumericFilters 

func WithParamsNumericFilters(val NumericFilters) ParamsOption

func WithParamsOptionalFilters 

func WithParamsOptionalFilters(val OptionalFilters) ParamsOption

func WithParamsPage 

func WithParamsPage(val int32) ParamsOption

func WithParamsQuery 

func WithParamsQuery(val string) ParamsOption

func WithParamsQueryLanguages 

func WithParamsQueryLanguages(val []SupportedLanguage) ParamsOption

func WithParamsRelevancyStrictness 

func WithParamsRelevancyStrictness(val int32) ParamsOption

func WithParamsRuleContexts 

func WithParamsRuleContexts(val []string) ParamsOption

func WithParamsSortBy added in v4.34.0 

func WithParamsSortBy(val string) ParamsOption

func WithParamsUserToken 

func WithParamsUserToken(val string) ParamsOption

type Personalization 

type Personalization struct {
	// The score of the filters.
	FiltersScore *int32 `json:"filtersScore,omitempty"`
	// The score of the ranking.
	RankingScore *int32 `json:"rankingScore,omitempty"`
	// The score of the event.
	Score *int32 `json:"score,omitempty"`
}

Personalization struct for Personalization.

func NewEmptyPersonalization 

func NewEmptyPersonalization() *Personalization

NewEmptyPersonalization return a pointer to an empty Personalization object.

func NewPersonalization 

func NewPersonalization(opts ...PersonalizationOption) *Personalization

NewPersonalization instantiates a new Personalization object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed.

func (*Personalization) GetFiltersScore 

func (o *Personalization) GetFiltersScore() int32

GetFiltersScore returns the FiltersScore field value if set, zero value otherwise.

func (*Personalization) GetFiltersScoreOk 

func (o *Personalization) GetFiltersScoreOk() (*int32, bool)

GetFiltersScoreOk returns a tuple with the FiltersScore field value if set, nil otherwise and a boolean to check if the value has been set.

func (*Personalization) GetRankingScore 

func (o *Personalization) GetRankingScore() int32

GetRankingScore returns the RankingScore field value if set, zero value otherwise.

func (*Personalization) GetRankingScoreOk 

func (o *Personalization) GetRankingScoreOk() (*int32, bool)

GetRankingScoreOk returns a tuple with the RankingScore field value if set, nil otherwise and a boolean to check if the value has been set.

func (*Personalization) GetScore 

func (o *Personalization) GetScore() int32

GetScore returns the Score field value if set, zero value otherwise.

func (*Personalization) GetScoreOk 

func (o *Personalization) GetScoreOk() (*int32, bool)

GetScoreOk returns a tuple with the Score field value if set, nil otherwise and a boolean to check if the value has been set.

func (*Personalization) HasFiltersScore 

func (o *Personalization) HasFiltersScore() bool

HasFiltersScore returns a boolean if a field has been set.

func (*Personalization) HasRankingScore 

func (o *Personalization) HasRankingScore() bool

HasRankingScore returns a boolean if a field has been set.

func (*Personalization) HasScore 

func (o *Personalization) HasScore() bool

HasScore returns a boolean if a field has been set.

func (Personalization) MarshalJSON 

func (o Personalization) MarshalJSON() ([]byte, error)

func (*Personalization) SetFiltersScore 

func (o *Personalization) SetFiltersScore(v int32) *Personalization

SetFiltersScore gets a reference to the given int32 and assigns it to the FiltersScore field.

func (*Personalization) SetRankingScore 

func (o *Personalization) SetRankingScore(v int32) *Personalization

SetRankingScore gets a reference to the given int32 and assigns it to the RankingScore field.

func (*Personalization) SetScore 

func (o *Personalization) SetScore(v int32) *Personalization

SetScore gets a reference to the given int32 and assigns it to the Score field.

func (Personalization) String 

func (o Personalization) String() string

type PersonalizationOption 

type PersonalizationOption func(f *Personalization)

func WithPersonalizationFiltersScore 

func WithPersonalizationFiltersScore(val int32) PersonalizationOption

func WithPersonalizationRankingScore 

func WithPersonalizationRankingScore(val int32) PersonalizationOption

func WithPersonalizationScore 

func WithPersonalizationScore(val int32) PersonalizationOption

type QueryType added in v4.26.0 

type QueryType string

QueryType Determines if and how query words are interpreted as prefixes. By default, only the last query word is treated as a prefix (`prefixLast`). To turn off prefix search, use `prefixNone`. Avoid `prefixAll`, which treats all query words as prefixes. This might lead to counterintuitive results and makes your search slower. For more information, see [Prefix searching](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/override-search-engine-defaults/in-depth/prefix-searching). 

const (
	QUERY_TYPE_PREFIX_LAST QueryType = "prefixLast"
	QUERY_TYPE_PREFIX_ALL  QueryType = "prefixAll"
	QUERY_TYPE_PREFIX_NONE QueryType = "prefixNone"
)

List of queryType.

func NewQueryTypeFromValue added in v4.26.0 

func NewQueryTypeFromValue(v string) (*QueryType, error)

NewQueryTypeFromValue returns a pointer to a valid QueryType. for the value passed as argument, or an error if the value passed is not allowed by the enum.

func (QueryType) IsValid added in v4.26.0 

func (v QueryType) IsValid() bool

IsValid return true if the value is valid for the enum, false otherwise.

func (QueryType) Ptr added in v4.26.0 

func (v QueryType) Ptr() *QueryType

Ptr returns reference to queryType value.

func (*QueryType) UnmarshalJSON added in v4.26.0 

func (v *QueryType) UnmarshalJSON(src []byte) error

type Recommend added in v4.38.0 

type Recommend struct {
	// Index to retrieve recommendations from.
	IndexName string `json:"indexName"`
	Model     Model  `json:"model"`
	// Minimum score a recommendation must have to be included.
	Threshold          int32                         `json:"threshold"`
	QueryParameters    *BaseInjectionQueryParameters `json:"queryParameters,omitempty"`
	FallbackParameters *BaseInjectionQueryParameters `json:"fallbackParameters,omitempty"`
}

Recommend struct for Recommend.

func NewEmptyRecommend added in v4.38.0 

func NewEmptyRecommend() *Recommend

NewEmptyRecommend return a pointer to an empty Recommend object.

func NewRecommend added in v4.38.0 

func NewRecommend(indexName string, model Model, threshold int32, opts ...RecommendOption) *Recommend

NewRecommend instantiates a new Recommend object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed.

func (*Recommend) GetFallbackParameters added in v4.38.0 

func (o *Recommend) GetFallbackParameters() BaseInjectionQueryParameters

GetFallbackParameters returns the FallbackParameters field value if set, zero value otherwise.

func (*Recommend) GetFallbackParametersOk added in v4.38.0 

func (o *Recommend) GetFallbackParametersOk() (*BaseInjectionQueryParameters, bool)

GetFallbackParametersOk returns a tuple with the FallbackParameters field value if set, nil otherwise and a boolean to check if the value has been set.

func (*Recommend) GetIndexName added in v4.38.0 

func (o *Recommend) GetIndexName() string

GetIndexName returns the IndexName field value.

func (*Recommend) GetIndexNameOk added in v4.38.0 

func (o *Recommend) GetIndexNameOk() (*string, bool)

GetIndexNameOk returns a tuple with the IndexName field value and a boolean to check if the value has been set.

func (*Recommend) GetModel added in v4.38.0 

func (o *Recommend) GetModel() Model

GetModel returns the Model field value.

func (*Recommend) GetModelOk added in v4.38.0 

func (o *Recommend) GetModelOk() (*Model, bool)

GetModelOk returns a tuple with the Model field value and a boolean to check if the value has been set.

func (*Recommend) GetQueryParameters added in v4.38.0 

func (o *Recommend) GetQueryParameters() BaseInjectionQueryParameters

GetQueryParameters returns the QueryParameters field value if set, zero value otherwise.

func (*Recommend) GetQueryParametersOk added in v4.38.0 

func (o *Recommend) GetQueryParametersOk() (*BaseInjectionQueryParameters, bool)

GetQueryParametersOk returns a tuple with the QueryParameters field value if set, nil otherwise and a boolean to check if the value has been set.

func (*Recommend) GetThreshold added in v4.38.0 

func (o *Recommend) GetThreshold() int32

GetThreshold returns the Threshold field value.

func (*Recommend) GetThresholdOk added in v4.38.0 

func (o *Recommend) GetThresholdOk() (*int32, bool)

GetThresholdOk returns a tuple with the Threshold field value and a boolean to check if the value has been set.

func (*Recommend) HasFallbackParameters added in v4.38.0 

func (o *Recommend) HasFallbackParameters() bool

HasFallbackParameters returns a boolean if a field has been set.

func (*Recommend) HasQueryParameters added in v4.38.0 

func (o *Recommend) HasQueryParameters() bool

HasQueryParameters returns a boolean if a field has been set.

func (Recommend) MarshalJSON added in v4.38.0 

func (o Recommend) MarshalJSON() ([]byte, error)

func (*Recommend) SetFallbackParameters added in v4.38.0 

func (o *Recommend) SetFallbackParameters(v *BaseInjectionQueryParameters) *Recommend

SetFallbackParameters gets a reference to the given BaseInjectionQueryParameters and assigns it to the FallbackParameters field.

func (*Recommend) SetIndexName added in v4.38.0 

func (o *Recommend) SetIndexName(v string) *Recommend

SetIndexName sets field value.

func (*Recommend) SetModel added in v4.38.0 

func (o *Recommend) SetModel(v Model) *Recommend

SetModel sets field value.

func (*Recommend) SetQueryParameters added in v4.38.0 

func (o *Recommend) SetQueryParameters(v *BaseInjectionQueryParameters) *Recommend

SetQueryParameters gets a reference to the given BaseInjectionQueryParameters and assigns it to the QueryParameters field.

func (*Recommend) SetThreshold added in v4.38.0 

func (o *Recommend) SetThreshold(v int32) *Recommend

SetThreshold sets field value.

func (Recommend) String added in v4.38.0 

func (o Recommend) String() string

type RecommendOption added in v4.38.0 

type RecommendOption func(f *Recommend)

func WithRecommendFallbackParameters added in v4.38.0 

func WithRecommendFallbackParameters(val BaseInjectionQueryParameters) RecommendOption

func WithRecommendQueryParameters added in v4.38.0 

func WithRecommendQueryParameters(val BaseInjectionQueryParameters) RecommendOption

type Redirect 

type Redirect struct {
	Index []RedirectRuleIndexMetadata `json:"index,omitempty"`
}

Redirect [Redirect results to a URL](https://www.algolia.com/doc/guides/managing-results/rules/merchandising-and-promoting/how-to/redirects), this this parameter is for internal use only.

func NewEmptyRedirect 

func NewEmptyRedirect() *Redirect

NewEmptyRedirect return a pointer to an empty Redirect object.

func NewRedirect 

func NewRedirect(opts ...RedirectOption) *Redirect

NewRedirect instantiates a new Redirect object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed.

func (*Redirect) GetIndex 

func (o *Redirect) GetIndex() []RedirectRuleIndexMetadata

GetIndex returns the Index field value if set, zero value otherwise.

func (*Redirect) GetIndexOk 

func (o *Redirect) GetIndexOk() ([]RedirectRuleIndexMetadata, bool)

GetIndexOk returns a tuple with the Index field value if set, nil otherwise and a boolean to check if the value has been set.

func (*Redirect) HasIndex 

func (o *Redirect) HasIndex() bool

HasIndex returns a boolean if a field has been set.

func (Redirect) MarshalJSON 

func (o Redirect) MarshalJSON() ([]byte, error)

func (*Redirect) SetIndex 

func (o *Redirect) SetIndex(v []RedirectRuleIndexMetadata) *Redirect

SetIndex gets a reference to the given []RedirectRuleIndexMetadata and assigns it to the Index field.

func (Redirect) String 

func (o Redirect) String() string

type RedirectOption 

type RedirectOption func(f *Redirect)

func WithRedirectIndex 

func WithRedirectIndex(val []RedirectRuleIndexMetadata) RedirectOption

type RedirectRuleIndexData 

type RedirectRuleIndexData struct {
	RuleObjectID string `json:"ruleObjectID"`
}

RedirectRuleIndexData Redirect rule data.

func NewEmptyRedirectRuleIndexData 

func NewEmptyRedirectRuleIndexData() *RedirectRuleIndexData

NewEmptyRedirectRuleIndexData return a pointer to an empty RedirectRuleIndexData object.

func NewRedirectRuleIndexData 

func NewRedirectRuleIndexData(ruleObjectID string) *RedirectRuleIndexData

NewRedirectRuleIndexData instantiates a new RedirectRuleIndexData object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed.

func (*RedirectRuleIndexData) GetRuleObjectID 

func (o *RedirectRuleIndexData) GetRuleObjectID() string

GetRuleObjectID returns the RuleObjectID field value.

func (*RedirectRuleIndexData) GetRuleObjectIDOk 

func (o *RedirectRuleIndexData) GetRuleObjectIDOk() (*string, bool)

GetRuleObjectIDOk returns a tuple with the RuleObjectID field value and a boolean to check if the value has been set.

func (RedirectRuleIndexData) MarshalJSON 

func (o RedirectRuleIndexData) MarshalJSON() ([]byte, error)

func (*RedirectRuleIndexData) SetRuleObjectID 

func (o *RedirectRuleIndexData) SetRuleObjectID(v string) *RedirectRuleIndexData

SetRuleObjectID sets field value.

func (RedirectRuleIndexData) String 

func (o RedirectRuleIndexData) String() string

type RedirectRuleIndexMetadata 

type RedirectRuleIndexMetadata struct {
	// Source index for the redirect rule.
	Source string `json:"source"`
	// Destination index for the redirect rule.
	Dest string `json:"dest"`
	// Reason for the redirect rule.
	Reason string `json:"reason"`
	// Redirect rule status.
	Succeed bool                  `json:"succeed"`
	Data    RedirectRuleIndexData `json:"data"`
}

RedirectRuleIndexMetadata struct for RedirectRuleIndexMetadata.

func NewEmptyRedirectRuleIndexMetadata 

func NewEmptyRedirectRuleIndexMetadata() *RedirectRuleIndexMetadata

NewEmptyRedirectRuleIndexMetadata return a pointer to an empty RedirectRuleIndexMetadata object.

func NewRedirectRuleIndexMetadata 

func NewRedirectRuleIndexMetadata(source string, dest string, reason string, succeed bool, data RedirectRuleIndexData) *RedirectRuleIndexMetadata

NewRedirectRuleIndexMetadata instantiates a new RedirectRuleIndexMetadata object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed.

func (*RedirectRuleIndexMetadata) GetData 

func (o *RedirectRuleIndexMetadata) GetData() RedirectRuleIndexData

GetData returns the Data field value.

func (*RedirectRuleIndexMetadata) GetDataOk 

func (o *RedirectRuleIndexMetadata) GetDataOk() (*RedirectRuleIndexData, bool)

GetDataOk returns a tuple with the Data field value and a boolean to check if the value has been set.

func (*RedirectRuleIndexMetadata) GetDest 

func (o *RedirectRuleIndexMetadata) GetDest() string

GetDest returns the Dest field value.

func (*RedirectRuleIndexMetadata) GetDestOk 

func (o *RedirectRuleIndexMetadata) GetDestOk() (*string, bool)

GetDestOk returns a tuple with the Dest field value and a boolean to check if the value has been set.

func (*RedirectRuleIndexMetadata) GetReason 

func (o *RedirectRuleIndexMetadata) GetReason() string

GetReason returns the Reason field value.

func (*RedirectRuleIndexMetadata) GetReasonOk 

func (o *RedirectRuleIndexMetadata) GetReasonOk() (*string, bool)

GetReasonOk returns a tuple with the Reason field value and a boolean to check if the value has been set.

func (*RedirectRuleIndexMetadata) GetSource 

func (o *RedirectRuleIndexMetadata) GetSource() string

GetSource returns the Source field value.

func (*RedirectRuleIndexMetadata) GetSourceOk 

func (o *RedirectRuleIndexMetadata) GetSourceOk() (*string, bool)

GetSourceOk returns a tuple with the Source field value and a boolean to check if the value has been set.

func (*RedirectRuleIndexMetadata) GetSucceed 

func (o *RedirectRuleIndexMetadata) GetSucceed() bool

GetSucceed returns the Succeed field value.

func (*RedirectRuleIndexMetadata) GetSucceedOk 

func (o *RedirectRuleIndexMetadata) GetSucceedOk() (*bool, bool)

GetSucceedOk returns a tuple with the Succeed field value and a boolean to check if the value has been set.

func (RedirectRuleIndexMetadata) MarshalJSON 

func (o RedirectRuleIndexMetadata) MarshalJSON() ([]byte, error)

func (*RedirectRuleIndexMetadata) SetData 

func (o *RedirectRuleIndexMetadata) SetData(v *RedirectRuleIndexData) *RedirectRuleIndexMetadata

SetData sets field value.

func (*RedirectRuleIndexMetadata) SetDest 

func (o *RedirectRuleIndexMetadata) SetDest(v string) *RedirectRuleIndexMetadata

SetDest sets field value.

func (*RedirectRuleIndexMetadata) SetReason 

func (o *RedirectRuleIndexMetadata) SetReason(v string) *RedirectRuleIndexMetadata

SetReason sets field value.

func (*RedirectRuleIndexMetadata) SetSource 

func (o *RedirectRuleIndexMetadata) SetSource(v string) *RedirectRuleIndexMetadata

SetSource sets field value.

func (*RedirectRuleIndexMetadata) SetSucceed 

func (o *RedirectRuleIndexMetadata) SetSucceed(v bool) *RedirectRuleIndexMetadata

SetSucceed sets field value.

func (RedirectRuleIndexMetadata) String 

func (o RedirectRuleIndexMetadata) String() string

type RedirectURL 

type RedirectURL struct {
	Url *string `json:"url,omitempty"`
}

RedirectURL The redirect rule container.

func NewEmptyRedirectURL 

func NewEmptyRedirectURL() *RedirectURL

NewEmptyRedirectURL return a pointer to an empty RedirectURL object.

func NewRedirectURL 

func NewRedirectURL(opts ...RedirectURLOption) *RedirectURL

NewRedirectURL instantiates a new RedirectURL object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed.

func (*RedirectURL) GetUrl 

func (o *RedirectURL) GetUrl() string

GetUrl returns the Url field value if set, zero value otherwise.

func (*RedirectURL) GetUrlOk 

func (o *RedirectURL) GetUrlOk() (*string, bool)

GetUrlOk returns a tuple with the Url field value if set, nil otherwise and a boolean to check if the value has been set.

func (*RedirectURL) HasUrl 

func (o *RedirectURL) HasUrl() bool

HasUrl returns a boolean if a field has been set.

func (RedirectURL) MarshalJSON 

func (o RedirectURL) MarshalJSON() ([]byte, error)

func (*RedirectURL) SetUrl 

func (o *RedirectURL) SetUrl(v string) *RedirectURL

SetUrl gets a reference to the given string and assigns it to the Url field.

func (RedirectURL) String 

func (o RedirectURL) String() string

type RedirectURLOption 

type RedirectURLOption func(f *RedirectURL)

func WithRedirectURLUrl 

func WithRedirectURLUrl(val string) RedirectURLOption

type RemoveStopWords added in v4.26.0 

type RemoveStopWords struct {
	ArrayOfSupportedLanguage *[]SupportedLanguage
	Bool                     *bool
}

RemoveStopWords - Removes stop words from the search query. Stop words are common words like articles, conjunctions, prepositions, or pronouns that have little or no meaning on their own. In English, \"the\", \"a\", or \"and\" are stop words. Only use this feature for the languages used in your index.

func ArrayOfSupportedLanguageAsRemoveStopWords added in v4.26.0 

func ArrayOfSupportedLanguageAsRemoveStopWords(v []SupportedLanguage) *RemoveStopWords

[]SupportedLanguageAsRemoveStopWords is a convenience function that returns []SupportedLanguage wrapped in RemoveStopWords.

func BoolAsRemoveStopWords added in v4.26.0 

func BoolAsRemoveStopWords(v bool) *RemoveStopWords

boolAsRemoveStopWords is a convenience function that returns bool wrapped in RemoveStopWords.

func (RemoveStopWords) GetActualInstance added in v4.26.0 

func (obj RemoveStopWords) GetActualInstance() any

Get the actual instance.

func (RemoveStopWords) MarshalJSON added in v4.26.0 

func (src RemoveStopWords) MarshalJSON() ([]byte, error)

Marshal data from the first non-nil pointers in the struct to JSON.

func (*RemoveStopWords) UnmarshalJSON added in v4.26.0 

func (dst *RemoveStopWords) UnmarshalJSON(data []byte) error

Unmarshal JSON data into one or more of the pointers in the struct.

type RemoveWordsIfNoResults added in v4.26.0 

type RemoveWordsIfNoResults string

RemoveWordsIfNoResults Strategy for removing words from the query when it doesn't return any results. This helps to avoid returning empty search results. - `none`. No words are removed when a query doesn't return results. - `lastWords`. Treat the last (then second to last, then third to last) word as optional, until there are results or at most 5 words have been removed. - `firstWords`. Treat the first (then second, then third) word as optional, until there are results or at most 5 words have been removed. - `allOptional`. Treat all words as optional. For more information, see [Remove words to improve results](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/empty-or-insufficient-results/in-depth/why-use-remove-words-if-no-results). 

const (
	REMOVE_WORDS_IF_NO_RESULTS_NONE         RemoveWordsIfNoResults = "none"
	REMOVE_WORDS_IF_NO_RESULTS_LAST_WORDS   RemoveWordsIfNoResults = "lastWords"
	REMOVE_WORDS_IF_NO_RESULTS_FIRST_WORDS  RemoveWordsIfNoResults = "firstWords"
	REMOVE_WORDS_IF_NO_RESULTS_ALL_OPTIONAL RemoveWordsIfNoResults = "allOptional"
)

List of removeWordsIfNoResults.

func NewRemoveWordsIfNoResultsFromValue added in v4.26.0 

func NewRemoveWordsIfNoResultsFromValue(v string) (*RemoveWordsIfNoResults, error)

NewRemoveWordsIfNoResultsFromValue returns a pointer to a valid RemoveWordsIfNoResults. for the value passed as argument, or an error if the value passed is not allowed by the enum.

func (RemoveWordsIfNoResults) IsValid added in v4.26.0 

func (v RemoveWordsIfNoResults) IsValid() bool

IsValid return true if the value is valid for the enum, false otherwise.

func (RemoveWordsIfNoResults) Ptr added in v4.26.0 

func (v RemoveWordsIfNoResults) Ptr() *RemoveWordsIfNoResults

Ptr returns reference to removeWordsIfNoResults value.

func (*RemoveWordsIfNoResults) UnmarshalJSON added in v4.26.0 

func (v *RemoveWordsIfNoResults) UnmarshalJSON(src []byte) error

type RenderingContent 

type RenderingContent struct {
	FacetOrdering *FacetOrdering `json:"facetOrdering,omitempty"`
	Redirect      *RedirectURL   `json:"redirect,omitempty"`
	Widgets       *Widgets       `json:"widgets,omitempty"`
}

RenderingContent Extra data that can be used in the search UI. You can use this to control aspects of your search UI, such as the order of facet names and values without changing your frontend code.

func NewEmptyRenderingContent 

func NewEmptyRenderingContent() *RenderingContent

NewEmptyRenderingContent return a pointer to an empty RenderingContent object.

func NewRenderingContent 

func NewRenderingContent(opts ...RenderingContentOption) *RenderingContent

NewRenderingContent instantiates a new RenderingContent object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed.

func (*RenderingContent) GetFacetOrdering 

func (o *RenderingContent) GetFacetOrdering() FacetOrdering

GetFacetOrdering returns the FacetOrdering field value if set, zero value otherwise.

func (*RenderingContent) GetFacetOrderingOk 

func (o *RenderingContent) GetFacetOrderingOk() (*FacetOrdering, bool)

GetFacetOrderingOk returns a tuple with the FacetOrdering field value if set, nil otherwise and a boolean to check if the value has been set.

func (*RenderingContent) GetRedirect 

func (o *RenderingContent) GetRedirect() RedirectURL

GetRedirect returns the Redirect field value if set, zero value otherwise.

func (*RenderingContent) GetRedirectOk 

func (o *RenderingContent) GetRedirectOk() (*RedirectURL, bool)

GetRedirectOk returns a tuple with the Redirect field value if set, nil otherwise and a boolean to check if the value has been set.

func (*RenderingContent) GetWidgets 

func (o *RenderingContent) GetWidgets() Widgets

GetWidgets returns the Widgets field value if set, zero value otherwise.

func (*RenderingContent) GetWidgetsOk 

func (o *RenderingContent) GetWidgetsOk() (*Widgets, bool)

GetWidgetsOk returns a tuple with the Widgets field value if set, nil otherwise and a boolean to check if the value has been set.

func (*RenderingContent) HasFacetOrdering 

func (o *RenderingContent) HasFacetOrdering() bool

HasFacetOrdering returns a boolean if a field has been set.

func (*RenderingContent) HasRedirect 

func (o *RenderingContent) HasRedirect() bool

HasRedirect returns a boolean if a field has been set.

func (*RenderingContent) HasWidgets 

func (o *RenderingContent) HasWidgets() bool

HasWidgets returns a boolean if a field has been set.

func (RenderingContent) MarshalJSON 

func (o RenderingContent) MarshalJSON() ([]byte, error)

func (*RenderingContent) SetFacetOrdering 

func (o *RenderingContent) SetFacetOrdering(v *FacetOrdering) *RenderingContent

SetFacetOrdering gets a reference to the given FacetOrdering and assigns it to the FacetOrdering field.

func (*RenderingContent) SetRedirect 

func (o *RenderingContent) SetRedirect(v *RedirectURL) *RenderingContent

SetRedirect gets a reference to the given RedirectURL and assigns it to the Redirect field.

func (*RenderingContent) SetWidgets 

func (o *RenderingContent) SetWidgets(v *Widgets) *RenderingContent

SetWidgets gets a reference to the given Widgets and assigns it to the Widgets field.

func (RenderingContent) String 

func (o RenderingContent) String() string

type RenderingContentOption 

type RenderingContentOption func(f *RenderingContent)

func WithRenderingContentFacetOrdering 

func WithRenderingContentFacetOrdering(val FacetOrdering) RenderingContentOption

func WithRenderingContentRedirect 

func WithRenderingContentRedirect(val RedirectURL) RenderingContentOption

func WithRenderingContentWidgets 

func WithRenderingContentWidgets(val Widgets) RenderingContentOption

type RequestBody 

type RequestBody struct {
	Params *Params `json:"params,omitempty"`
	// A list of Feed IDs that specifies the order in which to order the results in the response.  The IDs should be a subset of those in the `feeds` object of the targeted `multifeed` Composition / Composition Rule, and only those specified will be processed.   The value overrides the value in the defined behavior, and when unspecified, the value defined in the behavior is used. When neither value is present, all feeds are processed.
	FeedsOrder []string `json:"feedsOrder,omitempty"`
}

RequestBody struct for RequestBody.

func NewEmptyRequestBody 

func NewEmptyRequestBody() *RequestBody

NewEmptyRequestBody return a pointer to an empty RequestBody object.

func NewRequestBody 

func NewRequestBody(opts ...RequestBodyOption) *RequestBody

NewRequestBody instantiates a new RequestBody object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed.

func (*RequestBody) GetFeedsOrder added in v4.39.0 

func (o *RequestBody) GetFeedsOrder() []string

GetFeedsOrder returns the FeedsOrder field value if set, zero value otherwise.

func (*RequestBody) GetFeedsOrderOk added in v4.39.0 

func (o *RequestBody) GetFeedsOrderOk() ([]string, bool)

GetFeedsOrderOk returns a tuple with the FeedsOrder field value if set, nil otherwise and a boolean to check if the value has been set.

func (*RequestBody) GetParams 

func (o *RequestBody) GetParams() Params

GetParams returns the Params field value if set, zero value otherwise.

func (*RequestBody) GetParamsOk 

func (o *RequestBody) GetParamsOk() (*Params, bool)

GetParamsOk returns a tuple with the Params field value if set, nil otherwise and a boolean to check if the value has been set.

func (*RequestBody) HasFeedsOrder added in v4.39.0 

func (o *RequestBody) HasFeedsOrder() bool

HasFeedsOrder returns a boolean if a field has been set.

func (*RequestBody) HasParams 

func (o *RequestBody) HasParams() bool

HasParams returns a boolean if a field has been set.

func (RequestBody) MarshalJSON 

func (o RequestBody) MarshalJSON() ([]byte, error)

func (*RequestBody) SetFeedsOrder added in v4.39.0 

func (o *RequestBody) SetFeedsOrder(v []string) *RequestBody

SetFeedsOrder gets a reference to the given []string and assigns it to the FeedsOrder field.

func (*RequestBody) SetParams 

func (o *RequestBody) SetParams(v *Params) *RequestBody

SetParams gets a reference to the given Params and assigns it to the Params field.

func (RequestBody) String 

func (o RequestBody) String() string

type RequestBodyOption 

type RequestBodyOption func(f *RequestBody)

func WithRequestBodyFeedsOrder added in v4.39.0 

func WithRequestBodyFeedsOrder(val []string) RequestBodyOption

func WithRequestBodyParams 

func WithRequestBodyParams(val Params) RequestBodyOption

type RequestOption 

type RequestOption interface {
	// contains filtered or unexported methods
}

type ResultsCompositionInfoResponse 

type ResultsCompositionInfoResponse struct {
	InjectedItems []ResultsInjectedItemInfoResponse `json:"injectedItems"`
}

ResultsCompositionInfoResponse struct for ResultsCompositionInfoResponse.

func NewEmptyResultsCompositionInfoResponse 

func NewEmptyResultsCompositionInfoResponse() *ResultsCompositionInfoResponse

NewEmptyResultsCompositionInfoResponse return a pointer to an empty ResultsCompositionInfoResponse object.

func NewResultsCompositionInfoResponse 

func NewResultsCompositionInfoResponse(injectedItems []ResultsInjectedItemInfoResponse) *ResultsCompositionInfoResponse

NewResultsCompositionInfoResponse instantiates a new ResultsCompositionInfoResponse object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed.

func (*ResultsCompositionInfoResponse) GetInjectedItems 

func (o *ResultsCompositionInfoResponse) GetInjectedItems() []ResultsInjectedItemInfoResponse

GetInjectedItems returns the InjectedItems field value.

func (*ResultsCompositionInfoResponse) GetInjectedItemsOk 

func (o *ResultsCompositionInfoResponse) GetInjectedItemsOk() ([]ResultsInjectedItemInfoResponse, bool)

GetInjectedItemsOk returns a tuple with the InjectedItems field value and a boolean to check if the value has been set.

func (ResultsCompositionInfoResponse) MarshalJSON 

func (o ResultsCompositionInfoResponse) MarshalJSON() ([]byte, error)

func (*ResultsCompositionInfoResponse) SetInjectedItems 

func (o *ResultsCompositionInfoResponse) SetInjectedItems(v []ResultsInjectedItemInfoResponse) *ResultsCompositionInfoResponse

SetInjectedItems sets field value.

func (ResultsCompositionInfoResponse) String 

func (o ResultsCompositionInfoResponse) String() string

type ResultsInjectedItemAppliedRulesInfoResponse 

type ResultsInjectedItemAppliedRulesInfoResponse struct {
	// The objectID of the applied index level rule on this injected group.
	ObjectID string `json:"objectID"`
}

ResultsInjectedItemAppliedRulesInfoResponse struct for ResultsInjectedItemAppliedRulesInfoResponse.

func NewEmptyResultsInjectedItemAppliedRulesInfoResponse 

func NewEmptyResultsInjectedItemAppliedRulesInfoResponse() *ResultsInjectedItemAppliedRulesInfoResponse

NewEmptyResultsInjectedItemAppliedRulesInfoResponse return a pointer to an empty ResultsInjectedItemAppliedRulesInfoResponse object.

func NewResultsInjectedItemAppliedRulesInfoResponse 

func NewResultsInjectedItemAppliedRulesInfoResponse(objectID string) *ResultsInjectedItemAppliedRulesInfoResponse

NewResultsInjectedItemAppliedRulesInfoResponse instantiates a new ResultsInjectedItemAppliedRulesInfoResponse object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed.

func (*ResultsInjectedItemAppliedRulesInfoResponse) GetObjectID 

func (o *ResultsInjectedItemAppliedRulesInfoResponse) GetObjectID() string

GetObjectID returns the ObjectID field value.

func (*ResultsInjectedItemAppliedRulesInfoResponse) GetObjectIDOk 

func (o *ResultsInjectedItemAppliedRulesInfoResponse) GetObjectIDOk() (*string, bool)

GetObjectIDOk returns a tuple with the ObjectID field value and a boolean to check if the value has been set.

func (ResultsInjectedItemAppliedRulesInfoResponse) MarshalJSON 

func (o ResultsInjectedItemAppliedRulesInfoResponse) MarshalJSON() ([]byte, error)

func (*ResultsInjectedItemAppliedRulesInfoResponse) SetObjectID 

func (o *ResultsInjectedItemAppliedRulesInfoResponse) SetObjectID(v string) *ResultsInjectedItemAppliedRulesInfoResponse

SetObjectID sets field value.

func (ResultsInjectedItemAppliedRulesInfoResponse) String 

func (o ResultsInjectedItemAppliedRulesInfoResponse) String() string

type ResultsInjectedItemInfoResponse 

type ResultsInjectedItemInfoResponse struct {
	// The key of the injected group.
	Key                  string                                        `json:"key"`
	AppliedRules         []ResultsInjectedItemAppliedRulesInfoResponse `json:"appliedRules,omitempty"`
	AdditionalProperties map[string]any                                `json:"-"`
}

ResultsInjectedItemInfoResponse struct for ResultsInjectedItemInfoResponse.

func NewEmptyResultsInjectedItemInfoResponse 

func NewEmptyResultsInjectedItemInfoResponse() *ResultsInjectedItemInfoResponse

NewEmptyResultsInjectedItemInfoResponse return a pointer to an empty ResultsInjectedItemInfoResponse object.

func NewResultsInjectedItemInfoResponse 

func NewResultsInjectedItemInfoResponse(key string, opts ...ResultsInjectedItemInfoResponseOption) *ResultsInjectedItemInfoResponse

NewResultsInjectedItemInfoResponse instantiates a new ResultsInjectedItemInfoResponse object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed.

func (*ResultsInjectedItemInfoResponse) GetAppliedRules 

func (o *ResultsInjectedItemInfoResponse) GetAppliedRules() []ResultsInjectedItemAppliedRulesInfoResponse

GetAppliedRules returns the AppliedRules field value if set, zero value otherwise.

func (*ResultsInjectedItemInfoResponse) GetAppliedRulesOk 

func (o *ResultsInjectedItemInfoResponse) GetAppliedRulesOk() ([]ResultsInjectedItemAppliedRulesInfoResponse, bool)

GetAppliedRulesOk returns a tuple with the AppliedRules field value if set, nil otherwise and a boolean to check if the value has been set.

func (*ResultsInjectedItemInfoResponse) GetKey 

func (o *ResultsInjectedItemInfoResponse) GetKey() string

GetKey returns the Key field value.

func (*ResultsInjectedItemInfoResponse) GetKeyOk 

func (o *ResultsInjectedItemInfoResponse) GetKeyOk() (*string, bool)

GetKeyOk returns a tuple with the Key field value and a boolean to check if the value has been set.

func (*ResultsInjectedItemInfoResponse) HasAppliedRules 

func (o *ResultsInjectedItemInfoResponse) HasAppliedRules() bool

HasAppliedRules returns a boolean if a field has been set.

func (ResultsInjectedItemInfoResponse) MarshalJSON 

func (o ResultsInjectedItemInfoResponse) MarshalJSON() ([]byte, error)

func (*ResultsInjectedItemInfoResponse) SetAdditionalProperty 

func (o *ResultsInjectedItemInfoResponse) SetAdditionalProperty(key string, value any) *ResultsInjectedItemInfoResponse

func (*ResultsInjectedItemInfoResponse) SetAppliedRules 

func (o *ResultsInjectedItemInfoResponse) SetAppliedRules(v []ResultsInjectedItemAppliedRulesInfoResponse) *ResultsInjectedItemInfoResponse

SetAppliedRules gets a reference to the given []ResultsInjectedItemAppliedRulesInfoResponse and assigns it to the AppliedRules field.

func (*ResultsInjectedItemInfoResponse) SetKey 

func (o *ResultsInjectedItemInfoResponse) SetKey(v string) *ResultsInjectedItemInfoResponse

SetKey sets field value.

func (ResultsInjectedItemInfoResponse) String 

func (o ResultsInjectedItemInfoResponse) String() string

func (*ResultsInjectedItemInfoResponse) UnmarshalJSON 

func (o *ResultsInjectedItemInfoResponse) UnmarshalJSON(bytes []byte) error

type ResultsInjectedItemInfoResponseOption 

type ResultsInjectedItemInfoResponseOption func(f *ResultsInjectedItemInfoResponse)

func WithResultsInjectedItemInfoResponseAppliedRules 

func WithResultsInjectedItemInfoResponseAppliedRules(val []ResultsInjectedItemAppliedRulesInfoResponse) ResultsInjectedItemInfoResponseOption

type RulesBatchCompositionAction added in v4.26.0 

type RulesBatchCompositionAction struct {
	CompositionRule             *CompositionRule
	DeleteCompositionRuleAction *DeleteCompositionRuleAction
}

RulesBatchCompositionAction - struct for RulesBatchCompositionAction.

func CompositionRuleAsRulesBatchCompositionAction added in v4.26.0 

func CompositionRuleAsRulesBatchCompositionAction(v *CompositionRule) *RulesBatchCompositionAction

CompositionRuleAsRulesBatchCompositionAction is a convenience function that returns CompositionRule wrapped in RulesBatchCompositionAction.

func DeleteCompositionRuleActionAsRulesBatchCompositionAction added in v4.26.0 

func DeleteCompositionRuleActionAsRulesBatchCompositionAction(v *DeleteCompositionRuleAction) *RulesBatchCompositionAction

DeleteCompositionRuleActionAsRulesBatchCompositionAction is a convenience function that returns DeleteCompositionRuleAction wrapped in RulesBatchCompositionAction.

func (RulesBatchCompositionAction) GetActualInstance added in v4.26.0 

func (obj RulesBatchCompositionAction) GetActualInstance() any

Get the actual instance.

func (RulesBatchCompositionAction) MarshalJSON added in v4.26.0 

func (src RulesBatchCompositionAction) MarshalJSON() ([]byte, error)

Marshal data from the first non-nil pointers in the struct to JSON.

func (*RulesBatchCompositionAction) UnmarshalJSON added in v4.26.0 

func (dst *RulesBatchCompositionAction) UnmarshalJSON(data []byte) error

Unmarshal JSON data into one or more of the pointers in the struct.

type RulesMultipleBatchRequest added in v4.26.0 

type RulesMultipleBatchRequest struct {
	Action Action                      `json:"action"`
	Body   RulesBatchCompositionAction `json:"body"`
}

RulesMultipleBatchRequest struct for RulesMultipleBatchRequest.

func NewEmptyRulesMultipleBatchRequest added in v4.26.0 

func NewEmptyRulesMultipleBatchRequest() *RulesMultipleBatchRequest

NewEmptyRulesMultipleBatchRequest return a pointer to an empty RulesMultipleBatchRequest object.

func NewRulesMultipleBatchRequest added in v4.26.0 

func NewRulesMultipleBatchRequest(action Action, body RulesBatchCompositionAction) *RulesMultipleBatchRequest

NewRulesMultipleBatchRequest instantiates a new RulesMultipleBatchRequest object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed.

func (*RulesMultipleBatchRequest) GetAction added in v4.26.0 

func (o *RulesMultipleBatchRequest) GetAction() Action

GetAction returns the Action field value.

func (*RulesMultipleBatchRequest) GetActionOk added in v4.26.0 

func (o *RulesMultipleBatchRequest) GetActionOk() (*Action, bool)

GetActionOk returns a tuple with the Action field value and a boolean to check if the value has been set.

func (*RulesMultipleBatchRequest) GetBody added in v4.26.0 

func (o *RulesMultipleBatchRequest) GetBody() RulesBatchCompositionAction

GetBody returns the Body field value.

func (*RulesMultipleBatchRequest) GetBodyOk added in v4.26.0 

func (o *RulesMultipleBatchRequest) GetBodyOk() (*RulesBatchCompositionAction, bool)

GetBodyOk returns a tuple with the Body field value and a boolean to check if the value has been set.

func (RulesMultipleBatchRequest) MarshalJSON added in v4.26.0 

func (o RulesMultipleBatchRequest) MarshalJSON() ([]byte, error)

func (*RulesMultipleBatchRequest) SetAction added in v4.26.0 

func (o *RulesMultipleBatchRequest) SetAction(v Action) *RulesMultipleBatchRequest

SetAction sets field value.

func (*RulesMultipleBatchRequest) SetBody added in v4.26.0 

func (o *RulesMultipleBatchRequest) SetBody(v *RulesBatchCompositionAction) *RulesMultipleBatchRequest

SetBody sets field value.

func (RulesMultipleBatchRequest) String added in v4.26.0 

func (o RulesMultipleBatchRequest) String() string

type RulesMultipleBatchResponse added in v4.26.0 

type RulesMultipleBatchResponse struct {
	// Unique identifier of a task.  A successful API response means that a task was added to a queue. It might not run immediately. You can check the task's progress with the [`task` operation](https://www.algolia.com/doc/rest-api/search/get-task) and this task ID.
	TaskID int64 `json:"taskID"`
}

RulesMultipleBatchResponse struct for RulesMultipleBatchResponse.

func NewEmptyRulesMultipleBatchResponse added in v4.26.0 

func NewEmptyRulesMultipleBatchResponse() *RulesMultipleBatchResponse

NewEmptyRulesMultipleBatchResponse return a pointer to an empty RulesMultipleBatchResponse object.

func NewRulesMultipleBatchResponse added in v4.26.0 

func NewRulesMultipleBatchResponse(taskID int64) *RulesMultipleBatchResponse

NewRulesMultipleBatchResponse instantiates a new RulesMultipleBatchResponse object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed.

func (*RulesMultipleBatchResponse) GetTaskID added in v4.26.0 

func (o *RulesMultipleBatchResponse) GetTaskID() int64

GetTaskID returns the TaskID field value.

func (*RulesMultipleBatchResponse) GetTaskIDOk added in v4.26.0 

func (o *RulesMultipleBatchResponse) GetTaskIDOk() (*int64, bool)

GetTaskIDOk returns a tuple with the TaskID field value and a boolean to check if the value has been set.

func (RulesMultipleBatchResponse) MarshalJSON added in v4.26.0 

func (o RulesMultipleBatchResponse) MarshalJSON() ([]byte, error)

func (*RulesMultipleBatchResponse) SetTaskID added in v4.26.0 

func (o *RulesMultipleBatchResponse) SetTaskID(v int64) *RulesMultipleBatchResponse

SetTaskID sets field value.

func (RulesMultipleBatchResponse) String added in v4.26.0 

func (o RulesMultipleBatchResponse) String() string

type SearchCompositionRulesParams added in v4.26.0 

type SearchCompositionRulesParams struct {
	// Search query for rules.
	Query     *string    `json:"query,omitempty"`
	Anchoring *Anchoring `json:"anchoring,omitempty"`
	// Only return composition rules that match the context (exact match).
	Context *string `json:"context,omitempty"`
	// Requested page of the API response.  Algolia uses `page` and `hitsPerPage` to control how search results are displayed ([paginated](https://www.algolia.com/doc/guides/building-search-ui/ui-and-ux-patterns/pagination/js)).  - `hitsPerPage`: sets the number of search results (_hits_) displayed per page. - `page`: specifies the page number of the search results you want to retrieve. Page numbering starts at 0, so the first page is `page=0`, the second is `page=1`, and so on.  For example, to display 10 results per page starting from the third page, set `hitsPerPage` to 10 and `page` to 2.
	Page *int32 `json:"page,omitempty"`
	// Maximum number of hits per page.  Algolia uses `page` and `hitsPerPage` to control how search results are displayed ([paginated](https://www.algolia.com/doc/guides/building-search-ui/ui-and-ux-patterns/pagination/js)).  - `hitsPerPage`: sets the number of search results (_hits_) displayed per page. - `page`: specifies the page number of the search results you want to retrieve. Page numbering starts at 0, so the first page is `page=0`, the second is `page=1`, and so on.  For example, to display 10 results per page starting from the third page, set `hitsPerPage` to 10 and `page` to 2.
	HitsPerPage *int32 `json:"hitsPerPage,omitempty"`
	// If `true`, return only enabled composition rules. If `false`, return only inactive composition rules. By default, _all_ composition rules are returned.
	Enabled utils.Nullable[bool] `json:"enabled,omitempty"`
}

SearchCompositionRulesParams Composition Rules search parameters.

func NewEmptySearchCompositionRulesParams added in v4.26.0 

func NewEmptySearchCompositionRulesParams() *SearchCompositionRulesParams

NewEmptySearchCompositionRulesParams return a pointer to an empty SearchCompositionRulesParams object.

func NewSearchCompositionRulesParams added in v4.26.0 

func NewSearchCompositionRulesParams(opts ...SearchCompositionRulesParamsOption) *SearchCompositionRulesParams

NewSearchCompositionRulesParams instantiates a new SearchCompositionRulesParams object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed.

func (*SearchCompositionRulesParams) GetAnchoring added in v4.26.0 

func (o *SearchCompositionRulesParams) GetAnchoring() Anchoring

GetAnchoring returns the Anchoring field value if set, zero value otherwise.

func (*SearchCompositionRulesParams) GetAnchoringOk added in v4.26.0 

func (o *SearchCompositionRulesParams) GetAnchoringOk() (*Anchoring, bool)

GetAnchoringOk returns a tuple with the Anchoring field value if set, nil otherwise and a boolean to check if the value has been set.

func (*SearchCompositionRulesParams) GetContext added in v4.26.0 

func (o *SearchCompositionRulesParams) GetContext() string

GetContext returns the Context field value if set, zero value otherwise.

func (*SearchCompositionRulesParams) GetContextOk added in v4.26.0 

func (o *SearchCompositionRulesParams) GetContextOk() (*string, bool)

GetContextOk returns a tuple with the Context field value if set, nil otherwise and a boolean to check if the value has been set.

func (*SearchCompositionRulesParams) GetEnabled added in v4.26.0 

func (o *SearchCompositionRulesParams) GetEnabled() bool

GetEnabled returns the Enabled field value if set, zero value otherwise (both if not set or set to explicit null).

func (*SearchCompositionRulesParams) GetEnabledOk added in v4.26.0 

func (o *SearchCompositionRulesParams) GetEnabledOk() (*bool, bool)

GetEnabledOk returns a tuple with the Enabled field value if set, nil otherwise and a boolean to check if the value has been set. NOTE: If the value is an explicit nil, `nil, true` will be returned.

func (*SearchCompositionRulesParams) GetHitsPerPage added in v4.26.0 

func (o *SearchCompositionRulesParams) GetHitsPerPage() int32

GetHitsPerPage returns the HitsPerPage field value if set, zero value otherwise.

func (*SearchCompositionRulesParams) GetHitsPerPageOk added in v4.26.0 

func (o *SearchCompositionRulesParams) GetHitsPerPageOk() (*int32, bool)

GetHitsPerPageOk returns a tuple with the HitsPerPage field value if set, nil otherwise and a boolean to check if the value has been set.

func (*SearchCompositionRulesParams) GetPage added in v4.26.0 

func (o *SearchCompositionRulesParams) GetPage() int32

GetPage returns the Page field value if set, zero value otherwise.

func (*SearchCompositionRulesParams) GetPageOk added in v4.26.0 

func (o *SearchCompositionRulesParams) GetPageOk() (*int32, bool)

GetPageOk returns a tuple with the Page field value if set, nil otherwise and a boolean to check if the value has been set.

func (*SearchCompositionRulesParams) GetQuery added in v4.26.0 

func (o *SearchCompositionRulesParams) GetQuery() string

GetQuery returns the Query field value if set, zero value otherwise.

func (*SearchCompositionRulesParams) GetQueryOk added in v4.26.0 

func (o *SearchCompositionRulesParams) GetQueryOk() (*string, bool)

GetQueryOk returns a tuple with the Query field value if set, nil otherwise and a boolean to check if the value has been set.

func (*SearchCompositionRulesParams) HasAnchoring added in v4.26.0 

func (o *SearchCompositionRulesParams) HasAnchoring() bool

HasAnchoring returns a boolean if a field has been set.

func (*SearchCompositionRulesParams) HasContext added in v4.26.0 

func (o *SearchCompositionRulesParams) HasContext() bool

HasContext returns a boolean if a field has been set.

func (*SearchCompositionRulesParams) HasEnabled added in v4.26.0 

func (o *SearchCompositionRulesParams) HasEnabled() bool

HasEnabled returns a boolean if a field has been set.

func (*SearchCompositionRulesParams) HasHitsPerPage added in v4.26.0 

func (o *SearchCompositionRulesParams) HasHitsPerPage() bool

HasHitsPerPage returns a boolean if a field has been set.

func (*SearchCompositionRulesParams) HasPage added in v4.26.0 

func (o *SearchCompositionRulesParams) HasPage() bool

HasPage returns a boolean if a field has been set.

func (*SearchCompositionRulesParams) HasQuery added in v4.26.0 

func (o *SearchCompositionRulesParams) HasQuery() bool

HasQuery returns a boolean if a field has been set.

func (SearchCompositionRulesParams) MarshalJSON added in v4.26.0 

func (o SearchCompositionRulesParams) MarshalJSON() ([]byte, error)

func (*SearchCompositionRulesParams) SetAnchoring added in v4.26.0 

func (o *SearchCompositionRulesParams) SetAnchoring(v Anchoring) *SearchCompositionRulesParams

SetAnchoring gets a reference to the given Anchoring and assigns it to the Anchoring field.

func (*SearchCompositionRulesParams) SetContext added in v4.26.0 

func (o *SearchCompositionRulesParams) SetContext(v string) *SearchCompositionRulesParams

SetContext gets a reference to the given string and assigns it to the Context field.

func (*SearchCompositionRulesParams) SetEnabled added in v4.26.0 

func (o *SearchCompositionRulesParams) SetEnabled(v bool) *SearchCompositionRulesParams

SetEnabled gets a reference to the given utils.Nullable[bool] and assigns it to the Enabled field.

func (*SearchCompositionRulesParams) SetEnabledNil added in v4.26.0 

func (o *SearchCompositionRulesParams) SetEnabledNil()

SetEnabledNil sets the value for Enabled to be an explicit nil.

func (*SearchCompositionRulesParams) SetHitsPerPage added in v4.26.0 

func (o *SearchCompositionRulesParams) SetHitsPerPage(v int32) *SearchCompositionRulesParams

SetHitsPerPage gets a reference to the given int32 and assigns it to the HitsPerPage field.

func (*SearchCompositionRulesParams) SetPage added in v4.26.0 

func (o *SearchCompositionRulesParams) SetPage(v int32) *SearchCompositionRulesParams

SetPage gets a reference to the given int32 and assigns it to the Page field.

func (*SearchCompositionRulesParams) SetQuery added in v4.26.0 

func (o *SearchCompositionRulesParams) SetQuery(v string) *SearchCompositionRulesParams

SetQuery gets a reference to the given string and assigns it to the Query field.

func (SearchCompositionRulesParams) String added in v4.26.0 

func (o SearchCompositionRulesParams) String() string

func (*SearchCompositionRulesParams) UnsetEnabled added in v4.26.0 

func (o *SearchCompositionRulesParams) UnsetEnabled()

UnsetEnabled ensures that no value is present for Enabled, not even an explicit nil.

type SearchCompositionRulesParamsOption added in v4.26.0 

type SearchCompositionRulesParamsOption func(f *SearchCompositionRulesParams)

func WithSearchCompositionRulesParamsAnchoring added in v4.26.0 

func WithSearchCompositionRulesParamsAnchoring(val Anchoring) SearchCompositionRulesParamsOption

func WithSearchCompositionRulesParamsContext added in v4.26.0 

func WithSearchCompositionRulesParamsContext(val string) SearchCompositionRulesParamsOption

func WithSearchCompositionRulesParamsEnabled added in v4.26.0 

func WithSearchCompositionRulesParamsEnabled(val utils.Nullable[bool]) SearchCompositionRulesParamsOption

func WithSearchCompositionRulesParamsHitsPerPage added in v4.26.0 

func WithSearchCompositionRulesParamsHitsPerPage(val int32) SearchCompositionRulesParamsOption

func WithSearchCompositionRulesParamsPage added in v4.26.0 

func WithSearchCompositionRulesParamsPage(val int32) SearchCompositionRulesParamsOption

func WithSearchCompositionRulesParamsQuery added in v4.26.0 

func WithSearchCompositionRulesParamsQuery(val string) SearchCompositionRulesParamsOption

type SearchCompositionRulesResponse added in v4.26.0 

type SearchCompositionRulesResponse struct {
	// Composition rules that matched the search criteria.
	Hits []CompositionRule `json:"hits"`
	// Number of composition rules that matched the search criteria.
	NbHits int32 `json:"nbHits"`
	// Current page.
	Page int32 `json:"page"`
	// Number of pages.
	NbPages int32 `json:"nbPages"`
}

SearchCompositionRulesResponse struct for SearchCompositionRulesResponse.

func NewEmptySearchCompositionRulesResponse added in v4.26.0 

func NewEmptySearchCompositionRulesResponse() *SearchCompositionRulesResponse

NewEmptySearchCompositionRulesResponse return a pointer to an empty SearchCompositionRulesResponse object.

func NewSearchCompositionRulesResponse added in v4.26.0 

func NewSearchCompositionRulesResponse(hits []CompositionRule, nbHits int32, page int32, nbPages int32) *SearchCompositionRulesResponse

NewSearchCompositionRulesResponse instantiates a new SearchCompositionRulesResponse object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed.

func (*SearchCompositionRulesResponse) GetHits added in v4.26.0 

func (o *SearchCompositionRulesResponse) GetHits() []CompositionRule

GetHits returns the Hits field value.

func (*SearchCompositionRulesResponse) GetHitsOk added in v4.26.0 

func (o *SearchCompositionRulesResponse) GetHitsOk() ([]CompositionRule, bool)

GetHitsOk returns a tuple with the Hits field value and a boolean to check if the value has been set.

func (*SearchCompositionRulesResponse) GetNbHits added in v4.26.0 

func (o *SearchCompositionRulesResponse) GetNbHits() int32

GetNbHits returns the NbHits field value.

func (*SearchCompositionRulesResponse) GetNbHitsOk added in v4.26.0 

func (o *SearchCompositionRulesResponse) GetNbHitsOk() (*int32, bool)

GetNbHitsOk returns a tuple with the NbHits field value and a boolean to check if the value has been set.

func (*SearchCompositionRulesResponse) GetNbPages added in v4.26.0 

func (o *SearchCompositionRulesResponse) GetNbPages() int32

GetNbPages returns the NbPages field value.

func (*SearchCompositionRulesResponse) GetNbPagesOk added in v4.26.0 

func (o *SearchCompositionRulesResponse) GetNbPagesOk() (*int32, bool)

GetNbPagesOk returns a tuple with the NbPages field value and a boolean to check if the value has been set.

func (*SearchCompositionRulesResponse) GetPage added in v4.26.0 

func (o *SearchCompositionRulesResponse) GetPage() int32

GetPage returns the Page field value.

func (*SearchCompositionRulesResponse) GetPageOk added in v4.26.0 

func (o *SearchCompositionRulesResponse) GetPageOk() (*int32, bool)

GetPageOk returns a tuple with the Page field value and a boolean to check if the value has been set.

func (SearchCompositionRulesResponse) MarshalJSON added in v4.26.0 

func (o SearchCompositionRulesResponse) MarshalJSON() ([]byte, error)

func (*SearchCompositionRulesResponse) SetHits added in v4.26.0 

func (o *SearchCompositionRulesResponse) SetHits(v []CompositionRule) *SearchCompositionRulesResponse

SetHits sets field value.

func (*SearchCompositionRulesResponse) SetNbHits added in v4.26.0 

func (o *SearchCompositionRulesResponse) SetNbHits(v int32) *SearchCompositionRulesResponse

SetNbHits sets field value.

func (*SearchCompositionRulesResponse) SetNbPages added in v4.26.0 

func (o *SearchCompositionRulesResponse) SetNbPages(v int32) *SearchCompositionRulesResponse

SetNbPages sets field value.

func (*SearchCompositionRulesResponse) SetPage added in v4.26.0 

func (o *SearchCompositionRulesResponse) SetPage(v int32) *SearchCompositionRulesResponse

SetPage sets field value.

func (SearchCompositionRulesResponse) String added in v4.26.0 

func (o SearchCompositionRulesResponse) String() string

type SearchForFacetValuesParams 

type SearchForFacetValuesParams struct {
	// Search query.
	Query *string `json:"query,omitempty"`
	// Maximum number of facet values to return when [searching for facet values](https://www.algolia.com/doc/guides/managing-results/refine-results/faceting/#search-for-facet-values).
	MaxFacetHits *int32  `json:"maxFacetHits,omitempty"`
	SearchQuery  *Params `json:"searchQuery,omitempty"`
}

SearchForFacetValuesParams struct for SearchForFacetValuesParams.

func NewEmptySearchForFacetValuesParams 

func NewEmptySearchForFacetValuesParams() *SearchForFacetValuesParams

NewEmptySearchForFacetValuesParams return a pointer to an empty SearchForFacetValuesParams object.

func NewSearchForFacetValuesParams 

func NewSearchForFacetValuesParams(opts ...SearchForFacetValuesParamsOption) *SearchForFacetValuesParams

NewSearchForFacetValuesParams instantiates a new SearchForFacetValuesParams object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed.

func (*SearchForFacetValuesParams) GetMaxFacetHits 

func (o *SearchForFacetValuesParams) GetMaxFacetHits() int32

GetMaxFacetHits returns the MaxFacetHits field value if set, zero value otherwise.

func (*SearchForFacetValuesParams) GetMaxFacetHitsOk 

func (o *SearchForFacetValuesParams) GetMaxFacetHitsOk() (*int32, bool)

GetMaxFacetHitsOk returns a tuple with the MaxFacetHits field value if set, nil otherwise and a boolean to check if the value has been set.

func (*SearchForFacetValuesParams) GetQuery 

func (o *SearchForFacetValuesParams) GetQuery() string

GetQuery returns the Query field value if set, zero value otherwise.

func (*SearchForFacetValuesParams) GetQueryOk 

func (o *SearchForFacetValuesParams) GetQueryOk() (*string, bool)

GetQueryOk returns a tuple with the Query field value if set, nil otherwise and a boolean to check if the value has been set.

func (*SearchForFacetValuesParams) GetSearchQuery 

func (o *SearchForFacetValuesParams) GetSearchQuery() Params

GetSearchQuery returns the SearchQuery field value if set, zero value otherwise.

func (*SearchForFacetValuesParams) GetSearchQueryOk 

func (o *SearchForFacetValuesParams) GetSearchQueryOk() (*Params, bool)

GetSearchQueryOk returns a tuple with the SearchQuery field value if set, nil otherwise and a boolean to check if the value has been set.

func (*SearchForFacetValuesParams) HasMaxFacetHits 

func (o *SearchForFacetValuesParams) HasMaxFacetHits() bool

HasMaxFacetHits returns a boolean if a field has been set.

func (*SearchForFacetValuesParams) HasQuery 

func (o *SearchForFacetValuesParams) HasQuery() bool

HasQuery returns a boolean if a field has been set.

func (*SearchForFacetValuesParams) HasSearchQuery 

func (o *SearchForFacetValuesParams) HasSearchQuery() bool

HasSearchQuery returns a boolean if a field has been set.

func (SearchForFacetValuesParams) MarshalJSON 

func (o SearchForFacetValuesParams) MarshalJSON() ([]byte, error)

func (*SearchForFacetValuesParams) SetMaxFacetHits 

func (o *SearchForFacetValuesParams) SetMaxFacetHits(v int32) *SearchForFacetValuesParams

SetMaxFacetHits gets a reference to the given int32 and assigns it to the MaxFacetHits field.

func (*SearchForFacetValuesParams) SetQuery 

func (o *SearchForFacetValuesParams) SetQuery(v string) *SearchForFacetValuesParams

SetQuery gets a reference to the given string and assigns it to the Query field.

func (*SearchForFacetValuesParams) SetSearchQuery 

func (o *SearchForFacetValuesParams) SetSearchQuery(v *Params) *SearchForFacetValuesParams

SetSearchQuery gets a reference to the given Params and assigns it to the SearchQuery field.

func (SearchForFacetValuesParams) String 

func (o SearchForFacetValuesParams) String() string

type SearchForFacetValuesParamsOption 

type SearchForFacetValuesParamsOption func(f *SearchForFacetValuesParams)

func WithSearchForFacetValuesParamsMaxFacetHits 

func WithSearchForFacetValuesParamsMaxFacetHits(val int32) SearchForFacetValuesParamsOption

func WithSearchForFacetValuesParamsQuery 

func WithSearchForFacetValuesParamsQuery(val string) SearchForFacetValuesParamsOption

func WithSearchForFacetValuesParamsSearchQuery 

func WithSearchForFacetValuesParamsSearchQuery(val Params) SearchForFacetValuesParamsOption

type SearchForFacetValuesRequest 

type SearchForFacetValuesRequest struct {
	Params *SearchForFacetValuesParams `json:"params,omitempty"`
}

SearchForFacetValuesRequest struct for SearchForFacetValuesRequest.

func NewEmptySearchForFacetValuesRequest 

func NewEmptySearchForFacetValuesRequest() *SearchForFacetValuesRequest

NewEmptySearchForFacetValuesRequest return a pointer to an empty SearchForFacetValuesRequest object.

func NewSearchForFacetValuesRequest 

func NewSearchForFacetValuesRequest(opts ...SearchForFacetValuesRequestOption) *SearchForFacetValuesRequest

NewSearchForFacetValuesRequest instantiates a new SearchForFacetValuesRequest object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed.

func (*SearchForFacetValuesRequest) GetParams 

func (o *SearchForFacetValuesRequest) GetParams() SearchForFacetValuesParams

GetParams returns the Params field value if set, zero value otherwise.

func (*SearchForFacetValuesRequest) GetParamsOk 

func (o *SearchForFacetValuesRequest) GetParamsOk() (*SearchForFacetValuesParams, bool)

GetParamsOk returns a tuple with the Params field value if set, nil otherwise and a boolean to check if the value has been set.

func (*SearchForFacetValuesRequest) HasParams 

func (o *SearchForFacetValuesRequest) HasParams() bool

HasParams returns a boolean if a field has been set.

func (SearchForFacetValuesRequest) MarshalJSON 

func (o SearchForFacetValuesRequest) MarshalJSON() ([]byte, error)

func (*SearchForFacetValuesRequest) SetParams 

func (o *SearchForFacetValuesRequest) SetParams(v *SearchForFacetValuesParams) *SearchForFacetValuesRequest

SetParams gets a reference to the given SearchForFacetValuesParams and assigns it to the Params field.

func (SearchForFacetValuesRequest) String 

func (o SearchForFacetValuesRequest) String() string

type SearchForFacetValuesRequestOption 

type SearchForFacetValuesRequestOption func(f *SearchForFacetValuesRequest)

func WithSearchForFacetValuesRequestParams 

func WithSearchForFacetValuesRequestParams(val SearchForFacetValuesParams) SearchForFacetValuesRequestOption

type SearchForFacetValuesResponse 

type SearchForFacetValuesResponse struct {
	// Search for facet values results.
	Results []SearchForFacetValuesResults `json:"results,omitempty"`
}

SearchForFacetValuesResponse struct for SearchForFacetValuesResponse.

func NewEmptySearchForFacetValuesResponse 

func NewEmptySearchForFacetValuesResponse() *SearchForFacetValuesResponse

NewEmptySearchForFacetValuesResponse return a pointer to an empty SearchForFacetValuesResponse object.

func NewSearchForFacetValuesResponse 

func NewSearchForFacetValuesResponse(opts ...SearchForFacetValuesResponseOption) *SearchForFacetValuesResponse

NewSearchForFacetValuesResponse instantiates a new SearchForFacetValuesResponse object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed.

func (*SearchForFacetValuesResponse) GetResults 

func (o *SearchForFacetValuesResponse) GetResults() []SearchForFacetValuesResults

GetResults returns the Results field value if set, zero value otherwise.

func (*SearchForFacetValuesResponse) GetResultsOk 

func (o *SearchForFacetValuesResponse) GetResultsOk() ([]SearchForFacetValuesResults, bool)

GetResultsOk returns a tuple with the Results field value if set, nil otherwise and a boolean to check if the value has been set.

func (*SearchForFacetValuesResponse) HasResults 

func (o *SearchForFacetValuesResponse) HasResults() bool

HasResults returns a boolean if a field has been set.

func (SearchForFacetValuesResponse) MarshalJSON 

func (o SearchForFacetValuesResponse) MarshalJSON() ([]byte, error)

func (*SearchForFacetValuesResponse) SetResults 

func (o *SearchForFacetValuesResponse) SetResults(v []SearchForFacetValuesResults) *SearchForFacetValuesResponse

SetResults gets a reference to the given []SearchForFacetValuesResults and assigns it to the Results field.

func (SearchForFacetValuesResponse) String 

func (o SearchForFacetValuesResponse) String() string

type SearchForFacetValuesResponseOption 

type SearchForFacetValuesResponseOption func(f *SearchForFacetValuesResponse)

func WithSearchForFacetValuesResponseResults 

func WithSearchForFacetValuesResponseResults(val []SearchForFacetValuesResults) SearchForFacetValuesResponseOption

type SearchForFacetValuesResults 

type SearchForFacetValuesResults struct {
	IndexName string `json:"indexName"`
	// Matching facet values.
	FacetHits []FacetHits `json:"facetHits"`
	// Whether the facet count is exhaustive (true) or approximate (false). For more information, see [Why are my facet and hit counts not accurate](https://support.algolia.com/hc/articles/4406975248145-Why-are-my-facet-and-hit-counts-not-accurate).
	ExhaustiveFacetsCount bool `json:"exhaustiveFacetsCount"`
	// Time the server took to process the request, in milliseconds.
	ProcessingTimeMS *int32 `json:"processingTimeMS,omitempty"`
}

SearchForFacetValuesResults struct for SearchForFacetValuesResults.

func NewEmptySearchForFacetValuesResults 

func NewEmptySearchForFacetValuesResults() *SearchForFacetValuesResults

NewEmptySearchForFacetValuesResults return a pointer to an empty SearchForFacetValuesResults object.

func NewSearchForFacetValuesResults 

func NewSearchForFacetValuesResults(
	indexName string,
	facetHits []FacetHits,
	exhaustiveFacetsCount bool,
	opts ...SearchForFacetValuesResultsOption,
) *SearchForFacetValuesResults

NewSearchForFacetValuesResults instantiates a new SearchForFacetValuesResults object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed.

func (*SearchForFacetValuesResults) GetExhaustiveFacetsCount 

func (o *SearchForFacetValuesResults) GetExhaustiveFacetsCount() bool

GetExhaustiveFacetsCount returns the ExhaustiveFacetsCount field value.

func (*SearchForFacetValuesResults) GetExhaustiveFacetsCountOk 

func (o *SearchForFacetValuesResults) GetExhaustiveFacetsCountOk() (*bool, bool)

GetExhaustiveFacetsCountOk returns a tuple with the ExhaustiveFacetsCount field value and a boolean to check if the value has been set.

func (*SearchForFacetValuesResults) GetFacetHits 

func (o *SearchForFacetValuesResults) GetFacetHits() []FacetHits

GetFacetHits returns the FacetHits field value.

func (*SearchForFacetValuesResults) GetFacetHitsOk 

func (o *SearchForFacetValuesResults) GetFacetHitsOk() ([]FacetHits, bool)

GetFacetHitsOk returns a tuple with the FacetHits field value and a boolean to check if the value has been set.

func (*SearchForFacetValuesResults) GetIndexName 

func (o *SearchForFacetValuesResults) GetIndexName() string

GetIndexName returns the IndexName field value.

func (*SearchForFacetValuesResults) GetIndexNameOk 

func (o *SearchForFacetValuesResults) GetIndexNameOk() (*string, bool)

GetIndexNameOk returns a tuple with the IndexName field value and a boolean to check if the value has been set.

func (*SearchForFacetValuesResults) GetProcessingTimeMS 

func (o *SearchForFacetValuesResults) GetProcessingTimeMS() int32

GetProcessingTimeMS returns the ProcessingTimeMS field value if set, zero value otherwise.

func (*SearchForFacetValuesResults) GetProcessingTimeMSOk 

func (o *SearchForFacetValuesResults) GetProcessingTimeMSOk() (*int32, bool)

GetProcessingTimeMSOk returns a tuple with the ProcessingTimeMS field value if set, nil otherwise and a boolean to check if the value has been set.

func (*SearchForFacetValuesResults) HasProcessingTimeMS 

func (o *SearchForFacetValuesResults) HasProcessingTimeMS() bool

HasProcessingTimeMS returns a boolean if a field has been set.

func (SearchForFacetValuesResults) MarshalJSON 

func (o SearchForFacetValuesResults) MarshalJSON() ([]byte, error)

func (*SearchForFacetValuesResults) SetExhaustiveFacetsCount 

func (o *SearchForFacetValuesResults) SetExhaustiveFacetsCount(v bool) *SearchForFacetValuesResults

SetExhaustiveFacetsCount sets field value.

func (*SearchForFacetValuesResults) SetFacetHits 

func (o *SearchForFacetValuesResults) SetFacetHits(v []FacetHits) *SearchForFacetValuesResults

SetFacetHits sets field value.

func (*SearchForFacetValuesResults) SetIndexName 

func (o *SearchForFacetValuesResults) SetIndexName(v string) *SearchForFacetValuesResults

SetIndexName sets field value.

func (*SearchForFacetValuesResults) SetProcessingTimeMS 

func (o *SearchForFacetValuesResults) SetProcessingTimeMS(v int32) *SearchForFacetValuesResults

SetProcessingTimeMS gets a reference to the given int32 and assigns it to the ProcessingTimeMS field.

func (SearchForFacetValuesResults) String 

func (o SearchForFacetValuesResults) String() string

type SearchForFacetValuesResultsOption 

type SearchForFacetValuesResultsOption func(f *SearchForFacetValuesResults)

func WithSearchForFacetValuesResultsProcessingTimeMS 

func WithSearchForFacetValuesResultsProcessingTimeMS(val int32) SearchForFacetValuesResultsOption

type SearchResponse 

type SearchResponse struct {
	Compositions *CompositionsSearchResponse `json:"compositions,omitempty"`
	// Search results.
	Results              []SearchResultsItem `json:"results"`
	AdditionalProperties map[string]any      `json:"-"`
}

SearchResponse struct for SearchResponse.

func NewEmptySearchResponse 

func NewEmptySearchResponse() *SearchResponse

NewEmptySearchResponse return a pointer to an empty SearchResponse object.

func NewSearchResponse 

func NewSearchResponse(results []SearchResultsItem, opts ...SearchResponseOption) *SearchResponse

NewSearchResponse instantiates a new SearchResponse object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed.

func (*SearchResponse) GetCompositions 

func (o *SearchResponse) GetCompositions() CompositionsSearchResponse

GetCompositions returns the Compositions field value if set, zero value otherwise.

func (*SearchResponse) GetCompositionsOk 

func (o *SearchResponse) GetCompositionsOk() (*CompositionsSearchResponse, bool)

GetCompositionsOk returns a tuple with the Compositions field value if set, nil otherwise and a boolean to check if the value has been set.

func (*SearchResponse) GetResults 

func (o *SearchResponse) GetResults() []SearchResultsItem

GetResults returns the Results field value.

func (*SearchResponse) GetResultsOk 

func (o *SearchResponse) GetResultsOk() ([]SearchResultsItem, bool)

GetResultsOk returns a tuple with the Results field value and a boolean to check if the value has been set.

func (*SearchResponse) HasCompositions 

func (o *SearchResponse) HasCompositions() bool

HasCompositions returns a boolean if a field has been set.

func (SearchResponse) MarshalJSON 

func (o SearchResponse) MarshalJSON() ([]byte, error)

func (*SearchResponse) SetAdditionalProperty 

func (o *SearchResponse) SetAdditionalProperty(key string, value any) *SearchResponse

func (*SearchResponse) SetCompositions 

func (o *SearchResponse) SetCompositions(v *CompositionsSearchResponse) *SearchResponse

SetCompositions gets a reference to the given CompositionsSearchResponse and assigns it to the Compositions field.

func (*SearchResponse) SetResults 

func (o *SearchResponse) SetResults(v []SearchResultsItem) *SearchResponse

SetResults sets field value.

func (SearchResponse) String 

func (o SearchResponse) String() string

func (*SearchResponse) UnmarshalJSON 

func (o *SearchResponse) UnmarshalJSON(bytes []byte) error

type SearchResponseOption 

type SearchResponseOption func(f *SearchResponse)

func WithSearchResponseCompositions 

func WithSearchResponseCompositions(val CompositionsSearchResponse) SearchResponseOption

type SearchResultsItem 

type SearchResultsItem struct {
	// A/B test ID. This is only included in the response for indices that are part of an A/B test.
	AbTestID *int32 `json:"abTestID,omitempty"`
	// Variant ID. This is only included in the response for indices that are part of an A/B test.
	AbTestVariantID *int32 `json:"abTestVariantID,omitempty"`
	// Computed geographical location.
	AroundLatLng *string `json:"aroundLatLng,omitempty"`
	// Distance from a central coordinate provided by `aroundLatLng`.
	AutomaticRadius *string     `json:"automaticRadius,omitempty"`
	Exhaustive      *Exhaustive `json:"exhaustive,omitempty"`
	// Rules applied to the query.
	AppliedRules []map[string]any `json:"appliedRules,omitempty"`
	// See the `facetsCount` field of the `exhaustive` object in the response.
	// Deprecated
	ExhaustiveFacetsCount *bool `json:"exhaustiveFacetsCount,omitempty"`
	// See the `nbHits` field of the `exhaustive` object in the response.
	// Deprecated
	ExhaustiveNbHits *bool `json:"exhaustiveNbHits,omitempty"`
	// See the `typo` field of the `exhaustive` object in the response.
	// Deprecated
	ExhaustiveTypo *bool `json:"exhaustiveTypo,omitempty"`
	// Facet counts.
	Facets *map[string]map[string]int32 `json:"facets,omitempty"`
	// Statistics for numerical facets.
	FacetsStats *map[string]FacetStats `json:"facets_stats,omitempty"`
	// Index name used for the query.
	Index *string `json:"index,omitempty"`
	// Index name used for the query. During A/B testing, the targeted index isn't always the index used by the query.
	IndexUsed *string `json:"indexUsed,omitempty"`
	// Warnings about the query.
	Message *string `json:"message,omitempty"`
	// Number of hits selected and sorted by the relevant sort algorithm.
	NbSortedHits *int32 `json:"nbSortedHits,omitempty"`
	// Post-[normalization](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/handling-natural-languages-nlp/#what-does-normalization-mean) query string that will be searched.
	ParsedQuery *string `json:"parsedQuery,omitempty"`
	// Time the server took to process the request, in milliseconds.
	ProcessingTimeMS *int32 `json:"processingTimeMS,omitempty"`
	// Experimental. List of processing steps and their times, in milliseconds. You can use this list to investigate performance issues.
	ProcessingTimingsMS map[string]any `json:"processingTimingsMS,omitempty"`
	// Markup text indicating which parts of the original query have been removed to retrieve a non-empty result set.
	QueryAfterRemoval *string           `json:"queryAfterRemoval,omitempty"`
	Redirect          *Redirect         `json:"redirect,omitempty"`
	RenderingContent  *RenderingContent `json:"renderingContent,omitempty"`
	// Time the server took to process the request, in milliseconds.
	ServerTimeMS *int32 `json:"serverTimeMS,omitempty"`
	// Host name of the server that processed the request.
	ServerUsed *string `json:"serverUsed,omitempty"`
	// An object with custom data.  You can store up to 32kB as custom data.
	UserData any `json:"userData,omitempty"`
	// Unique identifier for the query. This is used for [click analytics](https://www.algolia.com/doc/guides/analytics/click-analytics).
	QueryID *string `json:"queryID,omitempty"`
	// Whether automatic events collection is enabled for the application.
	AutomaticInsights *bool `json:"_automaticInsights,omitempty"`
	// Search results (hits).  Hits are records from your index that match the search criteria, augmented with additional attributes, such as, for highlighting.
	Hits []Hit `json:"hits,omitempty"`
	// Number of hits returned per page.
	HitsPerPage *int32 `json:"hitsPerPage,omitempty"`
	// Number of results (hits).
	NbHits *int32 `json:"nbHits,omitempty"`
	// Number of pages of results.
	NbPages *int32 `json:"nbPages,omitempty"`
	// The current page of the results.
	Page *int32 `json:"page,omitempty"`
	// URL-encoded string of all search parameters.
	Params *string `json:"params,omitempty"`
	// The search query string.
	Query *string `json:"query,omitempty"`
	// The ID of the feed.
	FeedID       *string                                   `json:"feedID,omitempty"`
	Compositions map[string]ResultsCompositionInfoResponse `json:"compositions"`
}

SearchResultsItem struct for SearchResultsItem.

func NewEmptySearchResultsItem 

func NewEmptySearchResultsItem() *SearchResultsItem

NewEmptySearchResultsItem return a pointer to an empty SearchResultsItem object.

func NewSearchResultsItem 

func NewSearchResultsItem(compositions map[string]ResultsCompositionInfoResponse, opts ...SearchResultsItemOption) *SearchResultsItem

NewSearchResultsItem instantiates a new SearchResultsItem object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed.

func (*SearchResultsItem) GetAbTestID 

func (o *SearchResultsItem) GetAbTestID() int32

GetAbTestID returns the AbTestID field value if set, zero value otherwise.

func (*SearchResultsItem) GetAbTestIDOk 

func (o *SearchResultsItem) GetAbTestIDOk() (*int32, bool)

GetAbTestIDOk returns a tuple with the AbTestID field value if set, nil otherwise and a boolean to check if the value has been set.

func (*SearchResultsItem) GetAbTestVariantID 

func (o *SearchResultsItem) GetAbTestVariantID() int32

GetAbTestVariantID returns the AbTestVariantID field value if set, zero value otherwise.

func (*SearchResultsItem) GetAbTestVariantIDOk 

func (o *SearchResultsItem) GetAbTestVariantIDOk() (*int32, bool)

GetAbTestVariantIDOk returns a tuple with the AbTestVariantID field value if set, nil otherwise and a boolean to check if the value has been set.

func (*SearchResultsItem) GetAppliedRules 

func (o *SearchResultsItem) GetAppliedRules() []map[string]any

GetAppliedRules returns the AppliedRules field value if set, zero value otherwise.

func (*SearchResultsItem) GetAppliedRulesOk 

func (o *SearchResultsItem) GetAppliedRulesOk() ([]map[string]any, bool)

GetAppliedRulesOk returns a tuple with the AppliedRules field value if set, nil otherwise and a boolean to check if the value has been set.

func (*SearchResultsItem) GetAroundLatLng 

func (o *SearchResultsItem) GetAroundLatLng() string

GetAroundLatLng returns the AroundLatLng field value if set, zero value otherwise.

func (*SearchResultsItem) GetAroundLatLngOk 

func (o *SearchResultsItem) GetAroundLatLngOk() (*string, bool)

GetAroundLatLngOk returns a tuple with the AroundLatLng field value if set, nil otherwise and a boolean to check if the value has been set.

func (*SearchResultsItem) GetAutomaticInsights 

func (o *SearchResultsItem) GetAutomaticInsights() bool

GetAutomaticInsights returns the AutomaticInsights field value if set, zero value otherwise.

func (*SearchResultsItem) GetAutomaticInsightsOk 

func (o *SearchResultsItem) GetAutomaticInsightsOk() (*bool, bool)

GetAutomaticInsightsOk returns a tuple with the AutomaticInsights field value if set, nil otherwise and a boolean to check if the value has been set.

func (*SearchResultsItem) GetAutomaticRadius 

func (o *SearchResultsItem) GetAutomaticRadius() string

GetAutomaticRadius returns the AutomaticRadius field value if set, zero value otherwise.

func (*SearchResultsItem) GetAutomaticRadiusOk 

func (o *SearchResultsItem) GetAutomaticRadiusOk() (*string, bool)

GetAutomaticRadiusOk returns a tuple with the AutomaticRadius field value if set, nil otherwise and a boolean to check if the value has been set.

func (*SearchResultsItem) GetCompositions 

func (o *SearchResultsItem) GetCompositions() map[string]ResultsCompositionInfoResponse

GetCompositions returns the Compositions field value.

func (*SearchResultsItem) GetCompositionsOk 

func (o *SearchResultsItem) GetCompositionsOk() (*map[string]ResultsCompositionInfoResponse, bool)

GetCompositionsOk returns a tuple with the Compositions field value and a boolean to check if the value has been set.

func (*SearchResultsItem) GetExhaustive 

func (o *SearchResultsItem) GetExhaustive() Exhaustive

GetExhaustive returns the Exhaustive field value if set, zero value otherwise.

func (*SearchResultsItem) GetExhaustiveFacetsCount 

func (o *SearchResultsItem) GetExhaustiveFacetsCount() bool

GetExhaustiveFacetsCount returns the ExhaustiveFacetsCount field value if set, zero value otherwise. Deprecated.

func (*SearchResultsItem) GetExhaustiveFacetsCountOk 

func (o *SearchResultsItem) GetExhaustiveFacetsCountOk() (*bool, bool)

GetExhaustiveFacetsCountOk returns a tuple with the ExhaustiveFacetsCount field value if set, nil otherwise and a boolean to check if the value has been set. Deprecated.

func (*SearchResultsItem) GetExhaustiveNbHits 

func (o *SearchResultsItem) GetExhaustiveNbHits() bool

GetExhaustiveNbHits returns the ExhaustiveNbHits field value if set, zero value otherwise. Deprecated.

func (*SearchResultsItem) GetExhaustiveNbHitsOk 

func (o *SearchResultsItem) GetExhaustiveNbHitsOk() (*bool, bool)

GetExhaustiveNbHitsOk returns a tuple with the ExhaustiveNbHits field value if set, nil otherwise and a boolean to check if the value has been set. Deprecated.

func (*SearchResultsItem) GetExhaustiveOk 

func (o *SearchResultsItem) GetExhaustiveOk() (*Exhaustive, bool)

GetExhaustiveOk returns a tuple with the Exhaustive field value if set, nil otherwise and a boolean to check if the value has been set.

func (*SearchResultsItem) GetExhaustiveTypo 

func (o *SearchResultsItem) GetExhaustiveTypo() bool

GetExhaustiveTypo returns the ExhaustiveTypo field value if set, zero value otherwise. Deprecated.

func (*SearchResultsItem) GetExhaustiveTypoOk 

func (o *SearchResultsItem) GetExhaustiveTypoOk() (*bool, bool)

GetExhaustiveTypoOk returns a tuple with the ExhaustiveTypo field value if set, nil otherwise and a boolean to check if the value has been set. Deprecated.

func (*SearchResultsItem) GetFacets 

func (o *SearchResultsItem) GetFacets() map[string]map[string]int32

GetFacets returns the Facets field value if set, zero value otherwise.

func (*SearchResultsItem) GetFacetsOk 

func (o *SearchResultsItem) GetFacetsOk() (*map[string]map[string]int32, bool)

GetFacetsOk returns a tuple with the Facets field value if set, nil otherwise and a boolean to check if the value has been set.

func (*SearchResultsItem) GetFacetsStats 

func (o *SearchResultsItem) GetFacetsStats() map[string]FacetStats

GetFacetsStats returns the FacetsStats field value if set, zero value otherwise.

func (*SearchResultsItem) GetFacetsStatsOk 

func (o *SearchResultsItem) GetFacetsStatsOk() (*map[string]FacetStats, bool)

GetFacetsStatsOk returns a tuple with the FacetsStats field value if set, nil otherwise and a boolean to check if the value has been set.

func (*SearchResultsItem) GetFeedID added in v4.37.0 

func (o *SearchResultsItem) GetFeedID() string

GetFeedID returns the FeedID field value if set, zero value otherwise.

func (*SearchResultsItem) GetFeedIDOk added in v4.37.0 

func (o *SearchResultsItem) GetFeedIDOk() (*string, bool)

GetFeedIDOk returns a tuple with the FeedID field value if set, nil otherwise and a boolean to check if the value has been set.

func (*SearchResultsItem) GetHits 

func (o *SearchResultsItem) GetHits() []Hit

GetHits returns the Hits field value if set, zero value otherwise.

func (*SearchResultsItem) GetHitsOk 

func (o *SearchResultsItem) GetHitsOk() ([]Hit, bool)

GetHitsOk returns a tuple with the Hits field value if set, nil otherwise and a boolean to check if the value has been set.

func (*SearchResultsItem) GetHitsPerPage 

func (o *SearchResultsItem) GetHitsPerPage() int32

GetHitsPerPage returns the HitsPerPage field value if set, zero value otherwise.

func (*SearchResultsItem) GetHitsPerPageOk 

func (o *SearchResultsItem) GetHitsPerPageOk() (*int32, bool)

GetHitsPerPageOk returns a tuple with the HitsPerPage field value if set, nil otherwise and a boolean to check if the value has been set.

func (*SearchResultsItem) GetIndex 

func (o *SearchResultsItem) GetIndex() string

GetIndex returns the Index field value if set, zero value otherwise.

func (*SearchResultsItem) GetIndexOk 

func (o *SearchResultsItem) GetIndexOk() (*string, bool)

GetIndexOk returns a tuple with the Index field value if set, nil otherwise and a boolean to check if the value has been set.

func (*SearchResultsItem) GetIndexUsed 

func (o *SearchResultsItem) GetIndexUsed() string

GetIndexUsed returns the IndexUsed field value if set, zero value otherwise.

func (*SearchResultsItem) GetIndexUsedOk 

func (o *SearchResultsItem) GetIndexUsedOk() (*string, bool)

GetIndexUsedOk returns a tuple with the IndexUsed field value if set, nil otherwise and a boolean to check if the value has been set.

func (*SearchResultsItem) GetMessage 

func (o *SearchResultsItem) GetMessage() string

GetMessage returns the Message field value if set, zero value otherwise.

func (*SearchResultsItem) GetMessageOk 

func (o *SearchResultsItem) GetMessageOk() (*string, bool)

GetMessageOk returns a tuple with the Message field value if set, nil otherwise and a boolean to check if the value has been set.

func (*SearchResultsItem) GetNbHits 

func (o *SearchResultsItem) GetNbHits() int32

GetNbHits returns the NbHits field value if set, zero value otherwise.

func (*SearchResultsItem) GetNbHitsOk 

func (o *SearchResultsItem) GetNbHitsOk() (*int32, bool)

GetNbHitsOk returns a tuple with the NbHits field value if set, nil otherwise and a boolean to check if the value has been set.

func (*SearchResultsItem) GetNbPages 

func (o *SearchResultsItem) GetNbPages() int32

GetNbPages returns the NbPages field value if set, zero value otherwise.

func (*SearchResultsItem) GetNbPagesOk 

func (o *SearchResultsItem) GetNbPagesOk() (*int32, bool)

GetNbPagesOk returns a tuple with the NbPages field value if set, nil otherwise and a boolean to check if the value has been set.

func (*SearchResultsItem) GetNbSortedHits 

func (o *SearchResultsItem) GetNbSortedHits() int32

GetNbSortedHits returns the NbSortedHits field value if set, zero value otherwise.

func (*SearchResultsItem) GetNbSortedHitsOk 

func (o *SearchResultsItem) GetNbSortedHitsOk() (*int32, bool)

GetNbSortedHitsOk returns a tuple with the NbSortedHits field value if set, nil otherwise and a boolean to check if the value has been set.

func (*SearchResultsItem) GetPage 

func (o *SearchResultsItem) GetPage() int32

GetPage returns the Page field value if set, zero value otherwise.

func (*SearchResultsItem) GetPageOk 

func (o *SearchResultsItem) GetPageOk() (*int32, bool)

GetPageOk returns a tuple with the Page field value if set, nil otherwise and a boolean to check if the value has been set.

func (*SearchResultsItem) GetParams 

func (o *SearchResultsItem) GetParams() string

GetParams returns the Params field value if set, zero value otherwise.

func (*SearchResultsItem) GetParamsOk 

func (o *SearchResultsItem) GetParamsOk() (*string, bool)

GetParamsOk returns a tuple with the Params field value if set, nil otherwise and a boolean to check if the value has been set.

func (*SearchResultsItem) GetParsedQuery 

func (o *SearchResultsItem) GetParsedQuery() string

GetParsedQuery returns the ParsedQuery field value if set, zero value otherwise.

func (*SearchResultsItem) GetParsedQueryOk 

func (o *SearchResultsItem) GetParsedQueryOk() (*string, bool)

GetParsedQueryOk returns a tuple with the ParsedQuery field value if set, nil otherwise and a boolean to check if the value has been set.

func (*SearchResultsItem) GetProcessingTimeMS 

func (o *SearchResultsItem) GetProcessingTimeMS() int32

GetProcessingTimeMS returns the ProcessingTimeMS field value if set, zero value otherwise.

func (*SearchResultsItem) GetProcessingTimeMSOk 

func (o *SearchResultsItem) GetProcessingTimeMSOk() (*int32, bool)

GetProcessingTimeMSOk returns a tuple with the ProcessingTimeMS field value if set, nil otherwise and a boolean to check if the value has been set.

func (*SearchResultsItem) GetProcessingTimingsMS 

func (o *SearchResultsItem) GetProcessingTimingsMS() map[string]any

GetProcessingTimingsMS returns the ProcessingTimingsMS field value if set, zero value otherwise.

func (*SearchResultsItem) GetProcessingTimingsMSOk 

func (o *SearchResultsItem) GetProcessingTimingsMSOk() (map[string]any, bool)

GetProcessingTimingsMSOk returns a tuple with the ProcessingTimingsMS field value if set, nil otherwise and a boolean to check if the value has been set.

func (*SearchResultsItem) GetQuery 

func (o *SearchResultsItem) GetQuery() string

GetQuery returns the Query field value if set, zero value otherwise.

func (*SearchResultsItem) GetQueryAfterRemoval 

func (o *SearchResultsItem) GetQueryAfterRemoval() string

GetQueryAfterRemoval returns the QueryAfterRemoval field value if set, zero value otherwise.

func (*SearchResultsItem) GetQueryAfterRemovalOk 

func (o *SearchResultsItem) GetQueryAfterRemovalOk() (*string, bool)

GetQueryAfterRemovalOk returns a tuple with the QueryAfterRemoval field value if set, nil otherwise and a boolean to check if the value has been set.

func (*SearchResultsItem) GetQueryID 

func (o *SearchResultsItem) GetQueryID() string

GetQueryID returns the QueryID field value if set, zero value otherwise.

func (*SearchResultsItem) GetQueryIDOk 

func (o *SearchResultsItem) GetQueryIDOk() (*string, bool)

GetQueryIDOk returns a tuple with the QueryID field value if set, nil otherwise and a boolean to check if the value has been set.

func (*SearchResultsItem) GetQueryOk 

func (o *SearchResultsItem) GetQueryOk() (*string, bool)

GetQueryOk returns a tuple with the Query field value if set, nil otherwise and a boolean to check if the value has been set.

func (*SearchResultsItem) GetRedirect 

func (o *SearchResultsItem) GetRedirect() Redirect

GetRedirect returns the Redirect field value if set, zero value otherwise.

func (*SearchResultsItem) GetRedirectOk 

func (o *SearchResultsItem) GetRedirectOk() (*Redirect, bool)

GetRedirectOk returns a tuple with the Redirect field value if set, nil otherwise and a boolean to check if the value has been set.

func (*SearchResultsItem) GetRenderingContent 

func (o *SearchResultsItem) GetRenderingContent() RenderingContent

GetRenderingContent returns the RenderingContent field value if set, zero value otherwise.

func (*SearchResultsItem) GetRenderingContentOk 

func (o *SearchResultsItem) GetRenderingContentOk() (*RenderingContent, bool)

GetRenderingContentOk returns a tuple with the RenderingContent field value if set, nil otherwise and a boolean to check if the value has been set.

func (*SearchResultsItem) GetServerTimeMS 

func (o *SearchResultsItem) GetServerTimeMS() int32

GetServerTimeMS returns the ServerTimeMS field value if set, zero value otherwise.

func (*SearchResultsItem) GetServerTimeMSOk 

func (o *SearchResultsItem) GetServerTimeMSOk() (*int32, bool)

GetServerTimeMSOk returns a tuple with the ServerTimeMS field value if set, nil otherwise and a boolean to check if the value has been set.

func (*SearchResultsItem) GetServerUsed 

func (o *SearchResultsItem) GetServerUsed() string

GetServerUsed returns the ServerUsed field value if set, zero value otherwise.

func (*SearchResultsItem) GetServerUsedOk 

func (o *SearchResultsItem) GetServerUsedOk() (*string, bool)

GetServerUsedOk returns a tuple with the ServerUsed field value if set, nil otherwise and a boolean to check if the value has been set.

func (*SearchResultsItem) GetUserData 

func (o *SearchResultsItem) GetUserData() any

GetUserData returns the UserData field value if set, zero value otherwise (both if not set or set to explicit null).

func (*SearchResultsItem) GetUserDataOk 

func (o *SearchResultsItem) GetUserDataOk() (*any, bool)

GetUserDataOk returns a tuple with the UserData field value if set, nil otherwise and a boolean to check if the value has been set. NOTE: If the value is an explicit nil, `nil, true` will be returned.

func (*SearchResultsItem) HasAbTestID 

func (o *SearchResultsItem) HasAbTestID() bool

HasAbTestID returns a boolean if a field has been set.

func (*SearchResultsItem) HasAbTestVariantID 

func (o *SearchResultsItem) HasAbTestVariantID() bool

HasAbTestVariantID returns a boolean if a field has been set.

func (*SearchResultsItem) HasAppliedRules 

func (o *SearchResultsItem) HasAppliedRules() bool

HasAppliedRules returns a boolean if a field has been set.

func (*SearchResultsItem) HasAroundLatLng 

func (o *SearchResultsItem) HasAroundLatLng() bool

HasAroundLatLng returns a boolean if a field has been set.

func (*SearchResultsItem) HasAutomaticInsights 

func (o *SearchResultsItem) HasAutomaticInsights() bool

HasAutomaticInsights returns a boolean if a field has been set.

func (*SearchResultsItem) HasAutomaticRadius 

func (o *SearchResultsItem) HasAutomaticRadius() bool

HasAutomaticRadius returns a boolean if a field has been set.

func (*SearchResultsItem) HasExhaustive 

func (o *SearchResultsItem) HasExhaustive() bool

HasExhaustive returns a boolean if a field has been set.

func (*SearchResultsItem) HasExhaustiveFacetsCount 

func (o *SearchResultsItem) HasExhaustiveFacetsCount() bool

HasExhaustiveFacetsCount returns a boolean if a field has been set.

func (*SearchResultsItem) HasExhaustiveNbHits 

func (o *SearchResultsItem) HasExhaustiveNbHits() bool

HasExhaustiveNbHits returns a boolean if a field has been set.

func (*SearchResultsItem) HasExhaustiveTypo 

func (o *SearchResultsItem) HasExhaustiveTypo() bool

HasExhaustiveTypo returns a boolean if a field has been set.

func (*SearchResultsItem) HasFacets 

func (o *SearchResultsItem) HasFacets() bool

HasFacets returns a boolean if a field has been set.

func (*SearchResultsItem) HasFacetsStats 

func (o *SearchResultsItem) HasFacetsStats() bool

HasFacetsStats returns a boolean if a field has been set.

func (*SearchResultsItem) HasFeedID added in v4.37.0 

func (o *SearchResultsItem) HasFeedID() bool

HasFeedID returns a boolean if a field has been set.

func (*SearchResultsItem) HasHits added in v4.34.2 

func (o *SearchResultsItem) HasHits() bool

HasHits returns a boolean if a field has been set.

func (*SearchResultsItem) HasHitsPerPage added in v4.34.2 

func (o *SearchResultsItem) HasHitsPerPage() bool

HasHitsPerPage returns a boolean if a field has been set.

func (*SearchResultsItem) HasIndex 

func (o *SearchResultsItem) HasIndex() bool

HasIndex returns a boolean if a field has been set.

func (*SearchResultsItem) HasIndexUsed 

func (o *SearchResultsItem) HasIndexUsed() bool

HasIndexUsed returns a boolean if a field has been set.

func (*SearchResultsItem) HasMessage 

func (o *SearchResultsItem) HasMessage() bool

HasMessage returns a boolean if a field has been set.

func (*SearchResultsItem) HasNbHits added in v4.34.2 

func (o *SearchResultsItem) HasNbHits() bool

HasNbHits returns a boolean if a field has been set.

func (*SearchResultsItem) HasNbPages added in v4.34.2 

func (o *SearchResultsItem) HasNbPages() bool

HasNbPages returns a boolean if a field has been set.

func (*SearchResultsItem) HasNbSortedHits 

func (o *SearchResultsItem) HasNbSortedHits() bool

HasNbSortedHits returns a boolean if a field has been set.

func (*SearchResultsItem) HasPage added in v4.34.2 

func (o *SearchResultsItem) HasPage() bool

HasPage returns a boolean if a field has been set.

func (*SearchResultsItem) HasParams added in v4.34.2 

func (o *SearchResultsItem) HasParams() bool

HasParams returns a boolean if a field has been set.

func (*SearchResultsItem) HasParsedQuery 

func (o *SearchResultsItem) HasParsedQuery() bool

HasParsedQuery returns a boolean if a field has been set.

func (*SearchResultsItem) HasProcessingTimeMS added in v4.19.0 

func (o *SearchResultsItem) HasProcessingTimeMS() bool

HasProcessingTimeMS returns a boolean if a field has been set.

func (*SearchResultsItem) HasProcessingTimingsMS 

func (o *SearchResultsItem) HasProcessingTimingsMS() bool

HasProcessingTimingsMS returns a boolean if a field has been set.

func (*SearchResultsItem) HasQuery added in v4.34.2 

func (o *SearchResultsItem) HasQuery() bool

HasQuery returns a boolean if a field has been set.

func (*SearchResultsItem) HasQueryAfterRemoval 

func (o *SearchResultsItem) HasQueryAfterRemoval() bool

HasQueryAfterRemoval returns a boolean if a field has been set.

func (*SearchResultsItem) HasQueryID 

func (o *SearchResultsItem) HasQueryID() bool

HasQueryID returns a boolean if a field has been set.

func (*SearchResultsItem) HasRedirect 

func (o *SearchResultsItem) HasRedirect() bool

HasRedirect returns a boolean if a field has been set.

func (*SearchResultsItem) HasRenderingContent 

func (o *SearchResultsItem) HasRenderingContent() bool

HasRenderingContent returns a boolean if a field has been set.

func (*SearchResultsItem) HasServerTimeMS 

func (o *SearchResultsItem) HasServerTimeMS() bool

HasServerTimeMS returns a boolean if a field has been set.

func (*SearchResultsItem) HasServerUsed 

func (o *SearchResultsItem) HasServerUsed() bool

HasServerUsed returns a boolean if a field has been set.

func (*SearchResultsItem) HasUserData 

func (o *SearchResultsItem) HasUserData() bool

HasUserData returns a boolean if a field has been set.

func (SearchResultsItem) MarshalJSON 

func (o SearchResultsItem) MarshalJSON() ([]byte, error)

func (*SearchResultsItem) SetAbTestID 

func (o *SearchResultsItem) SetAbTestID(v int32) *SearchResultsItem

SetAbTestID gets a reference to the given int32 and assigns it to the AbTestID field.

func (*SearchResultsItem) SetAbTestVariantID 

func (o *SearchResultsItem) SetAbTestVariantID(v int32) *SearchResultsItem

SetAbTestVariantID gets a reference to the given int32 and assigns it to the AbTestVariantID field.

func (*SearchResultsItem) SetAppliedRules 

func (o *SearchResultsItem) SetAppliedRules(v []map[string]any) *SearchResultsItem

SetAppliedRules gets a reference to the given []map[string]any and assigns it to the AppliedRules field.

func (*SearchResultsItem) SetAroundLatLng 

func (o *SearchResultsItem) SetAroundLatLng(v string) *SearchResultsItem

SetAroundLatLng gets a reference to the given string and assigns it to the AroundLatLng field.

func (*SearchResultsItem) SetAutomaticInsights 

func (o *SearchResultsItem) SetAutomaticInsights(v bool) *SearchResultsItem

SetAutomaticInsights gets a reference to the given bool and assigns it to the AutomaticInsights field.

func (*SearchResultsItem) SetAutomaticRadius 

func (o *SearchResultsItem) SetAutomaticRadius(v string) *SearchResultsItem

SetAutomaticRadius gets a reference to the given string and assigns it to the AutomaticRadius field.

func (*SearchResultsItem) SetCompositions 

func (o *SearchResultsItem) SetCompositions(v map[string]ResultsCompositionInfoResponse) *SearchResultsItem

SetCompositions sets field value.

func (*SearchResultsItem) SetExhaustive 

func (o *SearchResultsItem) SetExhaustive(v *Exhaustive) *SearchResultsItem

SetExhaustive gets a reference to the given Exhaustive and assigns it to the Exhaustive field.

func (*SearchResultsItem) SetExhaustiveFacetsCount 

func (o *SearchResultsItem) SetExhaustiveFacetsCount(v bool) *SearchResultsItem

SetExhaustiveFacetsCount gets a reference to the given bool and assigns it to the ExhaustiveFacetsCount field. Deprecated.

func (*SearchResultsItem) SetExhaustiveNbHits 

func (o *SearchResultsItem) SetExhaustiveNbHits(v bool) *SearchResultsItem

SetExhaustiveNbHits gets a reference to the given bool and assigns it to the ExhaustiveNbHits field. Deprecated.

func (*SearchResultsItem) SetExhaustiveTypo 

func (o *SearchResultsItem) SetExhaustiveTypo(v bool) *SearchResultsItem

SetExhaustiveTypo gets a reference to the given bool and assigns it to the ExhaustiveTypo field. Deprecated.

func (*SearchResultsItem) SetFacets 

func (o *SearchResultsItem) SetFacets(v map[string]map[string]int32) *SearchResultsItem

SetFacets gets a reference to the given map[string]map[string]int32 and assigns it to the Facets field.

func (*SearchResultsItem) SetFacetsStats 

func (o *SearchResultsItem) SetFacetsStats(v map[string]FacetStats) *SearchResultsItem

SetFacetsStats gets a reference to the given map[string]FacetStats and assigns it to the FacetsStats field.

func (*SearchResultsItem) SetFeedID added in v4.37.0 

func (o *SearchResultsItem) SetFeedID(v string) *SearchResultsItem

SetFeedID gets a reference to the given string and assigns it to the FeedID field.

func (*SearchResultsItem) SetHits 

func (o *SearchResultsItem) SetHits(v []Hit) *SearchResultsItem

SetHits gets a reference to the given []Hit and assigns it to the Hits field.

func (*SearchResultsItem) SetHitsPerPage 

func (o *SearchResultsItem) SetHitsPerPage(v int32) *SearchResultsItem

SetHitsPerPage gets a reference to the given int32 and assigns it to the HitsPerPage field.

func (*SearchResultsItem) SetIndex 

func (o *SearchResultsItem) SetIndex(v string) *SearchResultsItem

SetIndex gets a reference to the given string and assigns it to the Index field.

func (*SearchResultsItem) SetIndexUsed 

func (o *SearchResultsItem) SetIndexUsed(v string) *SearchResultsItem

SetIndexUsed gets a reference to the given string and assigns it to the IndexUsed field.

func (*SearchResultsItem) SetMessage 

func (o *SearchResultsItem) SetMessage(v string) *SearchResultsItem

SetMessage gets a reference to the given string and assigns it to the Message field.

func (*SearchResultsItem) SetNbHits 

func (o *SearchResultsItem) SetNbHits(v int32) *SearchResultsItem

SetNbHits gets a reference to the given int32 and assigns it to the NbHits field.

func (*SearchResultsItem) SetNbPages 

func (o *SearchResultsItem) SetNbPages(v int32) *SearchResultsItem

SetNbPages gets a reference to the given int32 and assigns it to the NbPages field.

func (*SearchResultsItem) SetNbSortedHits 

func (o *SearchResultsItem) SetNbSortedHits(v int32) *SearchResultsItem

SetNbSortedHits gets a reference to the given int32 and assigns it to the NbSortedHits field.

func (*SearchResultsItem) SetPage 

func (o *SearchResultsItem) SetPage(v int32) *SearchResultsItem

SetPage gets a reference to the given int32 and assigns it to the Page field.

func (*SearchResultsItem) SetParams 

func (o *SearchResultsItem) SetParams(v string) *SearchResultsItem

SetParams gets a reference to the given string and assigns it to the Params field.

func (*SearchResultsItem) SetParsedQuery 

func (o *SearchResultsItem) SetParsedQuery(v string) *SearchResultsItem

SetParsedQuery gets a reference to the given string and assigns it to the ParsedQuery field.

func (*SearchResultsItem) SetProcessingTimeMS 

func (o *SearchResultsItem) SetProcessingTimeMS(v int32) *SearchResultsItem

SetProcessingTimeMS gets a reference to the given int32 and assigns it to the ProcessingTimeMS field.

func (*SearchResultsItem) SetProcessingTimingsMS 

func (o *SearchResultsItem) SetProcessingTimingsMS(v map[string]any) *SearchResultsItem

SetProcessingTimingsMS gets a reference to the given map[string]any and assigns it to the ProcessingTimingsMS field.

func (*SearchResultsItem) SetQuery 

func (o *SearchResultsItem) SetQuery(v string) *SearchResultsItem

SetQuery gets a reference to the given string and assigns it to the Query field.

func (*SearchResultsItem) SetQueryAfterRemoval 

func (o *SearchResultsItem) SetQueryAfterRemoval(v string) *SearchResultsItem

SetQueryAfterRemoval gets a reference to the given string and assigns it to the QueryAfterRemoval field.

func (*SearchResultsItem) SetQueryID 

func (o *SearchResultsItem) SetQueryID(v string) *SearchResultsItem

SetQueryID gets a reference to the given string and assigns it to the QueryID field.

func (*SearchResultsItem) SetRedirect 

func (o *SearchResultsItem) SetRedirect(v *Redirect) *SearchResultsItem

SetRedirect gets a reference to the given Redirect and assigns it to the Redirect field.

func (*SearchResultsItem) SetRenderingContent 

func (o *SearchResultsItem) SetRenderingContent(v *RenderingContent) *SearchResultsItem

SetRenderingContent gets a reference to the given RenderingContent and assigns it to the RenderingContent field.

func (*SearchResultsItem) SetServerTimeMS 

func (o *SearchResultsItem) SetServerTimeMS(v int32) *SearchResultsItem

SetServerTimeMS gets a reference to the given int32 and assigns it to the ServerTimeMS field.

func (*SearchResultsItem) SetServerUsed 

func (o *SearchResultsItem) SetServerUsed(v string) *SearchResultsItem

SetServerUsed gets a reference to the given string and assigns it to the ServerUsed field.

func (*SearchResultsItem) SetUserData 

func (o *SearchResultsItem) SetUserData(v any) *SearchResultsItem

SetUserData gets a reference to the given any and assigns it to the UserData field.

func (SearchResultsItem) String 

func (o SearchResultsItem) String() string

type SearchResultsItemOption 

type SearchResultsItemOption func(f *SearchResultsItem)

func WithSearchResultsItemAbTestID 

func WithSearchResultsItemAbTestID(val int32) SearchResultsItemOption

func WithSearchResultsItemAbTestVariantID 

func WithSearchResultsItemAbTestVariantID(val int32) SearchResultsItemOption

func WithSearchResultsItemAppliedRules 

func WithSearchResultsItemAppliedRules(val []map[string]any) SearchResultsItemOption

func WithSearchResultsItemAroundLatLng 

func WithSearchResultsItemAroundLatLng(val string) SearchResultsItemOption

func WithSearchResultsItemAutomaticInsights 

func WithSearchResultsItemAutomaticInsights(val bool) SearchResultsItemOption

func WithSearchResultsItemAutomaticRadius 

func WithSearchResultsItemAutomaticRadius(val string) SearchResultsItemOption

func WithSearchResultsItemExhaustive 

func WithSearchResultsItemExhaustive(val Exhaustive) SearchResultsItemOption

func WithSearchResultsItemExhaustiveFacetsCount 

func WithSearchResultsItemExhaustiveFacetsCount(val bool) SearchResultsItemOption

func WithSearchResultsItemExhaustiveNbHits 

func WithSearchResultsItemExhaustiveNbHits(val bool) SearchResultsItemOption

func WithSearchResultsItemExhaustiveTypo 

func WithSearchResultsItemExhaustiveTypo(val bool) SearchResultsItemOption

func WithSearchResultsItemFacets 

func WithSearchResultsItemFacets(val map[string]map[string]int32) SearchResultsItemOption

func WithSearchResultsItemFacetsStats 

func WithSearchResultsItemFacetsStats(val map[string]FacetStats) SearchResultsItemOption

func WithSearchResultsItemFeedID added in v4.37.0 

func WithSearchResultsItemFeedID(val string) SearchResultsItemOption

func WithSearchResultsItemHits added in v4.34.2 

func WithSearchResultsItemHits(val []Hit) SearchResultsItemOption

func WithSearchResultsItemHitsPerPage added in v4.34.2 

func WithSearchResultsItemHitsPerPage(val int32) SearchResultsItemOption

func WithSearchResultsItemIndex 

func WithSearchResultsItemIndex(val string) SearchResultsItemOption

func WithSearchResultsItemIndexUsed 

func WithSearchResultsItemIndexUsed(val string) SearchResultsItemOption

func WithSearchResultsItemMessage 

func WithSearchResultsItemMessage(val string) SearchResultsItemOption

func WithSearchResultsItemNbHits added in v4.34.2 

func WithSearchResultsItemNbHits(val int32) SearchResultsItemOption

func WithSearchResultsItemNbPages added in v4.34.2 

func WithSearchResultsItemNbPages(val int32) SearchResultsItemOption

func WithSearchResultsItemNbSortedHits 

func WithSearchResultsItemNbSortedHits(val int32) SearchResultsItemOption

func WithSearchResultsItemPage added in v4.34.2 

func WithSearchResultsItemPage(val int32) SearchResultsItemOption

func WithSearchResultsItemParams added in v4.34.2 

func WithSearchResultsItemParams(val string) SearchResultsItemOption

func WithSearchResultsItemParsedQuery 

func WithSearchResultsItemParsedQuery(val string) SearchResultsItemOption

func WithSearchResultsItemProcessingTimeMS added in v4.19.0 

func WithSearchResultsItemProcessingTimeMS(val int32) SearchResultsItemOption

func WithSearchResultsItemProcessingTimingsMS 

func WithSearchResultsItemProcessingTimingsMS(val map[string]any) SearchResultsItemOption

func WithSearchResultsItemQuery added in v4.34.2 

func WithSearchResultsItemQuery(val string) SearchResultsItemOption

func WithSearchResultsItemQueryAfterRemoval 

func WithSearchResultsItemQueryAfterRemoval(val string) SearchResultsItemOption

func WithSearchResultsItemQueryID 

func WithSearchResultsItemQueryID(val string) SearchResultsItemOption

func WithSearchResultsItemRedirect 

func WithSearchResultsItemRedirect(val Redirect) SearchResultsItemOption

func WithSearchResultsItemRenderingContent 

func WithSearchResultsItemRenderingContent(val RenderingContent) SearchResultsItemOption

func WithSearchResultsItemServerTimeMS 

func WithSearchResultsItemServerTimeMS(val int32) SearchResultsItemOption

func WithSearchResultsItemServerUsed 

func WithSearchResultsItemServerUsed(val string) SearchResultsItemOption

func WithSearchResultsItemUserData 

func WithSearchResultsItemUserData(val any) SearchResultsItemOption

type SnippetResult 

type SnippetResult struct {
	SnippetResultOption         *SnippetResultOption
	ArrayOfSnippetResult        *[]SnippetResult
	MapmapOfStringSnippetResult *map[string]SnippetResult
}

SnippetResult - struct for SnippetResult.

func ArrayOfSnippetResultAsSnippetResult 

func ArrayOfSnippetResultAsSnippetResult(v []SnippetResult) *SnippetResult

[]SnippetResultAsSnippetResult is a convenience function that returns []SnippetResult wrapped in SnippetResult.

func MapmapOfStringSnippetResultAsSnippetResult 

func MapmapOfStringSnippetResultAsSnippetResult(v map[string]SnippetResult) *SnippetResult

map[string]SnippetResultAsSnippetResult is a convenience function that returns map[string]SnippetResult wrapped in SnippetResult.

func SnippetResultOptionAsSnippetResult 

func SnippetResultOptionAsSnippetResult(v *SnippetResultOption) *SnippetResult

SnippetResultOptionAsSnippetResult is a convenience function that returns SnippetResultOption wrapped in SnippetResult.

func (SnippetResult) GetActualInstance 

func (obj SnippetResult) GetActualInstance() any

Get the actual instance.

func (SnippetResult) MarshalJSON 

func (src SnippetResult) MarshalJSON() ([]byte, error)

Marshal data from the first non-nil pointers in the struct to JSON.

func (*SnippetResult) UnmarshalJSON 

func (dst *SnippetResult) UnmarshalJSON(data []byte) error

Unmarshal JSON data into one or more of the pointers in the struct.

type SnippetResultOption 

type SnippetResultOption struct {
	// Highlighted attribute value, including HTML tags.
	Value      string     `json:"value"`
	MatchLevel MatchLevel `json:"matchLevel"`
}

SnippetResultOption Snippets that show the context around a matching search query.

func NewEmptySnippetResultOption 

func NewEmptySnippetResultOption() *SnippetResultOption

NewEmptySnippetResultOption return a pointer to an empty SnippetResultOption object.

func NewSnippetResultOption 

func NewSnippetResultOption(value string, matchLevel MatchLevel) *SnippetResultOption

NewSnippetResultOption instantiates a new SnippetResultOption object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed.

func (*SnippetResultOption) GetMatchLevel 

func (o *SnippetResultOption) GetMatchLevel() MatchLevel

GetMatchLevel returns the MatchLevel field value.

func (*SnippetResultOption) GetMatchLevelOk 

func (o *SnippetResultOption) GetMatchLevelOk() (*MatchLevel, bool)

GetMatchLevelOk returns a tuple with the MatchLevel field value and a boolean to check if the value has been set.

func (*SnippetResultOption) GetValue 

func (o *SnippetResultOption) GetValue() string

GetValue returns the Value field value.

func (*SnippetResultOption) GetValueOk 

func (o *SnippetResultOption) GetValueOk() (*string, bool)

GetValueOk returns a tuple with the Value field value and a boolean to check if the value has been set.

func (SnippetResultOption) MarshalJSON 

func (o SnippetResultOption) MarshalJSON() ([]byte, error)

func (*SnippetResultOption) SetMatchLevel 

func (o *SnippetResultOption) SetMatchLevel(v MatchLevel) *SnippetResultOption

SetMatchLevel sets field value.

func (*SnippetResultOption) SetValue 

func (o *SnippetResultOption) SetValue(v string) *SnippetResultOption

SetValue sets field value.

func (SnippetResultOption) String 

func (o SnippetResultOption) String() string

type SortRemainingBy 

type SortRemainingBy string

SortRemainingBy Order of facet values that aren't explicitly positioned with the `order` setting. - `count`. Order remaining facet values by decreasing count. The count is the number of matching records containing this facet value. - `alpha`. Sort facet values alphabetically. - `hidden`. Don't show facet values that aren't explicitly positioned. 

const (
	SORT_REMAINING_BY_COUNT  SortRemainingBy = "count"
	SORT_REMAINING_BY_ALPHA  SortRemainingBy = "alpha"
	SORT_REMAINING_BY_HIDDEN SortRemainingBy = "hidden"
)

List of sortRemainingBy.

func NewSortRemainingByFromValue 

func NewSortRemainingByFromValue(v string) (*SortRemainingBy, error)

NewSortRemainingByFromValue returns a pointer to a valid SortRemainingBy. for the value passed as argument, or an error if the value passed is not allowed by the enum.

func (SortRemainingBy) IsValid 

func (v SortRemainingBy) IsValid() bool

IsValid return true if the value is valid for the enum, false otherwise.

func (SortRemainingBy) Ptr 

func (v SortRemainingBy) Ptr() *SortRemainingBy

Ptr returns reference to sortRemainingBy value.

func (*SortRemainingBy) UnmarshalJSON 

func (v *SortRemainingBy) UnmarshalJSON(src []byte) error

type SupportedLanguage 

type SupportedLanguage string

SupportedLanguage ISO code for a supported language. 

const (
	SUPPORTED_LANGUAGE_AF    SupportedLanguage = "af"
	SUPPORTED_LANGUAGE_AR    SupportedLanguage = "ar"
	SUPPORTED_LANGUAGE_AZ    SupportedLanguage = "az"
	SUPPORTED_LANGUAGE_BG    SupportedLanguage = "bg"
	SUPPORTED_LANGUAGE_BN    SupportedLanguage = "bn"
	SUPPORTED_LANGUAGE_CA    SupportedLanguage = "ca"
	SUPPORTED_LANGUAGE_CS    SupportedLanguage = "cs"
	SUPPORTED_LANGUAGE_CY    SupportedLanguage = "cy"
	SUPPORTED_LANGUAGE_DA    SupportedLanguage = "da"
	SUPPORTED_LANGUAGE_DE    SupportedLanguage = "de"
	SUPPORTED_LANGUAGE_EL    SupportedLanguage = "el"
	SUPPORTED_LANGUAGE_EN    SupportedLanguage = "en"
	SUPPORTED_LANGUAGE_EO    SupportedLanguage = "eo"
	SUPPORTED_LANGUAGE_ES    SupportedLanguage = "es"
	SUPPORTED_LANGUAGE_ET    SupportedLanguage = "et"
	SUPPORTED_LANGUAGE_EU    SupportedLanguage = "eu"
	SUPPORTED_LANGUAGE_FA    SupportedLanguage = "fa"
	SUPPORTED_LANGUAGE_FI    SupportedLanguage = "fi"
	SUPPORTED_LANGUAGE_FO    SupportedLanguage = "fo"
	SUPPORTED_LANGUAGE_FR    SupportedLanguage = "fr"
	SUPPORTED_LANGUAGE_GA    SupportedLanguage = "ga"
	SUPPORTED_LANGUAGE_GL    SupportedLanguage = "gl"
	SUPPORTED_LANGUAGE_HE    SupportedLanguage = "he"
	SUPPORTED_LANGUAGE_HI    SupportedLanguage = "hi"
	SUPPORTED_LANGUAGE_HU    SupportedLanguage = "hu"
	SUPPORTED_LANGUAGE_HY    SupportedLanguage = "hy"
	SUPPORTED_LANGUAGE_ID    SupportedLanguage = "id"
	SUPPORTED_LANGUAGE_IS    SupportedLanguage = "is"
	SUPPORTED_LANGUAGE_IT    SupportedLanguage = "it"
	SUPPORTED_LANGUAGE_JA    SupportedLanguage = "ja"
	SUPPORTED_LANGUAGE_KA    SupportedLanguage = "ka"
	SUPPORTED_LANGUAGE_KK    SupportedLanguage = "kk"
	SUPPORTED_LANGUAGE_KO    SupportedLanguage = "ko"
	SUPPORTED_LANGUAGE_KU    SupportedLanguage = "ku"
	SUPPORTED_LANGUAGE_KY    SupportedLanguage = "ky"
	SUPPORTED_LANGUAGE_LT    SupportedLanguage = "lt"
	SUPPORTED_LANGUAGE_LV    SupportedLanguage = "lv"
	SUPPORTED_LANGUAGE_MI    SupportedLanguage = "mi"
	SUPPORTED_LANGUAGE_MN    SupportedLanguage = "mn"
	SUPPORTED_LANGUAGE_MR    SupportedLanguage = "mr"
	SUPPORTED_LANGUAGE_MS    SupportedLanguage = "ms"
	SUPPORTED_LANGUAGE_MT    SupportedLanguage = "mt"
	SUPPORTED_LANGUAGE_NB    SupportedLanguage = "nb"
	SUPPORTED_LANGUAGE_NL    SupportedLanguage = "nl"
	SUPPORTED_LANGUAGE_NO    SupportedLanguage = "no"
	SUPPORTED_LANGUAGE_NS    SupportedLanguage = "ns"
	SUPPORTED_LANGUAGE_PL    SupportedLanguage = "pl"
	SUPPORTED_LANGUAGE_PS    SupportedLanguage = "ps"
	SUPPORTED_LANGUAGE_PT    SupportedLanguage = "pt"
	SUPPORTED_LANGUAGE_PT_BR SupportedLanguage = "pt-br"
	SUPPORTED_LANGUAGE_QU    SupportedLanguage = "qu"
	SUPPORTED_LANGUAGE_RO    SupportedLanguage = "ro"
	SUPPORTED_LANGUAGE_RU    SupportedLanguage = "ru"
	SUPPORTED_LANGUAGE_SK    SupportedLanguage = "sk"
	SUPPORTED_LANGUAGE_SQ    SupportedLanguage = "sq"
	SUPPORTED_LANGUAGE_SV    SupportedLanguage = "sv"
	SUPPORTED_LANGUAGE_SW    SupportedLanguage = "sw"
	SUPPORTED_LANGUAGE_TA    SupportedLanguage = "ta"
	SUPPORTED_LANGUAGE_TE    SupportedLanguage = "te"
	SUPPORTED_LANGUAGE_TH    SupportedLanguage = "th"
	SUPPORTED_LANGUAGE_TL    SupportedLanguage = "tl"
	SUPPORTED_LANGUAGE_TN    SupportedLanguage = "tn"
	SUPPORTED_LANGUAGE_TR    SupportedLanguage = "tr"
	SUPPORTED_LANGUAGE_TT    SupportedLanguage = "tt"
	SUPPORTED_LANGUAGE_UK    SupportedLanguage = "uk"
	SUPPORTED_LANGUAGE_UR    SupportedLanguage = "ur"
	SUPPORTED_LANGUAGE_UZ    SupportedLanguage = "uz"
	SUPPORTED_LANGUAGE_ZH    SupportedLanguage = "zh"
)

List of supportedLanguage.

func NewSupportedLanguageFromValue 

func NewSupportedLanguageFromValue(v string) (*SupportedLanguage, error)

NewSupportedLanguageFromValue returns a pointer to a valid SupportedLanguage. for the value passed as argument, or an error if the value passed is not allowed by the enum.

func (SupportedLanguage) IsValid 

func (v SupportedLanguage) IsValid() bool

IsValid return true if the value is valid for the enum, false otherwise.

func (SupportedLanguage) Ptr 

func (v SupportedLanguage) Ptr() *SupportedLanguage

Ptr returns reference to supportedLanguage value.

func (*SupportedLanguage) UnmarshalJSON 

func (v *SupportedLanguage) UnmarshalJSON(src []byte) error

type TaskIDResponse added in v4.26.0 

type TaskIDResponse struct {
	// Unique identifier of a task.  A successful API response means that a task was added to a queue. It might not run immediately. You can check the task's progress with the [`task` operation](https://www.algolia.com/doc/rest-api/search/get-task) and this task ID.
	TaskID int64 `json:"taskID"`
}

TaskIDResponse struct for TaskIDResponse.

func NewEmptyTaskIDResponse added in v4.26.0 

func NewEmptyTaskIDResponse() *TaskIDResponse

NewEmptyTaskIDResponse return a pointer to an empty TaskIDResponse object.

func NewTaskIDResponse added in v4.26.0 

func NewTaskIDResponse(taskID int64) *TaskIDResponse

NewTaskIDResponse instantiates a new TaskIDResponse object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed.

func (*TaskIDResponse) GetTaskID added in v4.26.0 

func (o *TaskIDResponse) GetTaskID() int64

GetTaskID returns the TaskID field value.

func (*TaskIDResponse) GetTaskIDOk added in v4.26.0 

func (o *TaskIDResponse) GetTaskIDOk() (*int64, bool)

GetTaskIDOk returns a tuple with the TaskID field value and a boolean to check if the value has been set.

func (TaskIDResponse) MarshalJSON added in v4.26.0 

func (o TaskIDResponse) MarshalJSON() ([]byte, error)

func (*TaskIDResponse) SetTaskID added in v4.26.0 

func (o *TaskIDResponse) SetTaskID(v int64) *TaskIDResponse

SetTaskID sets field value.

func (TaskIDResponse) String added in v4.26.0 

func (o TaskIDResponse) String() string

type TaskStatus added in v4.26.0 

type TaskStatus string

TaskStatus Task status, `published` if the task is completed, `notPublished` otherwise. 

const (
	TASK_STATUS_PUBLISHED     TaskStatus = "published"
	TASK_STATUS_NOT_PUBLISHED TaskStatus = "notPublished"
)

List of taskStatus.

func NewTaskStatusFromValue added in v4.26.0 

func NewTaskStatusFromValue(v string) (*TaskStatus, error)

NewTaskStatusFromValue returns a pointer to a valid TaskStatus. for the value passed as argument, or an error if the value passed is not allowed by the enum.

func (TaskStatus) IsValid added in v4.26.0 

func (v TaskStatus) IsValid() bool

IsValid return true if the value is valid for the enum, false otherwise.

func (TaskStatus) Ptr added in v4.26.0 

func (v TaskStatus) Ptr() *TaskStatus

Ptr returns reference to taskStatus value.

func (*TaskStatus) UnmarshalJSON added in v4.26.0 

func (v *TaskStatus) UnmarshalJSON(src []byte) error

type TimeRange added in v4.26.0 

type TimeRange struct {
	// Timestamp when the rule should start to be active, measured in seconds since the Unix epoch.
	From *int64 `json:"from,omitempty"`
	// Timestamp when the rule should stop to be active, measured in seconds since the Unix epoch.
	Until *int64 `json:"until,omitempty"`
}

TimeRange struct for TimeRange.

func NewEmptyTimeRange added in v4.26.0 

func NewEmptyTimeRange() *TimeRange

NewEmptyTimeRange return a pointer to an empty TimeRange object.

func NewTimeRange added in v4.26.0 

func NewTimeRange(opts ...TimeRangeOption) *TimeRange

NewTimeRange instantiates a new TimeRange object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed.

func (*TimeRange) GetFrom added in v4.26.0 

func (o *TimeRange) GetFrom() int64

GetFrom returns the From field value if set, zero value otherwise.

func (*TimeRange) GetFromOk added in v4.26.0 

func (o *TimeRange) GetFromOk() (*int64, bool)

GetFromOk returns a tuple with the From field value if set, nil otherwise and a boolean to check if the value has been set.

func (*TimeRange) GetUntil added in v4.26.0 

func (o *TimeRange) GetUntil() int64

GetUntil returns the Until field value if set, zero value otherwise.

func (*TimeRange) GetUntilOk added in v4.26.0 

func (o *TimeRange) GetUntilOk() (*int64, bool)

GetUntilOk returns a tuple with the Until field value if set, nil otherwise and a boolean to check if the value has been set.

func (*TimeRange) HasFrom added in v4.26.0 

func (o *TimeRange) HasFrom() bool

HasFrom returns a boolean if a field has been set.

func (*TimeRange) HasUntil added in v4.26.0 

func (o *TimeRange) HasUntil() bool

HasUntil returns a boolean if a field has been set.

func (TimeRange) MarshalJSON added in v4.26.0 

func (o TimeRange) MarshalJSON() ([]byte, error)

func (*TimeRange) SetFrom added in v4.26.0 

func (o *TimeRange) SetFrom(v int64) *TimeRange

SetFrom gets a reference to the given int64 and assigns it to the From field.

func (*TimeRange) SetUntil added in v4.26.0 

func (o *TimeRange) SetUntil(v int64) *TimeRange

SetUntil gets a reference to the given int64 and assigns it to the Until field.

func (TimeRange) String added in v4.26.0 

func (o TimeRange) String() string

type TimeRangeOption added in v4.26.0 

type TimeRangeOption func(f *TimeRange)

func WithTimeRangeFrom added in v4.26.0 

func WithTimeRangeFrom(val int64) TimeRangeOption

func WithTimeRangeUntil added in v4.26.0 

func WithTimeRangeUntil(val int64) TimeRangeOption

type TypoTolerance added in v4.26.0 

type TypoTolerance struct {
	TypoToleranceEnum *TypoToleranceEnum
	Bool              *bool
}

TypoTolerance - Whether [typo tolerance](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/typo-tolerance) is enabled and how it is applied. If typo tolerance is true, `min`, or `strict`, [word splitting and concatenation](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/handling-natural-languages-nlp/in-depth/splitting-and-concatenation) are also active.

func BoolAsTypoTolerance added in v4.26.0 

func BoolAsTypoTolerance(v bool) *TypoTolerance

boolAsTypoTolerance is a convenience function that returns bool wrapped in TypoTolerance.

func TypoToleranceEnumAsTypoTolerance added in v4.26.0 

func TypoToleranceEnumAsTypoTolerance(v TypoToleranceEnum) *TypoTolerance

TypoToleranceEnumAsTypoTolerance is a convenience function that returns TypoToleranceEnum wrapped in TypoTolerance.

func (TypoTolerance) GetActualInstance added in v4.26.0 

func (obj TypoTolerance) GetActualInstance() any

Get the actual instance.

func (TypoTolerance) MarshalJSON added in v4.26.0 

func (src TypoTolerance) MarshalJSON() ([]byte, error)

Marshal data from the first non-nil pointers in the struct to JSON.

func (*TypoTolerance) UnmarshalJSON added in v4.26.0 

func (dst *TypoTolerance) UnmarshalJSON(data []byte) error

Unmarshal JSON data into one or more of the pointers in the struct.

type TypoToleranceEnum added in v4.26.0 

type TypoToleranceEnum string

TypoToleranceEnum - `min`. Return matches with the lowest number of typos. For example, if you have matches without typos, only include those. But if there are no matches without typos (with 1 typo), include matches with 1 typo (2 typos). - `strict`. Return matches with the two lowest numbers of typos. With `strict`, the Typo ranking criterion is applied first in the `ranking` setting. 

const (
	TYPO_TOLERANCE_ENUM_MIN    TypoToleranceEnum = "min"
	TYPO_TOLERANCE_ENUM_STRICT TypoToleranceEnum = "strict"
	TYPO_TOLERANCE_ENUM_TRUE   TypoToleranceEnum = "true"
	TYPO_TOLERANCE_ENUM_FALSE  TypoToleranceEnum = "false"
)

List of typoToleranceEnum.

func NewTypoToleranceEnumFromValue added in v4.26.0 

func NewTypoToleranceEnumFromValue(v string) (*TypoToleranceEnum, error)

NewTypoToleranceEnumFromValue returns a pointer to a valid TypoToleranceEnum. for the value passed as argument, or an error if the value passed is not allowed by the enum.

func (TypoToleranceEnum) IsValid added in v4.26.0 

func (v TypoToleranceEnum) IsValid() bool

IsValid return true if the value is valid for the enum, false otherwise.

func (TypoToleranceEnum) Ptr added in v4.26.0 

func (v TypoToleranceEnum) Ptr() *TypoToleranceEnum

Ptr returns reference to typoToleranceEnum value.

func (*TypoToleranceEnum) UnmarshalJSON added in v4.26.0 

func (v *TypoToleranceEnum) UnmarshalJSON(src []byte) error

type Value 

type Value struct {
	// Explicit order of facets or facet values.  This setting lets you always show specific facets or facet values at the top of the list.
	Order           []string         `json:"order,omitempty"`
	SortRemainingBy *SortRemainingBy `json:"sortRemainingBy,omitempty"`
	// Hide facet values.
	Hide []string `json:"hide,omitempty"`
}

Value struct for Value.

func NewEmptyValue 

func NewEmptyValue() *Value

NewEmptyValue return a pointer to an empty Value object.

func NewValue 

func NewValue(opts ...ValueOption) *Value

NewValue instantiates a new Value object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed.

func (*Value) GetHide 

func (o *Value) GetHide() []string

GetHide returns the Hide field value if set, zero value otherwise.

func (*Value) GetHideOk 

func (o *Value) GetHideOk() ([]string, bool)

GetHideOk returns a tuple with the Hide field value if set, nil otherwise and a boolean to check if the value has been set.

func (*Value) GetOrder 

func (o *Value) GetOrder() []string

GetOrder returns the Order field value if set, zero value otherwise.

func (*Value) GetOrderOk 

func (o *Value) GetOrderOk() ([]string, bool)

GetOrderOk returns a tuple with the Order field value if set, nil otherwise and a boolean to check if the value has been set.

func (*Value) GetSortRemainingBy 

func (o *Value) GetSortRemainingBy() SortRemainingBy

GetSortRemainingBy returns the SortRemainingBy field value if set, zero value otherwise.

func (*Value) GetSortRemainingByOk 

func (o *Value) GetSortRemainingByOk() (*SortRemainingBy, bool)

GetSortRemainingByOk returns a tuple with the SortRemainingBy field value if set, nil otherwise and a boolean to check if the value has been set.

func (*Value) HasHide 

func (o *Value) HasHide() bool

HasHide returns a boolean if a field has been set.

func (*Value) HasOrder 

func (o *Value) HasOrder() bool

HasOrder returns a boolean if a field has been set.

func (*Value) HasSortRemainingBy 

func (o *Value) HasSortRemainingBy() bool

HasSortRemainingBy returns a boolean if a field has been set.

func (Value) MarshalJSON 

func (o Value) MarshalJSON() ([]byte, error)

func (*Value) SetHide 

func (o *Value) SetHide(v []string) *Value

SetHide gets a reference to the given []string and assigns it to the Hide field.

func (*Value) SetOrder 

func (o *Value) SetOrder(v []string) *Value

SetOrder gets a reference to the given []string and assigns it to the Order field.

func (*Value) SetSortRemainingBy 

func (o *Value) SetSortRemainingBy(v SortRemainingBy) *Value

SetSortRemainingBy gets a reference to the given SortRemainingBy and assigns it to the SortRemainingBy field.

func (Value) String 

func (o Value) String() string

type ValueOption 

type ValueOption func(f *Value)

func WithValueHide 

func WithValueHide(val []string) ValueOption

func WithValueOrder 

func WithValueOrder(val []string) ValueOption

func WithValueSortRemainingBy 

func WithValueSortRemainingBy(val SortRemainingBy) ValueOption

type Widgets 

type Widgets struct {
	// Banners defined in the Merchandising Studio for a given search.
	Banners []Banner `json:"banners,omitempty"`
}

Widgets Widgets returned from any rules that are applied to the current search.

func NewEmptyWidgets 

func NewEmptyWidgets() *Widgets

NewEmptyWidgets return a pointer to an empty Widgets object.

func NewWidgets 

func NewWidgets(opts ...WidgetsOption) *Widgets

NewWidgets instantiates a new Widgets object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed.

func (*Widgets) GetBanners 

func (o *Widgets) GetBanners() []Banner

GetBanners returns the Banners field value if set, zero value otherwise.

func (*Widgets) GetBannersOk 

func (o *Widgets) GetBannersOk() ([]Banner, bool)

GetBannersOk returns a tuple with the Banners field value if set, nil otherwise and a boolean to check if the value has been set.

func (*Widgets) HasBanners 

func (o *Widgets) HasBanners() bool

HasBanners returns a boolean if a field has been set.

func (Widgets) MarshalJSON 

func (o Widgets) MarshalJSON() ([]byte, error)

func (*Widgets) SetBanners 

func (o *Widgets) SetBanners(v []Banner) *Widgets

SetBanners gets a reference to the given []Banner and assigns it to the Banners field.

func (Widgets) String 

func (o Widgets) String() string

type WidgetsOption 

type WidgetsOption func(f *Widgets)

func WithWidgetsBanners 

func WithWidgetsBanners(val []Banner) WidgetsOption

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.