putcohere

Documentation

Overview

Create a Cohere inference endpoint.

Create an inference endpoint to perform an inference task with the `cohere` service.

Index

• Variables
• type NewPutCohere
  • func NewPutCohereFunc(tp elastictransport.Interface) NewPutCohere
• type PutCohere
  • func New(tp elastictransport.Interface) *PutCohere
  • func (r *PutCohere) ChunkingSettings(chunkingsettings *types.InferenceChunkingSettings) *PutCohere
  • func (r PutCohere) Do(providedCtx context.Context) (*Response, error)
  • func (r *PutCohere) ErrorTrace(errortrace bool) *PutCohere
  • func (r *PutCohere) FilterPath(filterpaths ...string) *PutCohere
  • func (r *PutCohere) Header(key, value string) *PutCohere
  • func (r *PutCohere) HttpRequest(ctx context.Context) (*http.Request, error)
  • func (r *PutCohere) Human(human bool) *PutCohere
  • func (r PutCohere) Perform(providedCtx context.Context) (*http.Response, error)
  • func (r *PutCohere) Pretty(pretty bool) *PutCohere
  • func (r *PutCohere) Raw(raw io.Reader) *PutCohere
  • func (r *PutCohere) Request(req *Request) *PutCohere
  • func (r *PutCohere) Service(service cohereservicetype.CohereServiceType) *PutCohere
  • func (r *PutCohere) ServiceSettings(servicesettings *types.CohereServiceSettings) *PutCohere
  • func (r *PutCohere) TaskSettings(tasksettings *types.CohereTaskSettings) *PutCohere
• 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 NewPutCohere

type NewPutCohere func(tasktype, cohereinferenceid string) *PutCohere

NewPutCohere type alias for index.

func NewPutCohereFunc

func NewPutCohereFunc(tp elastictransport.Interface) NewPutCohere

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

type PutCohere

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

func New

func New(tp elastictransport.Interface) *PutCohere

Create a Cohere inference endpoint.

Create an inference endpoint to perform an inference task with the `cohere` service.

https://www.elastic.co/guide/en/elasticsearch/reference/current/infer-service-cohere.html

func (*PutCohere) ChunkingSettings

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

ChunkingSettings The chunking configuration object. API name: chunking_settings

func (PutCohere) Do

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

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

func (*PutCohere) ErrorTrace

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

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

func (*PutCohere) FilterPath

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

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

func (*PutCohere) Header

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

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

func (*PutCohere) HttpRequest

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

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

func (*PutCohere) Human

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

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

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

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

func (*PutCohere) Pretty

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

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

func (*PutCohere) Raw

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

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

func (*PutCohere) Request

func (r *PutCohere) Request(req *Request) *PutCohere

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

func (*PutCohere) Service

func (r *PutCohere) Service(service cohereservicetype.CohereServiceType) *PutCohere

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

func (*PutCohere) ServiceSettings

func (r *PutCohere) ServiceSettings(servicesettings *types.CohereServiceSettings) *PutCohere

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

func (*PutCohere) TaskSettings

func (r *PutCohere) TaskSettings(tasksettings *types.CohereTaskSettings) *PutCohere

TaskSettings Settings to configure the inference task. These settings are specific to the task type you specified. API name: task_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,
	// `cohere`.
	Service cohereservicetype.CohereServiceType `json:"service"`
	// ServiceSettings Settings used to install the inference model.
	// These settings are specific to the `cohere` service.
	ServiceSettings types.CohereServiceSettings `json:"service_settings"`
	// TaskSettings Settings to configure the inference task.
	// These settings are specific to the task type you specified.
	TaskSettings *types.CohereTaskSettings `json:"task_settings,omitempty"`
}

Request holds the request body struct for the package putcohere

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/inference/put_cohere/PutCohereRequest.ts#L30-L78

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 tasktypecohere.TaskTypeCohere `json:"task_type"`
}

Response holds the response body struct for the package putcohere

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

func NewResponse

func NewResponse() *Response

NewResponse returns a Response