Class ResponseInputItem.FunctionCallOutput.Builder
- 
                    
                    
- All Implemented Interfaces:
 
public final class ResponseInputItem.FunctionCallOutput.BuilderA builder for FunctionCallOutput.
 
- 
                
                    
                    
- 
                                
                            
                                
Method Summary
- 
                    
                    
                    
- 
                                
                            
                                
Method Detail
- 
                                        
callId
final ResponseInputItem.FunctionCallOutput.Builder callId(String callId)
The unique ID of the function tool call generated by the model.
 
- 
                                        
callId
final ResponseInputItem.FunctionCallOutput.Builder callId(JsonField<String> callId)
Sets Builder.callId to an arbitrary JSON value.
You should usually call Builder.callId with a well-typed String value instead. This method is primarily for setting the field to an undocumented or not yet supported value.
 
- 
                                        
output
final ResponseInputItem.FunctionCallOutput.Builder output(ResponseInputItem.FunctionCallOutput.Output output)
Text, image, or file output of the function tool call.
 
- 
                                        
output
final ResponseInputItem.FunctionCallOutput.Builder output(JsonField<ResponseInputItem.FunctionCallOutput.Output> output)
Sets Builder.output to an arbitrary JSON value.
You should usually call Builder.output with a well-typed Output value instead. This method is primarily for setting the field to an undocumented or not yet supported value.
 
- 
                                        
output
final ResponseInputItem.FunctionCallOutput.Builder output(String string)
Alias for calling output with
Output.ofString(string). 
- 
                                        
outputAsJson
final ResponseInputItem.FunctionCallOutput.Builder outputAsJson(Object functionResult)
Sets the output to text representing the JSON serialized form of a given object. This is useful when passing data that is the result of a function call.
 
- 
                                        
outputOfResponseFunctionCallOutputItemList
final ResponseInputItem.FunctionCallOutput.Builder outputOfResponseFunctionCallOutputItemList(List<ResponseFunctionCallOutputItem> responseFunctionCallOutputItemList)
Alias for calling output with
Output.ofResponseFunctionCallOutputItemList(responseFunctionCallOutputItemList). 
- 
                                        
type
final ResponseInputItem.FunctionCallOutput.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("function_call_output")This method is primarily for setting the field to an undocumented or not yet supported value.
 
- 
                                        
id
final ResponseInputItem.FunctionCallOutput.Builder id(String id)
The unique ID of the function tool call output. Populated when this item is returned via API.
 
- 
                                        
id
final ResponseInputItem.FunctionCallOutput.Builder id(Optional<String> id)
Alias for calling Builder.id with
id.orElse(null). 
- 
                                        
id
final ResponseInputItem.FunctionCallOutput.Builder id(JsonField<String> id)
Sets Builder.id to an arbitrary JSON value.
You should usually call Builder.id with a well-typed String value instead. This method is primarily for setting the field to an undocumented or not yet supported value.
 
- 
                                        
status
final ResponseInputItem.FunctionCallOutput.Builder status(ResponseInputItem.FunctionCallOutput.Status status)
The status of the item. One of
in_progress,completed, orincomplete. Populated when items are returned via API. 
- 
                                        
status
final ResponseInputItem.FunctionCallOutput.Builder status(Optional<ResponseInputItem.FunctionCallOutput.Status> status)
Alias for calling Builder.status with
status.orElse(null). 
- 
                                        
status
final ResponseInputItem.FunctionCallOutput.Builder status(JsonField<ResponseInputItem.FunctionCallOutput.Status> status)
Sets Builder.status to an arbitrary JSON value.
You should usually call Builder.status with a well-typed Status value instead. This method is primarily for setting the field to an undocumented or not yet supported value.
 
- 
                                        
additionalProperties
final ResponseInputItem.FunctionCallOutput.Builder additionalProperties(Map<String, JsonValue> additionalProperties)
 
- 
                                        
putAdditionalProperty
final ResponseInputItem.FunctionCallOutput.Builder putAdditionalProperty(String key, JsonValue value)
 
- 
                                        
putAllAdditionalProperties
final ResponseInputItem.FunctionCallOutput.Builder putAllAdditionalProperties(Map<String, JsonValue> additionalProperties)
 
- 
                                        
removeAdditionalProperty
final ResponseInputItem.FunctionCallOutput.Builder removeAdditionalProperty(String key)
 
- 
                                        
removeAllAdditionalProperties
final ResponseInputItem.FunctionCallOutput.Builder removeAllAdditionalProperties(Set<String> keys)
 
- 
                                        
build
final ResponseInputItem.FunctionCallOutput build()
Returns an immutable instance of FunctionCallOutput.
Further updates to this Builder will not mutate the returned instance.
The following fields are required:
.callId() .output() 
 - 
                                        
 
 - 
                                
                            
                                
 
 - 
                    
                    
                    
 
 -