org.openapitools.inference.client.model

Class EmbedRequestParameters

java.lang.Object

org.openapitools.inference.client.model.EmbedRequestParameters

@Generated(value="org.openapitools.codegen.languages.JavaClientCodegen",
           date="2024-10-23T20:47:14.512003Z[Etc/UTC]")
public class EmbedRequestParameters
extends java.lang.Object

Model-specific parameters.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	EmbedRequestParameters.CustomTypeAdapterFactory

Field Summary

Fields

Modifier and Type	Field and Description
static java.util.HashSet<java.lang.String>	openapiFields
static java.util.HashSet<java.lang.String>	openapiRequiredFields
static java.lang.String	SERIALIZED_NAME_INPUT_TYPE
static java.lang.String	SERIALIZED_NAME_TRUNCATE

Constructor Summary

Constructors

Constructor and Description
EmbedRequestParameters()

Method Summary

Modifier and Type	Method and Description
boolean	equals(java.lang.Object o)
static EmbedRequestParameters	fromJson(java.lang.String jsonString) Create an instance of EmbedRequestParameters given an JSON string
java.util.Map<java.lang.String,java.lang.Object>	getAdditionalProperties() Return the additional (undeclared) property.
java.lang.Object	getAdditionalProperty(java.lang.String key) Return the additional (undeclared) property with the specified name.
java.lang.String	getInputType() Common property used to distinguish between types of data.
java.lang.String	getTruncate() How to handle inputs longer than those supported by the model.
int	hashCode()
EmbedRequestParameters	inputType(java.lang.String inputType)
EmbedRequestParameters	putAdditionalProperty(java.lang.String key, java.lang.Object value) Set the additional (undeclared) property with the specified name and value.
void	setInputType(java.lang.String inputType)
void	setTruncate(java.lang.String truncate)
java.lang.String	toJson() Convert an instance of EmbedRequestParameters to an JSON string
java.lang.String	toString()
EmbedRequestParameters	truncate(java.lang.String truncate)
static void	validateJsonElement(com.google.gson.JsonElement jsonElement) Validates the JSON Element and throws an exception if issues found

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

SERIALIZED_NAME_INPUT_TYPE

public static final java.lang.String SERIALIZED_NAME_INPUT_TYPE

See Also:

Constant Field Values

SERIALIZED_NAME_TRUNCATE

public static final java.lang.String SERIALIZED_NAME_TRUNCATE

See Also:

Constant Field Values

openapiFields

public static java.util.HashSet<java.lang.String> openapiFields

openapiRequiredFields

public static java.util.HashSet<java.lang.String> openapiRequiredFields

Constructor Detail

EmbedRequestParameters

public EmbedRequestParameters()

Method Detail

inputType

public EmbedRequestParameters inputType(java.lang.String inputType)

getInputType

@Nullable
public java.lang.String getInputType()

Common property used to distinguish between types of data.

Returns:

inputType

setInputType

public void setInputType(java.lang.String inputType)

truncate

public EmbedRequestParameters truncate(java.lang.String truncate)

getTruncate

@Nullable
public java.lang.String getTruncate()

How to handle inputs longer than those supported by the model. If `\"END\"`, truncate the input sequence at the token limit. If `\"NONE\"`, return an error when the input exceeds the token limit.

Returns:

truncate

setTruncate

public void setTruncate(java.lang.String truncate)

putAdditionalProperty

public EmbedRequestParameters putAdditionalProperty(java.lang.String key,
                                                    java.lang.Object value)

Set the additional (undeclared) property with the specified name and value. If the property does not already exist, create it otherwise replace it.

Parameters:

key - name of the property

value - value of the property

Returns:

the EmbedRequestParameters instance itself

getAdditionalProperties

public java.util.Map<java.lang.String,java.lang.Object> getAdditionalProperties()

Return the additional (undeclared) property.

Returns:

a map of objects

getAdditionalProperty

public java.lang.Object getAdditionalProperty(java.lang.String key)

Return the additional (undeclared) property with the specified name.

Parameters:

key - name of the property

Returns:

an object

equals

public boolean equals(java.lang.Object o)

Overrides:

equals in class java.lang.Object

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

validateJsonElement

public static void validateJsonElement(com.google.gson.JsonElement jsonElement)
                                throws java.io.IOException

Validates the JSON Element and throws an exception if issues found

Parameters:

jsonElement - JSON Element

Throws:

java.io.IOException - if the JSON Element is invalid with respect to EmbedRequestParameters

fromJson

public static EmbedRequestParameters fromJson(java.lang.String jsonString)
                                       throws java.io.IOException

Create an instance of EmbedRequestParameters given an JSON string

Parameters:

jsonString - JSON string

Returns:

An instance of EmbedRequestParameters

Throws:

java.io.IOException - if the JSON string is invalid with respect to EmbedRequestParameters

toJson

public java.lang.String toJson()

Convert an instance of EmbedRequestParameters to an JSON string

Returns:

JSON string