org.openapitools.inference.client.model

Class EmbedRequest

java.lang.Object

org.openapitools.inference.client.model.EmbedRequest

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

EmbedRequest

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	EmbedRequest.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_INPUTS
static java.lang.String	SERIALIZED_NAME_MODEL
static java.lang.String	SERIALIZED_NAME_PARAMETERS

Constructor Summary

Constructors

Constructor and Description
EmbedRequest()

Method Summary

Modifier and Type	Method and Description
EmbedRequest	addInputsItem(EmbedRequestInputsInner inputsItem)
boolean	equals(java.lang.Object o)
static EmbedRequest	fromJson(java.lang.String jsonString) Create an instance of EmbedRequest 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<EmbedRequestInputsInner>	getInputs() List of inputs to generate embeddings for.
java.lang.String	getModel() The [model](https://docs.pinecone.io/guides/inference/understanding-inference#models) to use for embedding generation.
EmbedRequestParameters	getParameters() Get parameters
int	hashCode()
EmbedRequest	inputs(java.util.List<EmbedRequestInputsInner> inputs)
EmbedRequest	model(java.lang.String model)
EmbedRequest	parameters(EmbedRequestParameters parameters)
EmbedRequest	putAdditionalProperty(java.lang.String key, java.lang.Object value) Set the additional (undeclared) property with the specified name and value.
void	setInputs(java.util.List<EmbedRequestInputsInner> inputs)
void	setModel(java.lang.String model)
void	setParameters(EmbedRequestParameters parameters)
java.lang.String	toJson() Convert an instance of EmbedRequest to an JSON string
java.lang.String	toString()
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_PARAMETERS

public static final java.lang.String SERIALIZED_NAME_PARAMETERS

See Also:

Constant Field Values

SERIALIZED_NAME_INPUTS

public static final java.lang.String SERIALIZED_NAME_INPUTS

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

EmbedRequest

public EmbedRequest()

Method Detail

model

public EmbedRequest model(java.lang.String model)

getModel

@Nonnull
public java.lang.String getModel()

The [model](https://docs.pinecone.io/guides/inference/understanding-inference#models) to use for embedding generation.

Returns:

model

setModel

public void setModel(java.lang.String model)

parameters

public EmbedRequest parameters(EmbedRequestParameters parameters)

getParameters

@Nullable
public EmbedRequestParameters getParameters()

Get parameters

Returns:

parameters

setParameters

public void setParameters(EmbedRequestParameters parameters)

inputs

public EmbedRequest inputs(java.util.List<EmbedRequestInputsInner> inputs)

addInputsItem

public EmbedRequest addInputsItem(EmbedRequestInputsInner inputsItem)

getInputs

@Nonnull
public java.util.List<EmbedRequestInputsInner> getInputs()

List of inputs to generate embeddings for.

Returns:

inputs

setInputs

public void setInputs(java.util.List<EmbedRequestInputsInner> inputs)

putAdditionalProperty

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

fromJson

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

Create an instance of EmbedRequest given an JSON string

Parameters:

jsonString - JSON string

Returns:

An instance of EmbedRequest

Throws:

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

toJson

public java.lang.String toJson()

Convert an instance of EmbedRequest to an JSON string

Returns:

JSON string