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) Analyzer(analyzer string) *Analyze
  • func (r *Analyze) Attributes(attributes ...string) *Analyze
  • func (r *Analyze) CharFilter(charfilters ...types.CharFilter) *Analyze
  • func (r Analyze) Do(ctx context.Context) (*Response, error)
  • func (r *Analyze) Explain(explain bool) *Analyze
  • func (r *Analyze) Field(field string) *Analyze
  • func (r *Analyze) Filter(filters ...types.TokenFilter) *Analyze
  • func (r *Analyze) Header(key, value string) *Analyze
  • func (r *Analyze) HttpRequest(ctx context.Context) (*http.Request, error)
  • func (r *Analyze) Index(index string) *Analyze
  • func (r *Analyze) Normalizer(normalizer string) *Analyze
  • func (r Analyze) Perform(ctx context.Context) (*http.Response, error)
  • func (r *Analyze) Raw(raw io.Reader) *Analyze
  • func (r *Analyze) Request(req *Request) *Analyze
  • func (r *Analyze) Text(texttoanalyzes ...string) *Analyze
  • func (r *Analyze) Tokenizer(tokenizer types.Tokenizer) *Analyze
• type NewAnalyze
  • func NewAnalyzeFunc(tp elastictransport.Interface) NewAnalyze
• type Request
  • func NewRequest() *Request
  • func (r *Request) FromJSON(data string) (*Request, error)
• type Response
  • func NewResponse() *Response

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) Analyzer

func (r *Analyze) Analyzer(analyzer string) *Analyze

API name: analyzer

func (*Analyze) Attributes

func (r *Analyze) Attributes(attributes ...string) *Analyze

API name: attributes

func (*Analyze) CharFilter

func (r *Analyze) CharFilter(charfilters ...types.CharFilter) *Analyze

API name: char_filter

func (Analyze) Do

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

Do runs the request through the transport, handle the response and returns a analyze.Response

func (*Analyze) Explain

func (r *Analyze) Explain(explain bool) *Analyze

API name: explain

func (*Analyze) Field

func (r *Analyze) Field(field string) *Analyze

API name: field

func (*Analyze) Filter

func (r *Analyze) Filter(filters ...types.TokenFilter) *Analyze

API name: filter

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(index string) *Analyze

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

func (*Analyze) Normalizer

func (r *Analyze) Normalizer(normalizer string) *Analyze

API name: normalizer

func (Analyze) Perform

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

Perform runs the http.Request through the provided transport and returns an http.Response.

func (*Analyze) Raw

func (r *Analyze) Raw(raw io.Reader) *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.

func (*Analyze) Text

func (r *Analyze) Text(texttoanalyzes ...string) *Analyze

API name: text

func (*Analyze) Tokenizer

func (r *Analyze) Tokenizer(tokenizer types.Tokenizer) *Analyze

API name: tokenizer

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      *string             `json:"field,omitempty"`
	Filter     []types.TokenFilter `json:"filter,omitempty"`
	Normalizer *string             `json:"normalizer,omitempty"`
	Text       []string            `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/656080dee792f93a849cd7fbf566f528f858a5ea/specification/indices/analyze/IndicesAnalyzeRequest.ts#L27-L47

func NewRequest

func NewRequest() *Request

NewRequest returns a Request

func (*Request) FromJSON

func (r *Request) FromJSON(data string) (*Request, error)

FromJSON allows to load an arbitrary json into the request structure

type Response

type Response struct {
	Detail *types.AnalyzeDetail `json:"detail,omitempty"`
	Tokens []types.AnalyzeToken `json:"tokens,omitempty"`
}

func NewResponse

func NewResponse() *Response

NewResponse returns a Response