Package co.elastic.clients.elasticsearch.inference

Class CompletionToolFunction.Builder

java.lang.Object

co.elastic.clients.util.ObjectBuilderBase

co.elastic.clients.util.WithJsonObjectBuilderBase<CompletionToolFunction.Builder>

co.elastic.clients.elasticsearch.inference.CompletionToolFunction.Builder

All Implemented Interfaces:

WithJson<CompletionToolFunction.Builder>, ObjectBuilder<CompletionToolFunction>

Enclosing class:

CompletionToolFunction

public static class CompletionToolFunction.Builder
extends WithJsonObjectBuilderBase<CompletionToolFunction.Builder>
implements ObjectBuilder<CompletionToolFunction>

Builder for CompletionToolFunction.

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
CompletionToolFunction	build()	Builds a CompletionToolFunction.
final CompletionToolFunction.Builder	description(String value)	A description of what the function does.
final CompletionToolFunction.Builder	name(String value)	Required - The name of the function.
final CompletionToolFunction.Builder	parameters(JsonData value)	The parameters the functional accepts.
protected CompletionToolFunction.Builder	self()
final CompletionToolFunction.Builder	strict(Boolean value)	Whether to enable schema adherence when generating the function call.

Methods inherited from class co.elastic.clients.util.WithJsonObjectBuilderBase

withJson

Methods inherited from class co.elastic.clients.util.ObjectBuilderBase

_checkSingleUse, _listAdd, _listAddAll, _mapPut, _mapPutAll

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface co.elastic.clients.json.WithJson

withJson, withJson

Constructor Details

Builder

public Builder()

Method Details

description

public final CompletionToolFunction.Builder description(@Nullable
 String value)

A description of what the function does. This is used by the model to choose when and how to call the function.

API name: description

name

public final CompletionToolFunction.Builder name(String value)

Required - The name of the function.

API name: name

parameters

public final CompletionToolFunction.Builder parameters(@Nullable
 JsonData value)

The parameters the functional accepts. This should be formatted as a JSON object.

API name: parameters

strict

public final CompletionToolFunction.Builder strict(@Nullable
 Boolean value)

Whether to enable schema adherence when generating the function call.

API name: strict

self

protected CompletionToolFunction.Builder self()

Specified by:

self in class WithJsonObjectBuilderBase<CompletionToolFunction.Builder>

build

public CompletionToolFunction build()

Builds a CompletionToolFunction.

Specified by:

build in interface ObjectBuilder<CompletionToolFunction>

Throws:

NullPointerException - if some of the required fields are null.