Package com.openai.models.responses
Class ResponseFunctionWebSearch.Action.Find
-
- All Implemented Interfaces:
public final class ResponseFunctionWebSearch.Action.Find
Action type "find": Searches for a pattern within a loaded page.
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description public final class
ResponseFunctionWebSearch.Action.Find.Builder
A builder for Find.
-
Method Summary
Modifier and Type Method Description final String
pattern()
The pattern or text to search for within the page. final JsonValue
_type()
The action type. final String
url()
The URL of the page searched for the pattern. final JsonField<String>
_pattern()
Returns the raw JSON value of pattern. final JsonField<String>
_url()
Returns the raw JSON value of url. final Map<String, JsonValue>
_additionalProperties()
final ResponseFunctionWebSearch.Action.Find.Builder
toBuilder()
final ResponseFunctionWebSearch.Action.Find
validate()
final Boolean
isValid()
Boolean
equals(Object other)
Integer
hashCode()
String
toString()
final static ResponseFunctionWebSearch.Action.Find.Builder
builder()
Returns a mutable builder for constructing an instance of Find. -
-
Method Detail
-
_type
final JsonValue _type()
The action type.
Expected to always return the following:
JsonValue.from("find")
However, this method can be useful for debugging and logging (e.g. if the server responded with an unexpected value).
-
_pattern
final JsonField<String> _pattern()
Returns the raw JSON value of pattern.
Unlike pattern, this method doesn't throw if the JSON field has an unexpected type.
-
_url
final JsonField<String> _url()
Returns the raw JSON value of url.
Unlike url, this method doesn't throw if the JSON field has an unexpected type.
-
_additionalProperties
final Map<String, JsonValue> _additionalProperties()
-
toBuilder
final ResponseFunctionWebSearch.Action.Find.Builder toBuilder()
-
validate
final ResponseFunctionWebSearch.Action.Find validate()
-
builder
final static ResponseFunctionWebSearch.Action.Find.Builder builder()
Returns a mutable builder for constructing an instance of Find.
The following fields are required:
.pattern() .url()
-
-
-
-