Package com.openai.models.responses
        Class ToolChoiceFunction
- 
                    
                    
- All Implemented Interfaces:
 
public final class ToolChoiceFunctionUse this option to force the model to call a specific function.
 
- 
                
                    
                    
- 
                                
                            
                                
Nested Class Summary
Nested Classes Modifier and Type Class Description public final classToolChoiceFunction.BuilderA builder for ToolChoiceFunction.
 
- 
                                
                            
                                
Method Summary
Modifier and Type Method Description final Stringname()The name of the function to call. final JsonValue_type()For function calling, the type is always function.final JsonField<String>_name()Returns the raw JSON value of name. final Map<String, JsonValue>_additionalProperties()final ToolChoiceFunction.BuildertoBuilder()final ToolChoiceFunctionvalidate()final BooleanisValid()Booleanequals(Object other)IntegerhashCode()StringtoString()final static ToolChoiceFunction.Builderbuilder()Returns a mutable builder for constructing an instance of ToolChoiceFunction. - 
                    
                    
                    
- 
                                
                            
                                
Method Detail
- 
                                        
_type
final JsonValue _type()
For function calling, the type is always
function.Expected to always return the following:
JsonValue.from("function")However, this method can be useful for debugging and logging (e.g. if the server responded with an unexpected value).
 
- 
                                        
_name
final JsonField<String> _name()
Returns the raw JSON value of name.
Unlike name, this method doesn't throw if the JSON field has an unexpected type.
 
- 
                                        
_additionalProperties
final Map<String, JsonValue> _additionalProperties()
 
- 
                                        
toBuilder
final ToolChoiceFunction.Builder toBuilder()
 
- 
                                        
validate
final ToolChoiceFunction validate()
 
- 
                                        
builder
final static ToolChoiceFunction.Builder builder()
Returns a mutable builder for constructing an instance of ToolChoiceFunction.
The following fields are required:
.name() 
 - 
                                        
 
 - 
                                
                            
                                
 
 - 
                    
                    
                    
 
 -