WebSearchOptions class

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

Annotations
  • @freezed

Constructors

WebSearchOptions.new({@JsonKey(name: 'user_location', includeIfNull: false) WebSearchOptionsUserLocation? userLocation, @JsonKey(name: 'search_context_size') @Default(WebSearchContextSize.medium) WebSearchContextSize searchContextSize})
Factory constructor for WebSearchOptions
const
factory
WebSearchOptions.fromJson(Map<String, dynamic> json)
Object construction from a JSON representation
factory

Properties

copyWith → $WebSearchOptionsCopyWith<WebSearchOptions>
Create a copy of WebSearchOptions with the given fields replaced by the non-null parameter values.
no setterinherited
hashCode int
The hash code for this object.
no setterinherited
runtimeType Type
A representation of the runtime type of the object.
no setterinherited
searchContextSize WebSearchContextSize
High level guidance for the amount of context window space to use for the search. One of low, medium, or high. medium is the default.
no setterinherited
userLocation WebSearchOptionsUserLocation?
Approximate location parameters for the search.
no setterinherited

Methods

noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
toJson() Map<String, dynamic>
Serializes this WebSearchOptions to a JSON map.
inherited
toMap() Map<String, dynamic>
Map representation of object (not serialized)
toString() String
A string representation of this object.
inherited
validateSchema() String?
Perform validations on the schema property values

Operators

operator ==(Object other) bool
The equality operator.
inherited

Constants

propertyNames → const List<String>
List of all property names of schema