Package co.elastic.clients.elasticsearch.inference

Class CompletionToolFunction

java.lang.Object

co.elastic.clients.elasticsearch.inference.CompletionToolFunction

All Implemented Interfaces:

JsonpSerializable

@JsonpDeserializable
public class CompletionToolFunction
extends Object
implements JsonpSerializable

The completion tool function definition.

See Also:

• API specification

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	CompletionToolFunction.Builder	Builder for CompletionToolFunction.

Field Summary

Fields

Modifier and Type	Field	Description
static final JsonpDeserializer<CompletionToolFunction>	_DESERIALIZER	Json deserializer for CompletionToolFunction

Method Summary

Modifier and Type	Method	Description
final String	description()	A description of what the function does.
final String	name()	Required - The name of the function.
static CompletionToolFunction	of(Function<CompletionToolFunction.Builder,ObjectBuilder<CompletionToolFunction>> fn)
final JsonData	parameters()	The parameters the functional accepts.
void	serialize(jakarta.json.stream.JsonGenerator generator, JsonpMapper mapper)	Serialize this object to JSON.
protected void	serializeInternal(jakarta.json.stream.JsonGenerator generator, JsonpMapper mapper)
protected static void	setupCompletionToolFunctionDeserializer(ObjectDeserializer<CompletionToolFunction.Builder> op)
final Boolean	strict()	Whether to enable schema adherence when generating the function call.
String	toString()

Methods inherited from class java.lang.Object

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

Field Details

_DESERIALIZER

public static final JsonpDeserializer<CompletionToolFunction> _DESERIALIZER

Json deserializer for CompletionToolFunction

Method Details

of

public static CompletionToolFunction of(Function<CompletionToolFunction.Builder,ObjectBuilder<CompletionToolFunction>> fn)

description

@Nullable
public final String description()

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 String name()

Required - The name of the function.

API name: name

parameters

@Nullable
public final JsonData parameters()

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

API name: parameters

strict

@Nullable
public final Boolean strict()

Whether to enable schema adherence when generating the function call.

API name: strict

serialize

public void serialize(jakarta.json.stream.JsonGenerator generator,
 JsonpMapper mapper)

Serialize this object to JSON.

Specified by:

serialize in interface JsonpSerializable

serializeInternal

protected void serializeInternal(jakarta.json.stream.JsonGenerator generator,
 JsonpMapper mapper)

toString

public String toString()

Overrides:

toString in class Object

setupCompletionToolFunctionDeserializer

protected static void setupCompletionToolFunctionDeserializer(ObjectDeserializer<CompletionToolFunction.Builder> op)