ResponseJsonSchema.Builder (Oracle Cloud Infrastructure Java SDK - 3.72.0)

java.lang.Object
- com.oracle.bmc.generativeaiinference.model.ResponseJsonSchema.Builder

Enclosing class:: ResponseJsonSchema

public static class ResponseJsonSchema.Builder
extends Object

Constructor Summary

Constructors
Constructor Description

Builder()

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`ResponseJsonSchema`	`build()`
`ResponseJsonSchema.Builder`	`copy(ResponseJsonSchema model)`
`ResponseJsonSchema.Builder`	`description(String description)`	A description of what the response format is for, used by the model to determine how to respond in the format.
`ResponseJsonSchema.Builder`	`isStrict(Boolean isStrict)`	Whether to enable strict schema adherence when generating the output.
`ResponseJsonSchema.Builder`	`name(String name)`	The name of the response format.
`ResponseJsonSchema.Builder`	`schema(Object schema)`	The schema used by the structured output, described as a JSON Schema object.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - Builder
```
public Builder()
```
- Method Detail
  - name
```
public ResponseJsonSchema.Builder name(String name)
```
    The name of the response format.
    Must be a-z, A-Z, 0-9, or contain underscores and dashes.
    
    Parameters:
    
    name - the value to set
    
    Returns:
    
    this builder
  - description
```
public ResponseJsonSchema.Builder description(String description)
```
    A description of what the response format is for, used by the model to determine how to respond in the format.
    
    Parameters:
    
    description - the value to set
    
    Returns:
    
    this builder
  - schema
```
public ResponseJsonSchema.Builder schema(Object schema)
```
    The schema used by the structured output, described as a JSON Schema object.
    
    Parameters:
    
    schema - the value to set
    
    Returns:
    
    this builder
  - isStrict
```
public ResponseJsonSchema.Builder isStrict(Boolean isStrict)
```
    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.
    
    Parameters:
    
    isStrict - the value to set
    
    Returns:
    
    this builder
  - build
```
public ResponseJsonSchema build()
```
  - copy
```
public ResponseJsonSchema.Builder copy(ResponseJsonSchema model)
```