com.oracle.bmc.generativeaiinference.model

Class EmbedTextDetails

java.lang.Object

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

com.oracle.bmc.generativeaiinference.model.EmbedTextDetails

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

Details for the request to embed texts.
Note: Objects should always be created or deserialized using the EmbedTextDetails.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 EmbedTextDetails.Builder, which maintain a set of all explicitly set fields called EmbedTextDetails.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 and Description
static class	EmbedTextDetails.Builder
static class	EmbedTextDetails.InputType Specifies the input type.
static class	EmbedTextDetails.Truncate For an input that’s longer than the maximum token length, specifies which part of the input text will be truncated.

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 and Description
EmbedTextDetails(List<String> inputs, ServingMode servingMode, String compartmentId, Boolean isEcho, EmbedTextDetails.Truncate truncate, EmbedTextDetails.InputType inputType) Deprecated.

Method Summary

Modifier and Type	Method and Description
static EmbedTextDetails.Builder	builder() Create a new builder.
boolean	equals(Object o)
String	getCompartmentId() The OCID of compartment in which to call the Generative AI service to create text embeddings.
List<String>	getInputs() Provide a list of strings.
EmbedTextDetails.InputType	getInputType() Specifies the input type.
Boolean	getIsEcho() Whether or not to include the original inputs in the response.
ServingMode	getServingMode()
EmbedTextDetails.Truncate	getTruncate() For an input that’s longer than the maximum token length, specifies which part of the input text will be truncated.
int	hashCode()
EmbedTextDetails.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

EmbedTextDetails

@Deprecated
 @ConstructorProperties(value={"inputs","servingMode","compartmentId","isEcho","truncate","inputType"})
public EmbedTextDetails(List<String> inputs,
                                                                                                                                            ServingMode servingMode,
                                                                                                                                            String compartmentId,
                                                                                                                                            Boolean isEcho,
                                                                                                                                            EmbedTextDetails.Truncate truncate,
                                                                                                                                            EmbedTextDetails.InputType inputType)

Deprecated.

Method Detail

builder

public static EmbedTextDetails.Builder builder()

Create a new builder.

toBuilder

public EmbedTextDetails.Builder toBuilder()

getInputs

public List<String> getInputs()

Provide a list of strings. Each string can be words, a phrase, or a paragraph. The maximum length of each string entry in the list is 512 tokens.

Returns:

the value

getServingMode

public ServingMode getServingMode()

getCompartmentId

public String getCompartmentId()

The OCID of compartment in which to call the Generative AI service to create text embeddings.

Returns:

the value

getIsEcho

public Boolean getIsEcho()

Whether or not to include the original inputs in the response. Results are index-based.

Returns:

the value

getTruncate

public EmbedTextDetails.Truncate getTruncate()

For an input that’s longer than the maximum token length, specifies which part of the input text will be truncated.

Returns:

the value

getInputType

public EmbedTextDetails.InputType getInputType()

Specifies the input type.

Returns:

the value

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