Package com.oracle.bmc.generativeaiinference.model

Class WebSearchOptions

java.lang.Object

com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel

com.oracle.bmc.generativeaiinference.model.WebSearchOptions

@Generated(value="OracleSDKGenerator",
           comments="API Version: 20231130")
public final class WebSearchOptions
extends com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel

Options for performing a web search to augment the response.
Note: Objects should always be created or deserialized using the WebSearchOptions.Builder. This model distinguishes fields that are null because they are unset from fields that are explicitly set to null. This is done in the setter methods of the WebSearchOptions.Builder, which maintain a set of all explicitly set fields called WebSearchOptions.Builder.__explicitlySet__. The hashCode() and equals(Object) methods are implemented to take the explicitly set fields into account. The constructor, on the other hand, does not take the explicitly set fields into account (since the constructor cannot distinguish explicit null from unset null).

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	WebSearchOptions.Builder
static class	WebSearchOptions.SearchContextSize	Specifies the size of the web search context.

Field Summary

Fields inherited from class com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel

EXPLICITLY_SET_FILTER_NAME, EXPLICITLY_SET_PROPERTY_NAME

Constructor Summary

Constructors

Constructor	Description
WebSearchOptions(WebSearchOptions.SearchContextSize searchContextSize, ApproximateLocation userLocation)	Deprecated.

Method Summary

Modifier and Type	Method	Description
static WebSearchOptions.Builder	builder()	Create a new builder.
boolean	equals(Object o)
WebSearchOptions.SearchContextSize	getSearchContextSize()	Specifies the size of the web search context.
ApproximateLocation	getUserLocation()
int	hashCode()
WebSearchOptions.Builder	toBuilder()
String	toString()
String	toString(boolean includeByteArrayContents)	Return a string representation of the object.

Methods inherited from class com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel

markPropertyAsExplicitlySet, wasPropertyExplicitlySet

Methods inherited from class java.lang.Object

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

Constructor Detail

WebSearchOptions

@Deprecated
@ConstructorProperties({"searchContextSize","userLocation"})
public WebSearchOptions(WebSearchOptions.SearchContextSize searchContextSize,
                        ApproximateLocation userLocation)

Deprecated.

Method Detail

builder

public static WebSearchOptions.Builder builder()

Create a new builder.

toBuilder

public WebSearchOptions.Builder toBuilder()

getSearchContextSize

public WebSearchOptions.SearchContextSize getSearchContextSize()

Specifies the size of the web search context.

• HIGH: Most comprehensive context, highest cost, slower response. - MEDIUM: Balanced context, cost, and latency. - LOW: Least context, lowest cost, fastest response, but potentially lower answer quality.

Returns:

the value

getUserLocation

public ApproximateLocation getUserLocation()

toString

public String toString()

Overrides:

toString in class com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel

toString

public String toString(boolean includeByteArrayContents)

Return a string representation of the object.

Parameters:

includeByteArrayContents - true to include the full contents of byte arrays

Returns:

string representation

equals

public boolean equals(Object o)

Overrides:

equals in class com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel

hashCode

public int hashCode()

Overrides:

hashCode in class com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel