com.oracle.bmc.generativeaiagent.model

Class IndexSchema

java.lang.Object

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

com.oracle.bmc.generativeaiagent.model.IndexSchema

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

The index schema details.
Note: Objects should always be created or deserialized using the IndexSchema.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 IndexSchema.Builder, which maintain a set of all explicitly set fields called IndexSchema.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	IndexSchema.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 and Description
IndexSchema(String bodyKey, String urlKey, String titleKey, String embeddingBodyKey) Deprecated.

Method Summary

Modifier and Type	Method and Description
static IndexSchema.Builder	builder() Create a new builder.
boolean	equals(Object o)
String	getBodyKey() Body key name.
String	getEmbeddingBodyKey() Field within customer managed OCI OpenSearch document containing the vector embedding for queries.
String	getTitleKey() Title key that stores the Title of a document, if available.
String	getUrlKey() URL key that stores the URL of a document, if available.
int	hashCode()
IndexSchema.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

IndexSchema

@Deprecated
 @ConstructorProperties(value={"bodyKey","urlKey","titleKey","embeddingBodyKey"})
public IndexSchema(String bodyKey,
                                                                                                                 String urlKey,
                                                                                                                 String titleKey,
                                                                                                                 String embeddingBodyKey)

Deprecated.

Method Detail

builder

public static IndexSchema.Builder builder()

Create a new builder.

toBuilder

public IndexSchema.Builder toBuilder()

getBodyKey

public String getBodyKey()

Body key name.

Returns:

the value

getUrlKey

public String getUrlKey()

URL key that stores the URL of a document, if available.

Returns:

the value

getTitleKey

public String getTitleKey()

Title key that stores the Title of a document, if available.

Returns:

the value

getEmbeddingBodyKey

public String getEmbeddingBodyKey()

Field within customer managed OCI OpenSearch document containing the vector embedding for queries.

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