org.openapitools.inference.client.model

Class EmbeddingsList

java.lang.Object

org.openapitools.inference.client.model.EmbeddingsList

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

Embeddings generated for the input

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	EmbeddingsList.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_DATA
static java.lang.String	SERIALIZED_NAME_MODEL
static java.lang.String	SERIALIZED_NAME_USAGE

Constructor Summary

Constructors

Constructor and Description
EmbeddingsList()

Method Summary

Modifier and Type	Method and Description
EmbeddingsList	addDataItem(Embedding dataItem)
EmbeddingsList	data(java.util.List<Embedding> data)
boolean	equals(java.lang.Object o)
static EmbeddingsList	fromJson(java.lang.String jsonString) Create an instance of EmbeddingsList 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.util.List<Embedding>	getData() The embeddings generated for the inputs.
java.lang.String	getModel() The model used to generate the embeddings
EmbeddingsListUsage	getUsage() Get usage
int	hashCode()
EmbeddingsList	model(java.lang.String model)
EmbeddingsList	putAdditionalProperty(java.lang.String key, java.lang.Object value) Set the additional (undeclared) property with the specified name and value.
void	setData(java.util.List<Embedding> data)
void	setModel(java.lang.String model)
void	setUsage(EmbeddingsListUsage usage)
java.lang.String	toJson() Convert an instance of EmbeddingsList to an JSON string
java.lang.String	toString()
EmbeddingsList	usage(EmbeddingsListUsage usage)
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_MODEL

public static final java.lang.String SERIALIZED_NAME_MODEL

See Also:

Constant Field Values

SERIALIZED_NAME_DATA

public static final java.lang.String SERIALIZED_NAME_DATA

See Also:

Constant Field Values

SERIALIZED_NAME_USAGE

public static final java.lang.String SERIALIZED_NAME_USAGE

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

EmbeddingsList

public EmbeddingsList()

Method Detail

model

public EmbeddingsList model(java.lang.String model)

getModel

@Nonnull
public java.lang.String getModel()

The model used to generate the embeddings

Returns:

model

setModel

public void setModel(java.lang.String model)

data

public EmbeddingsList data(java.util.List<Embedding> data)

addDataItem

public EmbeddingsList addDataItem(Embedding dataItem)

getData

@Nonnull
public java.util.List<Embedding> getData()

The embeddings generated for the inputs.

Returns:

data

setData

public void setData(java.util.List<Embedding> data)

usage

public EmbeddingsList usage(EmbeddingsListUsage usage)

getUsage

@Nonnull
public EmbeddingsListUsage getUsage()

Get usage

Returns:

usage

setUsage

public void setUsage(EmbeddingsListUsage usage)

putAdditionalProperty

public EmbeddingsList 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 EmbeddingsList 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 EmbeddingsList

fromJson

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

Create an instance of EmbeddingsList given an JSON string

Parameters:

jsonString - JSON string

Returns:

An instance of EmbeddingsList

Throws:

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

toJson

public java.lang.String toJson()

Convert an instance of EmbeddingsList to an JSON string

Returns:

JSON string