puttrainedmodelvocabulary

Documentation

Overview

Create a trained model vocabulary. This API is supported only for natural language processing (NLP) models. The vocabulary is stored in the index as described in `inference_config.*.vocabulary` of the trained model definition.

Index

• Variables
• type NewPutTrainedModelVocabulary
  • func NewPutTrainedModelVocabularyFunc(tp elastictransport.Interface) NewPutTrainedModelVocabulary
• type PutTrainedModelVocabulary
  • func New(tp elastictransport.Interface) *PutTrainedModelVocabulary
  • func (r PutTrainedModelVocabulary) Do(providedCtx context.Context) (*Response, error)
  • func (r *PutTrainedModelVocabulary) ErrorTrace(errortrace bool) *PutTrainedModelVocabulary
  • func (r *PutTrainedModelVocabulary) FilterPath(filterpaths ...string) *PutTrainedModelVocabulary
  • func (r *PutTrainedModelVocabulary) Header(key, value string) *PutTrainedModelVocabulary
  • func (r *PutTrainedModelVocabulary) HttpRequest(ctx context.Context) (*http.Request, error)
  • func (r *PutTrainedModelVocabulary) Human(human bool) *PutTrainedModelVocabulary
  • func (r *PutTrainedModelVocabulary) Merges(merges ...string) *PutTrainedModelVocabulary
  • func (r PutTrainedModelVocabulary) Perform(providedCtx context.Context) (*http.Response, error)
  • func (r *PutTrainedModelVocabulary) Pretty(pretty bool) *PutTrainedModelVocabulary
  • func (r *PutTrainedModelVocabulary) Raw(raw io.Reader) *PutTrainedModelVocabulary
  • func (r *PutTrainedModelVocabulary) Request(req *Request) *PutTrainedModelVocabulary
  • func (r *PutTrainedModelVocabulary) Scores(scores ...types.Float64) *PutTrainedModelVocabulary
  • func (r *PutTrainedModelVocabulary) Vocabulary(vocabularies ...string) *PutTrainedModelVocabulary
• 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 NewPutTrainedModelVocabulary

type NewPutTrainedModelVocabulary func(modelid string) *PutTrainedModelVocabulary

NewPutTrainedModelVocabulary type alias for index.

func NewPutTrainedModelVocabularyFunc

func NewPutTrainedModelVocabularyFunc(tp elastictransport.Interface) NewPutTrainedModelVocabulary

NewPutTrainedModelVocabularyFunc returns a new instance of PutTrainedModelVocabulary with the provided transport. Used in the index of the library this allows to retrieve every apis in once place.

type PutTrainedModelVocabulary

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

func New

func New(tp elastictransport.Interface) *PutTrainedModelVocabulary

Create a trained model vocabulary. This API is supported only for natural language processing (NLP) models. The vocabulary is stored in the index as described in `inference_config.*.vocabulary` of the trained model definition.

https://www.elastic.co/guide/en/elasticsearch/reference/current/put-trained-model-vocabulary.html

func (PutTrainedModelVocabulary) Do

func (r PutTrainedModelVocabulary) Do(providedCtx context.Context) (*Response, error)

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

func (*PutTrainedModelVocabulary) ErrorTrace

func (r *PutTrainedModelVocabulary) ErrorTrace(errortrace bool) *PutTrainedModelVocabulary

ErrorTrace When set to `true` Elasticsearch will include the full stack trace of errors when they occur. API name: error_trace

func (*PutTrainedModelVocabulary) FilterPath

func (r *PutTrainedModelVocabulary) FilterPath(filterpaths ...string) *PutTrainedModelVocabulary

FilterPath Comma-separated list of filters in dot notation which reduce the response returned by Elasticsearch. API name: filter_path

func (*PutTrainedModelVocabulary) Header

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

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

func (*PutTrainedModelVocabulary) HttpRequest

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

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

func (*PutTrainedModelVocabulary) Human

func (r *PutTrainedModelVocabulary) Human(human bool) *PutTrainedModelVocabulary

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 (*PutTrainedModelVocabulary) Merges

func (r *PutTrainedModelVocabulary) Merges(merges ...string) *PutTrainedModelVocabulary

Merges The optional model merges if required by the tokenizer. API name: merges

func (PutTrainedModelVocabulary) Perform

func (r PutTrainedModelVocabulary) Perform(providedCtx context.Context) (*http.Response, error)

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

func (*PutTrainedModelVocabulary) Pretty

func (r *PutTrainedModelVocabulary) Pretty(pretty bool) *PutTrainedModelVocabulary

Pretty If set to `true` the returned JSON will be "pretty-formatted". Only use this option for debugging only. API name: pretty

func (*PutTrainedModelVocabulary) Raw

func (r *PutTrainedModelVocabulary) Raw(raw io.Reader) *PutTrainedModelVocabulary

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

func (*PutTrainedModelVocabulary) Request

func (r *PutTrainedModelVocabulary) Request(req *Request) *PutTrainedModelVocabulary

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

func (*PutTrainedModelVocabulary) Scores

func (r *PutTrainedModelVocabulary) Scores(scores ...types.Float64) *PutTrainedModelVocabulary

Scores The optional vocabulary value scores if required by the tokenizer. API name: scores

func (*PutTrainedModelVocabulary) Vocabulary

func (r *PutTrainedModelVocabulary) Vocabulary(vocabularies ...string) *PutTrainedModelVocabulary

Vocabulary The model vocabulary, which must not be empty. API name: vocabulary

type Request

type Request struct {

	// Merges The optional model merges if required by the tokenizer.
	Merges []string `json:"merges,omitempty"`
	// Scores The optional vocabulary value scores if required by the tokenizer.
	Scores []types.Float64 `json:"scores,omitempty"`
	// Vocabulary The model vocabulary, which must not be empty.
	Vocabulary []string `json:"vocabulary"`
}

Request holds the request body struct for the package puttrainedmodelvocabulary

https://github.com/elastic/elasticsearch-specification/blob/2f823ff6fcaa7f3f0f9b990dc90512d8901e5d64/specification/ml/put_trained_model_vocabulary/MlPutTrainedModelVocabularyRequest.ts#L24-L61

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 {

	// Acknowledged For a successful response, this value is always true. On failure, an
	// exception is returned instead.
	Acknowledged bool `json:"acknowledged"`
}

Response holds the response body struct for the package puttrainedmodelvocabulary

https://github.com/elastic/elasticsearch-specification/blob/2f823ff6fcaa7f3f0f9b990dc90512d8901e5d64/specification/ml/put_trained_model_vocabulary/MlPutTrainedModelVocabularyResponse.ts#L22-L24

func NewResponse

func NewResponse() *Response

NewResponse returns a Response