putopenai

Documentation

Overview

Create an OpenAI inference endpoint.

Create an inference endpoint to perform an inference task with the `openai` service or `openai` compatible APIs.

Index

• Variables
• type NewPutOpenai
  • func NewPutOpenaiFunc(tp elastictransport.Interface) NewPutOpenai
• type PutOpenai
  • func New(tp elastictransport.Interface) *PutOpenai
  • func (r *PutOpenai) ChunkingSettings(chunkingsettings *types.InferenceChunkingSettings) *PutOpenai
  • func (r PutOpenai) Do(providedCtx context.Context) (*Response, error)
  • func (r *PutOpenai) ErrorTrace(errortrace bool) *PutOpenai
  • func (r *PutOpenai) FilterPath(filterpaths ...string) *PutOpenai
  • func (r *PutOpenai) Header(key, value string) *PutOpenai
  • func (r *PutOpenai) HttpRequest(ctx context.Context) (*http.Request, error)
  • func (r *PutOpenai) Human(human bool) *PutOpenai
  • func (r PutOpenai) Perform(providedCtx context.Context) (*http.Response, error)
  • func (r *PutOpenai) Pretty(pretty bool) *PutOpenai
  • func (r *PutOpenai) Raw(raw io.Reader) *PutOpenai
  • func (r *PutOpenai) Request(req *Request) *PutOpenai
  • func (r *PutOpenai) Service(service openaiservicetype.OpenAIServiceType) *PutOpenai
  • func (r *PutOpenai) ServiceSettings(servicesettings *types.OpenAIServiceSettings) *PutOpenai
  • func (r *PutOpenai) TaskSettings(tasksettings *types.OpenAITaskSettings) *PutOpenai
  • func (r *PutOpenai) Timeout(duration string) *PutOpenai
• 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 NewPutOpenai

type NewPutOpenai func(tasktype, openaiinferenceid string) *PutOpenai

NewPutOpenai type alias for index.

func NewPutOpenaiFunc

func NewPutOpenaiFunc(tp elastictransport.Interface) NewPutOpenai

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

type PutOpenai

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

func New

func New(tp elastictransport.Interface) *PutOpenai

Create an OpenAI inference endpoint.

Create an inference endpoint to perform an inference task with the `openai` service or `openai` compatible APIs.

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

func (*PutOpenai) ChunkingSettings

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

ChunkingSettings The chunking configuration object. API name: chunking_settings

func (PutOpenai) Do

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

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

func (*PutOpenai) ErrorTrace

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

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

func (*PutOpenai) FilterPath

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

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

func (*PutOpenai) Header

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

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

func (*PutOpenai) HttpRequest

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

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

func (*PutOpenai) Human

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

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

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

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

func (*PutOpenai) Pretty

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

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

func (*PutOpenai) Raw

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

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

func (*PutOpenai) Request

func (r *PutOpenai) Request(req *Request) *PutOpenai

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

func (*PutOpenai) Service

func (r *PutOpenai) Service(service openaiservicetype.OpenAIServiceType) *PutOpenai

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

func (*PutOpenai) ServiceSettings

func (r *PutOpenai) ServiceSettings(servicesettings *types.OpenAIServiceSettings) *PutOpenai

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

func (*PutOpenai) TaskSettings

func (r *PutOpenai) TaskSettings(tasksettings *types.OpenAITaskSettings) *PutOpenai

TaskSettings Settings to configure the inference task. These settings are specific to the task type you specified. API name: task_settings

func (*PutOpenai) Timeout

func (r *PutOpenai) Timeout(duration string) *PutOpenai

Timeout Specifies the amount of time to wait for the inference endpoint to be created. API name: timeout

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,
	// `openai`.
	Service openaiservicetype.OpenAIServiceType `json:"service"`
	// ServiceSettings Settings used to install the inference model. These settings are specific to
	// the `openai` service.
	ServiceSettings types.OpenAIServiceSettings `json:"service_settings"`
	// TaskSettings Settings to configure the inference task.
	// These settings are specific to the task type you specified.
	TaskSettings *types.OpenAITaskSettings `json:"task_settings,omitempty"`
}

Request holds the request body struct for the package putopenai

https://github.com/elastic/elasticsearch-specification/blob/470b4b9aaaa25cae633ec690e54b725c6fc939c7/specification/inference/put_openai/PutOpenAiRequest.ts#L31-L86

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 tasktypeopenai.TaskTypeOpenAI `json:"task_type"`
}

Response holds the response body struct for the package putopenai

https://github.com/elastic/elasticsearch-specification/blob/470b4b9aaaa25cae633ec690e54b725c6fc939c7/specification/inference/put_openai/PutOpenAiResponse.ts#L22-L24

func NewResponse

func NewResponse() *Response

NewResponse returns a Response