putmistral

Documentation

Overview

Create a Mistral inference endpoint.

Creates an inference endpoint to perform an inference task with the `mistral` service.

Index

• Variables
• type NewPutMistral
  • func NewPutMistralFunc(tp elastictransport.Interface) NewPutMistral
• type PutMistral
  • func New(tp elastictransport.Interface) *PutMistral
  • func (r *PutMistral) ChunkingSettings(chunkingsettings *types.InferenceChunkingSettings) *PutMistral
  • func (r PutMistral) Do(providedCtx context.Context) (*Response, error)
  • func (r *PutMistral) ErrorTrace(errortrace bool) *PutMistral
  • func (r *PutMistral) FilterPath(filterpaths ...string) *PutMistral
  • func (r *PutMistral) Header(key, value string) *PutMistral
  • func (r *PutMistral) HttpRequest(ctx context.Context) (*http.Request, error)
  • func (r *PutMistral) Human(human bool) *PutMistral
  • func (r PutMistral) Perform(providedCtx context.Context) (*http.Response, error)
  • func (r *PutMistral) Pretty(pretty bool) *PutMistral
  • func (r *PutMistral) Raw(raw io.Reader) *PutMistral
  • func (r *PutMistral) Request(req *Request) *PutMistral
  • func (r *PutMistral) Service(service mistralservicetype.MistralServiceType) *PutMistral
  • func (r *PutMistral) ServiceSettings(servicesettings *types.MistralServiceSettings) *PutMistral
• 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 NewPutMistral

type NewPutMistral func(tasktype, mistralinferenceid string) *PutMistral

NewPutMistral type alias for index.

func NewPutMistralFunc

func NewPutMistralFunc(tp elastictransport.Interface) NewPutMistral

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

type PutMistral

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

func New

func New(tp elastictransport.Interface) *PutMistral

Create a Mistral inference endpoint.

Creates an inference endpoint to perform an inference task with the `mistral` service.

https://www.elastic.co/guide/en/elasticsearch/reference/{brnach}/infer-service-mistral.html

func (*PutMistral) ChunkingSettings

func (r *PutMistral) ChunkingSettings(chunkingsettings *types.InferenceChunkingSettings) *PutMistral

ChunkingSettings The chunking configuration object. API name: chunking_settings

func (PutMistral) Do

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

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

func (*PutMistral) ErrorTrace

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

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

func (*PutMistral) FilterPath

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

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

func (*PutMistral) Header

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

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

func (*PutMistral) HttpRequest

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

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

func (*PutMistral) Human

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

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 (PutMistral) Perform

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

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

func (*PutMistral) Pretty

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

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

func (*PutMistral) Raw

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

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

func (*PutMistral) Request

func (r *PutMistral) Request(req *Request) *PutMistral

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

func (*PutMistral) Service

func (r *PutMistral) Service(service mistralservicetype.MistralServiceType) *PutMistral

Service The type of service supported for the specified task type. In this case, `mistral`. API name: service

func (*PutMistral) ServiceSettings

func (r *PutMistral) ServiceSettings(servicesettings *types.MistralServiceSettings) *PutMistral

ServiceSettings Settings used to install the inference model. These settings are specific to the `mistral` service. API name: service_settings

type Request

type Request struct {

	// ChunkingSettings The chunking configuration object.
	ChunkingSettings *types.InferenceChunkingSettings `json:"chunking_settings,omitempty"`
	// Service The type of service supported for the specified task type. In this case,
	// `mistral`.
	Service mistralservicetype.MistralServiceType `json:"service"`
	// ServiceSettings Settings used to install the inference model. These settings are specific to
	// the `mistral` service.
	ServiceSettings types.MistralServiceSettings `json:"service_settings"`
}

Request holds the request body struct for the package putmistral

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/inference/put_mistral/PutMistralRequest.ts#L29-L72

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 {

	// ChunkingSettings Chunking configuration object
	ChunkingSettings *types.InferenceChunkingSettings `json:"chunking_settings,omitempty"`
	// InferenceId The inference Id
	InferenceId string `json:"inference_id"`
	// Service The service type
	Service string `json:"service"`
	// ServiceSettings Settings specific to the service
	ServiceSettings json.RawMessage `json:"service_settings"`
	// TaskSettings Task settings specific to the service and task type
	TaskSettings json.RawMessage `json:"task_settings,omitempty"`
	// TaskType The task type
	TaskType tasktypemistral.TaskTypeMistral `json:"task_type"`
}

Response holds the response body struct for the package putmistral

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/inference/put_mistral/PutMistralResponse.ts#L22-L25

func NewResponse

func NewResponse() *Response

NewResponse returns a Response