Class ChatCompletionCreateParams.WebSearchOptions.Builder
- 
                    
                    
- All Implemented Interfaces:
 
public final class ChatCompletionCreateParams.WebSearchOptions.BuilderA builder for WebSearchOptions.
 
- 
                
                    
                    
- 
                                
                            
                                
Method Summary
- 
                    
                    
                    
- 
                                
                            
                                
Method Detail
- 
                                        
searchContextSize
final ChatCompletionCreateParams.WebSearchOptions.Builder searchContextSize(ChatCompletionCreateParams.WebSearchOptions.SearchContextSize searchContextSize)
High level guidance for the amount of context window space to use for the search. One of
low,medium, orhigh.mediumis the default. 
- 
                                        
searchContextSize
final ChatCompletionCreateParams.WebSearchOptions.Builder searchContextSize(JsonField<ChatCompletionCreateParams.WebSearchOptions.SearchContextSize> searchContextSize)
Sets Builder.searchContextSize to an arbitrary JSON value.
You should usually call Builder.searchContextSize with a well-typed SearchContextSize value instead. This method is primarily for setting the field to an undocumented or not yet supported value.
 
- 
                                        
userLocation
final ChatCompletionCreateParams.WebSearchOptions.Builder userLocation(ChatCompletionCreateParams.WebSearchOptions.UserLocation userLocation)
Approximate location parameters for the search.
 
- 
                                        
userLocation
final ChatCompletionCreateParams.WebSearchOptions.Builder userLocation(Optional<ChatCompletionCreateParams.WebSearchOptions.UserLocation> userLocation)
Alias for calling Builder.userLocation with
userLocation.orElse(null). 
- 
                                        
userLocation
final ChatCompletionCreateParams.WebSearchOptions.Builder userLocation(JsonField<ChatCompletionCreateParams.WebSearchOptions.UserLocation> userLocation)
Sets Builder.userLocation to an arbitrary JSON value.
You should usually call Builder.userLocation with a well-typed UserLocation value instead. This method is primarily for setting the field to an undocumented or not yet supported value.
 
- 
                                        
additionalProperties
final ChatCompletionCreateParams.WebSearchOptions.Builder additionalProperties(Map<String, JsonValue> additionalProperties)
 
- 
                                        
putAdditionalProperty
final ChatCompletionCreateParams.WebSearchOptions.Builder putAdditionalProperty(String key, JsonValue value)
 
- 
                                        
putAllAdditionalProperties
final ChatCompletionCreateParams.WebSearchOptions.Builder putAllAdditionalProperties(Map<String, JsonValue> additionalProperties)
 
- 
                                        
removeAdditionalProperty
final ChatCompletionCreateParams.WebSearchOptions.Builder removeAdditionalProperty(String key)
 
- 
                                        
removeAllAdditionalProperties
final ChatCompletionCreateParams.WebSearchOptions.Builder removeAllAdditionalProperties(Set<String> keys)
 
- 
                                        
build
final ChatCompletionCreateParams.WebSearchOptions build()
Returns an immutable instance of WebSearchOptions.
Further updates to this Builder will not mutate the returned instance.
 
 - 
                                        
 
 - 
                                
                            
                                
 
 - 
                    
                    
                    
 
 -