Class ResponseCustomToolCallOutput
- 
                    
                    
- All Implemented Interfaces:
 
public final class ResponseCustomToolCallOutputThe output of a custom tool call from your code, being sent back to the model.
 
- 
                
                    
                    
- 
                                
                            
                                
Nested Class Summary
Nested Classes Modifier and Type Class Description public final classResponseCustomToolCallOutput.BuilderA builder for ResponseCustomToolCallOutput.
public final classResponseCustomToolCallOutput.OutputThe output from the custom tool call generated by your code. Can be a string or an list of output content.
 
- 
                                
                            
                                
Method Summary
Modifier and Type Method Description final StringcallId()The call ID, used to map this custom tool call output to a custom tool call. final ResponseCustomToolCallOutput.Outputoutput()The output from the custom tool call generated by your code. final JsonValue_type()The type of the custom tool call output. final Optional<String>id()The unique ID of the custom tool call output in the OpenAI platform. final JsonField<String>_callId()Returns the raw JSON value of callId. final JsonField<ResponseCustomToolCallOutput.Output>_output()Returns the raw JSON value of output. final JsonField<String>_id()Returns the raw JSON value of id. final Map<String, JsonValue>_additionalProperties()final ResponseCustomToolCallOutput.BuildertoBuilder()final ResponseCustomToolCallOutputvalidate()final BooleanisValid()Booleanequals(Object other)IntegerhashCode()StringtoString()final static ResponseCustomToolCallOutput.Builderbuilder()Returns a mutable builder for constructing an instance of ResponseCustomToolCallOutput. - 
                    
                    
                    
- 
                                
                            
                                
Method Detail
- 
                                        
callId
final String callId()
The call ID, used to map this custom tool call output to a custom tool call.
 
- 
                                        
output
final ResponseCustomToolCallOutput.Output output()
The output from the custom tool call generated by your code. Can be a string or an list of output content.
 
- 
                                        
_type
final JsonValue _type()
The type of the custom tool call output. Always
custom_tool_call_output.Expected to always return the following:
JsonValue.from("custom_tool_call_output")However, this method can be useful for debugging and logging (e.g. if the server responded with an unexpected value).
 
- 
                                        
_callId
final JsonField<String> _callId()
Returns the raw JSON value of callId.
Unlike callId, this method doesn't throw if the JSON field has an unexpected type.
 
- 
                                        
_output
final JsonField<ResponseCustomToolCallOutput.Output> _output()
Returns the raw JSON value of output.
Unlike output, this method doesn't throw if the JSON field has an unexpected type.
 
- 
                                        
_id
final JsonField<String> _id()
Returns the raw JSON value of id.
Unlike id, this method doesn't throw if the JSON field has an unexpected type.
 
- 
                                        
_additionalProperties
final Map<String, JsonValue> _additionalProperties()
 
- 
                                        
toBuilder
final ResponseCustomToolCallOutput.Builder toBuilder()
 
- 
                                        
validate
final ResponseCustomToolCallOutput validate()
 
- 
                                        
builder
final static ResponseCustomToolCallOutput.Builder builder()
Returns a mutable builder for constructing an instance of ResponseCustomToolCallOutput.
The following fields are required:
.callId() .output() 
 - 
                                        
 
 - 
                                
                            
                                
 
 - 
                    
                    
                    
 
 -