analyze

Documentation

Overview

Performs the analysis process on a text and return the tokens breakdown of the text.

Index

• Variables
• type Analyze
  • func New(tp elastictransport.Interface) *Analyze
  • func (r Analyze) Do(ctx context.Context) (*http.Response, error)
  • func (r *Analyze) Header(key, value string) *Analyze
  • func (r *Analyze) HttpRequest(ctx context.Context) (*http.Request, error)
  • func (r *Analyze) Index(v string) *Analyze
  • func (r *Analyze) Raw(raw json.RawMessage) *Analyze
  • func (r *Analyze) Request(req *Request) *Analyze
• type NewAnalyze
  • func NewAnalyzeFunc(tp elastictransport.Interface) NewAnalyze
• type Request
• type RequestBuilder
  • func NewRequestBuilder() *RequestBuilder
  • func (rb *RequestBuilder) Analyzer(analyzer string) *RequestBuilder
  • func (rb *RequestBuilder) Attributes(attributes ...string) *RequestBuilder
  • func (rb *RequestBuilder) Build() *Request
  • func (rb *RequestBuilder) CharFilter(char_filter ...types.CharFilter) *RequestBuilder
  • func (rb *RequestBuilder) Explain(explain bool) *RequestBuilder
  • func (rb *RequestBuilder) Field(field types.Field) *RequestBuilder
  • func (rb *RequestBuilder) Filter(filter ...types.TokenFilter) *RequestBuilder
  • func (rb *RequestBuilder) FromJSON(data string) (*Request, error)
  • func (rb *RequestBuilder) Normalizer(normalizer string) *RequestBuilder
  • func (rb *RequestBuilder) Text(text *types.TextToAnalyzeBuilder) *RequestBuilder
  • func (rb *RequestBuilder) Tokenizer(tokenizer *types.TokenizerBuilder) *RequestBuilder

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.

Types

type Analyze

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

func New

func New(tp elastictransport.Interface) *Analyze

Performs the analysis process on a text and return the tokens breakdown of the text.

https://www.elastic.co/guide/en/elasticsearch/reference/master/indices-analyze.html

func (Analyze) Do

func (r Analyze) Do(ctx context.Context) (*http.Response, error)

Do runs the http.Request through the provided transport.

func (*Analyze) Header

func (r *Analyze) Header(key, value string) *Analyze

Header set a key, value pair in the Analyze headers map.

func (*Analyze) HttpRequest

func (r *Analyze) HttpRequest(ctx context.Context) (*http.Request, error)

HttpRequest returns the http.Request object built from the given parameters.

func (*Analyze) Index

func (r *Analyze) Index(v string) *Analyze

Index The name of the index to scope the operation API Name: index

func (*Analyze) Raw

func (r *Analyze) Raw(raw json.RawMessage) *Analyze

Raw takes a json payload as input which is then passed to the http.Request If specified Raw takes precedence on Request method.

func (*Analyze) Request

func (r *Analyze) Request(req *Request) *Analyze

Request allows to set the request property with the appropriate payload.

type NewAnalyze

type NewAnalyze func() *Analyze

NewAnalyze type alias for index.

func NewAnalyzeFunc

func NewAnalyzeFunc(tp elastictransport.Interface) NewAnalyze

NewAnalyzeFunc returns a new instance of Analyze 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 {
	Analyzer *string `json:"analyzer,omitempty"`

	Attributes []string `json:"attributes,omitempty"`

	CharFilter []types.CharFilter `json:"char_filter,omitempty"`

	Explain *bool `json:"explain,omitempty"`

	Field *types.Field `json:"field,omitempty"`

	Filter []types.TokenFilter `json:"filter,omitempty"`

	Normalizer *string `json:"normalizer,omitempty"`

	Text *types.TextToAnalyze `json:"text,omitempty"`

	Tokenizer *types.Tokenizer `json:"tokenizer,omitempty"`
}

Request holds the request body struct for the package analyze

https://github.com/elastic/elasticsearch-specification/blob/1b56d7e58f5c59f05d1641c6d6a8117c5e01d741/specification/indices/analyze/IndicesAnalyzeRequest.ts#L27-L47

type RequestBuilder

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

RequestBuilder is the builder API for the analyze.Request

func NewRequestBuilder

func NewRequestBuilder() *RequestBuilder

NewRequest returns a RequestBuilder which can be chained and built to retrieve a RequestBuilder

func (*RequestBuilder) Analyzer

func (rb *RequestBuilder) Analyzer(analyzer string) *RequestBuilder

func (*RequestBuilder) Attributes

func (rb *RequestBuilder) Attributes(attributes ...string) *RequestBuilder

func (*RequestBuilder) Build

func (rb *RequestBuilder) Build() *Request

Build finalize the chain and returns the Request struct.

func (*RequestBuilder) CharFilter

func (rb *RequestBuilder) CharFilter(char_filter ...types.CharFilter) *RequestBuilder

func (*RequestBuilder) Explain

func (rb *RequestBuilder) Explain(explain bool) *RequestBuilder

func (*RequestBuilder) Field

func (rb *RequestBuilder) Field(field types.Field) *RequestBuilder

func (*RequestBuilder) Filter

func (rb *RequestBuilder) Filter(filter ...types.TokenFilter) *RequestBuilder

func (*RequestBuilder) FromJSON

func (rb *RequestBuilder) FromJSON(data string) (*Request, error)

FromJSON allows to load an arbitrary json into the request structure

func (*RequestBuilder) Normalizer

func (rb *RequestBuilder) Normalizer(normalizer string) *RequestBuilder

func (*RequestBuilder) Text

func (rb *RequestBuilder) Text(text *types.TextToAnalyzeBuilder) *RequestBuilder

func (*RequestBuilder) Tokenizer

func (rb *RequestBuilder) Tokenizer(tokenizer *types.TokenizerBuilder) *RequestBuilder