Class FileSearchToolCall.FileSearch.RankingOptions.Ranker
- 
                    
                    - All Implemented Interfaces:
- 
                            
                            com.openai.core.Enum
 
 public final class FileSearchToolCall.FileSearch.RankingOptions.Ranker implements EnumThe ranker to use for the file search. If not specified will use the autoranker.
- 
                
                    
                    - 
                                
                            
                                Nested Class SummaryNested Classes Modifier and Type Class Description public enumFileSearchToolCall.FileSearch.RankingOptions.Ranker.KnownAn enum containing Ranker's known values. public enumFileSearchToolCall.FileSearch.RankingOptions.Ranker.ValueAn enum containing Ranker's known values, as well as an _UNKNOWN member. An instance of Ranker can contain an unknown value in a couple of cases: - It was deserialized from data that doesn't match any known member. For example, if the SDK is on an older version than the API, then the API may respond with new members that the SDK is unaware of. 
- It was constructed with an arbitrary value using the of method. 
 
 - 
                                
                            
                                Field SummaryFields Modifier and Type Field Description public final static FileSearchToolCall.FileSearch.RankingOptions.RankerAUTOpublic final static FileSearchToolCall.FileSearch.RankingOptions.RankerDEFAULT_2024_08_21
 - 
                                
                            
                                Method SummaryModifier and Type Method Description final JsonField<String>_value()Returns this class instance's raw value. final FileSearchToolCall.FileSearch.RankingOptions.Ranker.Valuevalue()Returns an enum member corresponding to this class instance's value, or Value._UNKNOWN if the class was instantiated with an unknown value. final FileSearchToolCall.FileSearch.RankingOptions.Ranker.Knownknown()Returns an enum member corresponding to this class instance's value. final StringasString()Returns this class instance's primitive wire representation. final FileSearchToolCall.FileSearch.RankingOptions.Rankervalidate()final BooleanisValid()Booleanequals(Object other)IntegerhashCode()StringtoString()final static FileSearchToolCall.FileSearch.RankingOptions.Rankerof(String value)- 
                    
                    
                    - 
                                
                            
                                Method Detail- 
                                        _valuefinal JsonField<String> _value() Returns this class instance's raw value. This is usually only useful if this instance was deserialized from data that doesn't match any known member, and you want to know that value. For example, if the SDK is on an older version than the API, then the API may respond with new members that the SDK is unaware of. 
 - 
                                        valuefinal FileSearchToolCall.FileSearch.RankingOptions.Ranker.Value value() Returns an enum member corresponding to this class instance's value, or Value._UNKNOWN if the class was instantiated with an unknown value. Use the known method instead if you're certain the value is always known or if you want to throw for the unknown case. 
 - 
                                        knownfinal FileSearchToolCall.FileSearch.RankingOptions.Ranker.Known known() Returns an enum member corresponding to this class instance's value. Use the value method instead if you're uncertain the value is always known and don't want to throw for the unknown case. 
 - 
                                        asStringfinal String asString() Returns this class instance's primitive wire representation. This differs from the toString method because that method is primarily for debugging and generally doesn't throw. 
 - 
                                        validatefinal FileSearchToolCall.FileSearch.RankingOptions.Ranker validate() 
 - 
                                        offinal static FileSearchToolCall.FileSearch.RankingOptions.Ranker of(String value) 
 
- 
                                        
 
- 
                                
                            
                                
 
- 
                    
                    
                    
 
-