Documentation
      ¶
    
    
  
    
  
    Overview ¶
Create an Anthropic inference endpoint.
Create an inference endpoint to perform an inference task with the `anthropic` service.
Index ¶
- Variables
 - type NewPutAnthropic
 - type PutAnthropic
 - func (r *PutAnthropic) ChunkingSettings(chunkingsettings types.InferenceChunkingSettingsVariant) *PutAnthropic
 - func (r PutAnthropic) Do(providedCtx context.Context) (*Response, error)
 - func (r *PutAnthropic) ErrorTrace(errortrace bool) *PutAnthropic
 - func (r *PutAnthropic) FilterPath(filterpaths ...string) *PutAnthropic
 - func (r *PutAnthropic) Header(key, value string) *PutAnthropic
 - func (r *PutAnthropic) HttpRequest(ctx context.Context) (*http.Request, error)
 - func (r *PutAnthropic) Human(human bool) *PutAnthropic
 - func (r PutAnthropic) Perform(providedCtx context.Context) (*http.Response, error)
 - func (r *PutAnthropic) Pretty(pretty bool) *PutAnthropic
 - func (r *PutAnthropic) Raw(raw io.Reader) *PutAnthropic
 - func (r *PutAnthropic) Request(req *Request) *PutAnthropic
 - func (r *PutAnthropic) Service(service anthropicservicetype.AnthropicServiceType) *PutAnthropic
 - func (r *PutAnthropic) ServiceSettings(servicesettings types.AnthropicServiceSettingsVariant) *PutAnthropic
 - func (r *PutAnthropic) TaskSettings(tasksettings types.AnthropicTaskSettingsVariant) *PutAnthropic
 - func (r *PutAnthropic) Timeout(duration string) *PutAnthropic
 
- type Request
 - type Response
 
Constants ¶
This section is empty.
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.
Functions ¶
This section is empty.
Types ¶
type NewPutAnthropic ¶
type NewPutAnthropic func(tasktype, anthropicinferenceid string) *PutAnthropic
NewPutAnthropic type alias for index.
func NewPutAnthropicFunc ¶
func NewPutAnthropicFunc(tp elastictransport.Interface) NewPutAnthropic
NewPutAnthropicFunc returns a new instance of PutAnthropic with the provided transport. Used in the index of the library this allows to retrieve every apis in once place.
type PutAnthropic ¶
type PutAnthropic struct {
	// contains filtered or unexported fields
}
    func New ¶
func New(tp elastictransport.Interface) *PutAnthropic
Create an Anthropic inference endpoint.
Create an inference endpoint to perform an inference task with the `anthropic` service.
https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-inference-put-anthropic
func (*PutAnthropic) ChunkingSettings ¶
func (r *PutAnthropic) ChunkingSettings(chunkingsettings types.InferenceChunkingSettingsVariant) *PutAnthropic
The chunking configuration object. API name: chunking_settings
func (PutAnthropic) Do ¶
func (r PutAnthropic) Do(providedCtx context.Context) (*Response, error)
Do runs the request through the transport, handle the response and returns a putanthropic.Response
func (*PutAnthropic) ErrorTrace ¶
func (r *PutAnthropic) ErrorTrace(errortrace bool) *PutAnthropic
ErrorTrace When set to `true` Elasticsearch will include the full stack trace of errors when they occur. API name: error_trace
func (*PutAnthropic) FilterPath ¶
func (r *PutAnthropic) FilterPath(filterpaths ...string) *PutAnthropic
FilterPath Comma-separated list of filters in dot notation which reduce the response returned by Elasticsearch. API name: filter_path
func (*PutAnthropic) Header ¶
func (r *PutAnthropic) Header(key, value string) *PutAnthropic
Header set a key, value pair in the PutAnthropic headers map.
func (*PutAnthropic) HttpRequest ¶
HttpRequest returns the http.Request object built from the given parameters.
func (*PutAnthropic) Human ¶
func (r *PutAnthropic) Human(human bool) *PutAnthropic
Human When set to `true` will return statistics in a format suitable for humans. For example `"exists_time": "1h"` for humans and `"exists_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 (PutAnthropic) Perform ¶
Perform runs the http.Request through the provided transport and returns an http.Response.
func (*PutAnthropic) Pretty ¶
func (r *PutAnthropic) Pretty(pretty bool) *PutAnthropic
Pretty If set to `true` the returned JSON will be "pretty-formatted". Only use this option for debugging only. API name: pretty
func (*PutAnthropic) Raw ¶
func (r *PutAnthropic) Raw(raw io.Reader) *PutAnthropic
Raw takes a json payload as input which is then passed to the http.Request If specified Raw takes precedence on Request method.
func (*PutAnthropic) Request ¶
func (r *PutAnthropic) Request(req *Request) *PutAnthropic
Request allows to set the request property with the appropriate payload.
func (*PutAnthropic) Service ¶
func (r *PutAnthropic) Service(service anthropicservicetype.AnthropicServiceType) *PutAnthropic
The type of service supported for the specified task type. In this case, `anthropic`. API name: service
func (*PutAnthropic) ServiceSettings ¶
func (r *PutAnthropic) ServiceSettings(servicesettings types.AnthropicServiceSettingsVariant) *PutAnthropic
Settings used to install the inference model. These settings are specific to the `watsonxai` service. API name: service_settings
func (*PutAnthropic) TaskSettings ¶
func (r *PutAnthropic) TaskSettings(tasksettings types.AnthropicTaskSettingsVariant) *PutAnthropic
Settings to configure the inference task. These settings are specific to the task type you specified. API name: task_settings
func (*PutAnthropic) Timeout ¶ added in v9.0.1
func (r *PutAnthropic) Timeout(duration string) *PutAnthropic
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,
	// `anthropic`.
	Service anthropicservicetype.AnthropicServiceType `json:"service"`
	// ServiceSettings Settings used to install the inference model. These settings are specific to
	// the `watsonxai` service.
	ServiceSettings types.AnthropicServiceSettings `json:"service_settings"`
	// TaskSettings Settings to configure the inference task.
	// These settings are specific to the task type you specified.
	TaskSettings *types.AnthropicTaskSettings `json:"task_settings,omitempty"`
}
    Request holds the request body struct for the package putanthropic
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 tasktypeanthropic.TaskTypeAnthropic `json:"task_type"`
}
    Response holds the response body struct for the package putanthropic