Package com.openai.models
        Class ResponseFormatJsonSchema.Builder
- 
                    
                    
- All Implemented Interfaces:
 
public final class ResponseFormatJsonSchema.BuilderA builder for ResponseFormatJsonSchema.
 
- 
                
                    
                    
- 
                                
                            
                                
Method Summary
- 
                    
                    
                    
- 
                                
                            
                                
Method Detail
- 
                                        
jsonSchema
final ResponseFormatJsonSchema.Builder jsonSchema(ResponseFormatJsonSchema.JsonSchema jsonSchema)
Structured Outputs configuration options, including a JSON Schema.
 
- 
                                        
jsonSchema
final ResponseFormatJsonSchema.Builder jsonSchema(JsonField<ResponseFormatJsonSchema.JsonSchema> jsonSchema)
Sets Builder.jsonSchema to an arbitrary JSON value.
You should usually call Builder.jsonSchema with a well-typed JsonSchema value instead. This method is primarily for setting the field to an undocumented or not yet supported value.
 
- 
                                        
type
final ResponseFormatJsonSchema.Builder type(JsonValue type)
Sets the field to an arbitrary JSON value.
It is usually unnecessary to call this method because the field defaults to the following:
JsonValue.from("json_schema")This method is primarily for setting the field to an undocumented or not yet supported value.
 
- 
                                        
additionalProperties
final ResponseFormatJsonSchema.Builder additionalProperties(Map<String, JsonValue> additionalProperties)
 
- 
                                        
putAdditionalProperty
final ResponseFormatJsonSchema.Builder putAdditionalProperty(String key, JsonValue value)
 
- 
                                        
putAllAdditionalProperties
final ResponseFormatJsonSchema.Builder putAllAdditionalProperties(Map<String, JsonValue> additionalProperties)
 
- 
                                        
removeAdditionalProperty
final ResponseFormatJsonSchema.Builder removeAdditionalProperty(String key)
 
- 
                                        
removeAllAdditionalProperties
final ResponseFormatJsonSchema.Builder removeAllAdditionalProperties(Set<String> keys)
 
- 
                                        
build
final ResponseFormatJsonSchema build()
Returns an immutable instance of ResponseFormatJsonSchema.
Further updates to this Builder will not mutate the returned instance.
The following fields are required:
.jsonSchema() 
 - 
                                        
 
 - 
                                
                            
                                
 
 - 
                    
                    
                    
 
 -