putamazonbedrock

Documentation

Overview

Create an Amazon Bedrock inference endpoint.

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

>info > You need to provide the access and secret keys only once, during the inference model creation. The get inference API does not retrieve your access or secret keys. After creating the inference model, you cannot change the associated key pairs. If you want to use a different access and secret key pair, delete the inference model and recreate it with the same name and the updated keys.

Index

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

type NewPutAmazonbedrock func(tasktype, amazonbedrockinferenceid string) *PutAmazonbedrock

NewPutAmazonbedrock type alias for index.

func NewPutAmazonbedrockFunc

func NewPutAmazonbedrockFunc(tp elastictransport.Interface) NewPutAmazonbedrock

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

type PutAmazonbedrock

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

func New

func New(tp elastictransport.Interface) *PutAmazonbedrock

Create an Amazon Bedrock inference endpoint.

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

>info > You need to provide the access and secret keys only once, during the inference model creation. The get inference API does not retrieve your access or secret keys. After creating the inference model, you cannot change the associated key pairs. If you want to use a different access and secret key pair, delete the inference model and recreate it with the same name and the updated keys.

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

func (*PutAmazonbedrock) ChunkingSettings

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

ChunkingSettings The chunking configuration object. API name: chunking_settings

func (PutAmazonbedrock) Do

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

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

func (*PutAmazonbedrock) ErrorTrace

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

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

func (*PutAmazonbedrock) FilterPath

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

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

func (*PutAmazonbedrock) Header

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

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

func (*PutAmazonbedrock) HttpRequest

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

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

func (*PutAmazonbedrock) Human

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

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

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

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

func (*PutAmazonbedrock) Pretty

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

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

func (*PutAmazonbedrock) Raw

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

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

func (*PutAmazonbedrock) Request

func (r *PutAmazonbedrock) Request(req *Request) *PutAmazonbedrock

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

func (*PutAmazonbedrock) Service

func (r *PutAmazonbedrock) Service(service amazonbedrockservicetype.AmazonBedrockServiceType) *PutAmazonbedrock

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

func (*PutAmazonbedrock) ServiceSettings

func (r *PutAmazonbedrock) ServiceSettings(servicesettings *types.AmazonBedrockServiceSettings) *PutAmazonbedrock

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

func (*PutAmazonbedrock) TaskSettings

func (r *PutAmazonbedrock) TaskSettings(tasksettings *types.AmazonBedrockTaskSettings) *PutAmazonbedrock

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

Request holds the request body struct for the package putamazonbedrock

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/inference/put_amazonbedrock/PutAmazonBedrockRequest.ts#L30-L80

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 tasktypeamazonbedrock.TaskTypeAmazonBedrock `json:"task_type"`
}

Response holds the response body struct for the package putamazonbedrock

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

func NewResponse

func NewResponse() *Response

NewResponse returns a Response