Package com.oracle.bmc.generativeaiinference.model

Class ResponseJsonSchema

java.lang.Object

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

com.oracle.bmc.generativeaiinference.model.ResponseJsonSchema

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

The JSON schema definition to be used in JSON_SCHEMA response format.
Note: Objects should always be created or deserialized using the ResponseJsonSchema.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 ResponseJsonSchema.Builder, which maintain a set of all explicitly set fields called ResponseJsonSchema.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	ResponseJsonSchema.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
ResponseJsonSchema(String name, String description, Object schema, Boolean isStrict)	Deprecated.

Method Summary

Modifier and Type	Method	Description
static ResponseJsonSchema.Builder	builder()	Create a new builder.
boolean	equals(Object o)
String	getDescription()	A description of what the response format is for, used by the model to determine how to respond in the format.
Boolean	getIsStrict()	Whether to enable strict schema adherence when generating the output.
String	getName()	The name of the response format.
Object	getSchema()	The schema used by the structured output, described as a JSON Schema object.
int	hashCode()
ResponseJsonSchema.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

ResponseJsonSchema

@Deprecated
@ConstructorProperties({"name","description","schema","isStrict"})
public ResponseJsonSchema(String name,
                          String description,
                          Object schema,
                          Boolean isStrict)

Deprecated.

Method Detail

builder

public static ResponseJsonSchema.Builder builder()

Create a new builder.

toBuilder

public ResponseJsonSchema.Builder toBuilder()

getName

public String getName()

The name of the response format.

Must be a-z, A-Z, 0-9, or contain underscores and dashes.

Returns:

the value

getDescription

public String getDescription()

A description of what the response format is for, used by the model to determine how to respond in the format.

Returns:

the value

getSchema

public Object getSchema()

The schema used by the structured output, described as a JSON Schema object.

Returns:

the value

getIsStrict

public Boolean getIsStrict()

Whether to enable strict schema adherence when generating the output.

If set to true, the model will always follow the exact schema defined in the schema field. Only a subset of JSON Schema is supported when strict is true.

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