JsonSchemaResponseFormat (Oracle Cloud Infrastructure Java SDK - 3.72.0)

java.lang.Object
- com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel
- - com.oracle.bmc.generativeaiinference.model.ResponseFormat
  - - com.oracle.bmc.generativeaiinference.model.JsonSchemaResponseFormat

```
@Generated(value="OracleSDKGenerator",
           comments="API Version: 20231130")
public final class JsonSchemaResponseFormat
extends ResponseFormat
```
Enables Structured Outputs which ensures the model will match your supplied JSON schema.
Note: Objects should always be created or deserialized using the JsonSchemaResponseFormat.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 JsonSchemaResponseFormat.Builder, which maintain a set of all explicitly set fields called JsonSchemaResponseFormat.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 JsonSchemaResponseFormat.Builder
- Nested classes/interfaces inherited from class com.oracle.bmc.generativeaiinference.model.ResponseFormat
  ResponseFormat.Type

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

JsonSchemaResponseFormat(ResponseJsonSchema jsonSchema)
Deprecated.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`static JsonSchemaResponseFormat.Builder`	`builder()`	Create a new builder.
`boolean`	`equals(Object o)`
`ResponseJsonSchema`	`getJsonSchema()`
`int`	`hashCode()`
`JsonSchemaResponseFormat.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
  - JsonSchemaResponseFormat
```
@Deprecated
public JsonSchemaResponseFormat(ResponseJsonSchema jsonSchema)
```
    Deprecated.
- Method Detail
  - builder
```
public static JsonSchemaResponseFormat.Builder builder()
```
    Create a new builder.
  - toBuilder
```
public JsonSchemaResponseFormat.Builder toBuilder()
```
  - getJsonSchema
```
public ResponseJsonSchema getJsonSchema()
```
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class ResponseFormat
  - toString
```
public String toString(boolean includeByteArrayContents)
```
    Return a string representation of the object.
    
    Overrides:
    
    toString in class ResponseFormat
    
    Parameters:
    
    includeByteArrayContents - true to include the full contents of byte arrays
    
    Returns:
    
    string representation
  - equals
```
public boolean equals(Object o)
```
    Overrides:
    
    equals in class ResponseFormat
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class ResponseFormat