puttrainedmodelvocabulary

package
v9.0.0 Latest Latest
Warning

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

Go to latest
Published: Apr 17, 2025 License: Apache-2.0 Imports: 12 Imported by: 0

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

Constants

This section is empty.

Variables

View Source
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 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

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/docs/api/doc/elasticsearch/v9/operation/operation-ml-put-trained-model-vocabulary

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

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

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

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

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

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

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

func (*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

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/52c473efb1fb5320a5bac12572d0b285882862fb/specification/ml/put_trained_model_vocabulary/MlPutTrainedModelVocabularyRequest.ts#L24-L68

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/52c473efb1fb5320a5bac12572d0b285882862fb/specification/ml/put_trained_model_vocabulary/MlPutTrainedModelVocabularyResponse.ts#L22-L25

func NewResponse

func NewResponse() *Response

NewResponse returns a Response

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL