Package org.springframework.ai.openai.api

Record Class OpenAiApi.ChatCompletionRequest.WebSearchOptions

java.lang.Object

java.lang.Record

org.springframework.ai.openai.api.OpenAiApi.ChatCompletionRequest.WebSearchOptions

Record Components:

searchContextSize -

userLocation -

Enclosing class:

OpenAiApi.ChatCompletionRequest

public static record OpenAiApi.ChatCompletionRequest.WebSearchOptions(OpenAiApi.ChatCompletionRequest.WebSearchOptions.SearchContextSize searchContextSize, OpenAiApi.ChatCompletionRequest.WebSearchOptions.UserLocation userLocation)
extends Record

This tool searches the web for relevant results to use in a response.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static enum	OpenAiApi.ChatCompletionRequest.WebSearchOptions.SearchContextSize	High level guidance for the amount of context window space to use for the search.
static final record	OpenAiApi.ChatCompletionRequest.WebSearchOptions.UserLocation	Approximate location parameters for the search.

Constructor Summary

Constructors

Constructor	Description
WebSearchOptions(OpenAiApi.ChatCompletionRequest.WebSearchOptions.SearchContextSize searchContextSize, OpenAiApi.ChatCompletionRequest.WebSearchOptions.UserLocation userLocation)	Creates an instance of a WebSearchOptions record class.

Method Summary

Modifier and Type	Method	Description
final boolean	equals(Object o)	Indicates whether some other object is "equal to" this one.
final int	hashCode()	Returns a hash code value for this object.
OpenAiApi.ChatCompletionRequest.WebSearchOptions.SearchContextSize	searchContextSize()	Returns the value of the searchContextSize record component.
final String	toString()	Returns a string representation of this record class.
OpenAiApi.ChatCompletionRequest.WebSearchOptions.UserLocation	userLocation()	Returns the value of the userLocation record component.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Details

WebSearchOptions

public WebSearchOptions(OpenAiApi.ChatCompletionRequest.WebSearchOptions.SearchContextSize searchContextSize,
 OpenAiApi.ChatCompletionRequest.WebSearchOptions.UserLocation userLocation)

Creates an instance of a WebSearchOptions record class.

Parameters:

searchContextSize - the value for the searchContextSize record component

userLocation - the value for the userLocation record component

Method Details

toString

public final String toString()

Returns a string representation of this record class. The representation contains the name of the class, followed by the name and value of each of the record components.

Specified by:

toString in class Record

Returns:

a string representation of this object

hashCode

public final int hashCode()

Returns a hash code value for this object. The value is derived from the hash code of each of the record components.

Specified by:

hashCode in class Record

Returns:

a hash code value for this object

equals

public final boolean equals(Object o)

Indicates whether some other object is "equal to" this one. The objects are equal if the other object is of the same class and if all the record components are equal. All components in this record class are compared with Objects::equals(Object,Object).

Specified by:

equals in class Record

Parameters:

o - the object with which to compare

Returns:

true if this object is the same as the o argument; false otherwise.

searchContextSize

public OpenAiApi.ChatCompletionRequest.WebSearchOptions.SearchContextSize searchContextSize()

Returns the value of the searchContextSize record component.

Returns:

the value of the searchContextSize record component

userLocation

public OpenAiApi.ChatCompletionRequest.WebSearchOptions.UserLocation userLocation()

Returns the value of the userLocation record component.

Returns:

the value of the userLocation record component