Package com.oracle.bmc.generativeaiinference.model

Class EmbedTextResult

java.lang.Object

com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel

com.oracle.bmc.generativeaiinference.model.EmbedTextResult

@Generated(value="OracleSDKGenerator",
           comments="API Version: 20231130")
public final class EmbedTextResult
extends com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel

The generated embedded result to return.
Note: Objects should always be created or deserialized using the EmbedTextResult.Builder. This model distinguishes fields that are null because they are unset from fields that are explicitly set to null. This is done in the setter methods of the EmbedTextResult.Builder, which maintain a set of all explicitly set fields called EmbedTextResult.Builder.__explicitlySet__. The hashCode() and equals(Object) methods are implemented to take the explicitly set fields into account. The constructor, on the other hand, does not take the explicitly set fields into account (since the constructor cannot distinguish explicit null from unset null).

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	EmbedTextResult.Builder

Field Summary

Fields inherited from class com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel

EXPLICITLY_SET_FILTER_NAME, EXPLICITLY_SET_PROPERTY_NAME

Constructor Summary

Constructors

Constructor	Description
EmbedTextResult(String id, List<String> inputs, List<List<Float>> embeddings, String modelId, String modelVersion, Usage usage)	Deprecated.

Method Summary

Modifier and Type	Method	Description
static EmbedTextResult.Builder	builder()	Create a new builder.
boolean	equals(Object o)
List<List<Float>>	getEmbeddings()	The embeddings corresponding to inputs.
String	getId()	A unique identifier for the generated result.
List<String>	getInputs()	The original inputs.
String	getModelId()	The OCID of the model used in this inference request.
String	getModelVersion()	The version of the model.
Usage	getUsage()
int	hashCode()
EmbedTextResult.Builder	toBuilder()
String	toString()
String	toString(boolean includeByteArrayContents)	Return a string representation of the object.

Methods inherited from class com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel

markPropertyAsExplicitlySet, wasPropertyExplicitlySet

Methods inherited from class java.lang.Object

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

Constructor Detail

EmbedTextResult

@Deprecated
@ConstructorProperties({"id","inputs","embeddings","modelId","modelVersion","usage"})
public EmbedTextResult(String id,
                       List<String> inputs,
                       List<List<Float>> embeddings,
                       String modelId,
                       String modelVersion,
                       Usage usage)

Deprecated.

Method Detail

builder

public static EmbedTextResult.Builder builder()

Create a new builder.

toBuilder

public EmbedTextResult.Builder toBuilder()

getId

public String getId()

A unique identifier for the generated result.

Returns:

the value

getInputs

public List<String> getInputs()

The original inputs.

Only present if “isEcho” is set to true.

Returns:

the value

getEmbeddings

public List<List<Float>> getEmbeddings()

The embeddings corresponding to inputs.

Returns:

the value

getModelId

public String getModelId()

The OCID of the model used in this inference request.

Returns:

the value

getModelVersion

public String getModelVersion()

The version of the model.

Returns:

the value

getUsage

public Usage getUsage()

toString

public String toString()

Overrides:

toString in class com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel

toString

public String toString(boolean includeByteArrayContents)

Return a string representation of the object.

Parameters:

includeByteArrayContents - true to include the full contents of byte arrays

Returns:

string representation

equals

public boolean equals(Object o)

Overrides:

equals in class com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel

hashCode

public int hashCode()

Overrides:

hashCode in class com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel