The highest tagged major version is
Documentation
¶
Overview ¶
Explain a document match result. Get information about why a specific document matches, or doesn't match, a query. It computes a score explanation for a query and a specific document.
Index ¶
- Variables
- type Explain
- func (r *Explain) AnalyzeWildcard(analyzewildcard bool) *Explain
- func (r *Explain) Analyzer(analyzer string) *Explain
- func (r *Explain) DefaultOperator(defaultoperator operator.Operator) *Explain
- func (r *Explain) Df(df string) *Explain
- func (r Explain) Do(providedCtx context.Context) (*Response, error)
- func (r *Explain) ErrorTrace(errortrace bool) *Explain
- func (r *Explain) FilterPath(filterpaths ...string) *Explain
- func (r *Explain) Header(key, value string) *Explain
- func (r *Explain) HttpRequest(ctx context.Context) (*http.Request, error)
- func (r *Explain) Human(human bool) *Explain
- func (r *Explain) Lenient(lenient bool) *Explain
- func (r Explain) Perform(providedCtx context.Context) (*http.Response, error)
- func (r *Explain) Preference(preference string) *Explain
- func (r *Explain) Pretty(pretty bool) *Explain
- func (r *Explain) Q(q string) *Explain
- func (r *Explain) Query(query *types.Query) *Explain
- func (r *Explain) Raw(raw io.Reader) *Explain
- func (r *Explain) Request(req *Request) *Explain
- func (r *Explain) Routing(routing string) *Explain
- func (r *Explain) SourceExcludes_(fields ...string) *Explain
- func (r *Explain) SourceIncludes_(fields ...string) *Explain
- func (r *Explain) Source_(sourceconfigparam string) *Explain
- func (r *Explain) StoredFields(fields ...string) *Explain
- type NewExplain
- type Request
- type Response
Constants ¶
This section is empty.
Variables ¶
var ErrBuildPath = errors.New("cannot build path, check for missing path parameters")
ErrBuildPath is returned in case of missing parameters within the build of the request.
Functions ¶
This section is empty.
Types ¶
type Explain ¶
type Explain struct {
// contains filtered or unexported fields
}
func New ¶
func New(tp elastictransport.Interface) *Explain
Explain a document match result. Get information about why a specific document matches, or doesn't match, a query. It computes a score explanation for a query and a specific document.
https://www.elastic.co/guide/en/elasticsearch/reference/current/search-explain.html
func (*Explain) AnalyzeWildcard ¶
AnalyzeWildcard If `true`, wildcard and prefix queries are analyzed. This parameter can be used only when the `q` query string parameter is specified. API name: analyze_wildcard
func (*Explain) Analyzer ¶
Analyzer The analyzer to use for the query string. This parameter can be used only when the `q` query string parameter is specified. API name: analyzer
func (*Explain) DefaultOperator ¶
DefaultOperator The default operator for query string query: `AND` or `OR`. This parameter can be used only when the `q` query string parameter is specified. API name: default_operator
func (*Explain) Df ¶
Df The field to use as default where no field prefix is given in the query string. This parameter can be used only when the `q` query string parameter is specified. API name: df
func (Explain) Do ¶
Do runs the request through the transport, handle the response and returns a explain.Response
func (*Explain) ErrorTrace ¶ added in v8.14.0
ErrorTrace When set to `true` Elasticsearch will include the full stack trace of errors when they occur. API name: error_trace
func (*Explain) FilterPath ¶ added in v8.14.0
FilterPath Comma-separated list of filters in dot notation which reduce the response returned by Elasticsearch. API name: filter_path
func (*Explain) HttpRequest ¶
HttpRequest returns the http.Request object built from the given parameters.
func (*Explain) Human ¶ added in v8.14.0
Human When set to `true` will return statistics in a format suitable for humans. For example `"exists_time": "1h"` for humans and `"eixsts_time_in_millis": 3600000` for computers. When disabled the human readable values will be omitted. This makes sense for responses being consumed only by machines. API name: human
func (*Explain) Lenient ¶
Lenient If `true`, format-based query failures (such as providing text to a numeric field) in the query string will be ignored. This parameter can be used only when the `q` query string parameter is specified. API name: lenient
func (Explain) Perform ¶ added in v8.7.0
Perform runs the http.Request through the provided transport and returns an http.Response.
func (*Explain) Preference ¶
Preference The node or shard the operation should be performed on. It is random by default. API name: preference
func (*Explain) Pretty ¶ added in v8.14.0
Pretty If set to `true` the returned JSON will be "pretty-formatted". Only use this option for debugging only. API name: pretty
func (*Explain) Query ¶ added in v8.9.0
Query Defines the search definition using the Query DSL. API name: query
func (*Explain) Raw ¶
Raw takes a json payload as input which is then passed to the http.Request If specified Raw takes precedence on Request method.
func (*Explain) Routing ¶
Routing A custom value used to route operations to a specific shard. API name: routing
func (*Explain) SourceExcludes_ ¶
SourceExcludes_ A comma-separated list of source fields to exclude from the response. You can also use this parameter to exclude fields from the subset specified in `_source_includes` query parameter. If the `_source` parameter is `false`, this parameter is ignored. API name: _source_excludes
func (*Explain) SourceIncludes_ ¶
SourceIncludes_ A comma-separated list of source fields to include in the response. If this parameter is specified, only these source fields are returned. You can exclude fields from this subset using the `_source_excludes` query parameter. If the `_source` parameter is `false`, this parameter is ignored. API name: _source_includes
func (*Explain) Source_ ¶
Source_ `True` or `false` to return the `_source` field or not or a list of fields to return. API name: _source
func (*Explain) StoredFields ¶
StoredFields A comma-separated list of stored fields to return in the response. API name: stored_fields
type NewExplain ¶
NewExplain type alias for index.
func NewExplainFunc ¶
func NewExplainFunc(tp elastictransport.Interface) NewExplain
NewExplainFunc returns a new instance of Explain with the provided transport. Used in the index of the library this allows to retrieve every apis in once place.
type Request ¶
type Request struct {
// Query Defines the search definition using the Query DSL.
Query *types.Query `json:"query,omitempty"`
}
Request holds the request body struct for the package explain
type Response ¶ added in v8.7.0
type Response struct {
Explanation *types.ExplanationDetail `json:"explanation,omitempty"`
Get *types.InlineGet `json:"get,omitempty"`
Id_ string `json:"_id"`
Index_ string `json:"_index"`
Matched bool `json:"matched"`
}
Response holds the response body struct for the package explain
Source Files