searchindex

package
v0.0.0-...-9032398 Latest Latest
Warning

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

 Go to latest Published: Jun 22, 2023 License: MIT Imports: 20 Imported by: 0

README

Go API client for searchindex

Client that can be used to query an index and upload, merge, or delete documents.

Overview

This API client was generated by the OpenAPI Generator project. By using the OpenAPI-spec from a remote server, you can easily generate an API client.

  • API version: 2023-07-01-Preview
  • Package version: 1.0.0
  • Build package: org.openapitools.codegen.languages.GoClientCodegen

Installation

Install the following dependencies:

go get github.com/stretchr/testify/assert
go get golang.org/x/net/context

Put the package under your project folder and add the following in import:

import searchindex "github.com/ks6088ts-labs/cogsearch-client-go"

To use a proxy, set the environment variable HTTP_PROXY:

os.Setenv("HTTP_PROXY", "http://proxy_name:proxy_port")

Configuration of Server URL

Default configuration comes with Servers field that contains server objects as defined in the OpenAPI specification.

Select Server Configuration

For using other server than the one defined on index 0 set context value sw.ContextServerIndex of type int.

ctx := context.WithValue(context.Background(), searchindex.ContextServerIndex, 1)
Templated Server URL

Templated server URL is formatted using default variables from configuration or from context value sw.ContextServerVariables of type map[string]string.

ctx := context.WithValue(context.Background(), searchindex.ContextServerVariables, map[string]string{
	"basePath": "v2",
})

Note, enum values are always validated and all unused variables are silently ignored.

URLs Configuration per Operation

Each operation can use different server URL defined using OperationServers map in the Configuration. An operation is uniquely identified by "{classname}Service.{nickname}" string. Similar rules for overriding default operation server index and variables applies by using sw.ContextOperationServerIndices and sw.ContextOperationServerVariables context maps.

ctx := context.WithValue(context.Background(), searchindex.ContextOperationServerIndices, map[string]int{
	"{classname}Service.{nickname}": 2,
})
ctx = context.WithValue(context.Background(), searchindex.ContextOperationServerVariables, map[string]map[string]string{
	"{classname}Service.{nickname}": {
		"port": "8443",
	},
})

Documentation for API Endpoints

All URIs are relative to http://localhost

Class Method HTTP request Description
DocumentsApi DocumentsAutocompleteGet Get /docs/search.autocomplete
DocumentsApi DocumentsAutocompletePost Post /docs/search.post.autocomplete
DocumentsApi DocumentsCount Get /docs/$count
DocumentsApi DocumentsGet Get /docs('{key}')
DocumentsApi DocumentsIndex Post /docs/search.index
DocumentsApi DocumentsSearchGet Get /docs
DocumentsApi DocumentsSearchPost Post /docs/search.post.search
DocumentsApi DocumentsSuggestGet Get /docs/search.suggest
DocumentsApi DocumentsSuggestPost Post /docs/search.post.suggest

Documentation For Models

Documentation For Authorization

Endpoints do not require authorization.

Documentation for Utility Methods

Due to the fact that model structure members are all pointers, this package contains a number of utility functions to easily obtain pointers to values of basic types. Each of these functions takes a value of the given basic type and returns a pointer to it:

  • PtrBool
  • PtrInt
  • PtrInt32
  • PtrInt64
  • PtrFloat
  • PtrFloat32
  • PtrFloat64
  • PtrString
  • PtrTime

Author

Documentation

Index

Constants

This section is empty.

Variables

View Source 
var (
	// ContextServerIndex uses a server configuration from the index.
	ContextServerIndex = contextKey("serverIndex")

	// ContextOperationServerIndices uses a server configuration from the index mapping.
	ContextOperationServerIndices = contextKey("serverOperationIndices")

	// ContextServerVariables overrides a server configuration variables.
	ContextServerVariables = contextKey("serverVariables")

	// ContextOperationServerVariables overrides a server configuration variables using operation specific values.
	ContextOperationServerVariables = contextKey("serverOperationVariables")
)
View Source 
var AllowedAnswersEnumValues = []Answers{
	"none",
	"extractive",
}

All allowed values of Answers enum

View Source 
var AllowedAutocompleteModeEnumValues = []AutocompleteMode{
	"oneTerm",
	"twoTerms",
	"oneTermWithContext",
}

All allowed values of AutocompleteMode enum

View Source 
var AllowedCaptionsEnumValues = []Captions{
	"none",
	"extractive",
}

All allowed values of Captions enum

View Source 
var AllowedQueryDebugModeEnumValues = []QueryDebugMode{
	"disabled",
	"semantic",
}

All allowed values of QueryDebugMode enum

View Source 
var AllowedQueryLanguageEnumValues = []QueryLanguage{
	"none",
	"en-us",
	"en-gb",
	"en-in",
	"en-ca",
	"en-au",
	"fr-fr",
	"fr-ca",
	"de-de",
	"es-es",
	"es-mx",
	"zh-cn",
	"zh-tw",
	"pt-br",
	"pt-pt",
	"it-it",
	"ja-jp",
	"ko-kr",
	"ru-ru",
	"cs-cz",
	"nl-be",
	"nl-nl",
	"hu-hu",
	"pl-pl",
	"sv-se",
	"tr-tr",
	"hi-in",
	"ar-sa",
	"ar-eg",
	"ar-ma",
	"ar-kw",
	"ar-jo",
	"da-dk",
	"no-no",
	"bg-bg",
	"hr-hr",
	"hr-ba",
	"ms-my",
	"ms-bn",
	"sl-sl",
	"ta-in",
	"vi-vn",
	"el-gr",
	"ro-ro",
	"is-is",
	"id-id",
	"th-th",
	"lt-lt",
	"uk-ua",
	"lv-lv",
	"et-ee",
	"ca-es",
	"fi-fi",
	"sr-ba",
	"sr-me",
	"sr-rs",
	"sk-sk",
	"nb-no",
	"hy-am",
	"bn-in",
	"eu-es",
	"gl-es",
	"gu-in",
	"he-il",
	"ga-ie",
	"kn-in",
	"ml-in",
	"mr-in",
	"fa-ae",
	"pa-in",
	"te-in",
	"ur-pk",
}

All allowed values of QueryLanguage enum

View Source 
var AllowedQueryResultDocumentSemanticFieldStateEnumValues = []QueryResultDocumentSemanticFieldState{
	"used",
	"unused",
	"partial",
}

All allowed values of QueryResultDocumentSemanticFieldState enum

View Source 
var AllowedQueryTypeEnumValues = []QueryType{
	"simple",
	"full",
	"semantic",
}

All allowed values of QueryType enum

View Source 
var AllowedScoringStatisticsEnumValues = []ScoringStatistics{
	"local",
	"global",
}

All allowed values of ScoringStatistics enum

View Source 
var AllowedSearchModeEnumValues = []SearchMode{
	"any",
	"all",
}

All allowed values of SearchMode enum

View Source 
var AllowedSemanticErrorHandlingEnumValues = []SemanticErrorHandling{
	"partial",
	"fail",
}

All allowed values of SemanticErrorHandling enum

View Source 
var AllowedSemanticPartialResponseReasonEnumValues = []SemanticPartialResponseReason{
	"maxWaitExceeded",
	"capacityOverloaded",
	"transient",
}

All allowed values of SemanticPartialResponseReason enum

View Source 
var AllowedSemanticPartialResponseTypeEnumValues = []SemanticPartialResponseType{
	"baseResults",
	"rerankedResults",
}

All allowed values of SemanticPartialResponseType enum

View Source 
var AllowedSpellerEnumValues = []Speller{
	"none",
	"lexicon",
}

All allowed values of Speller enum

Functions

func CacheExpires 

func CacheExpires(r *http.Response) time.Time

CacheExpires helper function to determine remaining time before repeating a request.

func IsNil 

func IsNil(i interface{}) bool

IsNil checks if an input is nil

func PtrBool 

func PtrBool(v bool) *bool

PtrBool is a helper routine that returns a pointer to given boolean value.

func PtrFloat32 

func PtrFloat32(v float32) *float32

PtrFloat32 is a helper routine that returns a pointer to given float value.

func PtrFloat64 

func PtrFloat64(v float64) *float64

PtrFloat64 is a helper routine that returns a pointer to given float value.

func PtrInt 

func PtrInt(v int) *int

PtrInt is a helper routine that returns a pointer to given integer value.

func PtrInt32 

func PtrInt32(v int32) *int32

PtrInt32 is a helper routine that returns a pointer to given integer value.

func PtrInt64 

func PtrInt64(v int64) *int64

PtrInt64 is a helper routine that returns a pointer to given integer value.

func PtrString 

func PtrString(v string) *string

PtrString is a helper routine that returns a pointer to given string value.

func PtrTime 

func PtrTime(v time.Time) *time.Time

PtrTime is helper routine that returns a pointer to given Time value.

Types

type APIClient 

type APIClient struct {
	DocumentsApi *DocumentsApiService
	// contains filtered or unexported fields
}

APIClient manages communication with the SearchIndexClient API v2023-07-01-Preview In most cases there should be only one, shared, APIClient.

func NewAPIClient 

func NewAPIClient(cfg *Configuration) *APIClient

NewAPIClient creates a new API client. Requires a userAgent string describing your application. optionally a custom http.Client to allow for advanced features such as caching.

func (*APIClient) GetConfig 

func (c *APIClient) GetConfig() *Configuration

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

type APIKey 

type APIKey struct {
	Key    string
	Prefix string
}

APIKey provides API key based authentication to a request passed via context using ContextAPIKey

type APIResponse 

type APIResponse struct {
	*http.Response `json:"-"`
	Message        string `json:"message,omitempty"`
	// Operation is the name of the OpenAPI operation.
	Operation string `json:"operation,omitempty"`
	// RequestURL is the request URL. This value is always available, even if the
	// embedded *http.Response is nil.
	RequestURL string `json:"url,omitempty"`
	// Method is the HTTP method used for the request.  This value is always
	// available, even if the embedded *http.Response is nil.
	Method string `json:"method,omitempty"`
	// Payload holds the contents of the response body (which may be nil or empty).
	// This is provided here as the raw response.Body() reader will have already
	// been drained.
	Payload []byte `json:"-"`
}

APIResponse stores the API response returned by the server.

func NewAPIResponse 

func NewAPIResponse(r *http.Response) *APIResponse

NewAPIResponse returns a new APIResponse object.

func NewAPIResponseWithError 

func NewAPIResponseWithError(errorMessage string) *APIResponse

NewAPIResponseWithError returns a new APIResponse object with the provided error message.

type AnswerResult 

type AnswerResult struct {
	// The score value represents how relevant the answer is to the query relative to other answers returned for the query.
	Score *float64 `json:"score,omitempty"`
	// The key of the document the answer was extracted from.
	Key *string `json:"key,omitempty"`
	// The text passage extracted from the document contents as the answer.
	Text *string `json:"text,omitempty"`
	// Same text passage as in the Text property with highlighted text phrases most relevant to the query.
	Highlights NullableString `json:"highlights,omitempty"`
}

AnswerResult An answer is a text passage extracted from the contents of the most relevant documents that matched the query. Answers are extracted from the top search results. Answer candidates are scored and the top answers are selected.

func NewAnswerResult 

func NewAnswerResult() *AnswerResult

NewAnswerResult instantiates a new AnswerResult 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 NewAnswerResultWithDefaults 

func NewAnswerResultWithDefaults() *AnswerResult

NewAnswerResultWithDefaults instantiates a new AnswerResult object This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set

func (*AnswerResult) GetHighlights 

func (o *AnswerResult) GetHighlights() string

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

func (*AnswerResult) GetHighlightsOk 

func (o *AnswerResult) GetHighlightsOk() (*string, bool)

GetHighlightsOk returns a tuple with the Highlights 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 (*AnswerResult) GetKey 

func (o *AnswerResult) GetKey() string

GetKey returns the Key field value if set, zero value otherwise.

func (*AnswerResult) GetKeyOk 

func (o *AnswerResult) GetKeyOk() (*string, bool)

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

func (*AnswerResult) GetScore 

func (o *AnswerResult) GetScore() float64

GetScore returns the Score field value if set, zero value otherwise.

func (*AnswerResult) GetScoreOk 

