Package com.openai.models.beta.realtime
        Class ResponseCreateEvent.Response.Tool
- 
                    
                    
- All Implemented Interfaces:
 
public final class ResponseCreateEvent.Response.Tool 
- 
                
                    
                    
- 
                                
                            
                                
Nested Class Summary
Nested Classes Modifier and Type Class Description public final classResponseCreateEvent.Response.Tool.BuilderA builder for Tool.
public final classResponseCreateEvent.Response.Tool.TypeThe type of the tool, i.e.
function. 
- 
                                
                            
                                
Method Summary
Modifier and Type Method Description final Optional<String>description()The description of the function, including guidance on when and how to call it, and guidance about what to tell the user when calling (if anything). final Optional<String>name()The name of the function. final JsonValue_parameters()Parameters of the function in JSON Schema. final Optional<ResponseCreateEvent.Response.Tool.Type>type()The type of the tool, i.e. final JsonField<String>_description()Returns the raw JSON value of description. final JsonField<String>_name()Returns the raw JSON value of name. final JsonField<ResponseCreateEvent.Response.Tool.Type>_type()Returns the raw JSON value of type. final Map<String, JsonValue>_additionalProperties()final ResponseCreateEvent.Response.Tool.BuildertoBuilder()final ResponseCreateEvent.Response.Toolvalidate()final BooleanisValid()Booleanequals(Object other)IntegerhashCode()StringtoString()final static ResponseCreateEvent.Response.Tool.Builderbuilder()Returns a mutable builder for constructing an instance of Tool. - 
                    
                    
                    
- 
                                
                            
                                
Method Detail
- 
                                        
description
final Optional<String> description()
The description of the function, including guidance on when and how to call it, and guidance about what to tell the user when calling (if anything).
 
- 
                                        
_parameters
final JsonValue _parameters()
Parameters of the function in JSON Schema.
 
- 
                                        
type
final Optional<ResponseCreateEvent.Response.Tool.Type> type()
The type of the tool, i.e.
function. 
- 
                                        
_description
final JsonField<String> _description()
Returns the raw JSON value of description.
Unlike description, this method doesn't throw if the JSON field has an unexpected type.
 
- 
                                        
_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.
 
- 
                                        
_type
final JsonField<ResponseCreateEvent.Response.Tool.Type> _type()
Returns the raw JSON value of type.
Unlike type, this method doesn't throw if the JSON field has an unexpected type.
 
- 
                                        
_additionalProperties
final Map<String, JsonValue> _additionalProperties()
 
- 
                                        
toBuilder
final ResponseCreateEvent.Response.Tool.Builder toBuilder()
 
- 
                                        
validate
final ResponseCreateEvent.Response.Tool validate()
 
- 
                                        
builder
final static ResponseCreateEvent.Response.Tool.Builder builder()
Returns a mutable builder for constructing an instance of Tool.
 
 - 
                                        
 
 - 
                                
                            
                                
 
 - 
                    
                    
                    
 
 -