putgooglevertexai

Documentation

Overview

Create a Google Vertex AI inference endpoint.

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

Index

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

type NewPutGooglevertexai func(tasktype, googlevertexaiinferenceid string) *PutGooglevertexai

NewPutGooglevertexai type alias for index.

func NewPutGooglevertexaiFunc

func NewPutGooglevertexaiFunc(tp elastictransport.Interface) NewPutGooglevertexai

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

type PutGooglevertexai

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

func New

func New(tp elastictransport.Interface) *PutGooglevertexai

Create a Google Vertex AI inference endpoint.

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

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

func (*PutGooglevertexai) ChunkingSettings

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

ChunkingSettings The chunking configuration object. API name: chunking_settings

func (PutGooglevertexai) Do

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

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

func (*PutGooglevertexai) ErrorTrace

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

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

func (*PutGooglevertexai) FilterPath

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

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

func (*PutGooglevertexai) Header

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

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

func (*PutGooglevertexai) HttpRequest

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

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

func (*PutGooglevertexai) Human

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

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

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

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

func (*PutGooglevertexai) Pretty

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

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

func (*PutGooglevertexai) Raw

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

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

func (*PutGooglevertexai) Request

func (r *PutGooglevertexai) Request(req *Request) *PutGooglevertexai

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

func (*PutGooglevertexai) Service

func (r *PutGooglevertexai) Service(service googlevertexaiservicetype.GoogleVertexAIServiceType) *PutGooglevertexai

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

func (*PutGooglevertexai) ServiceSettings

func (r *PutGooglevertexai) ServiceSettings(servicesettings *types.GoogleVertexAIServiceSettings) *PutGooglevertexai

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

func (*PutGooglevertexai) TaskSettings

func (r *PutGooglevertexai) TaskSettings(tasksettings *types.GoogleVertexAITaskSettings) *PutGooglevertexai

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

Request holds the request body struct for the package putgooglevertexai

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/inference/put_googlevertexai/PutGoogleVertexAiRequest.ts#L30-L77

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 tasktypegooglevertexai.TaskTypeGoogleVertexAI `json:"task_type"`
}

Response holds the response body struct for the package putgooglevertexai

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

func NewResponse

func NewResponse() *Response

NewResponse returns a Response