func (o *AnswerResult) GetScoreOk() (*float64, 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 (*AnswerResult) GetText 

func (o *AnswerResult) GetText() string

GetText returns the Text field value if set, zero value otherwise.

func (*AnswerResult) GetTextOk 

func (o *AnswerResult) GetTextOk() (*string, bool)

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

func (*AnswerResult) HasHighlights 

func (o *AnswerResult) HasHighlights() bool

HasHighlights returns a boolean if a field has been set.

func (*AnswerResult) HasKey 

func (o *AnswerResult) HasKey() bool

HasKey returns a boolean if a field has been set.

func (*AnswerResult) HasScore 

func (o *AnswerResult) HasScore() bool

HasScore returns a boolean if a field has been set.

func (*AnswerResult) HasText 

func (o *AnswerResult) HasText() bool

HasText returns a boolean if a field has been set.

func (AnswerResult) MarshalJSON 

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

func (*AnswerResult) SetHighlights 

func (o *AnswerResult) SetHighlights(v string)

SetHighlights gets a reference to the given NullableString and assigns it to the Highlights field.

func (*AnswerResult) SetHighlightsNil 

func (o *AnswerResult) SetHighlightsNil()

SetHighlightsNil sets the value for Highlights to be an explicit nil

func (*AnswerResult) SetKey 

func (o *AnswerResult) SetKey(v string)

SetKey gets a reference to the given string and assigns it to the Key field.

func (*AnswerResult) SetScore 

func (o *AnswerResult) SetScore(v float64)

SetScore gets a reference to the given float64 and assigns it to the Score field.

func (*AnswerResult) SetText 

func (o *AnswerResult) SetText(v string)

SetText gets a reference to the given string and assigns it to the Text field.

func (AnswerResult) ToMap 

func (o AnswerResult) ToMap() (map[string]interface{}, error)

func (*AnswerResult) UnsetHighlights 

func (o *AnswerResult) UnsetHighlights()

UnsetHighlights ensures that no value is present for Highlights, not even an explicit nil

type Answers 

type Answers string

Answers This parameter is only valid if the query type is 'semantic'. If set, the query returns answers extracted from key passages in the highest ranked documents. The number of answers returned can be configured by appending the pipe character '|' followed by the 'count-<number of answers>' option after the answers parameter value, such as 'extractive|count-3'. Default count is 1. The confidence threshold can be configured by appending the pipe character '|' followed by the 'threshold-<confidence threshold>' option after the answers parameter value, such as 'extractive|threshold-0.9'. Default threshold is 0.7. 

const (
	NONE       Answers = "none"
	EXTRACTIVE Answers = "extractive"
)

List of Answers

func NewAnswersFromValue 

func NewAnswersFromValue(v string) (*Answers, error)

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

func (Answers) IsValid 

func (v Answers) IsValid() bool

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

func (Answers) Ptr 

func (v Answers) Ptr() *Answers

Ptr returns reference to Answers value

func (*Answers) UnmarshalJSON 

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

type ApiDocumentsAutocompleteGetRequest 

type ApiDocumentsAutocompleteGetRequest struct {
	ApiService *DocumentsApiService
	// contains filtered or unexported fields
}

func (ApiDocumentsAutocompleteGetRequest) ApiVersion 

func (r ApiDocumentsAutocompleteGetRequest) ApiVersion(apiVersion string) ApiDocumentsAutocompleteGetRequest

Client Api Version.

func (ApiDocumentsAutocompleteGetRequest) AutocompleteMode 

func (r ApiDocumentsAutocompleteGetRequest) AutocompleteMode(autocompleteMode string) ApiDocumentsAutocompleteGetRequest

Specifies the mode for Autocomplete. The default is &#39;oneTerm&#39;. Use &#39;twoTerms&#39; to get shingles and &#39;oneTermWithContext&#39; to use the current context while producing auto-completed terms.

func (ApiDocumentsAutocompleteGetRequest) Execute 

func (r ApiDocumentsAutocompleteGetRequest) Execute() (*AutocompleteResult, *http.Response, error)

func (ApiDocumentsAutocompleteGetRequest) Filter 

func (r ApiDocumentsAutocompleteGetRequest) Filter(filter string) ApiDocumentsAutocompleteGetRequest

An OData expression that filters the documents used to produce completed terms for the Autocomplete result.

func (ApiDocumentsAutocompleteGetRequest) Fuzzy 

func (r ApiDocumentsAutocompleteGetRequest) Fuzzy(fuzzy bool) ApiDocumentsAutocompleteGetRequest

A value indicating whether to use fuzzy matching for the autocomplete query. Default is false. When set to true, the query will find terms even if there&#39;s a substituted or missing character in the search text. While this provides a better experience in some scenarios, it comes at a performance cost as fuzzy autocomplete queries are slower and consume more resources.

func (ApiDocumentsAutocompleteGetRequest) HighlightPostTag 

func (r ApiDocumentsAutocompleteGetRequest) HighlightPostTag(highlightPostTag string) ApiDocumentsAutocompleteGetRequest

A string tag that is appended to hit highlights. Must be set with highlightPreTag. If omitted, hit highlighting is disabled.

func (ApiDocumentsAutocompleteGetRequest) HighlightPreTag 

func (r ApiDocumentsAutocompleteGetRequest) HighlightPreTag(highlightPreTag string) ApiDocumentsAutocompleteGetRequest

A string tag that is prepended to hit highlights. Must be set with highlightPostTag. If omitted, hit highlighting is disabled.

func (ApiDocumentsAutocompleteGetRequest) MinimumCoverage 

func (r ApiDocumentsAutocompleteGetRequest) MinimumCoverage(minimumCoverage float64) ApiDocumentsAutocompleteGetRequest

A number between 0 and 100 indicating the percentage of the index that must be covered by an autocomplete query in order for the query to be reported as a success. This parameter can be useful for ensuring search availability even for services with only one replica. The default is 80.

func (ApiDocumentsAutocompleteGetRequest) Search 

func (r ApiDocumentsAutocompleteGetRequest) Search(search string) ApiDocumentsAutocompleteGetRequest

The incomplete term which should be auto-completed.

func (ApiDocumentsAutocompleteGetRequest) SearchFields 

func (r ApiDocumentsAutocompleteGetRequest) SearchFields(searchFields []string) ApiDocumentsAutocompleteGetRequest

The list of field names to consider when querying for auto-completed terms. Target fields must be included in the specified suggester.

func (ApiDocumentsAutocompleteGetRequest) SuggesterName 

func (r ApiDocumentsAutocompleteGetRequest) SuggesterName(suggesterName string) ApiDocumentsAutocompleteGetRequest

The name of the suggester as specified in the suggesters collection that&#39;s part of the index definition.

func (ApiDocumentsAutocompleteGetRequest) Top 

func (r ApiDocumentsAutocompleteGetRequest) Top(top int32) ApiDocumentsAutocompleteGetRequest

The number of auto-completed terms to retrieve. This must be a value between 1 and 100. The default is 5.

func (ApiDocumentsAutocompleteGetRequest) XMsClientRequestId 

func (r ApiDocumentsAutocompleteGetRequest) XMsClientRequestId(xMsClientRequestId string) ApiDocumentsAutocompleteGetRequest

The tracking ID sent with the request to help with debugging.

type ApiDocumentsAutocompletePostRequest 

type ApiDocumentsAutocompletePostRequest struct {
	ApiService *DocumentsApiService
	// contains filtered or unexported fields
}

func (ApiDocumentsAutocompletePostRequest) ApiVersion 

func (r ApiDocumentsAutocompletePostRequest) ApiVersion(apiVersion string) ApiDocumentsAutocompletePostRequest

Client Api Version.

func (ApiDocumentsAutocompletePostRequest) AutocompleteRequest 

func (r ApiDocumentsAutocompletePostRequest) AutocompleteRequest(autocompleteRequest AutocompleteRequest) ApiDocumentsAutocompletePostRequest

The definition of the Autocomplete request.

func (ApiDocumentsAutocompletePostRequest) Execute 

func (r ApiDocumentsAutocompletePostRequest) Execute() (*AutocompleteResult, *http.Response, error)

func (ApiDocumentsAutocompletePostRequest) XMsClientRequestId 

func (r ApiDocumentsAutocompletePostRequest) XMsClientRequestId(xMsClientRequestId string) ApiDocumentsAutocompletePostRequest

The tracking ID sent with the request to help with debugging.

type ApiDocumentsCountRequest 

type ApiDocumentsCountRequest struct {
	ApiService *DocumentsApiService
	// contains filtered or unexported fields
}

func (ApiDocumentsCountRequest) ApiVersion 

func (r ApiDocumentsCountRequest) ApiVersion(apiVersion string) ApiDocumentsCountRequest

Client Api Version.

func (ApiDocumentsCountRequest) Execute 

func (r ApiDocumentsCountRequest) Execute() (int64, *http.Response, error)

func (ApiDocumentsCountRequest) XMsClientRequestId 

func (r ApiDocumentsCountRequest) XMsClientRequestId(xMsClientRequestId string) ApiDocumentsCountRequest

The tracking ID sent with the request to help with debugging.

type ApiDocumentsGetRequest 

type ApiDocumentsGetRequest struct {
	ApiService *DocumentsApiService
	// contains filtered or unexported fields
}

func (ApiDocumentsGetRequest) ApiVersion 

func (r ApiDocumentsGetRequest) ApiVersion(apiVersion string) ApiDocumentsGetRequest

Client Api Version.

func (ApiDocumentsGetRequest) Execute 

func (r ApiDocumentsGetRequest) Execute() (map[string]interface{}, *http.Response, error)

func (ApiDocumentsGetRequest) Select_ 

func (r ApiDocumentsGetRequest) Select_(select_ []string) ApiDocumentsGetRequest

List of field names to retrieve for the document; Any field not retrieved will be missing from the returned document.

func (ApiDocumentsGetRequest) XMsClientRequestId 

func (r ApiDocumentsGetRequest) XMsClientRequestId(xMsClientRequestId string) ApiDocumentsGetRequest

The tracking ID sent with the request to help with debugging.

type ApiDocumentsIndexRequest 

type ApiDocumentsIndexRequest struct {
	ApiService *DocumentsApiService
	// contains filtered or unexported fields
}

func (ApiDocumentsIndexRequest) ApiVersion 

func (r ApiDocumentsIndexRequest) ApiVersion(apiVersion string) ApiDocumentsIndexRequest

Client Api Version.

func (ApiDocumentsIndexRequest) Batch 

func (r ApiDocumentsIndexRequest) Batch(batch IndexBatch) ApiDocumentsIndexRequest

The batch of index actions.

func (ApiDocumentsIndexRequest) Execute 

func (r ApiDocumentsIndexRequest) Execute() (*IndexDocumentsResult, *http.Response, error)

func (ApiDocumentsIndexRequest) XMsClientRequestId 

func (r ApiDocumentsIndexRequest) XMsClientRequestId(xMsClientRequestId string) ApiDocumentsIndexRequest

The tracking ID sent with the request to help with debugging.

type ApiDocumentsSearchGetRequest 

type ApiDocumentsSearchGetRequest struct {
	ApiService *DocumentsApiService
	// contains filtered or unexported fields
}

func (ApiDocumentsSearchGetRequest) Answers 

func (r ApiDocumentsSearchGetRequest) Answers(answers string) ApiDocumentsSearchGetRequest

This parameter is only valid if the query type is &#39;semantic&#39;. If set, the query returns answers extracted from key passages in the highest ranked documents. The number of answers returned can be configured by appending the pipe character &#39;|&#39; followed by the &#39;count-&lt;number of answers&gt;&#39; option after the answers parameter value, such as &#39;extractive|count-3&#39;. Default count is 1. The confidence threshold can be configured by appending the pipe character &#39;|&#39; followed by the &#39;threshold-&lt;confidence threshold&gt;&#39; option after the answers parameter value, such as &#39;extractive|threshold-0.9&#39;. Default threshold is 0.7.

func (ApiDocumentsSearchGetRequest) ApiVersion 

func (r ApiDocumentsSearchGetRequest) ApiVersion(apiVersion string) ApiDocumentsSearchGetRequest

Client Api Version.

func (ApiDocumentsSearchGetRequest) Captions 

func (r ApiDocumentsSearchGetRequest) Captions(captions string) ApiDocumentsSearchGetRequest

This parameter is only valid if the query type is &#39;semantic&#39;. If set, the query returns captions extracted from key passages in the highest ranked documents. When Captions is set to &#39;extractive&#39;, highlighting is enabled by default, and can be configured by appending the pipe character &#39;|&#39; followed by the &#39;highlight-&lt;true/false&gt;&#39; option, such as &#39;extractive|highlight-true&#39;. Defaults to &#39;None&#39;.

func (ApiDocumentsSearchGetRequest) Count 

func (r ApiDocumentsSearchGetRequest) Count(count bool) ApiDocumentsSearchGetRequest

A value that specifies whether to fetch the total count of results. Default is false. Setting this value to true may have a performance impact. Note that the count returned is an approximation.

func (ApiDocumentsSearchGetRequest) Debug 

func (r ApiDocumentsSearchGetRequest) Debug(debug string) ApiDocumentsSearchGetRequest

Enables a debugging tool that can be used to further explore your search results.

func (ApiDocumentsSearchGetRequest) Execute 

func (r ApiDocumentsSearchGetRequest) Execute() (*SearchDocumentsResult, *http.Response, error)

func (ApiDocumentsSearchGetRequest) Facet 

func (r ApiDocumentsSearchGetRequest) Facet(facet []string) ApiDocumentsSearchGetRequest

The list of facet expressions to apply to the search query. Each facet expression contains a field name, optionally followed by a comma-separated list of name:value pairs.

func (ApiDocumentsSearchGetRequest) Filter 

func (r ApiDocumentsSearchGetRequest) Filter(filter string) ApiDocumentsSearchGetRequest

The OData $filter expression to apply to the search query.

func (ApiDocumentsSearchGetRequest) Highlight 

func (r ApiDocumentsSearchGetRequest) Highlight(highlight []string) ApiDocumentsSearchGetRequest

The list of field names to use for hit highlights. Only searchable fields can be used for hit highlighting.

func (ApiDocumentsSearchGetRequest) HighlightPostTag 

func (r ApiDocumentsSearchGetRequest) HighlightPostTag(highlightPostTag string) ApiDocumentsSearchGetRequest

A string tag that is appended to hit highlights. Must be set with highlightPreTag. Default is &amp;lt;/em&amp;gt;.

func (ApiDocumentsSearchGetRequest) HighlightPreTag 

func (r ApiDocumentsSearchGetRequest) HighlightPreTag(highlightPreTag string) ApiDocumentsSearchGetRequest

A string tag that is prepended to hit highlights. Must be set with highlightPostTag. Default is &amp;lt;em&amp;gt;.

func (ApiDocumentsSearchGetRequest) MinimumCoverage 

func (r ApiDocumentsSearchGetRequest) MinimumCoverage(minimumCoverage float64) ApiDocumentsSearchGetRequest

A number between 0 and 100 indicating the percentage of the index that must be covered by a search query in order for the query to be reported as a success. This parameter can be useful for ensuring search availability even for services with only one replica. The default is 100.

func (ApiDocumentsSearchGetRequest) Orderby 

func (r ApiDocumentsSearchGetRequest) Orderby(orderby []string) ApiDocumentsSearchGetRequest

The list of OData $orderby expressions by which to sort the results. Each expression can be either a field name or a call to either the geo.distance() or the search.score() functions. Each expression can be followed by asc to indicate ascending, and desc to indicate descending. The default is ascending order. Ties will be broken by the match scores of documents. If no OrderBy is specified, the default sort order is descending by document match score. There can be at most 32 $orderby clauses.

func (ApiDocumentsSearchGetRequest) QueryLanguage 

func (r ApiDocumentsSearchGetRequest) QueryLanguage(queryLanguage string) ApiDocumentsSearchGetRequest

The language of the query.

func (ApiDocumentsSearchGetRequest) QueryType 

func (r ApiDocumentsSearchGetRequest) QueryType(queryType string) ApiDocumentsSearchGetRequest

A value that specifies the syntax of the search query. The default is &#39;simple&#39;. Use &#39;full&#39; if your query uses the Lucene query syntax.

func (ApiDocumentsSearchGetRequest) ScoringParameter 

func (r ApiDocumentsSearchGetRequest) ScoringParameter(scoringParameter []string) ApiDocumentsSearchGetRequest

The list of parameter values to be used in scoring functions (for example, referencePointParameter) using the format name-values. For example, if the scoring profile defines a function with a parameter called &#39;mylocation&#39; the parameter string would be \&quot;mylocation--122.2,44.8\&quot; (without the quotes).

func (ApiDocumentsSearchGetRequest) ScoringProfile 

func (r ApiDocumentsSearchGetRequest) ScoringProfile(scoringProfile string) ApiDocumentsSearchGetRequest

The name of a scoring profile to evaluate match scores for matching documents in order to sort the results.

func (ApiDocumentsSearchGetRequest) ScoringStatistics 

func (r ApiDocumentsSearchGetRequest) ScoringStatistics(scoringStatistics string) ApiDocumentsSearchGetRequest

A value that specifies whether we want to calculate scoring statistics (such as document frequency) globally for more consistent scoring, or locally, for lower latency.

func (ApiDocumentsSearchGetRequest) Search 

func (r ApiDocumentsSearchGetRequest) Search(search string) ApiDocumentsSearchGetRequest

A full-text search query expression; Use \&quot;*\&quot; or omit this parameter to match all documents.

func (ApiDocumentsSearchGetRequest) SearchFields 

func (r ApiDocumentsSearchGetRequest) SearchFields(searchFields []string) ApiDocumentsSearchGetRequest

The list of field names to which to scope the full-text search. When using fielded search (fieldName:searchExpression) in a full Lucene query, the field names of each fielded search expression take precedence over any field names listed in this parameter.

func (ApiDocumentsSearchGetRequest) SearchMode 

func (r ApiDocumentsSearchGetRequest) SearchMode(searchMode string) ApiDocumentsSearchGetRequest

A value that specifies whether any or all of the search terms must be matched in order to count the document as a match.

func (ApiDocumentsSearchGetRequest) Select_ 

func (r ApiDocumentsSearchGetRequest) Select_(select_ []string) ApiDocumentsSearchGetRequest

The list of fields to retrieve. If unspecified, all fields marked as retrievable in the schema are included.

func (ApiDocumentsSearchGetRequest) SemanticConfiguration 

func (r ApiDocumentsSearchGetRequest) SemanticConfiguration(semanticConfiguration string) ApiDocumentsSearchGetRequest

The name of the semantic configuration that lists which fields should be used for semantic ranking, captions, highlights, and answers

func (ApiDocumentsSearchGetRequest) SemanticErrorHandling 

func (r ApiDocumentsSearchGetRequest) SemanticErrorHandling(semanticErrorHandling string) ApiDocumentsSearchGetRequest

Allows the user to choose whether a semantic call should fail completely, or to return partial results.

func (ApiDocumentsSearchGetRequest) SemanticFields 

func (r ApiDocumentsSearchGetRequest) SemanticFields(semanticFields []string) ApiDocumentsSearchGetRequest

The list of field names used for semantic search.

func (ApiDocumentsSearchGetRequest) SemanticMaxWaitInMilliseconds 

func (r ApiDocumentsSearchGetRequest) SemanticMaxWaitInMilliseconds(semanticMaxWaitInMilliseconds int32) ApiDocumentsSearchGetRequest

Allows the user to set an upper bound on the amount of time it takes for semantic enrichment to finish processing before the request fails.

func (ApiDocumentsSearchGetRequest) SessionId 

func (r ApiDocumentsSearchGetRequest) SessionId(sessionId string) ApiDocumentsSearchGetRequest

A value to be used to create a sticky session, which can help to get more consistent results. As long as the same sessionId is used, a best-effort attempt will be made to target the same replica set. Be wary that reusing the same sessionID values repeatedly can interfere with the load balancing of the requests across replicas and adversely affect the performance of the search service. The value used as sessionId cannot start with a &#39;_&#39; character.

func (ApiDocumentsSearchGetRequest) Skip 

func (r ApiDocumentsSearchGetRequest) Skip(skip int32) ApiDocumentsSearchGetRequest

The number of search results to skip. This value cannot be greater than 100,000. If you need to scan documents in sequence, but cannot use $skip due to this limitation, consider using $orderby on a totally-ordered key and $filter with a range query instead.

func (ApiDocumentsSearchGetRequest) Speller 

func (r ApiDocumentsSearchGetRequest) Speller(speller string) ApiDocumentsSearchGetRequest

Improve search recall by spell-correcting individual search query terms.

func (ApiDocumentsSearchGetRequest) Top 

func (r ApiDocumentsSearchGetRequest) Top(top int32) ApiDocumentsSearchGetRequest

The number of search results to retrieve. This can be used in conjunction with $skip to implement client-side paging of search results. If results are truncated due to server-side paging, the response will include a continuation token that can be used to issue another Search request for the next page of results.

func (ApiDocumentsSearchGetRequest) XMsClientRequestId 

func (r ApiDocumentsSearchGetRequest) XMsClientRequestId(xMsClientRequestId string) ApiDocumentsSearchGetRequest

The tracking ID sent with the request to help with debugging.

type ApiDocumentsSearchPostRequest 

type ApiDocumentsSearchPostRequest struct {
	ApiService *DocumentsApiService
	// contains filtered or unexported fields
}

func (ApiDocumentsSearchPostRequest) ApiVersion 

func (r ApiDocumentsSearchPostRequest) ApiVersion(apiVersion string) ApiDocumentsSearchPostRequest

Client Api Version.

func (ApiDocumentsSearchPostRequest) Execute 

func (r ApiDocumentsSearchPostRequest) Execute() (*SearchDocumentsResult, *http.Response, error)

func (ApiDocumentsSearchPostRequest) SearchRequest 

func (r ApiDocumentsSearchPostRequest) SearchRequest(searchRequest SearchRequest) ApiDocumentsSearchPostRequest

The definition of the Search request.

func (ApiDocumentsSearchPostRequest) XMsClientRequestId 

func (r ApiDocumentsSearchPostRequest) XMsClientRequestId(xMsClientRequestId string) ApiDocumentsSearchPostRequest

The tracking ID sent with the request to help with debugging.

type ApiDocumentsSuggestGetRequest 

type ApiDocumentsSuggestGetRequest struct {
	ApiService *DocumentsApiService
	// contains filtered or unexported fields
}

func (ApiDocumentsSuggestGetRequest) ApiVersion 

func (r ApiDocumentsSuggestGetRequest) ApiVersion(apiVersion string) ApiDocumentsSuggestGetRequest

Client Api Version.

func (ApiDocumentsSuggestGetRequest) Execute 

func (r ApiDocumentsSuggestGetRequest) Execute() (*SuggestDocumentsResult, *http.Response, error)

func (ApiDocumentsSuggestGetRequest) Filter 

func (r ApiDocumentsSuggestGetRequest) Filter(filter string) ApiDocumentsSuggestGetRequest

An OData expression that filters the documents considered for suggestions.

func (ApiDocumentsSuggestGetRequest) Fuzzy 

func (r ApiDocumentsSuggestGetRequest) Fuzzy(fuzzy bool) ApiDocumentsSuggestGetRequest

A value indicating whether to use fuzzy matching for the suggestions query. Default is false. When set to true, the query will find terms even if there&#39;s a substituted or missing character in the search text. While this provides a better experience in some scenarios, it comes at a performance cost as fuzzy suggestions queries are slower and consume more resources.

func (ApiDocumentsSuggestGetRequest) HighlightPostTag 

func (r ApiDocumentsSuggestGetRequest) HighlightPostTag(highlightPostTag string) ApiDocumentsSuggestGetRequest

A string tag that is appended to hit highlights. Must be set with highlightPreTag. If omitted, hit highlighting of suggestions is disabled.

func (ApiDocumentsSuggestGetRequest) HighlightPreTag 

func (r ApiDocumentsSuggestGetRequest) HighlightPreTag(highlightPreTag string) ApiDocumentsSuggestGetRequest

A string tag that is prepended to hit highlights. Must be set with highlightPostTag. If omitted, hit highlighting of suggestions is disabled.

func (ApiDocumentsSuggestGetRequest) MinimumCoverage 

func (r ApiDocumentsSuggestGetRequest) MinimumCoverage(minimumCoverage float64) ApiDocumentsSuggestGetRequest

A number between 0 and 100 indicating the percentage of the index that must be covered by a suggestions query in order for the query to be reported as a success. This parameter can be useful for ensuring search availability even for services with only one replica. The default is 80.

func (ApiDocumentsSuggestGetRequest) Orderby 

func (r ApiDocumentsSuggestGetRequest) Orderby(orderby []string) ApiDocumentsSuggestGetRequest

The list of OData $orderby expressions by which to sort the results. Each expression can be either a field name or a call to either the geo.distance() or the search.score() functions. Each expression can be followed by asc to indicate ascending, or desc to indicate descending. The default is ascending order. Ties will be broken by the match scores of documents. If no $orderby is specified, the default sort order is descending by document match score. There can be at most 32 $orderby clauses.

func (ApiDocumentsSuggestGetRequest) Search 

func (r ApiDocumentsSuggestGetRequest) Search(search string) ApiDocumentsSuggestGetRequest

The search text to use to suggest documents. Must be at least 1 character, and no more than 100 characters.

func (ApiDocumentsSuggestGetRequest) SearchFields 

func (r ApiDocumentsSuggestGetRequest) SearchFields(searchFields []string) ApiDocumentsSuggestGetRequest

The list of field names to search for the specified search text. Target fields must be included in the specified suggester.

func (ApiDocumentsSuggestGetRequest) Select_ 

func (r ApiDocumentsSuggestGetRequest) Select_(select_ []string) ApiDocumentsSuggestGetRequest

The list of fields to retrieve. If unspecified, only the key field will be included in the results.

func (ApiDocumentsSuggestGetRequest) SuggesterName 

func (r ApiDocumentsSuggestGetRequest) SuggesterName(suggesterName string) ApiDocumentsSuggestGetRequest

The name of the suggester as specified in the suggesters collection that&#39;s part of the index definition.

func (ApiDocumentsSuggestGetRequest) Top 

func (r ApiDocumentsSuggestGetRequest) Top(top int32) ApiDocumentsSuggestGetRequest

The number of suggestions to retrieve. The value must be a number between 1 and 100. The default is 5.

func (ApiDocumentsSuggestGetRequest) XMsClientRequestId 

func (r ApiDocumentsSuggestGetRequest) XMsClientRequestId(xMsClientRequestId string) ApiDocumentsSuggestGetRequest

The tracking ID sent with the request to help with debugging.

type ApiDocumentsSuggestPostRequest 

type ApiDocumentsSuggestPostRequest struct {
	ApiService *DocumentsApiService
	// contains filtered or unexported fields
}

func (ApiDocumentsSuggestPostRequest) ApiVersion 

func (r ApiDocumentsSuggestPostRequest) ApiVersion(apiVersion string) ApiDocumentsSuggestPostRequest

Client Api Version.

func (ApiDocumentsSuggestPostRequest) Execute 

func (r ApiDocumentsSuggestPostRequest) Execute() (*SuggestDocumentsResult, *http.Response, error)

func (ApiDocumentsSuggestPostRequest) SuggestRequest 

func (r ApiDocumentsSuggestPostRequest) SuggestRequest(suggestRequest SuggestRequest) ApiDocumentsSuggestPostRequest

The Suggest request.

func (ApiDocumentsSuggestPostRequest) XMsClientRequestId 

func (r ApiDocumentsSuggestPostRequest) XMsClientRequestId(xMsClientRequestId string) ApiDocumentsSuggestPostRequest

The tracking ID sent with the request to help with debugging.

type AutocompleteItem 

type AutocompleteItem struct {
	// The completed term.
	Text string `json:"text"`
	// The query along with the completed term.
	QueryPlusText string `json:"queryPlusText"`
}

AutocompleteItem The result of Autocomplete requests.

func NewAutocompleteItem 

func NewAutocompleteItem(text string, queryPlusText string) *AutocompleteItem

NewAutocompleteItem instantiates a new AutocompleteItem 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 NewAutocompleteItemWithDefaults 

func NewAutocompleteItemWithDefaults() *AutocompleteItem

NewAutocompleteItemWithDefaults instantiates a new AutocompleteItem object This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set

func (*AutocompleteItem) GetQueryPlusText 

func (o *AutocompleteItem) GetQueryPlusText() string

GetQueryPlusText returns the QueryPlusText field value

func (*AutocompleteItem) GetQueryPlusTextOk 

func (o *AutocompleteItem) GetQueryPlusTextOk() (*string, bool)

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

func (*AutocompleteItem) GetText 

func (o *AutocompleteItem) GetText() string

GetText returns the Text field value

func (*AutocompleteItem) GetTextOk 

func (o *AutocompleteItem) GetTextOk() (*string, bool)

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

func (AutocompleteItem) MarshalJSON 

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

func (*AutocompleteItem) SetQueryPlusText 

func (o *AutocompleteItem) SetQueryPlusText(v string)

SetQueryPlusText sets field value

func (*AutocompleteItem) SetText 

func (o *AutocompleteItem) SetText(v string)

SetText sets field value

func (AutocompleteItem) ToMap 

func (o AutocompleteItem) ToMap() (map[string]interface{}, error)

type AutocompleteMode 

type AutocompleteMode string

AutocompleteMode Specifies the mode for Autocomplete. The default is 'oneTerm'. Use 'twoTerms' to get shingles and 'oneTermWithContext' to use the current context in producing autocomplete terms. 

const (
	ONE_TERM              AutocompleteMode = "oneTerm"
	TWO_TERMS             AutocompleteMode = "twoTerms"
	ONE_TERM_WITH_CONTEXT AutocompleteMode = "oneTermWithContext"
)

List of AutocompleteMode

func NewAutocompleteModeFromValue 

func NewAutocompleteModeFromValue(v string) (*AutocompleteMode, error)

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

func (AutocompleteMode) IsValid 

func (v AutocompleteMode) IsValid() bool

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

func (AutocompleteMode) Ptr 

func (v AutocompleteMode) Ptr() *AutocompleteMode

Ptr returns reference to AutocompleteMode value

func (*AutocompleteMode) UnmarshalJSON 

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

type AutocompleteRequest 

type AutocompleteRequest struct {
	// The search text on which to base autocomplete results.
	Search           string            `json:"search"`
	AutocompleteMode *AutocompleteMode `json:"autocompleteMode,omitempty"`
	// An OData expression that filters the documents used to produce completed terms for the Autocomplete result.
	Filter *string `json:"filter,omitempty"`
	// A value indicating whether to use fuzzy matching for the autocomplete query. Default is false. When set to true, the query will autocomplete terms even if there's a substituted or missing character in the search text. While this provides a better experience in some scenarios, it comes at a performance cost as fuzzy autocomplete queries are slower and consume more resources.
	Fuzzy *bool `json:"fuzzy,omitempty"`
	// A string tag that is appended to hit highlights. Must be set with highlightPreTag. If omitted, hit highlighting is disabled.
	HighlightPostTag *string `json:"highlightPostTag,omitempty"`
	// A string tag that is prepended to hit highlights. Must be set with highlightPostTag. If omitted, hit highlighting is disabled.
	HighlightPreTag *string `json:"highlightPreTag,omitempty"`
	// A number between 0 and 100 indicating the percentage of the index that must be covered by an autocomplete query in order for the query to be reported as a success. This parameter can be useful for ensuring search availability even for services with only one replica. The default is 80.
	MinimumCoverage *float64 `json:"minimumCoverage,omitempty"`
	// The comma-separated list of field names to consider when querying for auto-completed terms. Target fields must be included in the specified suggester.
	SearchFields *string `json:"searchFields,omitempty"`
	// The name of the suggester as specified in the suggesters collection that's part of the index definition.
	SuggesterName string `json:"suggesterName"`
	// The number of auto-completed terms to retrieve. This must be a value between 1 and 100. The default is 5.
	Top *int32 `json:"top,omitempty"`
}

AutocompleteRequest Parameters for fuzzy matching, and other autocomplete query behaviors.

func NewAutocompleteRequest 

func NewAutocompleteRequest(search string, suggesterName string) *AutocompleteRequest

NewAutocompleteRequest instantiates a new AutocompleteRequest 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 NewAutocompleteRequestWithDefaults 

func NewAutocompleteRequestWithDefaults() *AutocompleteRequest

NewAutocompleteRequestWithDefaults instantiates a new AutocompleteRequest object This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set

func (*AutocompleteRequest) GetAutocompleteMode 

func (o *AutocompleteRequest) GetAutocompleteMode() AutocompleteMode

GetAutocompleteMode returns the AutocompleteMode field value if set, zero value otherwise.

func (*AutocompleteRequest) GetAutocompleteModeOk 

func (o *AutocompleteRequest) GetAutocompleteModeOk() (*AutocompleteMode, bool)

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

func (*AutocompleteRequest) GetFilter 

func (o *AutocompleteRequest) GetFilter() string

GetFilter returns the Filter field value if set, zero value otherwise.

func (*AutocompleteRequest) GetFilterOk 

func (o *AutocompleteRequest) GetFilterOk() (*string, bool)

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

func (*AutocompleteRequest) GetFuzzy 

func (o *AutocompleteRequest) GetFuzzy() bool

GetFuzzy returns the Fuzzy field value if set, zero value otherwise.

func (*AutocompleteRequest) GetFuzzyOk 

func (o *AutocompleteRequest) GetFuzzyOk() (*bool, bool)

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

func (*AutocompleteRequest) GetHighlightPostTag 

func (o *AutocompleteRequest) GetHighlightPostTag() string

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

func (*AutocompleteRequest) GetHighlightPostTagOk 

func (o *AutocompleteRequest) 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 (*AutocompleteRequest) GetHighlightPreTag 

func (o *AutocompleteRequest) GetHighlightPreTag() string

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

func (*AutocompleteRequest) GetHighlightPreTagOk 

func (o *AutocompleteRequest) 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 (*AutocompleteRequest) GetMinimumCoverage 

func (o *AutocompleteRequest) GetMinimumCoverage() float64

GetMinimumCoverage returns the MinimumCoverage field value if set, zero value otherwise.

func (*AutocompleteRequest) GetMinimumCoverageOk 

func (o *AutocompleteRequest) GetMinimumCoverageOk() (*float64, bool)

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

func (*AutocompleteRequest) GetSearch 

func (o *AutocompleteRequest) GetSearch() string

GetSearch returns the Search field value

func (*AutocompleteRequest) GetSearchFields 

func (o *AutocompleteRequest) GetSearchFields() string

GetSearchFields returns the SearchFields field value if set, zero value otherwise.

func (*AutocompleteRequest) GetSearchFieldsOk 

func (o *AutocompleteRequest) GetSearchFieldsOk() (*string, bool)

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

func (*AutocompleteRequest) GetSearchOk 

func (o *AutocompleteRequest) GetSearchOk() (*string, bool)

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

func (*AutocompleteRequest) GetSuggesterName 

func (o *AutocompleteRequest) GetSuggesterName() string

GetSuggesterName returns the SuggesterName field value

func (*AutocompleteRequest) GetSuggesterNameOk 

func (o *AutocompleteRequest) GetSuggesterNameOk() (*string, bool)

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

func (*AutocompleteRequest) GetTop 

func (o *AutocompleteRequest) GetTop() int32

GetTop returns the Top field value if set, zero value otherwise.

func (*AutocompleteRequest) GetTopOk 

func (o *AutocompleteRequest) GetTopOk() (*int32, bool)

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

func (*AutocompleteRequest) HasAutocompleteMode 

func (o *AutocompleteRequest) HasAutocompleteMode() bool

HasAutocompleteMode returns a boolean if a field has been set.

func (*AutocompleteRequest) HasFilter 

func (o *AutocompleteRequest) HasFilter() bool

HasFilter returns a boolean if a field has been set.

func (*AutocompleteRequest) HasFuzzy 

func (o *AutocompleteRequest) HasFuzzy() bool

HasFuzzy returns a boolean if a field has been set.

func (*AutocompleteRequest) HasHighlightPostTag 

func (o *AutocompleteRequest) HasHighlightPostTag() bool

HasHighlightPostTag returns a boolean if a field has been set.

func (*AutocompleteRequest) HasHighlightPreTag 

func (o *AutocompleteRequest) HasHighlightPreTag() bool

HasHighlightPreTag returns a boolean if a field has been set.

func (*AutocompleteRequest) HasMinimumCoverage 

func (o *AutocompleteRequest) HasMinimumCoverage() bool

HasMinimumCoverage returns a boolean if a field has been set.

func (*AutocompleteRequest) HasSearchFields 

func (o *AutocompleteRequest) HasSearchFields() bool

HasSearchFields returns a boolean if a field has been set.

func (*AutocompleteRequest) HasTop 

func (o *AutocompleteRequest) HasTop() bool

HasTop returns a boolean if a field has been set.

func (AutocompleteRequest) MarshalJSON 

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

func (*AutocompleteRequest) SetAutocompleteMode 

func (o *AutocompleteRequest) SetAutocompleteMode(v AutocompleteMode)

SetAutocompleteMode gets a reference to the given AutocompleteMode and assigns it to the AutocompleteMode field.

func (*AutocompleteRequest) SetFilter 

func (o *AutocompleteRequest) SetFilter(v string)

SetFilter gets a reference to the given string and assigns it to the Filter field.

func (*AutocompleteRequest) SetFuzzy 

func (o *AutocompleteRequest) SetFuzzy(v bool)

SetFuzzy gets a reference to the given bool and assigns it to the Fuzzy field.

func (*AutocompleteRequest) SetHighlightPostTag 

func (o *AutocompleteRequest) SetHighlightPostTag(v string)

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

func (*AutocompleteRequest) SetHighlightPreTag 

func (o *AutocompleteRequest) SetHighlightPreTag(v string)

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

func (*AutocompleteRequest) SetMinimumCoverage 

func (o *AutocompleteRequest) SetMinimumCoverage(v float64)

SetMinimumCoverage gets a reference to the given float64 and assigns it to the MinimumCoverage field.

func (*AutocompleteRequest) SetSearch 

func (o *AutocompleteRequest) SetSearch(v string)

SetSearch sets field value

func (*AutocompleteRequest) SetSearchFields 

func (o *AutocompleteRequest) SetSearchFields(v string)

SetSearchFields gets a reference to the given string and assigns it to the SearchFields field.

func (*AutocompleteRequest) SetSuggesterName 

func (o *AutocompleteRequest) SetSuggesterName(v string)

SetSuggesterName sets field value

func (*AutocompleteRequest) SetTop 

func (o *AutocompleteRequest) SetTop(v int32)

SetTop gets a reference to the given int32 and assigns it to the Top field.

func (AutocompleteRequest) ToMap 

func (o AutocompleteRequest) ToMap() (map[string]interface{}, error)

type AutocompleteResult 

type AutocompleteResult struct {
	// A value indicating the percentage of the index that was considered by the autocomplete request, or null if minimumCoverage was not specified in the request.
	SearchCoverage *float64 `json:"@search.coverage,omitempty"`
	// The list of returned Autocompleted items.
	Value []AutocompleteItem `json:"value"`
}

AutocompleteResult The result of Autocomplete query.

func NewAutocompleteResult 

func NewAutocompleteResult(value []AutocompleteItem) *AutocompleteResult

NewAutocompleteResult instantiates a new AutocompleteResult 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 NewAutocompleteResultWithDefaults 

func NewAutocompleteResultWithDefaults() *AutocompleteResult

NewAutocompleteResultWithDefaults instantiates a new AutocompleteResult object This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set

func (*AutocompleteResult) GetSearchCoverage 

func (o *AutocompleteResult) GetSearchCoverage() float64

GetSearchCoverage returns the SearchCoverage field value if set, zero value otherwise.

func (*AutocompleteResult) GetSearchCoverageOk 

func (o *AutocompleteResult) GetSearchCoverageOk() (*float64, bool)

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

func (*AutocompleteResult) GetValue 

func (o *AutocompleteResult) GetValue() []AutocompleteItem

GetValue returns the Value field value

func (*AutocompleteResult) GetValueOk 

func (o *AutocompleteResult) GetValueOk() ([]AutocompleteItem, bool)

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

func (*AutocompleteResult) HasSearchCoverage 

func (o *AutocompleteResult) HasSearchCoverage() bool

HasSearchCoverage returns a boolean if a field has been set.

func (AutocompleteResult) MarshalJSON 

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

func (*AutocompleteResult) SetSearchCoverage 

func (o *AutocompleteResult) SetSearchCoverage(v float64)

SetSearchCoverage gets a reference to the given float64 and assigns it to the SearchCoverage field.

func (*AutocompleteResult) SetValue 

func (o *AutocompleteResult) SetValue(v []AutocompleteItem)

SetValue sets field value

func (AutocompleteResult) ToMap 

func (o AutocompleteResult) ToMap() (map[string]interface{}, error)

type BasicAuth 

type BasicAuth struct {
	UserName string `json:"userName,omitempty"`
	Password string `json:"password,omitempty"`
}

BasicAuth provides basic http authentication to a request passed via context using ContextBasicAuth

type CaptionResult 

type CaptionResult struct {
	// A representative text passage extracted from the document most relevant to the search query.
	Text *string `json:"text,omitempty"`
	// Same text passage as in the Text property with highlighted phrases most relevant to the query.
	Highlights NullableString `json:"highlights,omitempty"`
}

CaptionResult Captions are the most representative passages from the document relatively to the search query. They are often used as document summary. Captions are only returned for queries of type 'semantic'..

func NewCaptionResult 

func NewCaptionResult() *CaptionResult

NewCaptionResult instantiates a new CaptionResult 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 NewCaptionResultWithDefaults 

func NewCaptionResultWithDefaults() *CaptionResult

NewCaptionResultWithDefaults instantiates a new CaptionResult object This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set

func (*CaptionResult) GetHighlights 

func (o *CaptionResult) GetHighlights() string

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

func (*CaptionResult) GetHighlightsOk 

func (o *CaptionResult) GetHighlightsOk() (*string, bool)

GetHighlightsOk returns a tuple with the Highlights 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 (*CaptionResult) GetText 

func (o *CaptionResult) GetText() string

GetText returns the Text field value if set, zero value otherwise.

func (*CaptionResult) GetTextOk 

func (o *CaptionResult) GetTextOk() (*string, bool)

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

func (*CaptionResult) HasHighlights 

func (o *CaptionResult) HasHighlights() bool

HasHighlights returns a boolean if a field has been set.

func (*CaptionResult) HasText 

func (o *CaptionResult) HasText() bool

HasText returns a boolean if a field has been set.

func (CaptionResult) MarshalJSON 

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

func (*CaptionResult) SetHighlights 

func (o *CaptionResult) SetHighlights(v string)

SetHighlights gets a reference to the given NullableString and assigns it to the Highlights field.

func (*CaptionResult) SetHighlightsNil 

func (o *CaptionResult) SetHighlightsNil()

SetHighlightsNil sets the value for Highlights to be an explicit nil

func (*CaptionResult) SetText 

func (o *CaptionResult) SetText(v string)

SetText gets a reference to the given string and assigns it to the Text field.

func (CaptionResult) ToMap 

func (o CaptionResult) ToMap() (map[string]interface{}, error)

func (*CaptionResult) UnsetHighlights 

func (o *CaptionResult) UnsetHighlights()

UnsetHighlights ensures that no value is present for Highlights, not even an explicit nil

type Captions 

type Captions string

Captions This parameter is only valid if the query type is 'semantic'. If set, the query returns captions extracted from key passages in the highest ranked documents. When Captions is set to 'extractive', highlighting is enabled by default, and can be configured by appending the pipe character '|' followed by the 'highlight-<true/false>' option, such as 'extractive|highlight-true'. Defaults to 'None'.

func NewCaptionsFromValue 

func NewCaptionsFromValue(v string) (*Captions, error)

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

func (Captions) IsValid 

func (v Captions) IsValid() bool

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

func (Captions) Ptr 

func (v Captions) Ptr() *Captions

Ptr returns reference to Captions value

func (*Captions) UnmarshalJSON 

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

type Configuration 

type Configuration struct {
	Host             string            `json:"host,omitempty"`
	Scheme           string            `json:"scheme,omitempty"`
	DefaultHeader    map[string]string `json:"defaultHeader,omitempty"`
	UserAgent        string            `json:"userAgent,omitempty"`
	Debug            bool              `json:"debug,omitempty"`
	Servers          ServerConfigurations
	OperationServers map[string]ServerConfigurations
	HTTPClient       *http.Client
}

Configuration stores the configuration of the API client

func NewConfiguration 

func NewConfiguration() *Configuration

NewConfiguration returns a new Configuration object

func (*Configuration) AddDefaultHeader 

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

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

func (*Configuration) ServerURL 

func (c *Configuration) ServerURL(index int, variables map[string]string) (string, error)

ServerURL returns URL based on server settings

func (*Configuration) ServerURLWithContext 

func (c *Configuration) ServerURLWithContext(ctx context.Context, endpoint string) (string, error)

ServerURLWithContext returns a new server URL given an endpoint

type DocumentDebugInfo 

type DocumentDebugInfo struct {
	Semantic *SemanticDebugInfo `json:"semantic,omitempty"`
}

DocumentDebugInfo Contains debugging information that can be used to further explore your search results.

func NewDocumentDebugInfo 

func NewDocumentDebugInfo() *DocumentDebugInfo

NewDocumentDebugInfo instantiates a new DocumentDebugInfo 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 NewDocumentDebugInfoWithDefaults 

func NewDocumentDebugInfoWithDefaults() *DocumentDebugInfo

NewDocumentDebugInfoWithDefaults instantiates a new DocumentDebugInfo object This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set

func (*DocumentDebugInfo) GetSemantic 

func (o *DocumentDebugInfo) GetSemantic() SemanticDebugInfo

GetSemantic returns the Semantic field value if set, zero value otherwise.

func (*DocumentDebugInfo) GetSemanticOk 

func (o *DocumentDebugInfo) GetSemanticOk() (*SemanticDebugInfo, bool)

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

func (*DocumentDebugInfo) HasSemantic 

func (o *DocumentDebugInfo) HasSemantic() bool

HasSemantic returns a boolean if a field has been set.

func (DocumentDebugInfo) MarshalJSON 

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

func (*DocumentDebugInfo) SetSemantic 

func (o *DocumentDebugInfo) SetSemantic(v SemanticDebugInfo)

SetSemantic gets a reference to the given SemanticDebugInfo and assigns it to the Semantic field.

func (DocumentDebugInfo) ToMap 

func (o DocumentDebugInfo) ToMap() (map[string]interface{}, error)

type DocumentsApiService 

type DocumentsApiService service

DocumentsApiService DocumentsApi service

func (*DocumentsApiService) DocumentsAutocompleteGet 

func (a *DocumentsApiService) DocumentsAutocompleteGet(ctx context.Context) ApiDocumentsAutocompleteGetRequest

DocumentsAutocompleteGet Method for DocumentsAutocompleteGet

Autocompletes incomplete query terms based on input text and matching terms in the index. 

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@return ApiDocumentsAutocompleteGetRequest

func (*DocumentsApiService) DocumentsAutocompleteGetExecute 

func (a *DocumentsApiService) DocumentsAutocompleteGetExecute(r ApiDocumentsAutocompleteGetRequest) (*AutocompleteResult, *http.Response, error)

Execute executes the request 

@return AutocompleteResult

func (*DocumentsApiService) DocumentsAutocompletePost 

func (a *DocumentsApiService) DocumentsAutocompletePost(ctx context.Context) ApiDocumentsAutocompletePostRequest

DocumentsAutocompletePost Method for DocumentsAutocompletePost

Autocompletes incomplete query terms based on input text and matching terms in the index. 

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@return ApiDocumentsAutocompletePostRequest

func (*DocumentsApiService) DocumentsAutocompletePostExecute 

func (a *DocumentsApiService) DocumentsAutocompletePostExecute(r ApiDocumentsAutocompletePostRequest) (*AutocompleteResult, *http.Response, error)

Execute executes the request 

@return AutocompleteResult

func (*DocumentsApiService) DocumentsCount 

func (a *DocumentsApiService) DocumentsCount(ctx context.Context) ApiDocumentsCountRequest

DocumentsCount Method for DocumentsCount

Queries the number of documents in the index. 

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@return ApiDocumentsCountRequest

func (*DocumentsApiService) DocumentsCountExecute 

func (a *DocumentsApiService) DocumentsCountExecute(r ApiDocumentsCountRequest) (int64, *http.Response, error)

Execute executes the request 

@return int64

func (*DocumentsApiService) DocumentsGet 

func (a *DocumentsApiService) DocumentsGet(ctx context.Context, key string) ApiDocumentsGetRequest

DocumentsGet Method for DocumentsGet

Retrieves a document from the index. 

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param key The key of the document to retrieve.
@return ApiDocumentsGetRequest

func (*DocumentsApiService) DocumentsGetExecute 

func (a *DocumentsApiService) DocumentsGetExecute(r ApiDocumentsGetRequest) (map[string]interface{}, *http.Response, error)

Execute executes the request 

@return map[string]interface{}

func (*DocumentsApiService) DocumentsIndex 

func (a *DocumentsApiService) DocumentsIndex(ctx context.Context) ApiDocumentsIndexRequest

DocumentsIndex Method for DocumentsIndex

Sends a batch of document write actions to the index. 

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@return ApiDocumentsIndexRequest

func (*DocumentsApiService) DocumentsIndexExecute 

func (a *DocumentsApiService) DocumentsIndexExecute(r ApiDocumentsIndexRequest) (*IndexDocumentsResult, *http.Response, error)

Execute executes the request 

@return IndexDocumentsResult

func (*DocumentsApiService) DocumentsSearchGet 

func (a *DocumentsApiService) DocumentsSearchGet(ctx context.Context) ApiDocumentsSearchGetRequest

DocumentsSearchGet Method for DocumentsSearchGet

Searches for documents in the index. 

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@return ApiDocumentsSearchGetRequest

func (*DocumentsApiService) DocumentsSearchGetExecute 

func (a *DocumentsApiService) DocumentsSearchGetExecute(r ApiDocumentsSearchGetRequest) (*SearchDocumentsResult, *http.Response, error)

Execute executes the request 

@return SearchDocumentsResult

func (*DocumentsApiService) DocumentsSearchPost 

func (a *DocumentsApiService) DocumentsSearchPost(ctx context.Context) ApiDocumentsSearchPostRequest

DocumentsSearchPost Method for DocumentsSearchPost

Searches for documents in the index. 

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@return ApiDocumentsSearchPostRequest

func (*DocumentsApiService) DocumentsSearchPostExecute 

func (a *DocumentsApiService) DocumentsSearchPostExecute(r ApiDocumentsSearchPostRequest) (*SearchDocumentsResult, *http.Response, error)

Execute executes the request 

@return SearchDocumentsResult

func (*DocumentsApiService) DocumentsSuggestGet 

func (a *DocumentsApiService) DocumentsSuggestGet(ctx context.Context) ApiDocumentsSuggestGetRequest

DocumentsSuggestGet Method for DocumentsSuggestGet

Suggests documents in the index that match the given partial query text. 

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@return ApiDocumentsSuggestGetRequest

func (*DocumentsApiService) DocumentsSuggestGetExecute 

func (a *DocumentsApiService) DocumentsSuggestGetExecute(r ApiDocumentsSuggestGetRequest) (*SuggestDocumentsResult, *http.Response, error)

Execute executes the request 

@return SuggestDocumentsResult

func (*DocumentsApiService) DocumentsSuggestPost 

func (a *DocumentsApiService) DocumentsSuggestPost(ctx context.Context) ApiDocumentsSuggestPostRequest

DocumentsSuggestPost Method for DocumentsSuggestPost

Suggests documents in the index that match the given partial query text. 

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@return ApiDocumentsSuggestPostRequest

func (*DocumentsApiService) DocumentsSuggestPostExecute 

func (a *DocumentsApiService) DocumentsSuggestPostExecute(r ApiDocumentsSuggestPostRequest) (*SuggestDocumentsResult, *http.Response, error)

Execute executes the request 

@return SuggestDocumentsResult

type FacetResult 

type FacetResult struct {
	// The approximate count of documents falling within the bucket described by this facet.
	Count *int64 `json:"count,omitempty"`
}

FacetResult A single bucket of a facet query result. Reports the number of documents with a field value falling within a particular range or having a particular value or interval.

func NewFacetResult 

func NewFacetResult() *FacetResult

NewFacetResult instantiates a new FacetResult 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 NewFacetResultWithDefaults 

func NewFacetResultWithDefaults() *FacetResult

NewFacetResultWithDefaults instantiates a new FacetResult object This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set

func (*FacetResult) GetCount 

func (o *FacetResult) GetCount() int64

GetCount returns the Count field value if set, zero value otherwise.

func (*FacetResult) GetCountOk 

func (o *FacetResult) GetCountOk() (*int64, bool)

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

func (*FacetResult) HasCount 

func (o *FacetResult) HasCount() bool

HasCount returns a boolean if a field has been set.

func (FacetResult) MarshalJSON 

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

func (*FacetResult) SetCount 

func (o *FacetResult) SetCount(v int64)

SetCount gets a reference to the given int64 and assigns it to the Count field.

func (FacetResult) ToMap 

func (o FacetResult) ToMap() (map[string]interface{}, error)

type GenericOpenAPIError 

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

GenericOpenAPIError Provides access to the body, error and model on returned errors.

func (GenericOpenAPIError) Body 

func (e GenericOpenAPIError) Body() []byte

Body returns the raw bytes of the response

func (GenericOpenAPIError) Error 

func (e GenericOpenAPIError) Error() string

Error returns non-empty string if there was an error.

func (GenericOpenAPIError) Model 

func (e GenericOpenAPIError) Model() interface{}

Model returns the unpacked model of the error

type IndexAction 

type IndexAction struct {
	// The operation to perform on a document in an indexing batch.
	SearchAction *string `json:"@search.action,omitempty"`
}

IndexAction Represents an index action that operates on a document.

func NewIndexAction 

func NewIndexAction() *IndexAction

NewIndexAction instantiates a new IndexAction 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 NewIndexActionWithDefaults 

func NewIndexActionWithDefaults() *IndexAction

NewIndexActionWithDefaults instantiates a new IndexAction object This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set

func (*IndexAction) GetSearchAction 

func (o *IndexAction) GetSearchAction() string

GetSearchAction returns the SearchAction field value if set, zero value otherwise.

func (*IndexAction) GetSearchActionOk 

func (o *IndexAction) GetSearchActionOk() (*string, bool)

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

func (*IndexAction) HasSearchAction 

func (o *IndexAction) HasSearchAction() bool

HasSearchAction returns a boolean if a field has been set.

func (IndexAction) MarshalJSON 

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

func (*IndexAction) SetSearchAction 

func (o *IndexAction) SetSearchAction(v string)

SetSearchAction gets a reference to the given string and assigns it to the SearchAction field.

func (IndexAction) ToMap 

func (o IndexAction) ToMap() (map[string]interface{}, error)

type IndexBatch 

type IndexBatch struct {
	// The actions in the batch.
	Value []IndexAction `json:"value"`
}

IndexBatch Contains a batch of document write actions to send to the index.

func NewIndexBatch 

func NewIndexBatch(value []IndexAction) *IndexBatch

NewIndexBatch instantiates a new IndexBatch 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 NewIndexBatchWithDefaults 

func NewIndexBatchWithDefaults() *IndexBatch

NewIndexBatchWithDefaults instantiates a new IndexBatch object This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set

func (*IndexBatch) GetValue 

func (o *IndexBatch) GetValue() []IndexAction

GetValue returns the Value field value

func (*IndexBatch) GetValueOk 

func (o *IndexBatch) GetValueOk() ([]IndexAction, bool)

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

func (IndexBatch) MarshalJSON 

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

func (*IndexBatch) SetValue 

func (o *IndexBatch) SetValue(v []IndexAction)

SetValue sets field value

func (IndexBatch) ToMap 

func (o IndexBatch) ToMap() (map[string]interface{}, error)

type IndexDocumentsResult 

type IndexDocumentsResult struct {
	// The list of status information for each document in the indexing request.
	Value []IndexingResult `json:"value"`
}

IndexDocumentsResult Response containing the status of operations for all documents in the indexing request.

func NewIndexDocumentsResult 

func NewIndexDocumentsResult(value []IndexingResult) *IndexDocumentsResult

NewIndexDocumentsResult instantiates a new IndexDocumentsResult 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 NewIndexDocumentsResultWithDefaults 

func NewIndexDocumentsResultWithDefaults() *IndexDocumentsResult

NewIndexDocumentsResultWithDefaults instantiates a new IndexDocumentsResult object This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set

func (*IndexDocumentsResult) GetValue 

func (o *IndexDocumentsResult) GetValue() []IndexingResult

GetValue returns the Value field value

func (*IndexDocumentsResult) GetValueOk 

func (o *IndexDocumentsResult) GetValueOk() ([]IndexingResult, bool)

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

func (IndexDocumentsResult) MarshalJSON 

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

func (*IndexDocumentsResult) SetValue 

func (o *IndexDocumentsResult) SetValue(v []IndexingResult)

SetValue sets field value

func (IndexDocumentsResult) ToMap 

func (o IndexDocumentsResult) ToMap() (map[string]interface{}, error)

type IndexingResult 

type IndexingResult struct {
	// The key of a document that was in the indexing request.
	Key string `json:"key"`
	// The error message explaining why the indexing operation failed for the document identified by the key; null if indexing succeeded.
	ErrorMessage *string `json:"errorMessage,omitempty"`
	// A value indicating whether the indexing operation succeeded for the document identified by the key.
	Status bool `json:"status"`
	// The status code of the indexing operation. Possible values include: 200 for a successful update or delete, 201 for successful document creation, 400 for a malformed input document, 404 for document not found, 409 for a version conflict, 422 when the index is temporarily unavailable, or 503 for when the service is too busy.
	StatusCode int32 `json:"statusCode"`
}

IndexingResult Status of an indexing operation for a single document.

func NewIndexingResult 

func NewIndexingResult(key string, status bool, statusCode int32) *IndexingResult

NewIndexingResult instantiates a new IndexingResult 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 NewIndexingResultWithDefaults 

func NewIndexingResultWithDefaults() *IndexingResult

NewIndexingResultWithDefaults instantiates a new IndexingResult object This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set

func (*IndexingResult) GetErrorMessage 

func (o *IndexingResult) GetErrorMessage() string

GetErrorMessage returns the ErrorMessage field value if set, zero value otherwise.

func (*IndexingResult) GetErrorMessageOk 

func (o *IndexingResult) GetErrorMessageOk() (*string, bool)

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

func (*IndexingResult) GetKey 

func (o *IndexingResult) GetKey() string

GetKey returns the Key field value

func (*IndexingResult) GetKeyOk 

func (o *IndexingResult) GetKeyOk() (*string, bool)

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

func (*IndexingResult) GetStatus 

func (o *IndexingResult) GetStatus() bool

GetStatus returns the Status field value

func (*IndexingResult) GetStatusCode 

func (o *IndexingResult) GetStatusCode() int32

GetStatusCode returns the StatusCode field value

func (*IndexingResult) GetStatusCodeOk 

func (o *IndexingResult) GetStatusCodeOk() (*int32, bool)

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

func (*IndexingResult) GetStatusOk 

func (o *IndexingResult) GetStatusOk() (*bool, bool)

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

func (*IndexingResult) HasErrorMessage 

func (o *IndexingResult) HasErrorMessage() bool

HasErrorMessage returns a boolean if a field has been set.

func (IndexingResult) MarshalJSON 

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

func (*IndexingResult) SetErrorMessage 

func (o *IndexingResult) SetErrorMessage(v string)

SetErrorMessage gets a reference to the given string and assigns it to the ErrorMessage field.

func (*IndexingResult) SetKey 

func (o *IndexingResult) SetKey(v string)

SetKey sets field value

func (*IndexingResult) SetStatus 

func (o *IndexingResult) SetStatus(v bool)

SetStatus sets field value

func (*IndexingResult) SetStatusCode 

func (o *IndexingResult) SetStatusCode(v int32)

SetStatusCode sets field value

func (IndexingResult) ToMap 

func (o IndexingResult) ToMap() (map[string]interface{}, error)

type MappedNullable 

type MappedNullable interface {
	ToMap() (map[string]interface{}, error)
}

type NullableAnswerResult 

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

func NewNullableAnswerResult 

func NewNullableAnswerResult(val *AnswerResult) *NullableAnswerResult

func (NullableAnswerResult) Get 

func (v NullableAnswerResult) Get() *AnswerResult

func (NullableAnswerResult) IsSet 

func (v NullableAnswerResult) IsSet() bool

func (NullableAnswerResult) MarshalJSON 

func (v NullableAnswerResult) MarshalJSON() ([]byte, error)

func (*NullableAnswerResult) Set 

func (v *NullableAnswerResult) Set(val *AnswerResult)

func (*NullableAnswerResult) UnmarshalJSON 

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

func (*NullableAnswerResult) Unset 

func (v *NullableAnswerResult) Unset()

type NullableAnswers 

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

func NewNullableAnswers 

func NewNullableAnswers(val *Answers) *NullableAnswers

func (NullableAnswers) Get 

func (v NullableAnswers) Get() *Answers

func (NullableAnswers) IsSet 

func (v NullableAnswers) IsSet() bool

func (NullableAnswers) MarshalJSON 

func (v NullableAnswers) MarshalJSON() ([]byte, error)

func (*NullableAnswers) Set 

func (v *NullableAnswers) Set(val *Answers)

func (*NullableAnswers) UnmarshalJSON 

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

func (*NullableAnswers) Unset 

func (v *NullableAnswers) Unset()

type NullableAutocompleteItem 

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

func NewNullableAutocompleteItem 

func NewNullableAutocompleteItem(val *AutocompleteItem) *NullableAutocompleteItem

func (NullableAutocompleteItem) Get 

func (v NullableAutocompleteItem) Get() *AutocompleteItem

func (NullableAutocompleteItem) IsSet 

func (v NullableAutocompleteItem) IsSet() bool

func (NullableAutocompleteItem) MarshalJSON 

func (v NullableAutocompleteItem) MarshalJSON() ([]byte, error)

func (*NullableAutocompleteItem) Set 

func (v *NullableAutocompleteItem) Set(val *AutocompleteItem)

func (*NullableAutocompleteItem) UnmarshalJSON 

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

func (*NullableAutocompleteItem) Unset 

func (v *NullableAutocompleteItem) Unset()

type NullableAutocompleteMode 

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

func NewNullableAutocompleteMode 

func NewNullableAutocompleteMode(val *AutocompleteMode) *NullableAutocompleteMode

func (NullableAutocompleteMode) Get 

func (v NullableAutocompleteMode) Get() *AutocompleteMode

func (NullableAutocompleteMode) IsSet 

func (v NullableAutocompleteMode) IsSet() bool

func (NullableAutocompleteMode) MarshalJSON 

func (v NullableAutocompleteMode) MarshalJSON() ([]byte, error)

func (*NullableAutocompleteMode) Set 

func (v *NullableAutocompleteMode) Set(val *AutocompleteMode)

func (*NullableAutocompleteMode) UnmarshalJSON 

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

func (*NullableAutocompleteMode) Unset 

func (v *NullableAutocompleteMode) Unset()

type NullableAutocompleteRequest 

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

func NewNullableAutocompleteRequest 

func NewNullableAutocompleteRequest(val *AutocompleteRequest) *NullableAutocompleteRequest

func (NullableAutocompleteRequest) Get 

func (v NullableAutocompleteRequest) Get() *AutocompleteRequest

func (NullableAutocompleteRequest) IsSet 

func (v NullableAutocompleteRequest) IsSet() bool

func (NullableAutocompleteRequest) MarshalJSON 

func (v NullableAutocompleteRequest) MarshalJSON() ([]byte, error)

func (*NullableAutocompleteRequest) Set 

func (v *NullableAutocompleteRequest) Set(val *AutocompleteRequest)

func (*NullableAutocompleteRequest) UnmarshalJSON 

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

func (*NullableAutocompleteRequest) Unset 

func (v *NullableAutocompleteRequest) Unset()

type NullableAutocompleteResult 

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

func NewNullableAutocompleteResult 

func NewNullableAutocompleteResult(val *AutocompleteResult) *NullableAutocompleteResult

func (NullableAutocompleteResult) Get 

func (v NullableAutocompleteResult) Get() *AutocompleteResult

func (NullableAutocompleteResult) IsSet 

func (v NullableAutocompleteResult) IsSet() bool

func (NullableAutocompleteResult) MarshalJSON 

func (v NullableAutocompleteResult) MarshalJSON() ([]byte, error)

func (*NullableAutocompleteResult) Set 

func (v *NullableAutocompleteResult) Set(val *AutocompleteResult)

func (*NullableAutocompleteResult) UnmarshalJSON 

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

func (*NullableAutocompleteResult) Unset 

func (v *NullableAutocompleteResult) Unset()

type NullableBool 

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

func NewNullableBool 

func NewNullableBool(val *bool) *NullableBool

func (NullableBool) Get 

func (v NullableBool) Get() *bool

func (NullableBool) IsSet 

func (v NullableBool) IsSet() bool

func (NullableBool) MarshalJSON 

func (v NullableBool) MarshalJSON() ([]byte, error)

func (*NullableBool) Set 

func (v *NullableBool) Set(val *bool)

func (*NullableBool) UnmarshalJSON 

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

func (*NullableBool) Unset 

func (v *NullableBool) Unset()

type NullableCaptionResult 

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

func NewNullableCaptionResult 

func NewNullableCaptionResult(val *CaptionResult) *NullableCaptionResult

func (NullableCaptionResult) Get 

func (v NullableCaptionResult) Get() *CaptionResult

func (NullableCaptionResult) IsSet 

func (v NullableCaptionResult) IsSet() bool

func (NullableCaptionResult) MarshalJSON 

func (v NullableCaptionResult) MarshalJSON() ([]byte, error)

func (*NullableCaptionResult) Set 

func (v *NullableCaptionResult) Set(val *CaptionResult)

func (*NullableCaptionResult) UnmarshalJSON 

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

func (*NullableCaptionResult) Unset 

func (v *NullableCaptionResult) Unset()

type NullableCaptions 

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

func NewNullableCaptions 

func NewNullableCaptions(val *Captions) *NullableCaptions

func (NullableCaptions) Get 

func (v NullableCaptions) Get() *Captions

func (NullableCaptions) IsSet 

func (v NullableCaptions) IsSet() bool

func (NullableCaptions) MarshalJSON 

func (v NullableCaptions) MarshalJSON() ([]byte, error)

func (*NullableCaptions) Set 

func (v *NullableCaptions) Set(val *Captions)

func (*NullableCaptions) UnmarshalJSON 

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

func (*NullableCaptions) Unset 

func (v *NullableCaptions) Unset()

type NullableDocumentDebugInfo 

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

func NewNullableDocumentDebugInfo 

func NewNullableDocumentDebugInfo(val *DocumentDebugInfo) *NullableDocumentDebugInfo

func (NullableDocumentDebugInfo) Get 

func (v NullableDocumentDebugInfo) Get() *DocumentDebugInfo

func (NullableDocumentDebugInfo) IsSet 

func (v NullableDocumentDebugInfo) IsSet() bool

func (NullableDocumentDebugInfo) MarshalJSON 

func (v NullableDocumentDebugInfo) MarshalJSON() ([]byte, error)

func (*NullableDocumentDebugInfo) Set 

func (v *NullableDocumentDebugInfo) Set(val *DocumentDebugInfo)

func (*NullableDocumentDebugInfo) UnmarshalJSON 

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

func (*NullableDocumentDebugInfo) Unset 

func (v *NullableDocumentDebugInfo) Unset()

type NullableFacetResult 

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

func NewNullableFacetResult 

func NewNullableFacetResult(val *FacetResult) *NullableFacetResult

func (NullableFacetResult) Get 

func (v NullableFacetResult) Get() *FacetResult

func (NullableFacetResult) IsSet 

func (v NullableFacetResult) IsSet() bool

func (NullableFacetResult) MarshalJSON 

func (v NullableFacetResult) MarshalJSON() ([]byte, error)

func (*NullableFacetResult) Set 

func (v *NullableFacetResult) Set(val *FacetResult)

func (*NullableFacetResult) UnmarshalJSON 

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

func (*NullableFacetResult) Unset 

func (v *NullableFacetResult) Unset()

type NullableFloat32 

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

func NewNullableFloat32 

func NewNullableFloat32(val *float32) *NullableFloat32

func (NullableFloat32) Get 

func (v NullableFloat32) Get() *float32

func (NullableFloat32) IsSet 

func (v NullableFloat32) IsSet() bool

func (NullableFloat32) MarshalJSON 

func (v NullableFloat32) MarshalJSON() ([]byte, error)

func (*NullableFloat32) Set 

func (v *NullableFloat32) Set(val *float32)

func (*NullableFloat32) UnmarshalJSON 

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

func (*NullableFloat32) Unset 

func (v *NullableFloat32) Unset()

type NullableFloat64 

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

func NewNullableFloat64 

func NewNullableFloat64(val *float64) *NullableFloat64

func (NullableFloat64) Get 

func (v NullableFloat64) Get() *float64

func (NullableFloat64) IsSet 

func (v NullableFloat64) IsSet() bool

func (NullableFloat64) MarshalJSON 

func (v NullableFloat64) MarshalJSON() ([]byte, error)

func (*NullableFloat64) Set 

func (v *NullableFloat64) Set(val *float64)

func (*NullableFloat64) UnmarshalJSON 

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

func (*NullableFloat64) Unset 

func (v *NullableFloat64) Unset()

type NullableIndexAction 

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

func NewNullableIndexAction 

func NewNullableIndexAction(val *IndexAction) *NullableIndexAction

func (NullableIndexAction) Get 

func (v NullableIndexAction) Get() *IndexAction

func (NullableIndexAction) IsSet 

func (v NullableIndexAction) IsSet() bool

func (NullableIndexAction) MarshalJSON 

func (v NullableIndexAction) MarshalJSON() ([]byte, error)

func (*NullableIndexAction) Set 

func (v *NullableIndexAction) Set(val *IndexAction)

func (*NullableIndexAction) UnmarshalJSON 

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

func (*NullableIndexAction) Unset 

func (v *NullableIndexAction) Unset()

type NullableIndexBatch 

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

func NewNullableIndexBatch 

func NewNullableIndexBatch(val *IndexBatch) *NullableIndexBatch

func (NullableIndexBatch) Get 

func (v NullableIndexBatch) Get() *IndexBatch

func (NullableIndexBatch) IsSet 

func (v NullableIndexBatch) IsSet() bool

func (NullableIndexBatch) MarshalJSON 

func (v NullableIndexBatch) MarshalJSON() ([]byte, error)

func (*NullableIndexBatch) Set 

func (v *NullableIndexBatch) Set(val *IndexBatch)

func (*NullableIndexBatch) UnmarshalJSON 

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

func (*NullableIndexBatch) Unset 

func (v *NullableIndexBatch) Unset()

type NullableIndexDocumentsResult 

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

func NewNullableIndexDocumentsResult 

func NewNullableIndexDocumentsResult(val *IndexDocumentsResult) *NullableIndexDocumentsResult

func (NullableIndexDocumentsResult) Get 

func (v NullableIndexDocumentsResult) Get() *IndexDocumentsResult

func (NullableIndexDocumentsResult) IsSet 

func (v NullableIndexDocumentsResult) IsSet() bool

func (NullableIndexDocumentsResult) MarshalJSON 

func (v NullableIndexDocumentsResult) MarshalJSON() ([]byte, error)

func (*NullableIndexDocumentsResult) Set 

func (v *NullableIndexDocumentsResult) Set(val *IndexDocumentsResult)

func (*NullableIndexDocumentsResult) UnmarshalJSON 

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

func (*NullableIndexDocumentsResult) Unset 

func (v *NullableIndexDocumentsResult) Unset()

type NullableIndexingResult 

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

func NewNullableIndexingResult 

func NewNullableIndexingResult(val *IndexingResult) *NullableIndexingResult

func (NullableIndexingResult) Get 

func (v NullableIndexingResult) Get() *IndexingResult

func (NullableIndexingResult) IsSet 

func (v NullableIndexingResult) IsSet() bool

func (NullableIndexingResult) MarshalJSON 

func (v NullableIndexingResult) MarshalJSON() ([]byte, error)

func (*NullableIndexingResult) Set 

func (v *NullableIndexingResult) Set(val *IndexingResult)

func (*NullableIndexingResult) UnmarshalJSON 

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

func (*NullableIndexingResult) Unset 

func (v *NullableIndexingResult) Unset()

type NullableInt 

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

func NewNullableInt 

func NewNullableInt(val *int) *NullableInt

func (NullableInt) Get 

func (v NullableInt) Get() *int

func (NullableInt) IsSet 

func (v NullableInt) IsSet() bool

func (NullableInt) MarshalJSON 

func (v NullableInt) MarshalJSON() ([]byte, error)

func (*NullableInt) Set 

func (v *NullableInt) Set(val *int)

func (*NullableInt) UnmarshalJSON 

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

func (*NullableInt) Unset 

func (v *NullableInt) Unset()

type NullableInt32 

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

func NewNullableInt32 

func NewNullableInt32(val *int32) *NullableInt32

func (NullableInt32) Get 

func (v NullableInt32) Get() *int32

func (NullableInt32) IsSet 

func (v NullableInt32) IsSet() bool

func (NullableInt32) MarshalJSON 

func (v NullableInt32) MarshalJSON() ([]byte, error)

func (*NullableInt32) Set 

func (v *NullableInt32) Set(val *int32)

func (*NullableInt32) UnmarshalJSON 

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

func (*NullableInt32) Unset 

func (v *NullableInt32) Unset()

type NullableInt64 

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

func NewNullableInt64 

func NewNullableInt64(val *int64) *NullableInt64

func (NullableInt64) Get 

func (v NullableInt64) Get() *int64

func (NullableInt64) IsSet 

func (v NullableInt64) IsSet() bool

func (NullableInt64) MarshalJSON 

func (v NullableInt64) MarshalJSON() ([]byte, error)

func (*NullableInt64) Set 

func (v *NullableInt64) Set(val *int64)

func (*NullableInt64) UnmarshalJSON 

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

func (*NullableInt64) Unset 

func (v *NullableInt64) Unset()

type NullableQueryDebugMode 

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

func NewNullableQueryDebugMode 

func NewNullableQueryDebugMode(val *QueryDebugMode) *NullableQueryDebugMode

func (NullableQueryDebugMode) Get 

func (v NullableQueryDebugMode) Get() *QueryDebugMode

func (NullableQueryDebugMode) IsSet 

func (v NullableQueryDebugMode) IsSet() bool

func (NullableQueryDebugMode) MarshalJSON 

func (v NullableQueryDebugMode) MarshalJSON() ([]byte, error)

func (*NullableQueryDebugMode) Set 

func (v *NullableQueryDebugMode) Set(val *QueryDebugMode)

func (*NullableQueryDebugMode) UnmarshalJSON 

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

func (*NullableQueryDebugMode) Unset 

func (v *NullableQueryDebugMode) Unset()

type NullableQueryLanguage 

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

func NewNullableQueryLanguage 

func NewNullableQueryLanguage(val *QueryLanguage) *NullableQueryLanguage

func (NullableQueryLanguage) Get 

func (v NullableQueryLanguage) Get() *QueryLanguage

func (NullableQueryLanguage) IsSet 

func (v NullableQueryLanguage) IsSet() bool

func (NullableQueryLanguage) MarshalJSON 

func (v NullableQueryLanguage) MarshalJSON() ([]byte, error)

func (*NullableQueryLanguage) Set 

func (v *NullableQueryLanguage) Set(val *QueryLanguage)

func (*NullableQueryLanguage) UnmarshalJSON 

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

func (*NullableQueryLanguage) Unset 

func (v *NullableQueryLanguage) Unset()

type NullableQueryResultDocumentRerankerInput 

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

func NewNullableQueryResultDocumentRerankerInput 

func NewNullableQueryResultDocumentRerankerInput(val *QueryResultDocumentRerankerInput) *NullableQueryResultDocumentRerankerInput

func (NullableQueryResultDocumentRerankerInput) Get 

func (v NullableQueryResultDocumentRerankerInput) Get() *QueryResultDocumentRerankerInput

func (NullableQueryResultDocumentRerankerInput) IsSet 

func (v NullableQueryResultDocumentRerankerInput) IsSet() bool

func (NullableQueryResultDocumentRerankerInput) MarshalJSON 

func (v NullableQueryResultDocumentRerankerInput) MarshalJSON() ([]byte, error)

func (*NullableQueryResultDocumentRerankerInput) Set 

func (v *NullableQueryResultDocumentRerankerInput) Set(val *QueryResultDocumentRerankerInput)

func (*NullableQueryResultDocumentRerankerInput) UnmarshalJSON 

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

func (*NullableQueryResultDocumentRerankerInput) Unset 

func (v *NullableQueryResultDocumentRerankerInput) Unset()

type NullableQueryResultDocumentSemanticField 

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

func NewNullableQueryResultDocumentSemanticField 

func NewNullableQueryResultDocumentSemanticField(val *QueryResultDocumentSemanticField) *NullableQueryResultDocumentSemanticField

func (NullableQueryResultDocumentSemanticField) Get 

func (v NullableQueryResultDocumentSemanticField) Get() *QueryResultDocumentSemanticField

func (NullableQueryResultDocumentSemanticField) IsSet 

func (v NullableQueryResultDocumentSemanticField) IsSet() bool

func (NullableQueryResultDocumentSemanticField) MarshalJSON 

func (v NullableQueryResultDocumentSemanticField) MarshalJSON() ([]byte, error)

func (*NullableQueryResultDocumentSemanticField) Set 

func (v *NullableQueryResultDocumentSemanticField) Set(val *QueryResultDocumentSemanticField)

func (*NullableQueryResultDocumentSemanticField) UnmarshalJSON 

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

func (*NullableQueryResultDocumentSemanticField) Unset 

func (v *NullableQueryResultDocumentSemanticField) Unset()

type NullableQueryResultDocumentSemanticFieldState 

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

func NewNullableQueryResultDocumentSemanticFieldState 

func NewNullableQueryResultDocumentSemanticFieldState(val *QueryResultDocumentSemanticFieldState) *NullableQueryResultDocumentSemanticFieldState

func (NullableQueryResultDocumentSemanticFieldState) Get 

func (v NullableQueryResultDocumentSemanticFieldState) Get() *QueryResultDocumentSemanticFieldState

func (NullableQueryResultDocumentSemanticFieldState) IsSet 

func (v NullableQueryResultDocumentSemanticFieldState) IsSet() bool

func (NullableQueryResultDocumentSemanticFieldState) MarshalJSON 

func (v NullableQueryResultDocumentSemanticFieldState) MarshalJSON() ([]byte, error)

func (*NullableQueryResultDocumentSemanticFieldState) Set 

func (v *NullableQueryResultDocumentSemanticFieldState) Set(val *QueryResultDocumentSemanticFieldState)

func (*NullableQueryResultDocumentSemanticFieldState) UnmarshalJSON 

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

func (*NullableQueryResultDocumentSemanticFieldState) Unset 

func (v *NullableQueryResultDocumentSemanticFieldState) Unset()

type NullableQueryType 

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

func NewNullableQueryType 

func NewNullableQueryType(val *QueryType) *NullableQueryType

func (NullableQueryType) Get 

func (v NullableQueryType) Get() *QueryType

func (NullableQueryType) IsSet 

func (v NullableQueryType) IsSet() bool

func (NullableQueryType) MarshalJSON 

func (v NullableQueryType) MarshalJSON() ([]byte, error)

func (*NullableQueryType) Set 

func (v *NullableQueryType) Set(val *QueryType)

func (*NullableQueryType) UnmarshalJSON 

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

func (*NullableQueryType) Unset 

func (v *NullableQueryType) Unset()

type NullableScoringStatistics 

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

func NewNullableScoringStatistics 

func NewNullableScoringStatistics(val *ScoringStatistics) *NullableScoringStatistics

func (NullableScoringStatistics) Get 

func (v NullableScoringStatistics) Get() *ScoringStatistics

func (NullableScoringStatistics) IsSet 

func (v NullableScoringStatistics) IsSet() bool

func (NullableScoringStatistics) MarshalJSON 

func (v NullableScoringStatistics) MarshalJSON() ([]byte, error)

func (*NullableScoringStatistics) Set 

func (v *NullableScoringStatistics) Set(val *ScoringStatistics)

func (*NullableScoringStatistics) UnmarshalJSON 

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

func (*NullableScoringStatistics) Unset 

func (v *NullableScoringStatistics) Unset()

type NullableSearchDocumentsResult 

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

func NewNullableSearchDocumentsResult 

func NewNullableSearchDocumentsResult(val *SearchDocumentsResult) *NullableSearchDocumentsResult

func (NullableSearchDocumentsResult) Get 

func (v NullableSearchDocumentsResult) Get() *SearchDocumentsResult

func (NullableSearchDocumentsResult) IsSet 

func (v NullableSearchDocumentsResult) IsSet() bool

func (NullableSearchDocumentsResult) MarshalJSON 

func (v NullableSearchDocumentsResult) MarshalJSON() ([]byte, error)

func (*NullableSearchDocumentsResult) Set 

func (v *NullableSearchDocumentsResult) Set(val *SearchDocumentsResult)

func (*NullableSearchDocumentsResult) UnmarshalJSON 

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

func (*NullableSearchDocumentsResult) Unset 

func (v *NullableSearchDocumentsResult) Unset()

type NullableSearchError 

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

func NewNullableSearchError 

func NewNullableSearchError(val *SearchError) *NullableSearchError

func (NullableSearchError) Get 

func (v NullableSearchError) Get() *SearchError

func (NullableSearchError) IsSet 

func (v NullableSearchError) IsSet() bool

func (NullableSearchError) MarshalJSON 

func (v NullableSearchError) MarshalJSON() ([]byte, error)

func (*NullableSearchError) Set 

func (v *NullableSearchError) Set(val *SearchError)

func (*NullableSearchError) UnmarshalJSON 

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

func (*NullableSearchError) Unset 

func (v *NullableSearchError) Unset()

type NullableSearchMode 

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

func NewNullableSearchMode 

func NewNullableSearchMode(val *SearchMode) *NullableSearchMode

func (NullableSearchMode) Get 

func (v NullableSearchMode) Get() *SearchMode

func (NullableSearchMode) IsSet 

func (v NullableSearchMode) IsSet() bool

func (NullableSearchMode) MarshalJSON 

func (v NullableSearchMode) MarshalJSON() ([]byte, error)

func (*NullableSearchMode) Set 

func (v *NullableSearchMode) Set(val *SearchMode)

func (*NullableSearchMode) UnmarshalJSON 

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

func (*NullableSearchMode) Unset 

func (v *NullableSearchMode) Unset()

type NullableSearchRequest 

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

func NewNullableSearchRequest 

func NewNullableSearchRequest(val *SearchRequest) *NullableSearchRequest

func (NullableSearchRequest) Get 

func (v NullableSearchRequest) Get() *SearchRequest

func (NullableSearchRequest) IsSet 

func (v NullableSearchRequest) IsSet() bool

func (NullableSearchRequest) MarshalJSON 

func (v NullableSearchRequest) MarshalJSON() ([]byte, error)

func (*NullableSearchRequest) Set 

func (v *NullableSearchRequest) Set(val *SearchRequest)

func (*NullableSearchRequest) UnmarshalJSON 

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

func (*NullableSearchRequest) Unset 

func (v *NullableSearchRequest) Unset()

type NullableSearchResult 

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

func NewNullableSearchResult 

func NewNullableSearchResult(val *SearchResult) *NullableSearchResult

func (NullableSearchResult) Get 

func (v NullableSearchResult) Get() *SearchResult

func (NullableSearchResult) IsSet 

func (v NullableSearchResult) IsSet() bool

func (NullableSearchResult) MarshalJSON 

func (v NullableSearchResult) MarshalJSON() ([]byte, error)

func (*NullableSearchResult) Set 

func (v *NullableSearchResult) Set(val *SearchResult)

func (*NullableSearchResult) UnmarshalJSON 

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

func (*NullableSearchResult) Unset 

func (v *NullableSearchResult) Unset()

type NullableSemanticDebugInfo 

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

func NewNullableSemanticDebugInfo 

func NewNullableSemanticDebugInfo(val *SemanticDebugInfo) *NullableSemanticDebugInfo

func (NullableSemanticDebugInfo) Get 

func (v NullableSemanticDebugInfo) Get() *SemanticDebugInfo

func (NullableSemanticDebugInfo) IsSet 

func (v NullableSemanticDebugInfo) IsSet() bool

func (NullableSemanticDebugInfo) MarshalJSON 

func (v NullableSemanticDebugInfo) MarshalJSON() ([]byte, error)

func (*NullableSemanticDebugInfo) Set 

func (v *NullableSemanticDebugInfo) Set(val *SemanticDebugInfo)

func (*NullableSemanticDebugInfo) UnmarshalJSON 

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

func (*NullableSemanticDebugInfo) Unset 

func (v *NullableSemanticDebugInfo) Unset()

type NullableSemanticErrorHandling 

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

func NewNullableSemanticErrorHandling 

func NewNullableSemanticErrorHandling(val *SemanticErrorHandling) *NullableSemanticErrorHandling

func (NullableSemanticErrorHandling) Get 

func (v NullableSemanticErrorHandling) Get() *SemanticErrorHandling

func (NullableSemanticErrorHandling) IsSet 

func (v NullableSemanticErrorHandling) IsSet() bool

func (NullableSemanticErrorHandling) MarshalJSON 

func (v NullableSemanticErrorHandling) MarshalJSON() ([]byte, error)

func (*NullableSemanticErrorHandling) Set 

func (v *NullableSemanticErrorHandling) Set(val *SemanticErrorHandling)

func (*NullableSemanticErrorHandling) UnmarshalJSON 

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

func (*NullableSemanticErrorHandling) Unset 

func (v *NullableSemanticErrorHandling) Unset()

type NullableSemanticPartialResponseReason 

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

func NewNullableSemanticPartialResponseReason 

func NewNullableSemanticPartialResponseReason(val *SemanticPartialResponseReason) *NullableSemanticPartialResponseReason

func (NullableSemanticPartialResponseReason) Get 

func (v NullableSemanticPartialResponseReason) Get() *SemanticPartialResponseReason

func (NullableSemanticPartialResponseReason) IsSet 

func (v NullableSemanticPartialResponseReason) IsSet() bool

func (NullableSemanticPartialResponseReason) MarshalJSON 

func (v NullableSemanticPartialResponseReason) MarshalJSON() ([]byte, error)

func (*NullableSemanticPartialResponseReason) Set 

func (v *NullableSemanticPartialResponseReason) Set(val *SemanticPartialResponseReason)

func (*NullableSemanticPartialResponseReason) UnmarshalJSON 

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

func (*NullableSemanticPartialResponseReason) Unset 

func (v *NullableSemanticPartialResponseReason) Unset()

type NullableSemanticPartialResponseType 

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

func NewNullableSemanticPartialResponseType 

func NewNullableSemanticPartialResponseType(val *SemanticPartialResponseType) *NullableSemanticPartialResponseType

func (NullableSemanticPartialResponseType) Get 

func (v NullableSemanticPartialResponseType) Get() *SemanticPartialResponseType

func (NullableSemanticPartialResponseType) IsSet 

func (v NullableSemanticPartialResponseType) IsSet() bool

func (NullableSemanticPartialResponseType) MarshalJSON 

func (v NullableSemanticPartialResponseType) MarshalJSON() ([]byte, error)

func (*NullableSemanticPartialResponseType) Set 

func (v *NullableSemanticPartialResponseType) Set(val *SemanticPartialResponseType)

func (*NullableSemanticPartialResponseType) UnmarshalJSON 

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

func (*NullableSemanticPartialResponseType) Unset 

func (v *NullableSemanticPartialResponseType) Unset()

type NullableSpeller 

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

func NewNullableSpeller 

func NewNullableSpeller(val *Speller) *NullableSpeller

func (NullableSpeller) Get 

func (v NullableSpeller) Get() *Speller

func (NullableSpeller) IsSet 

func (v NullableSpeller) IsSet() bool

func (NullableSpeller) MarshalJSON 

func (v NullableSpeller) MarshalJSON() ([]byte, error)

func (*NullableSpeller) Set 

func (v *NullableSpeller) Set(val *Speller)

func (*NullableSpeller) UnmarshalJSON 

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

func (*NullableSpeller) Unset 

func (v *NullableSpeller) Unset()

type NullableString 

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

func NewNullableString 

func NewNullableString(val *string) *NullableString

func (NullableString) Get 

func (v NullableString) Get() *string

func (NullableString) IsSet 

func (v NullableString) IsSet() bool

func (NullableString) MarshalJSON 

func (v NullableString) MarshalJSON() ([]byte, error)

func (*NullableString) Set 

func (v *NullableString) Set(val *string)

func (*NullableString) UnmarshalJSON 

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

func (*NullableString) Unset 

func (v *NullableString) Unset()

type NullableSuggestDocumentsResult 

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

func NewNullableSuggestDocumentsResult 

func NewNullableSuggestDocumentsResult(val *SuggestDocumentsResult) *NullableSuggestDocumentsResult

func (NullableSuggestDocumentsResult) Get 

func (v NullableSuggestDocumentsResult) Get() *SuggestDocumentsResult

func (NullableSuggestDocumentsResult) IsSet 

func (v NullableSuggestDocumentsResult) IsSet() bool

func (NullableSuggestDocumentsResult) MarshalJSON 

func (v NullableSuggestDocumentsResult) MarshalJSON() ([]byte, error)

func (*NullableSuggestDocumentsResult) Set 

func (v *NullableSuggestDocumentsResult) Set(val *SuggestDocumentsResult)

func (*NullableSuggestDocumentsResult) UnmarshalJSON 

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

func (*NullableSuggestDocumentsResult) Unset 

func (v *NullableSuggestDocumentsResult) Unset()

type NullableSuggestRequest 

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

func NewNullableSuggestRequest 

func NewNullableSuggestRequest(val *SuggestRequest) *NullableSuggestRequest

func (NullableSuggestRequest) Get 

func (v NullableSuggestRequest) Get() *SuggestRequest

func (NullableSuggestRequest) IsSet 

func (v NullableSuggestRequest) IsSet() bool

func (NullableSuggestRequest) MarshalJSON 

func (v NullableSuggestRequest) MarshalJSON() ([]byte, error)

func (*NullableSuggestRequest) Set 

func (v *NullableSuggestRequest) Set(val *SuggestRequest)

func (*NullableSuggestRequest) UnmarshalJSON 

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

func (*NullableSuggestRequest) Unset 

func (v *NullableSuggestRequest) Unset()

type NullableSuggestResult 

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

func NewNullableSuggestResult 

func NewNullableSuggestResult(val *SuggestResult) *NullableSuggestResult

func (NullableSuggestResult) Get 

func (v NullableSuggestResult) Get() *SuggestResult

func (NullableSuggestResult) IsSet 

func (v NullableSuggestResult) IsSet() bool

func (NullableSuggestResult) MarshalJSON 

func (v NullableSuggestResult) MarshalJSON() ([]byte, error)

func (*NullableSuggestResult) Set 

func (v *NullableSuggestResult) Set(val *SuggestResult)

func (*NullableSuggestResult) UnmarshalJSON 

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

func (*NullableSuggestResult) Unset 

func (v *NullableSuggestResult) Unset()

type NullableTime 

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

func NewNullableTime 

func NewNullableTime(val *time.Time) *NullableTime

func (NullableTime) Get 

func (v NullableTime) Get() *time.Time

func (NullableTime) IsSet 

func (v NullableTime) IsSet() bool

func (NullableTime) MarshalJSON 

func (v NullableTime) MarshalJSON() ([]byte, error)

func (*NullableTime) Set 

func (v *NullableTime) Set(val *time.Time)

func (*NullableTime) UnmarshalJSON 

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

func (*NullableTime) Unset 

func (v *NullableTime) Unset()

type NullableVector 

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

func NewNullableVector 

func NewNullableVector(val *Vector) *NullableVector

func (NullableVector) Get 

func (v NullableVector) Get() *Vector

func (NullableVector) IsSet 

func (v NullableVector) IsSet() bool

func (NullableVector) MarshalJSON 

func (v NullableVector) MarshalJSON() ([]byte, error)

func (*NullableVector) Set 

func (v *NullableVector) Set(val *Vector)

func (*NullableVector) UnmarshalJSON 

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

func (*NullableVector) Unset 

func (v *NullableVector) Unset()

type QueryDebugMode 

type QueryDebugMode string

QueryDebugMode Enables a debugging tool that can be used to further explore your search results. 

const (
	DISABLED QueryDebugMode = "disabled"
)

List of QueryDebugMode

func NewQueryDebugModeFromValue 

func NewQueryDebugModeFromValue(v string) (*QueryDebugMode, error)

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

func (QueryDebugMode) IsValid 

func (v QueryDebugMode) IsValid() bool

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

func (QueryDebugMode) Ptr 

func (v QueryDebugMode) Ptr() *QueryDebugMode

Ptr returns reference to QueryDebugMode value

func (*QueryDebugMode) UnmarshalJSON 

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

type QueryLanguage 

type QueryLanguage string

QueryLanguage The language of the query. 

const (
	// NONE QueryLanguage = "none"
	EN_US QueryLanguage = "en-us"
	EN_GB QueryLanguage = "en-gb"
	EN_IN QueryLanguage = "en-in"
	EN_CA QueryLanguage = "en-ca"
	EN_AU QueryLanguage = "en-au"
	FR_FR QueryLanguage = "fr-fr"
	FR_CA QueryLanguage = "fr-ca"
	DE_DE QueryLanguage = "de-de"
	ES_ES QueryLanguage = "es-es"
	ES_MX QueryLanguage = "es-mx"
	ZH_CN QueryLanguage = "zh-cn"
	ZH_TW QueryLanguage = "zh-tw"
	PT_BR QueryLanguage = "pt-br"
	PT_PT QueryLanguage = "pt-pt"
	IT_IT QueryLanguage = "it-it"
	JA_JP QueryLanguage = "ja-jp"
	KO_KR QueryLanguage = "ko-kr"
	RU_RU QueryLanguage = "ru-ru"
	CS_CZ QueryLanguage = "cs-cz"
	NL_BE QueryLanguage = "nl-be"
	NL_NL QueryLanguage = "nl-nl"
	HU_HU QueryLanguage = "hu-hu"
	PL_PL QueryLanguage = "pl-pl"
	SV_SE QueryLanguage = "sv-se"
	TR_TR QueryLanguage = "tr-tr"
	HI_IN QueryLanguage = "hi-in"
	AR_SA QueryLanguage = "ar-sa"
	AR_EG QueryLanguage = "ar-eg"
	AR_MA QueryLanguage = "ar-ma"
	AR_KW QueryLanguage = "ar-kw"
	AR_JO QueryLanguage = "ar-jo"
	DA_DK QueryLanguage = "da-dk"
	NO_NO QueryLanguage = "no-no"
	BG_BG QueryLanguage = "bg-bg"
	HR_HR QueryLanguage = "hr-hr"
	HR_BA QueryLanguage = "hr-ba"
	MS_MY QueryLanguage = "ms-my"
	MS_BN QueryLanguage = "ms-bn"
	SL_SL QueryLanguage = "sl-sl"
	TA_IN QueryLanguage = "ta-in"
	VI_VN QueryLanguage = "vi-vn"
	EL_GR QueryLanguage = "el-gr"
	RO_RO QueryLanguage = "ro-ro"
	IS_IS QueryLanguage = "is-is"
	ID_ID QueryLanguage = "id-id"
	TH_TH QueryLanguage = "th-th"
	LT_LT QueryLanguage = "lt-lt"
	UK_UA QueryLanguage = "uk-ua"
	LV_LV QueryLanguage = "lv-lv"
	ET_EE QueryLanguage = "et-ee"
	CA_ES QueryLanguage = "ca-es"
	FI_FI QueryLanguage = "fi-fi"
	SR_BA QueryLanguage = "sr-ba"
	SR_ME QueryLanguage = "sr-me"
	SR_RS QueryLanguage = "sr-rs"
	SK_SK QueryLanguage = "sk-sk"
	NB_NO QueryLanguage = "nb-no"
	HY_AM QueryLanguage = "hy-am"
	BN_IN QueryLanguage = "bn-in"
	EU_ES QueryLanguage = "eu-es"
	GL_ES QueryLanguage = "gl-es"
	GU_IN QueryLanguage = "gu-in"
	HE_IL QueryLanguage = "he-il"
	GA_IE QueryLanguage = "ga-ie"
	KN_IN QueryLanguage = "kn-in"
	ML_IN QueryLanguage = "ml-in"
	MR_IN QueryLanguage = "mr-in"
	FA_AE QueryLanguage = "fa-ae"
	PA_IN QueryLanguage = "pa-in"
	TE_IN QueryLanguage = "te-in"
	UR_PK QueryLanguage = "ur-pk"
)

List of QueryLanguage

func NewQueryLanguageFromValue 

func NewQueryLanguageFromValue(v string) (*QueryLanguage, error)

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

func (QueryLanguage) IsValid 

func (v QueryLanguage) IsValid() bool

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

func (QueryLanguage) Ptr 

func (v QueryLanguage) Ptr() *QueryLanguage

Ptr returns reference to QueryLanguage value

func (*QueryLanguage) UnmarshalJSON 

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

type QueryResultDocumentRerankerInput 

type QueryResultDocumentRerankerInput struct {
	// The raw string for the title field that was used for semantic enrichment.
	Title *string `json:"title,omitempty"`
	// The raw concatenated strings for the content fields that were used for semantic enrichment.
	Content *string `json:"content,omitempty"`
	// The raw concatenated strings for the keyword fields that were used for semantic enrichment.
	Keywords *string `json:"keywords,omitempty"`
}

QueryResultDocumentRerankerInput The raw concatenated strings that were sent to the semantic enrichment process.

func NewQueryResultDocumentRerankerInput 

func NewQueryResultDocumentRerankerInput() *QueryResultDocumentRerankerInput

NewQueryResultDocumentRerankerInput instantiates a new QueryResultDocumentRerankerInput 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 NewQueryResultDocumentRerankerInputWithDefaults 

func NewQueryResultDocumentRerankerInputWithDefaults() *QueryResultDocumentRerankerInput

NewQueryResultDocumentRerankerInputWithDefaults instantiates a new QueryResultDocumentRerankerInput object This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set

func (*QueryResultDocumentRerankerInput) GetContent 

func (o *QueryResultDocumentRerankerInput) GetContent() string

GetContent returns the Content field value if set, zero value otherwise.

func (*QueryResultDocumentRerankerInput) GetContentOk 

func (o *QueryResultDocumentRerankerInput) GetContentOk() (*string, bool)

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

func (*QueryResultDocumentRerankerInput) GetKeywords 

func (o *QueryResultDocumentRerankerInput) GetKeywords() string

GetKeywords returns the Keywords field value if set, zero value otherwise.

func (*QueryResultDocumentRerankerInput) GetKeywordsOk 

func (o *QueryResultDocumentRerankerInput) GetKeywordsOk() (*string, bool)

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

func (*QueryResultDocumentRerankerInput) GetTitle 

func (o *QueryResultDocumentRerankerInput) GetTitle() string

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

func (*QueryResultDocumentRerankerInput) GetTitleOk 

func (o *QueryResultDocumentRerankerInput) 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 (*QueryResultDocumentRerankerInput) HasContent 

func (o *QueryResultDocumentRerankerInput) HasContent() bool

HasContent returns a boolean if a field has been set.

func (*QueryResultDocumentRerankerInput) HasKeywords 

func (o *QueryResultDocumentRerankerInput) HasKeywords() bool

HasKeywords returns a boolean if a field has been set.

func (*QueryResultDocumentRerankerInput) HasTitle 

func (o *QueryResultDocumentRerankerInput) HasTitle() bool

HasTitle returns a boolean if a field has been set.

func (QueryResultDocumentRerankerInput) MarshalJSON 

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

func (*QueryResultDocumentRerankerInput) SetContent 

func (o *QueryResultDocumentRerankerInput) SetContent(v string)

SetContent gets a reference to the given string and assigns it to the Content field.

func (*QueryResultDocumentRerankerInput) SetKeywords 

func (o *QueryResultDocumentRerankerInput) SetKeywords(v string)

SetKeywords gets a reference to the given string and assigns it to the Keywords field.

func (*QueryResultDocumentRerankerInput) SetTitle 

func (o *QueryResultDocumentRerankerInput) SetTitle(v string)

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

func (QueryResultDocumentRerankerInput) ToMap 

func (o QueryResultDocumentRerankerInput) ToMap() (map[string]interface{}, error)

type QueryResultDocumentSemanticField 

type QueryResultDocumentSemanticField struct {
	// The name of the field that was sent to the semantic enrichment process
	Name  *string                                `json:"name,omitempty"`
	State *QueryResultDocumentSemanticFieldState `json:"state,omitempty"`
}

QueryResultDocumentSemanticField Description of fields that were sent to the semantic enrichment process, as well as how they were used

func NewQueryResultDocumentSemanticField 

func NewQueryResultDocumentSemanticField() *QueryResultDocumentSemanticField

NewQueryResultDocumentSemanticField instantiates a new QueryResultDocumentSemanticField 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 NewQueryResultDocumentSemanticFieldWithDefaults 

func NewQueryResultDocumentSemanticFieldWithDefaults() *QueryResultDocumentSemanticField

NewQueryResultDocumentSemanticFieldWithDefaults instantiates a new QueryResultDocumentSemanticField object This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set

func (*QueryResultDocumentSemanticField) GetName 

func (o *QueryResultDocumentSemanticField) GetName() string

GetName returns the Name field value if set, zero value otherwise.

func (*QueryResultDocumentSemanticField) GetNameOk 

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

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

func (*QueryResultDocumentSemanticField) GetState 

func (o *QueryResultDocumentSemanticField) GetState() QueryResultDocumentSemanticFieldState

GetState returns the State field value if set, zero value otherwise.

func (*QueryResultDocumentSemanticField) GetStateOk 

func (o *QueryResultDocumentSemanticField) GetStateOk() (*QueryResultDocumentSemanticFieldState, bool)

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

func (*QueryResultDocumentSemanticField) HasName 

func (o *QueryResultDocumentSemanticField) HasName() bool

HasName returns a boolean if a field has been set.

func (*QueryResultDocumentSemanticField) HasState 

func (o *QueryResultDocumentSemanticField) HasState() bool

HasState returns a boolean if a field has been set.

func (QueryResultDocumentSemanticField) MarshalJSON 

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

func (*QueryResultDocumentSemanticField) SetName 

func (o *QueryResultDocumentSemanticField) SetName(v string)

SetName gets a reference to the given string and assigns it to the Name field.

func (*QueryResultDocumentSemanticField) SetState 

func (o *QueryResultDocumentSemanticField) SetState(v QueryResultDocumentSemanticFieldState)

SetState gets a reference to the given QueryResultDocumentSemanticFieldState and assigns it to the State field.

func (QueryResultDocumentSemanticField) ToMap 

func (o QueryResultDocumentSemanticField) ToMap() (map[string]interface{}, error)

type QueryResultDocumentSemanticFieldState 

type QueryResultDocumentSemanticFieldState string

QueryResultDocumentSemanticFieldState The way the field was used for the semantic enrichment process. 

const (
	USED    QueryResultDocumentSemanticFieldState = "used"
	UNUSED  QueryResultDocumentSemanticFieldState = "unused"
	PARTIAL QueryResultDocumentSemanticFieldState = "partial"
)

List of QueryResultDocumentSemanticFieldState

func NewQueryResultDocumentSemanticFieldStateFromValue 

func NewQueryResultDocumentSemanticFieldStateFromValue(v string) (*QueryResultDocumentSemanticFieldState, error)

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

func (QueryResultDocumentSemanticFieldState) IsValid 

func (v QueryResultDocumentSemanticFieldState) IsValid() bool

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

func (QueryResultDocumentSemanticFieldState) Ptr 

func (v QueryResultDocumentSemanticFieldState) Ptr() *QueryResultDocumentSemanticFieldState

Ptr returns reference to QueryResultDocumentSemanticFieldState value

func (*QueryResultDocumentSemanticFieldState) UnmarshalJSON 

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

type QueryType 

type QueryType string

QueryType Specifies the syntax of the search query. The default is 'simple'. Use 'full' if your query uses the Lucene query syntax and 'semantic' if query syntax is not needed. 

const (
	SIMPLE   QueryType = "simple"
	FULL     QueryType = "full"
	SEMANTIC QueryType = "semantic"
)

List of QueryType

func NewQueryTypeFromValue 

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 

func (v QueryType) IsValid() bool

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

func (QueryType) Ptr 

func (v QueryType) Ptr() *QueryType

Ptr returns reference to QueryType value

func (*QueryType) UnmarshalJSON 

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

type ScoringStatistics 

type ScoringStatistics string

ScoringStatistics A value that specifies whether we want to calculate scoring statistics (such as document frequency) globally for more consistent scoring, or locally, for lower latency. The default is 'local'. Use 'global' to aggregate scoring statistics globally before scoring. Using global scoring statistics can increase latency of search queries. 

const (
	LOCAL  ScoringStatistics = "local"
	GLOBAL ScoringStatistics = "global"
)

List of ScoringStatistics

func NewScoringStatisticsFromValue 

func NewScoringStatisticsFromValue(v string) (*ScoringStatistics, error)

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

func (ScoringStatistics) IsValid 

func (v ScoringStatistics) IsValid() bool

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

func (ScoringStatistics) Ptr 

func (v ScoringStatistics) Ptr() *ScoringStatistics

Ptr returns reference to ScoringStatistics value

func (*ScoringStatistics) UnmarshalJSON 

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

type SearchDocumentsResult 

type SearchDocumentsResult struct {
	// The total count of results found by the search operation, or null if the count was not requested. If present, the count may be greater than the number of results in this response. This can happen if you use the $top or $skip parameters, or if Azure Cognitive Search can't return all the requested documents in a single Search response.
	OdataCount *int64 `json:"@odata.count,omitempty"`
	// A value indicating the percentage of the index that was included in the query, or null if minimumCoverage was not specified in the request.
	SearchCoverage *float64 `json:"@search.coverage,omitempty"`
	// The facet query results for the search operation, organized as a collection of buckets for each faceted field; null if the query did not include any facet expressions.
	SearchFacets *map[string][]FacetResult `json:"@search.facets,omitempty"`
	// The answers query results for the search operation; null if the answers query parameter was not specified or set to 'none'.
	SearchAnswers                       []AnswerResult                 `json:"@search.answers,omitempty"`
	SearchNextPageParameters            *SearchRequest                 `json:"@search.nextPageParameters,omitempty"`
	SearchSemanticPartialResponseReason *SemanticPartialResponseReason `json:"@search.semanticPartialResponseReason,omitempty"`
	SearchSemanticPartialResponseType   *SemanticPartialResponseType   `json:"@search.semanticPartialResponseType,omitempty"`
	// The sequence of results returned by the query.
	Value []SearchResult `json:"value"`
	// Continuation URL returned when Azure Cognitive Search can't return all the requested results in a single Search response. You can use this URL to formulate another GET or POST Search request to get the next part of the search response. Make sure to use the same verb (GET or POST) as the request that produced this response.
	OdataNextLink *string `json:"@odata.nextLink,omitempty"`
}

SearchDocumentsResult Response containing search results from an index.

func NewSearchDocumentsResult 

func NewSearchDocumentsResult(value []SearchResult) *SearchDocumentsResult

NewSearchDocumentsResult instantiates a new SearchDocumentsResult 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 NewSearchDocumentsResultWithDefaults 

func NewSearchDocumentsResultWithDefaults() *SearchDocumentsResult

NewSearchDocumentsResultWithDefaults instantiates a new SearchDocumentsResult object This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set

func (*SearchDocumentsResult) GetOdataCount 

func (o *SearchDocumentsResult) GetOdataCount() int64

GetOdataCount returns the OdataCount field value if set, zero value otherwise.

func (*SearchDocumentsResult) GetOdataCountOk 

func (o *SearchDocumentsResult) GetOdataCountOk() (*int64, bool)

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

func (o *SearchDocumentsResult) GetOdataNextLink() string

GetOdataNextLink returns the OdataNextLink field value if set, zero value otherwise.

func (*SearchDocumentsResult) GetOdataNextLinkOk 

func (o *SearchDocumentsResult) GetOdataNextLinkOk() (*string, bool)

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

func (*SearchDocumentsResult) GetSearchAnswers 

func (o *SearchDocumentsResult) GetSearchAnswers() []AnswerResult

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

func (*SearchDocumentsResult) GetSearchAnswersOk 

func (o *SearchDocumentsResult) GetSearchAnswersOk() ([]AnswerResult, bool)

GetSearchAnswersOk returns a tuple with the SearchAnswers 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 (*SearchDocumentsResult) GetSearchCoverage 

func (o *SearchDocumentsResult) GetSearchCoverage() float64

GetSearchCoverage returns the SearchCoverage field value if set, zero value otherwise.

func (*SearchDocumentsResult) GetSearchCoverageOk 

func (o *SearchDocumentsResult) GetSearchCoverageOk() (*float64, bool)

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

func (*SearchDocumentsResult) GetSearchFacets 

func (o *SearchDocumentsResult) GetSearchFacets() map[string][]FacetResult

GetSearchFacets returns the SearchFacets field value if set, zero value otherwise.

func (*SearchDocumentsResult) GetSearchFacetsOk 

func (o *SearchDocumentsResult) GetSearchFacetsOk() (*map[string][]FacetResult, bool)

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

func (*SearchDocumentsResult) GetSearchNextPageParameters 

func (o *SearchDocumentsResult) GetSearchNextPageParameters() SearchRequest

GetSearchNextPageParameters returns the SearchNextPageParameters field value if set, zero value otherwise.

func (*SearchDocumentsResult) GetSearchNextPageParametersOk 

func (o *SearchDocumentsResult) GetSearchNextPageParametersOk() (*SearchRequest, bool)

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

func (*SearchDocumentsResult) GetSearchSemanticPartialResponseReason 

func (o *SearchDocumentsResult) GetSearchSemanticPartialResponseReason() SemanticPartialResponseReason

GetSearchSemanticPartialResponseReason returns the SearchSemanticPartialResponseReason field value if set, zero value otherwise.

func (*SearchDocumentsResult) GetSearchSemanticPartialResponseReasonOk 

func (o *SearchDocumentsResult) GetSearchSemanticPartialResponseReasonOk() (*SemanticPartialResponseReason, bool)

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

func (*SearchDocumentsResult) GetSearchSemanticPartialResponseType 

func (o *SearchDocumentsResult) GetSearchSemanticPartialResponseType() SemanticPartialResponseType

GetSearchSemanticPartialResponseType returns the SearchSemanticPartialResponseType field value if set, zero value otherwise.

func (*SearchDocumentsResult) GetSearchSemanticPartialResponseTypeOk 

func (o *SearchDocumentsResult) GetSearchSemanticPartialResponseTypeOk() (*SemanticPartialResponseType, bool)

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

func (*SearchDocumentsResult) GetValue 

func (o *SearchDocumentsResult) GetValue() []SearchResult

GetValue returns the Value field value

func (*SearchDocumentsResult) GetValueOk 

func (o *SearchDocumentsResult) GetValueOk() ([]SearchResult, bool)

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

func (*SearchDocumentsResult) HasOdataCount 

func (o *SearchDocumentsResult) HasOdataCount() bool

HasOdataCount returns a boolean if a field has been set. 

func (o *SearchDocumentsResult) HasOdataNextLink() bool

HasOdataNextLink returns a boolean if a field has been set.

func (*SearchDocumentsResult) HasSearchAnswers 

func (o *SearchDocumentsResult) HasSearchAnswers() bool

HasSearchAnswers returns a boolean if a field has been set.

func (*SearchDocumentsResult) HasSearchCoverage 

func (o *SearchDocumentsResult) HasSearchCoverage() bool

HasSearchCoverage returns a boolean if a field has been set.

func (*SearchDocumentsResult) HasSearchFacets 

func (o *SearchDocumentsResult) HasSearchFacets() bool

HasSearchFacets returns a boolean if a field has been set.

func (*SearchDocumentsResult) HasSearchNextPageParameters 

func (o *SearchDocumentsResult) HasSearchNextPageParameters() bool

HasSearchNextPageParameters returns a boolean if a field has been set.

func (*SearchDocumentsResult) HasSearchSemanticPartialResponseReason 

func (o *SearchDocumentsResult) HasSearchSemanticPartialResponseReason() bool

HasSearchSemanticPartialResponseReason returns a boolean if a field has been set.

func (*SearchDocumentsResult) HasSearchSemanticPartialResponseType 

func (o *SearchDocumentsResult) HasSearchSemanticPartialResponseType() bool

HasSearchSemanticPartialResponseType returns a boolean if a field has been set.

func (SearchDocumentsResult) MarshalJSON 

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

func (*SearchDocumentsResult) SetOdataCount 

func (o *SearchDocumentsResult) SetOdataCount(v int64)

SetOdataCount gets a reference to the given int64 and assigns it to the OdataCount field. 

func (o *SearchDocumentsResult) SetOdataNextLink(v string)

SetOdataNextLink gets a reference to the given string and assigns it to the OdataNextLink field.

func (*SearchDocumentsResult) SetSearchAnswers 

func (o *SearchDocumentsResult) SetSearchAnswers(v []AnswerResult)

SetSearchAnswers gets a reference to the given []AnswerResult and assigns it to the SearchAnswers field.

func (*SearchDocumentsResult) SetSearchCoverage 

func (o *SearchDocumentsResult) SetSearchCoverage(v float64)

SetSearchCoverage gets a reference to the given float64 and assigns it to the SearchCoverage field.

func (*SearchDocumentsResult) SetSearchFacets 

func (o *SearchDocumentsResult) SetSearchFacets(v map[string][]FacetResult)

SetSearchFacets gets a reference to the given map[string][]FacetResult and assigns it to the SearchFacets field.

func (*SearchDocumentsResult) SetSearchNextPageParameters 

func (o *SearchDocumentsResult) SetSearchNextPageParameters(v SearchRequest)

SetSearchNextPageParameters gets a reference to the given SearchRequest and assigns it to the SearchNextPageParameters field.

func (*SearchDocumentsResult) SetSearchSemanticPartialResponseReason 

func (o *SearchDocumentsResult) SetSearchSemanticPartialResponseReason(v SemanticPartialResponseReason)

SetSearchSemanticPartialResponseReason gets a reference to the given SemanticPartialResponseReason and assigns it to the SearchSemanticPartialResponseReason field.

func (*SearchDocumentsResult) SetSearchSemanticPartialResponseType 

func (o *SearchDocumentsResult) SetSearchSemanticPartialResponseType(v SemanticPartialResponseType)

SetSearchSemanticPartialResponseType gets a reference to the given SemanticPartialResponseType and assigns it to the SearchSemanticPartialResponseType field.

func (*SearchDocumentsResult) SetValue 

func (o *SearchDocumentsResult) SetValue(v []SearchResult)

SetValue sets field value

func (SearchDocumentsResult) ToMap 

func (o SearchDocumentsResult) ToMap() (map[string]interface{}, error)

type SearchError 

type SearchError struct {
	// One of a server-defined set of error codes.
	Code *string `json:"code,omitempty"`
	// A human-readable representation of the error.
	Message string `json:"message"`
	// An array of details about specific errors that led to this reported error.
	Details []SearchError `json:"details,omitempty"`
}

SearchError Describes an error condition for the Azure Cognitive Search API.

func NewSearchError 

func NewSearchError(message string) *SearchError

NewSearchError instantiates a new SearchError 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 NewSearchErrorWithDefaults 

func NewSearchErrorWithDefaults() *SearchError

NewSearchErrorWithDefaults instantiates a new SearchError object This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set

func (*SearchError) GetCode 

func (o *SearchError) GetCode() string

GetCode returns the Code field value if set, zero value otherwise.

func (*SearchError) GetCodeOk 

func (o *SearchError) GetCodeOk() (*string, bool)

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

func (*SearchError) GetDetails 

func (o *SearchError) GetDetails() []SearchError

GetDetails returns the Details field value if set, zero value otherwise.

func (*SearchError) GetDetailsOk 

func (o *SearchError) GetDetailsOk() ([]SearchError, bool)

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

func (*SearchError) GetMessage 

func (o *SearchError) GetMessage() string

GetMessage returns the Message field value

func (*SearchError) GetMessageOk 

func (o *SearchError) GetMessageOk() (*string, bool)

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

func (*SearchError) HasCode 

func (o *SearchError) HasCode() bool

HasCode returns a boolean if a field has been set.

func (*SearchError) HasDetails 

func (o *SearchError) HasDetails() bool

HasDetails returns a boolean if a field has been set.

func (SearchError) MarshalJSON 

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

func (*SearchError) SetCode 

func (o *SearchError) SetCode(v string)

SetCode gets a reference to the given string and assigns it to the Code field.

func (*SearchError) SetDetails 

func (o *SearchError) SetDetails(v []SearchError)

SetDetails gets a reference to the given []SearchError and assigns it to the Details field.

func (*SearchError) SetMessage 

func (o *SearchError) SetMessage(v string)

SetMessage sets field value

func (SearchError) ToMap 

func (o SearchError) ToMap() (map[string]interface{}, error)

type SearchMode 

type SearchMode string

SearchMode Specifies whether any or all of the search terms must be matched in order to count the document as a match. 

const (
	ANY SearchMode = "any"
	ALL SearchMode = "all"
)

List of SearchMode

func NewSearchModeFromValue 

func NewSearchModeFromValue(v string) (*SearchMode, error)

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

func (SearchMode) IsValid 

func (v SearchMode) IsValid() bool

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

func (SearchMode) Ptr 

func (v SearchMode) Ptr() *SearchMode

Ptr returns reference to SearchMode value

func (*SearchMode) UnmarshalJSON 

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

type SearchRequest 

type SearchRequest struct {
	// A value that specifies whether to fetch the total count of results. Default is false. Setting this value to true may have a performance impact. Note that the count returned is an approximation.
	Count *bool `json:"count,omitempty"`
	// The list of facet expressions to apply to the search query. Each facet expression contains a field name, optionally followed by a comma-separated list of name:value pairs.
	Facets []string `json:"facets,omitempty"`
	// The OData $filter expression to apply to the search query.
	Filter *string `json:"filter,omitempty"`
	// The comma-separated list of field names to use for hit highlights. Only searchable fields can be used for hit highlighting.
	Highlight *string `json:"highlight,omitempty"`
	// A string tag that is appended to hit highlights. Must be set with highlightPreTag. Default is &lt;/em&gt;.
	HighlightPostTag *string `json:"highlightPostTag,omitempty"`
	// A string tag that is prepended to hit highlights. Must be set with highlightPostTag. Default is &lt;em&gt;.
	HighlightPreTag *string `json:"highlightPreTag,omitempty"`
	// A number between 0 and 100 indicating the percentage of the index that must be covered by a search query in order for the query to be reported as a success. This parameter can be useful for ensuring search availability even for services with only one replica. The default is 100.
	MinimumCoverage *float64 `json:"minimumCoverage,omitempty"`
	// The comma-separated list of OData $orderby expressions by which to sort the results. Each expression can be either a field name or a call to either the geo.distance() or the search.score() functions. Each expression can be followed by asc to indicate ascending, or desc to indicate descending. The default is ascending order. Ties will be broken by the match scores of documents. If no $orderby is specified, the default sort order is descending by document match score. There can be at most 32 $orderby clauses.
	Orderby           *string            `json:"orderby,omitempty"`
	QueryType         *QueryType         `json:"queryType,omitempty"`
	ScoringStatistics *ScoringStatistics `json:"scoringStatistics,omitempty"`
	// A value to be used to create a sticky session, which can help getting more consistent results. As long as the same sessionId is used, a best-effort attempt will be made to target the same replica set. Be wary that reusing the same sessionID values repeatedly can interfere with the load balancing of the requests across replicas and adversely affect the performance of the search service. The value used as sessionId cannot start with a '_' character.
	SessionId *string `json:"sessionId,omitempty"`
	// The list of parameter values to be used in scoring functions (for example, referencePointParameter) using the format name-values. For example, if the scoring profile defines a function with a parameter called 'mylocation' the parameter string would be \"mylocation--122.2,44.8\" (without the quotes).
	ScoringParameters []string `json:"scoringParameters,omitempty"`
	// The name of a scoring profile to evaluate match scores for matching documents in order to sort the results.
	ScoringProfile *string `json:"scoringProfile,omitempty"`
	// The name of a semantic configuration that will be used when processing documents for queries of type semantic.
	SemanticConfiguration *string                `json:"semanticConfiguration,omitempty"`
	SemanticErrorHandling *SemanticErrorHandling `json:"semanticErrorHandling,omitempty"`
	// Allows the user to set an upper bound on the amount of time it takes for semantic enrichment to finish processing before the request fails.
	SemanticMaxWaitInMilliseconds NullableInt32   `json:"semanticMaxWaitInMilliseconds,omitempty"`
	Debug                         *QueryDebugMode `json:"debug,omitempty"`
	// A full-text search query expression; Use \"*\" or omit this parameter to match all documents.
	Search *string `json:"search,omitempty"`
	// The comma-separated list of field names to which to scope the full-text search. When using fielded search (fieldName:searchExpression) in a full Lucene query, the field names of each fielded search expression take precedence over any field names listed in this parameter.
	SearchFields  *string        `json:"searchFields,omitempty"`
	SearchMode    *SearchMode    `json:"searchMode,omitempty"`
	QueryLanguage *QueryLanguage `json:"queryLanguage,omitempty"`
	Speller       *Speller       `json:"speller,omitempty"`
	Answers       *Answers       `json:"answers,omitempty"`
	// The comma-separated list of fields to retrieve. If unspecified, all fields marked as retrievable in the schema are included.
	Select *string `json:"select,omitempty"`
	// The number of search results to skip. This value cannot be greater than 100,000. If you need to scan documents in sequence, but cannot use skip due to this limitation, consider using orderby on a totally-ordered key and filter with a range query instead.
	Skip *int32 `json:"skip,omitempty"`
	// The number of search results to retrieve. This can be used in conjunction with $skip to implement client-side paging of search results. If results are truncated due to server-side paging, the response will include a continuation token that can be used to issue another Search request for the next page of results.
	Top      *int32    `json:"top,omitempty"`
	Captions *Captions `json:"captions,omitempty"`
	// The comma-separated list of field names used for semantic search.
	SemanticFields *string `json:"semanticFields,omitempty"`
	Vector         *Vector `json:"vector,omitempty"`
}

SearchRequest Parameters for filtering, sorting, faceting, paging, and other search query behaviors.

func NewSearchRequest 

func NewSearchRequest() *SearchRequest

NewSearchRequest instantiates a new SearchRequest 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 NewSearchRequestWithDefaults 

func NewSearchRequestWithDefaults() *SearchRequest

NewSearchRequestWithDefaults instantiates a new SearchRequest object This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set

func (*SearchRequest) GetAnswers 

func (o *SearchRequest) GetAnswers() Answers

GetAnswers returns the Answers field value if set, zero value otherwise.

func (*SearchRequest) GetAnswersOk 

func (o *SearchRequest) GetAnswersOk() (*Answers, bool)

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

func (*SearchRequest) GetCaptions 

func (o *SearchRequest) GetCaptions() Captions

GetCaptions returns the Captions field value if set, zero value otherwise.

func (*SearchRequest) GetCaptionsOk 

func (o *SearchRequest) GetCaptionsOk() (*Captions, bool)

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

func (*SearchRequest) GetCount 

func (o *SearchRequest) GetCount() bool

GetCount returns the Count field value if set, zero value otherwise.

func (*SearchRequest) GetCountOk 

func (o *SearchRequest) GetCountOk() (*bool, bool)

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

func (*SearchRequest) GetDebug 

func (o *SearchRequest) GetDebug() QueryDebugMode

GetDebug returns the Debug field value if set, zero value otherwise.

func (*SearchRequest) GetDebugOk 

func (o *SearchRequest) GetDebugOk() (*QueryDebugMode, bool)

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

func (*SearchRequest) GetFacets 

func (o *SearchRequest) GetFacets() []string

GetFacets returns the Facets field value if set, zero value otherwise.

func (*SearchRequest) GetFacetsOk 

func (o *SearchRequest) 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 (*SearchRequest) GetFilter 

func (o *SearchRequest) GetFilter() string

GetFilter returns the Filter field value if set, zero value otherwise.

func (*SearchRequest) GetFilterOk 

func (o *SearchRequest) GetFilterOk() (*string, bool)

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

func (*SearchRequest) GetHighlight 

func (o *SearchRequest) GetHighlight() string

GetHighlight returns the Highlight field value if set, zero value otherwise.

func (*SearchRequest) GetHighlightOk 

func (o *SearchRequest) GetHighlightOk() (*string, bool)

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

func (*SearchRequest) GetHighlightPostTag 

func (o *SearchRequest) GetHighlightPostTag() string

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

func (*SearchRequest) GetHighlightPostTagOk 

func (o *SearchRequest) 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 (*SearchRequest) GetHighlightPreTag 

func (o *SearchRequest) GetHighlightPreTag() string

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

func (*SearchRequest) GetHighlightPreTagOk 

func (o *SearchRequest) 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 (*SearchRequest) GetMinimumCoverage 

func (o *SearchRequest) GetMinimumCoverage() float64

GetMinimumCoverage returns the MinimumCoverage field value if set, zero value otherwise.

func (*SearchRequest) GetMinimumCoverageOk 

func (o *SearchRequest) GetMinimumCoverageOk() (*float64, bool)

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

func (*SearchRequest) GetOrderby 

func (o *SearchRequest) GetOrderby() string

GetOrderby returns the Orderby field value if set, zero value otherwise.

func (*SearchRequest) GetOrderbyOk 

func (o *SearchRequest) GetOrderbyOk() (*string, bool)

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

func (*SearchRequest) GetQueryLanguage 

func (o *SearchRequest) GetQueryLanguage() QueryLanguage

GetQueryLanguage returns the QueryLanguage field value if set, zero value otherwise.

func (*SearchRequest) GetQueryLanguageOk 

func (o *SearchRequest) GetQueryLanguageOk() (*QueryLanguage, bool)

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

func (*SearchRequest) GetQueryType 

func (o *SearchRequest) GetQueryType() QueryType

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

func (*SearchRequest) GetQueryTypeOk 

func (o *SearchRequest) 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 (*SearchRequest) GetScoringParameters 

func (o *SearchRequest) GetScoringParameters() []string

GetScoringParameters returns the ScoringParameters field value if set, zero value otherwise.

func (*SearchRequest) GetScoringParametersOk 

func (o *SearchRequest) GetScoringParametersOk() ([]string, bool)

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

func (*SearchRequest) GetScoringProfile 

func (o *SearchRequest) GetScoringProfile() string

GetScoringProfile returns the ScoringProfile field value if set, zero value otherwise.

func (*SearchRequest) GetScoringProfileOk 

func (o *SearchRequest) GetScoringProfileOk() (*string, bool)

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

func (*SearchRequest) GetScoringStatistics 

func (o *SearchRequest) GetScoringStatistics() ScoringStatistics

GetScoringStatistics returns the ScoringStatistics field value if set, zero value otherwise.

func (*SearchRequest) GetScoringStatisticsOk 

func (o *SearchRequest) GetScoringStatisticsOk() (*ScoringStatistics, bool)

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

func (*SearchRequest) GetSearch 

func (o *SearchRequest) GetSearch() string

GetSearch returns the Search field value if set, zero value otherwise.

func (*SearchRequest) GetSearchFields 

func (o *SearchRequest) GetSearchFields() string

GetSearchFields returns the SearchFields field value if set, zero value otherwise.

func (*SearchRequest) GetSearchFieldsOk 

func (o *SearchRequest) GetSearchFieldsOk() (*string, bool)

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

func (*SearchRequest) GetSearchMode 

func (o *SearchRequest) GetSearchMode() SearchMode

GetSearchMode returns the SearchMode field value if set, zero value otherwise.

func (*SearchRequest) GetSearchModeOk 

func (o *SearchRequest) GetSearchModeOk() (*SearchMode, bool)

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

func (*SearchRequest) GetSearchOk 

func (o *SearchRequest) GetSearchOk() (*string, bool)

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

func (*SearchRequest) GetSelect 

func (o *SearchRequest) GetSelect() string

GetSelect returns the Select field value if set, zero value otherwise.

func (*SearchRequest) GetSelectOk 

func (o *SearchRequest) GetSelectOk() (*string, bool)

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

func (*SearchRequest) GetSemanticConfiguration 

func (o *SearchRequest) GetSemanticConfiguration() string

GetSemanticConfiguration returns the SemanticConfiguration field value if set, zero value otherwise.

func (*SearchRequest) GetSemanticConfigurationOk 

func (o *SearchRequest) GetSemanticConfigurationOk() (*string, bool)

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

func (*SearchRequest) GetSemanticErrorHandling 

func (o *SearchRequest) GetSemanticErrorHandling() SemanticErrorHandling

GetSemanticErrorHandling returns the SemanticErrorHandling field value if set, zero value otherwise.

func (*SearchRequest) GetSemanticErrorHandlingOk 

func (o *SearchRequest) GetSemanticErrorHandlingOk() (*SemanticErrorHandling, bool)

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

func (*SearchRequest) GetSemanticFields 

func (o *SearchRequest) GetSemanticFields() string

GetSemanticFields returns the SemanticFields field value if set, zero value otherwise.

func (*SearchRequest) GetSemanticFieldsOk 

func (o *SearchRequest) GetSemanticFieldsOk() (*string, bool)

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

func (*SearchRequest) GetSemanticMaxWaitInMilliseconds 

func (o *SearchRequest) GetSemanticMaxWaitInMilliseconds() int32

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

func (*SearchRequest) GetSemanticMaxWaitInMillisecondsOk 

func (o *SearchRequest) GetSemanticMaxWaitInMillisecondsOk() (*int32, bool)

GetSemanticMaxWaitInMillisecondsOk returns a tuple with the SemanticMaxWaitInMilliseconds 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 (*SearchRequest) GetSessionId 

func (o *SearchRequest) GetSessionId() string

GetSessionId returns the SessionId field value if set, zero value otherwise.

func (*SearchRequest) GetSessionIdOk 

func (o *SearchRequest) GetSessionIdOk() (*string, bool)

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

func (*SearchRequest) GetSkip 

func (o *SearchRequest) GetSkip() int32

GetSkip returns the Skip field value if set, zero value otherwise.

func (*SearchRequest) GetSkipOk 

func (o *SearchRequest) GetSkipOk() (*int32, bool)

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

func (*SearchRequest) GetSpeller 

func (o *SearchRequest) GetSpeller() Speller

GetSpeller returns the Speller field value if set, zero value otherwise.

func (*SearchRequest) GetSpellerOk 

func (o *SearchRequest) GetSpellerOk() (*Speller, bool)

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

func (*SearchRequest) GetTop 

func (o *SearchRequest) GetTop() int32

GetTop returns the Top field value if set, zero value otherwise.

func (*SearchRequest) GetTopOk 

func (o *SearchRequest) GetTopOk() (*int32, bool)

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

func (*SearchRequest) GetVector 

func (o *SearchRequest) GetVector() Vector

GetVector returns the Vector field value if set, zero value otherwise.

func (*SearchRequest) GetVectorOk 

func (o *SearchRequest) GetVectorOk() (*Vector, bool)

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

func (*SearchRequest) HasAnswers 

func (o *SearchRequest) HasAnswers() bool

HasAnswers returns a boolean if a field has been set.

func (*SearchRequest) HasCaptions 

func (o *SearchRequest) HasCaptions() bool

HasCaptions returns a boolean if a field has been set.

func (*SearchRequest) HasCount 

func (o *SearchRequest) HasCount() bool

HasCount returns a boolean if a field has been set.

func (*SearchRequest) HasDebug 

func (o *SearchRequest) HasDebug() bool

HasDebug returns a boolean if a field has been set.

func (*SearchRequest) HasFacets 

func (o *SearchRequest) HasFacets() bool

HasFacets returns a boolean if a field has been set.

func (*SearchRequest) HasFilter 

func (o *SearchRequest) HasFilter() bool

HasFilter returns a boolean if a field has been set.

func (*SearchRequest) HasHighlight 

func (o *SearchRequest) HasHighlight() bool

HasHighlight returns a boolean if a field has been set.

func (*SearchRequest) HasHighlightPostTag 

func (o *SearchRequest) HasHighlightPostTag() bool

HasHighlightPostTag returns a boolean if a field has been set.

func (*SearchRequest) HasHighlightPreTag 

func (o *SearchRequest) HasHighlightPreTag() bool

HasHighlightPreTag returns a boolean if a field has been set.

func (*SearchRequest) HasMinimumCoverage 

func (o *SearchRequest) HasMinimumCoverage() bool

HasMinimumCoverage returns a boolean if a field has been set.

func (*SearchRequest) HasOrderby 

func (o *SearchRequest) HasOrderby() bool

HasOrderby returns a boolean if a field has been set.

func (*SearchRequest) HasQueryLanguage 

func (o *SearchRequest) HasQueryLanguage() bool

HasQueryLanguage returns a boolean if a field has been set.

func (*SearchRequest) HasQueryType 

func (o *SearchRequest) HasQueryType() bool

HasQueryType returns a boolean if a field has been set.

func (*SearchRequest) HasScoringParameters 

func (o *SearchRequest) HasScoringParameters() bool

HasScoringParameters returns a boolean if a field has been set.

func (*SearchRequest) HasScoringProfile 

func (o *SearchRequest) HasScoringProfile() bool

HasScoringProfile returns a boolean if a field has been set.

func (*SearchRequest) HasScoringStatistics 

func (o *SearchRequest) HasScoringStatistics() bool

HasScoringStatistics returns a boolean if a field has been set.

func (*SearchRequest) HasSearch 

func (o *SearchRequest) HasSearch() bool

HasSearch returns a boolean if a field has been set.

func (*SearchRequest) HasSearchFields 

func (o *SearchRequest) HasSearchFields() bool

HasSearchFields returns a boolean if a field has been set.

func (*SearchRequest) HasSearchMode 

func (o *SearchRequest) HasSearchMode() bool

HasSearchMode returns a boolean if a field has been set.

func (*SearchRequest) HasSelect 

func (o *SearchRequest) HasSelect() bool

HasSelect returns a boolean if a field has been set.

func (*SearchRequest) HasSemanticConfiguration 

func (o *SearchRequest) HasSemanticConfiguration() bool

HasSemanticConfiguration returns a boolean if a field has been set.

func (*SearchRequest) HasSemanticErrorHandling 

func (o *SearchRequest) HasSemanticErrorHandling() bool

HasSemanticErrorHandling returns a boolean if a field has been set.

func (*SearchRequest) HasSemanticFields 

func (o *SearchRequest) HasSemanticFields() bool

HasSemanticFields returns a boolean if a field has been set.

func (*SearchRequest) HasSemanticMaxWaitInMilliseconds 

func (o *SearchRequest) HasSemanticMaxWaitInMilliseconds() bool

HasSemanticMaxWaitInMilliseconds returns a boolean if a field has been set.

func (*SearchRequest) HasSessionId 

func (o *SearchRequest) HasSessionId() bool

HasSessionId returns a boolean if a field has been set.

func (*SearchRequest) HasSkip 

func (o *SearchRequest) HasSkip() bool

HasSkip returns a boolean if a field has been set.

func (*SearchRequest) HasSpeller 

func (o *SearchRequest) HasSpeller() bool

HasSpeller returns a boolean if a field has been set.

func (*SearchRequest) HasTop 

func (o *SearchRequest) HasTop() bool

HasTop returns a boolean if a field has been set.

func (*SearchRequest) HasVector 

func (o *SearchRequest) HasVector() bool

HasVector returns a boolean if a field has been set.

func (SearchRequest) MarshalJSON 

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

func (*SearchRequest) SetAnswers 

func (o *SearchRequest) SetAnswers(v Answers)

SetAnswers gets a reference to the given Answers and assigns it to the Answers field.

func (*SearchRequest) SetCaptions 

func (o *SearchRequest) SetCaptions(v Captions)

SetCaptions gets a reference to the given Captions and assigns it to the Captions field.

func (*SearchRequest) SetCount 

func (o *SearchRequest) SetCount(v bool)

SetCount gets a reference to the given bool and assigns it to the Count field.

func (*SearchRequest) SetDebug 

func (o *SearchRequest) SetDebug(v QueryDebugMode)

SetDebug gets a reference to the given QueryDebugMode and assigns it to the Debug field.

func (*SearchRequest) SetFacets 

func (o *SearchRequest) SetFacets(v []string)

SetFacets gets a reference to the given []string and assigns it to the Facets field.

func (*SearchRequest) SetFilter 

func (o *SearchRequest) SetFilter(v string)

SetFilter gets a reference to the given string and assigns it to the Filter field.

func (*SearchRequest) SetHighlight 

func (o *SearchRequest) SetHighlight(v string)

SetHighlight gets a reference to the given string and assigns it to the Highlight field.

func (*SearchRequest) SetHighlightPostTag 

func (o *SearchRequest) SetHighlightPostTag(v string)

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

func (*SearchRequest) SetHighlightPreTag 

func (o *SearchRequest) SetHighlightPreTag(v string)

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

func (*SearchRequest) SetMinimumCoverage 

func (o *SearchRequest) SetMinimumCoverage(v float64)

SetMinimumCoverage gets a reference to the given float64 and assigns it to the MinimumCoverage field.

func (*SearchRequest) SetOrderby 

func (o *SearchRequest) SetOrderby(v string)

SetOrderby gets a reference to the given string and assigns it to the Orderby field.

func (*SearchRequest) SetQueryLanguage 

func (o *SearchRequest) SetQueryLanguage(v QueryLanguage)

SetQueryLanguage gets a reference to the given QueryLanguage and assigns it to the QueryLanguage field.

func (*SearchRequest) SetQueryType 

func (o *SearchRequest) SetQueryType(v QueryType)

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

func (*SearchRequest) SetScoringParameters 

func (o *SearchRequest) SetScoringParameters(v []string)

SetScoringParameters gets a reference to the given []string and assigns it to the ScoringParameters field.

func (*SearchRequest) SetScoringProfile 

func (o *SearchRequest) SetScoringProfile(v string)

SetScoringProfile gets a reference to the given string and assigns it to the ScoringProfile field.

func (*SearchRequest) SetScoringStatistics 

func (o *SearchRequest) SetScoringStatistics(v ScoringStatistics)

SetScoringStatistics gets a reference to the given ScoringStatistics and assigns it to the ScoringStatistics field.

func (*SearchRequest) SetSearch 

func (o *SearchRequest) SetSearch(v string)

SetSearch gets a reference to the given string and assigns it to the Search field.

func (*SearchRequest) SetSearchFields 

func (o *SearchRequest) SetSearchFields(v string)

SetSearchFields gets a reference to the given string and assigns it to the SearchFields field.

func (*SearchRequest) SetSearchMode 

func (o *SearchRequest) SetSearchMode(v SearchMode)

SetSearchMode gets a reference to the given SearchMode and assigns it to the SearchMode field.

func (*SearchRequest) SetSelect 

func (o *SearchRequest) SetSelect(v string)

SetSelect gets a reference to the given string and assigns it to the Select field.

func (*SearchRequest) SetSemanticConfiguration 

func (o *SearchRequest) SetSemanticConfiguration(v string)

SetSemanticConfiguration gets a reference to the given string and assigns it to the SemanticConfiguration field.

func (*SearchRequest) SetSemanticErrorHandling 

func (o *SearchRequest) SetSemanticErrorHandling(v SemanticErrorHandling)

SetSemanticErrorHandling gets a reference to the given SemanticErrorHandling and assigns it to the SemanticErrorHandling field.

func (*SearchRequest) SetSemanticFields 

func (o *SearchRequest) SetSemanticFields(v string)

SetSemanticFields gets a reference to the given string and assigns it to the SemanticFields field.

func (*SearchRequest) SetSemanticMaxWaitInMilliseconds 

func (o *SearchRequest) SetSemanticMaxWaitInMilliseconds(v int32)

SetSemanticMaxWaitInMilliseconds gets a reference to the given NullableInt32 and assigns it to the SemanticMaxWaitInMilliseconds field.

func (*SearchRequest) SetSemanticMaxWaitInMillisecondsNil 

func (o *SearchRequest) SetSemanticMaxWaitInMillisecondsNil()

SetSemanticMaxWaitInMillisecondsNil sets the value for SemanticMaxWaitInMilliseconds to be an explicit nil

func (*SearchRequest) SetSessionId 

func (o *SearchRequest) SetSessionId(v string)

SetSessionId gets a reference to the given string and assigns it to the SessionId field.

func (*SearchRequest) SetSkip 

func (o *SearchRequest) SetSkip(v int32)

SetSkip gets a reference to the given int32 and assigns it to the Skip field.

func (*SearchRequest) SetSpeller 

func (o *SearchRequest) SetSpeller(v Speller)

SetSpeller gets a reference to the given Speller and assigns it to the Speller field.

func (*SearchRequest) SetTop 

func (o *SearchRequest) SetTop(v int32)

SetTop gets a reference to the given int32 and assigns it to the Top field.

func (*SearchRequest) SetVector 

func (o *SearchRequest) SetVector(v Vector)

SetVector gets a reference to the given Vector and assigns it to the Vector field.

func (SearchRequest) ToMap 

func (o SearchRequest) ToMap() (map[string]interface{}, error)

func (*SearchRequest) UnsetSemanticMaxWaitInMilliseconds 

func (o *SearchRequest) UnsetSemanticMaxWaitInMilliseconds()

UnsetSemanticMaxWaitInMilliseconds ensures that no value is present for SemanticMaxWaitInMilliseconds, not even an explicit nil

type SearchResult 

type SearchResult struct {
	// The relevance score of the document compared to other documents returned by the query.
	SearchScore float64 `json:"@search.score"`
	// The relevance score computed by the semantic ranker for the top search results. Search results are sorted by the RerankerScore first and then by the Score. RerankerScore is only returned for queries of type 'semantic'.
	SearchRerankerScore NullableFloat64 `json:"@search.rerankerScore,omitempty"`
	// Text fragments from the document that indicate the matching search terms, organized by each applicable field; null if hit highlighting was not enabled for the query.
	SearchHighlights *map[string][]string `json:"@search.highlights,omitempty"`
	// Captions are the most representative passages from the document relatively to the search query. They are often used as document summary. Captions are only returned for queries of type 'semantic'.
	SearchCaptions []CaptionResult `json:"@search.captions,omitempty"`
	// Contains debugging information that can be used to further explore your search results.
	SearchDocumentDebugInfo []DocumentDebugInfo `json:"@search.documentDebugInfo,omitempty"`
}

SearchResult Contains a document found by a search query, plus associated metadata.

func NewSearchResult 

func NewSearchResult(searchScore float64) *SearchResult

NewSearchResult instantiates a new SearchResult 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 NewSearchResultWithDefaults 

func NewSearchResultWithDefaults() *SearchResult

NewSearchResultWithDefaults instantiates a new SearchResult object This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set

func (*SearchResult) GetSearchCaptions 

func (o *SearchResult) GetSearchCaptions() []CaptionResult

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

func (*SearchResult) GetSearchCaptionsOk 

func (o *SearchResult) GetSearchCaptionsOk() ([]CaptionResult, bool)

GetSearchCaptionsOk returns a tuple with the SearchCaptions 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 (*SearchResult) GetSearchDocumentDebugInfo 

func (o *SearchResult) GetSearchDocumentDebugInfo() []DocumentDebugInfo

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

func (*SearchResult) GetSearchDocumentDebugInfoOk 

func (o *SearchResult) GetSearchDocumentDebugInfoOk() ([]DocumentDebugInfo, bool)

GetSearchDocumentDebugInfoOk returns a tuple with the SearchDocumentDebugInfo 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 (*SearchResult) GetSearchHighlights 

func (o *SearchResult) GetSearchHighlights() map[string][]string

GetSearchHighlights returns the SearchHighlights field value if set, zero value otherwise.

func (*SearchResult) GetSearchHighlightsOk 

func (o *SearchResult) GetSearchHighlightsOk() (*map[string][]string, bool)

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

func (*SearchResult) GetSearchRerankerScore 

func (o *SearchResult) GetSearchRerankerScore() float64

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

func (*SearchResult) GetSearchRerankerScoreOk 

func (o *SearchResult) GetSearchRerankerScoreOk() (*float64, bool)

GetSearchRerankerScoreOk returns a tuple with the SearchRerankerScore 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 (*SearchResult) GetSearchScore 

func (o *SearchResult) GetSearchScore() float64

GetSearchScore returns the SearchScore field value

func (*SearchResult) GetSearchScoreOk 

func (o *SearchResult) GetSearchScoreOk() (*float64, bool)

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

func (*SearchResult) HasSearchCaptions 

func (o *SearchResult) HasSearchCaptions() bool

HasSearchCaptions returns a boolean if a field has been set.

func (*SearchResult) HasSearchDocumentDebugInfo 

func (o *SearchResult) HasSearchDocumentDebugInfo() bool

HasSearchDocumentDebugInfo returns a boolean if a field has been set.

func (*SearchResult) HasSearchHighlights 

func (o *SearchResult) HasSearchHighlights() bool

HasSearchHighlights returns a boolean if a field has been set.

func (*SearchResult) HasSearchRerankerScore 

func (o *SearchResult) HasSearchRerankerScore() bool

HasSearchRerankerScore returns a boolean if a field has been set.

func (SearchResult) MarshalJSON 

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

func (*SearchResult) SetSearchCaptions 

func (o *SearchResult) SetSearchCaptions(v []CaptionResult)

SetSearchCaptions gets a reference to the given []CaptionResult and assigns it to the SearchCaptions field.

func (*SearchResult) SetSearchDocumentDebugInfo 

func (o *SearchResult) SetSearchDocumentDebugInfo(v []DocumentDebugInfo)

SetSearchDocumentDebugInfo gets a reference to the given []DocumentDebugInfo and assigns it to the SearchDocumentDebugInfo field.

func (*SearchResult) SetSearchHighlights 

func (o *SearchResult) SetSearchHighlights(v map[string][]string)

SetSearchHighlights gets a reference to the given map[string][]string and assigns it to the SearchHighlights field.

func (*SearchResult) SetSearchRerankerScore 

func (o *SearchResult) SetSearchRerankerScore(v float64)

SetSearchRerankerScore gets a reference to the given NullableFloat64 and assigns it to the SearchRerankerScore field.

func (*SearchResult) SetSearchRerankerScoreNil 

func (o *SearchResult) SetSearchRerankerScoreNil()

SetSearchRerankerScoreNil sets the value for SearchRerankerScore to be an explicit nil

func (*SearchResult) SetSearchScore 

func (o *SearchResult) SetSearchScore(v float64)

SetSearchScore sets field value

func (SearchResult) ToMap 

func (o SearchResult) ToMap() (map[string]interface{}, error)

func (*SearchResult) UnsetSearchRerankerScore 

func (o *SearchResult) UnsetSearchRerankerScore()

UnsetSearchRerankerScore ensures that no value is present for SearchRerankerScore, not even an explicit nil

type SemanticDebugInfo 

type SemanticDebugInfo struct {
	TitleField *QueryResultDocumentSemanticField `json:"titleField,omitempty"`
	// The content fields that were sent to the semantic enrichment process, as well as how they were used
	ContentFields []QueryResultDocumentSemanticField `json:"contentFields,omitempty"`
	// The keyword fields that were sent to the semantic enrichment process, as well as how they were used
	KeywordFields []QueryResultDocumentSemanticField `json:"keywordFields,omitempty"`
	RerankerInput *QueryResultDocumentRerankerInput  `json:"rerankerInput,omitempty"`
}

SemanticDebugInfo struct for SemanticDebugInfo

func NewSemanticDebugInfo 

func NewSemanticDebugInfo() *SemanticDebugInfo

NewSemanticDebugInfo instantiates a new SemanticDebugInfo 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 NewSemanticDebugInfoWithDefaults 

func NewSemanticDebugInfoWithDefaults() *SemanticDebugInfo

NewSemanticDebugInfoWithDefaults instantiates a new SemanticDebugInfo object This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set

func (*SemanticDebugInfo) GetContentFields 

func (o *SemanticDebugInfo) GetContentFields() []QueryResultDocumentSemanticField

GetContentFields returns the ContentFields field value if set, zero value otherwise.

func (*SemanticDebugInfo) GetContentFieldsOk 

func (o *SemanticDebugInfo) GetContentFieldsOk() ([]QueryResultDocumentSemanticField, bool)

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

func (*SemanticDebugInfo) GetKeywordFields 

func (o *SemanticDebugInfo) GetKeywordFields() []QueryResultDocumentSemanticField

GetKeywordFields returns the KeywordFields field value if set, zero value otherwise.

func (*SemanticDebugInfo) GetKeywordFieldsOk 

func (o *SemanticDebugInfo) GetKeywordFieldsOk() ([]QueryResultDocumentSemanticField, bool)

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

func (*SemanticDebugInfo) GetRerankerInput 

func (o *SemanticDebugInfo) GetRerankerInput() QueryResultDocumentRerankerInput

GetRerankerInput returns the RerankerInput field value if set, zero value otherwise.

func (*SemanticDebugInfo) GetRerankerInputOk 

func (o *SemanticDebugInfo) GetRerankerInputOk() (*QueryResultDocumentRerankerInput, bool)

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

func (*SemanticDebugInfo) GetTitleField 

func (o *SemanticDebugInfo) GetTitleField() QueryResultDocumentSemanticField

GetTitleField returns the TitleField field value if set, zero value otherwise.

func (*SemanticDebugInfo) GetTitleFieldOk 

func (o *SemanticDebugInfo) GetTitleFieldOk() (*QueryResultDocumentSemanticField, bool)

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

func (*SemanticDebugInfo) HasContentFields 

func (o *SemanticDebugInfo) HasContentFields() bool

HasContentFields returns a boolean if a field has been set.

func (*SemanticDebugInfo) HasKeywordFields 

func (o *SemanticDebugInfo) HasKeywordFields() bool

HasKeywordFields returns a boolean if a field has been set.

func (*SemanticDebugInfo) HasRerankerInput 

func (o *SemanticDebugInfo) HasRerankerInput() bool

HasRerankerInput returns a boolean if a field has been set.

func (*SemanticDebugInfo) HasTitleField 

func (o *SemanticDebugInfo) HasTitleField() bool

HasTitleField returns a boolean if a field has been set.

func (SemanticDebugInfo) MarshalJSON 

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

func (*SemanticDebugInfo) SetContentFields 

func (o *SemanticDebugInfo) SetContentFields(v []QueryResultDocumentSemanticField)

SetContentFields gets a reference to the given []QueryResultDocumentSemanticField and assigns it to the ContentFields field.

func (*SemanticDebugInfo) SetKeywordFields 

func (o *SemanticDebugInfo) SetKeywordFields(v []QueryResultDocumentSemanticField)

SetKeywordFields gets a reference to the given []QueryResultDocumentSemanticField and assigns it to the KeywordFields field.

func (*SemanticDebugInfo) SetRerankerInput 

func (o *SemanticDebugInfo) SetRerankerInput(v QueryResultDocumentRerankerInput)

SetRerankerInput gets a reference to the given QueryResultDocumentRerankerInput and assigns it to the RerankerInput field.

func (*SemanticDebugInfo) SetTitleField 

func (o *SemanticDebugInfo) SetTitleField(v QueryResultDocumentSemanticField)

SetTitleField gets a reference to the given QueryResultDocumentSemanticField and assigns it to the TitleField field.

func (SemanticDebugInfo) ToMap 

func (o SemanticDebugInfo) ToMap() (map[string]interface{}, error)

type SemanticErrorHandling 

type SemanticErrorHandling string

SemanticErrorHandling Allows the user to choose whether a semantic call should fail completely, or to return partial results. 

const (
	// PARTIAL SemanticErrorHandling = "partial"
	FAIL SemanticErrorHandling = "fail"
)

List of SemanticErrorHandling

func NewSemanticErrorHandlingFromValue 

func NewSemanticErrorHandlingFromValue(v string) (*SemanticErrorHandling, error)

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

func (SemanticErrorHandling) IsValid 

func (v SemanticErrorHandling) IsValid() bool

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

func (SemanticErrorHandling) Ptr 

func (v SemanticErrorHandling) Ptr() *SemanticErrorHandling

Ptr returns reference to SemanticErrorHandling value

func (*SemanticErrorHandling) UnmarshalJSON 

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

type SemanticPartialResponseReason 

type SemanticPartialResponseReason string

SemanticPartialResponseReason Reason that a partial response was returned for a semantic search request. 

const (
	MAX_WAIT_EXCEEDED   SemanticPartialResponseReason = "maxWaitExceeded"
	CAPACITY_OVERLOADED SemanticPartialResponseReason = "capacityOverloaded"
	TRANSIENT           SemanticPartialResponseReason = "transient"
)

List of SemanticPartialResponseReason

func NewSemanticPartialResponseReasonFromValue 

func NewSemanticPartialResponseReasonFromValue(v string) (*SemanticPartialResponseReason, error)

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

func (SemanticPartialResponseReason) IsValid 

func (v SemanticPartialResponseReason) IsValid() bool

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

func (SemanticPartialResponseReason) Ptr 

func (v SemanticPartialResponseReason) Ptr() *SemanticPartialResponseReason

Ptr returns reference to SemanticPartialResponseReason value

func (*SemanticPartialResponseReason) UnmarshalJSON 

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

type SemanticPartialResponseType 

type SemanticPartialResponseType string

SemanticPartialResponseType Type of partial response that was returned for a semantic search request. 

const (
	BASE_RESULTS     SemanticPartialResponseType = "baseResults"
	RERANKED_RESULTS SemanticPartialResponseType = "rerankedResults"
)

List of SemanticPartialResponseType

func NewSemanticPartialResponseTypeFromValue 

func NewSemanticPartialResponseTypeFromValue(v string) (*SemanticPartialResponseType, error)

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

func (SemanticPartialResponseType) IsValid 

func (v SemanticPartialResponseType) IsValid() bool

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

func (SemanticPartialResponseType) Ptr 

func (v SemanticPartialResponseType) Ptr() *SemanticPartialResponseType

Ptr returns reference to SemanticPartialResponseType value

func (*SemanticPartialResponseType) UnmarshalJSON 

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

type ServerConfiguration 

type ServerConfiguration struct {
	URL         string
	Description string
	Variables   map[string]ServerVariable
}

ServerConfiguration stores the information about a server

type ServerConfigurations 

type ServerConfigurations []ServerConfiguration

ServerConfigurations stores multiple ServerConfiguration items

func (ServerConfigurations) URL 

func (sc ServerConfigurations) URL(index int, variables map[string]string) (string, error)

URL formats template on a index using given variables

type ServerVariable 

type ServerVariable struct {
	Description  string
	DefaultValue string
	EnumValues   []string
}

ServerVariable stores the information about a server variable

type Speller 

type Speller string

Speller Improve search recall by spell-correcting individual search query terms. 

const (
	// NONE Speller = "none"
	LEXICON Speller = "lexicon"
)

List of Speller

func NewSpellerFromValue 

func NewSpellerFromValue(v string) (*Speller, error)

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

func (Speller) IsValid 

func (v Speller) IsValid() bool

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

func (Speller) Ptr 

func (v Speller) Ptr() *Speller

Ptr returns reference to Speller value

func (*Speller) UnmarshalJSON 

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

type SuggestDocumentsResult 

type SuggestDocumentsResult struct {
	// The sequence of results returned by the query.
	Value []SuggestResult `json:"value"`
	// A value indicating the percentage of the index that was included in the query, or null if minimumCoverage was not set in the request.
	SearchCoverage *float64 `json:"@search.coverage,omitempty"`
}

SuggestDocumentsResult Response containing suggestion query results from an index.

func NewSuggestDocumentsResult 

func NewSuggestDocumentsResult(value []SuggestResult) *SuggestDocumentsResult

NewSuggestDocumentsResult instantiates a new SuggestDocumentsResult 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 NewSuggestDocumentsResultWithDefaults 

func NewSuggestDocumentsResultWithDefaults() *SuggestDocumentsResult

NewSuggestDocumentsResultWithDefaults instantiates a new SuggestDocumentsResult object This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set

func (*SuggestDocumentsResult) GetSearchCoverage 

func (o *SuggestDocumentsResult) GetSearchCoverage() float64

GetSearchCoverage returns the SearchCoverage field value if set, zero value otherwise.

func (*SuggestDocumentsResult) GetSearchCoverageOk 

func (o *SuggestDocumentsResult) GetSearchCoverageOk() (*float64, bool)

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

func (*SuggestDocumentsResult) GetValue 

func (o *SuggestDocumentsResult) GetValue() []SuggestResult

GetValue returns the Value field value

func (*SuggestDocumentsResult) GetValueOk 

func (o *SuggestDocumentsResult) GetValueOk() ([]SuggestResult, bool)

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

func (*SuggestDocumentsResult) HasSearchCoverage 

func (o *SuggestDocumentsResult) HasSearchCoverage() bool

HasSearchCoverage returns a boolean if a field has been set.

func (SuggestDocumentsResult) MarshalJSON 

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

func (*SuggestDocumentsResult) SetSearchCoverage 

func (o *SuggestDocumentsResult) SetSearchCoverage(v float64)

SetSearchCoverage gets a reference to the given float64 and assigns it to the SearchCoverage field.

func (*SuggestDocumentsResult) SetValue 

func (o *SuggestDocumentsResult) SetValue(v []SuggestResult)

SetValue sets field value

func (SuggestDocumentsResult) ToMap 

func (o SuggestDocumentsResult) ToMap() (map[string]interface{}, error)

type SuggestRequest 

type SuggestRequest struct {
	// An OData expression that filters the documents considered for suggestions.
	Filter *string `json:"filter,omitempty"`
	// A value indicating whether to use fuzzy matching for the suggestion query. Default is false. When set to true, the query will find suggestions even if there's a substituted or missing character in the search text. While this provides a better experience in some scenarios, it comes at a performance cost as fuzzy suggestion searches are slower and consume more resources.
	Fuzzy *bool `json:"fuzzy,omitempty"`
	// A string tag that is appended to hit highlights. Must be set with highlightPreTag. If omitted, hit highlighting of suggestions is disabled.
	HighlightPostTag *string `json:"highlightPostTag,omitempty"`
	// A string tag that is prepended to hit highlights. Must be set with highlightPostTag. If omitted, hit highlighting of suggestions is disabled.
	HighlightPreTag *string `json:"highlightPreTag,omitempty"`
	// A number between 0 and 100 indicating the percentage of the index that must be covered by a suggestion query in order for the query to be reported as a success. This parameter can be useful for ensuring search availability even for services with only one replica. The default is 80.
	MinimumCoverage *float64 `json:"minimumCoverage,omitempty"`
	// The comma-separated list of OData $orderby expressions by which to sort the results. Each expression can be either a field name or a call to either the geo.distance() or the search.score() functions. Each expression can be followed by asc to indicate ascending, or desc to indicate descending. The default is ascending order. Ties will be broken by the match scores of documents. If no $orderby is specified, the default sort order is descending by document match score. There can be at most 32 $orderby clauses.
	Orderby *string `json:"orderby,omitempty"`
	// The search text to use to suggest documents. Must be at least 1 character, and no more than 100 characters.
	Search string `json:"search"`
	// The comma-separated list of field names to search for the specified search text. Target fields must be included in the specified suggester.
	SearchFields *string `json:"searchFields,omitempty"`
	// The comma-separated list of fields to retrieve. If unspecified, only the key field will be included in the results.
	Select *string `json:"select,omitempty"`
	// The name of the suggester as specified in the suggesters collection that's part of the index definition.
	SuggesterName string `json:"suggesterName"`
	// The number of suggestions to retrieve. This must be a value between 1 and 100. The default is 5.
	Top *int32 `json:"top,omitempty"`
}

SuggestRequest Parameters for filtering, sorting, fuzzy matching, and other suggestions query behaviors.

func NewSuggestRequest 

func NewSuggestRequest(search string, suggesterName string) *SuggestRequest

NewSuggestRequest instantiates a new SuggestRequest 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 NewSuggestRequestWithDefaults 

func NewSuggestRequestWithDefaults() *SuggestRequest

NewSuggestRequestWithDefaults instantiates a new SuggestRequest object This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set

func (*SuggestRequest) GetFilter 

func (o *SuggestRequest) GetFilter() string

GetFilter returns the Filter field value if set, zero value otherwise.

func (*SuggestRequest) GetFilterOk 

func (o *SuggestRequest) GetFilterOk() (*string, bool)

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

func (*SuggestRequest) GetFuzzy 

func (o *SuggestRequest) GetFuzzy() bool

GetFuzzy returns the Fuzzy field value if set, zero value otherwise.

func (*SuggestRequest) GetFuzzyOk 

func (o *SuggestRequest) GetFuzzyOk() (*bool, bool)

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

func (*SuggestRequest) GetHighlightPostTag 

func (o *SuggestRequest) GetHighlightPostTag() string

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

func (*SuggestRequest) GetHighlightPostTagOk 

func (o *SuggestRequest) 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 (*SuggestRequest) GetHighlightPreTag 

func (o *SuggestRequest) GetHighlightPreTag() string

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

func (*SuggestRequest) GetHighlightPreTagOk 

func (o *SuggestRequest) 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 (*SuggestRequest) GetMinimumCoverage 

func (o *SuggestRequest) GetMinimumCoverage() float64

GetMinimumCoverage returns the MinimumCoverage field value if set, zero value otherwise.

func (*SuggestRequest) GetMinimumCoverageOk 

func (o *SuggestRequest) GetMinimumCoverageOk() (*float64, bool)

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

func (*SuggestRequest) GetOrderby 

func (o *SuggestRequest) GetOrderby() string

GetOrderby returns the Orderby field value if set, zero value otherwise.

func (*SuggestRequest) GetOrderbyOk 

func (o *SuggestRequest) GetOrderbyOk() (*string, bool)

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

func (*SuggestRequest) GetSearch 

func (o *SuggestRequest) GetSearch() string

GetSearch returns the Search field value

func (*SuggestRequest) GetSearchFields 

func (o *SuggestRequest) GetSearchFields() string

GetSearchFields returns the SearchFields field value if set, zero value otherwise.

func (*SuggestRequest) GetSearchFieldsOk 

func (o *SuggestRequest) GetSearchFieldsOk() (*string, bool)

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

func (*SuggestRequest) GetSearchOk 

func (o *SuggestRequest) GetSearchOk() (*string, bool)

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

func (*SuggestRequest) GetSelect 

func (o *SuggestRequest) GetSelect() string

GetSelect returns the Select field value if set, zero value otherwise.

func (*SuggestRequest) GetSelectOk 

func (o *SuggestRequest) GetSelectOk() (*string, bool)

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

func (*SuggestRequest) GetSuggesterName 

func (o *SuggestRequest) GetSuggesterName() string

GetSuggesterName returns the SuggesterName field value

func (*SuggestRequest) GetSuggesterNameOk 

func (o *SuggestRequest) GetSuggesterNameOk() (*string, bool)

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

func (*SuggestRequest) GetTop 

func (o *SuggestRequest) GetTop() int32

GetTop returns the Top field value if set, zero value otherwise.

func (*SuggestRequest) GetTopOk 

func (o *SuggestRequest) GetTopOk() (*int32, bool)

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

func (*SuggestRequest) HasFilter 

func (o *SuggestRequest) HasFilter() bool

HasFilter returns a boolean if a field has been set.

func (*SuggestRequest) HasFuzzy 

func (o *SuggestRequest) HasFuzzy() bool

HasFuzzy returns a boolean if a field has been set.

func (*SuggestRequest) HasHighlightPostTag 

func (o *SuggestRequest) HasHighlightPostTag() bool

HasHighlightPostTag returns a boolean if a field has been set.

func (*SuggestRequest) HasHighlightPreTag 

func (o *SuggestRequest) HasHighlightPreTag() bool

HasHighlightPreTag returns a boolean if a field has been set.

func (*SuggestRequest) HasMinimumCoverage 

func (o *SuggestRequest) HasMinimumCoverage() bool

HasMinimumCoverage returns a boolean if a field has been set.

func (*SuggestRequest) HasOrderby 

func (o *SuggestRequest) HasOrderby() bool

HasOrderby returns a boolean if a field has been set.

func (*SuggestRequest) HasSearchFields 

func (o *SuggestRequest) HasSearchFields() bool

HasSearchFields returns a boolean if a field has been set.

func (*SuggestRequest) HasSelect 

func (o *SuggestRequest) HasSelect() bool

HasSelect returns a boolean if a field has been set.

func (*SuggestRequest) HasTop 

func (o *SuggestRequest) HasTop() bool

HasTop returns a boolean if a field has been set.

func (SuggestRequest) MarshalJSON 

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

func (*SuggestRequest) SetFilter 

func (o *SuggestRequest) SetFilter(v string)

SetFilter gets a reference to the given string and assigns it to the Filter field.

func (*SuggestRequest) SetFuzzy 

func (o *SuggestRequest) SetFuzzy(v bool)

SetFuzzy gets a reference to the given bool and assigns it to the Fuzzy field.

func (*SuggestRequest) SetHighlightPostTag 

func (o *SuggestRequest) SetHighlightPostTag(v string)

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

func (*SuggestRequest) SetHighlightPreTag 

func (o *SuggestRequest) SetHighlightPreTag(v string)

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

func (*SuggestRequest) SetMinimumCoverage 

func (o *SuggestRequest) SetMinimumCoverage(v float64)

SetMinimumCoverage gets a reference to the given float64 and assigns it to the MinimumCoverage field.

func (*SuggestRequest) SetOrderby 

func (o *SuggestRequest) SetOrderby(v string)

SetOrderby gets a reference to the given string and assigns it to the Orderby field.

func (*SuggestRequest) SetSearch 

func (o *SuggestRequest) SetSearch(v string)

SetSearch sets field value

func (*SuggestRequest) SetSearchFields 

func (o *SuggestRequest) SetSearchFields(v string)

SetSearchFields gets a reference to the given string and assigns it to the SearchFields field.

func (*SuggestRequest) SetSelect 

func (o *SuggestRequest) SetSelect(v string)

SetSelect gets a reference to the given string and assigns it to the Select field.

func (*SuggestRequest) SetSuggesterName 

func (o *SuggestRequest) SetSuggesterName(v string)

SetSuggesterName sets field value

func (*SuggestRequest) SetTop 

func (o *SuggestRequest) SetTop(v int32)

SetTop gets a reference to the given int32 and assigns it to the Top field.

func (SuggestRequest) ToMap 

func (o SuggestRequest) ToMap() (map[string]interface{}, error)

type SuggestResult 

type SuggestResult struct {
	// The text of the suggestion result.
	SearchText string `json:"@search.text"`
}

SuggestResult A result containing a document found by a suggestion query, plus associated metadata.

func NewSuggestResult 

func NewSuggestResult(searchText string) *SuggestResult

NewSuggestResult instantiates a new SuggestResult 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 NewSuggestResultWithDefaults 

func NewSuggestResultWithDefaults() *SuggestResult

NewSuggestResultWithDefaults instantiates a new SuggestResult object This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set

func (*SuggestResult) GetSearchText 

func (o *SuggestResult) GetSearchText() string

GetSearchText returns the SearchText field value

func (*SuggestResult) GetSearchTextOk 

func (o *SuggestResult) GetSearchTextOk() (*string, bool)

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

func (SuggestResult) MarshalJSON 

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

func (*SuggestResult) SetSearchText 

func (o *SuggestResult) SetSearchText(v string)

SetSearchText sets field value

func (SuggestResult) ToMap 

func (o SuggestResult) ToMap() (map[string]interface{}, error)

type Vector 

type Vector struct {
	// The vector representation of a search query.
	Value []float32 `json:"value,omitempty"`
	// Number of nearest neighbors to return as top hits.
	K *int32 `json:"k,omitempty"`
	// Vector Fields of type Collection(Edm.Single) to be included in the vector searched.
	Fields *string `json:"fields,omitempty"`
}

Vector The query parameters for vector and hybrid search queries.

func NewVector 

func NewVector() *Vector

NewVector instantiates a new Vector 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 NewVectorWithDefaults 

func NewVectorWithDefaults() *Vector

NewVectorWithDefaults instantiates a new Vector object This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set

func (*Vector) GetFields 

func (o *Vector) GetFields() string

GetFields returns the Fields field value if set, zero value otherwise.

func (*Vector) GetFieldsOk 

func (o *Vector) GetFieldsOk() (*string, bool)

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

func (*Vector) GetK 

func (o *Vector) GetK() int32

GetK returns the K field value if set, zero value otherwise.

func (*Vector) GetKOk 

func (o *Vector) GetKOk() (*int32, bool)

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

func (*Vector) GetValue 

func (o *Vector) GetValue() []float32

GetValue returns the Value field value if set, zero value otherwise.

func (*Vector) GetValueOk 

func (o *Vector) GetValueOk() ([]float32, 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 (*Vector) HasFields 

func (o *Vector) HasFields() bool

HasFields returns a boolean if a field has been set.

func (*Vector) HasK 

func (o *Vector) HasK() bool

HasK returns a boolean if a field has been set.

func (*Vector) HasValue 

func (o *Vector) HasValue() bool

HasValue returns a boolean if a field has been set.

func (Vector) MarshalJSON 

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

func (*Vector) SetFields 

func (o *Vector) SetFields(v string)

SetFields gets a reference to the given string and assigns it to the Fields field.

func (*Vector) SetK 

func (o *Vector) SetK(v int32)

SetK gets a reference to the given int32 and assigns it to the K field.

func (*Vector) SetValue 

func (o *Vector) SetValue(v []float32)

SetValue gets a reference to the given []float32 and assigns it to the Value field.

func (Vector) ToMap 

func (o Vector) ToMap() (map[string]interface{}, error)

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.