Package com.oracle.bmc.generativeaiinference.model

Class DocumentUrl

java.lang.Object

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

com.oracle.bmc.generativeaiinference.model.DocumentUrl

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

The base64 encoded document data or a document uri if it’s supported.
Note: Objects should always be created or deserialized using the DocumentUrl.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 DocumentUrl.Builder, which maintain a set of all explicitly set fields called DocumentUrl.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	DocumentUrl.Builder
static class	DocumentUrl.Detail	The default value is AUTO and only AUTO is supported.

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
DocumentUrl(String url, DocumentUrl.Detail detail)	Deprecated.

Method Summary

Modifier and Type	Method	Description
static DocumentUrl.Builder	builder()	Create a new builder.
boolean	equals(Object o)
DocumentUrl.Detail	getDetail()	The default value is AUTO and only AUTO is supported.
String	getUrl()	The base64 encoded document data or a document uri if it’s supported.
int	hashCode()
DocumentUrl.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

DocumentUrl

@Deprecated
@ConstructorProperties({"url","detail"})
public DocumentUrl(String url,
                   DocumentUrl.Detail detail)

Deprecated.

Method Detail

builder

public static DocumentUrl.Builder builder()

Create a new builder.

toBuilder

public DocumentUrl.Builder toBuilder()

getUrl

public String getUrl()

The base64 encoded document data or a document uri if it’s supported.

Example for a pdf document: { "type": "DOCUMENT", "documentUrl": { "url": "data:application/pdf;base64," } }

Example with a document uri: { "type": "DOCUMENT", "videoUrl": { "url": "data:application/pdf;uri," } }

Returns:

the value

getDetail

public DocumentUrl.Detail getDetail()

The default value is AUTO and only AUTO is supported.

This option controls how to convert the base64 encoded document to tokens.

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