Constructor Detail

Method Detail

• search

   final Optional<ResponseFunctionWebSearch.Action.Search> search()

  Action type "search" - Performs a web search query.

• openPage

   final Optional<ResponseFunctionWebSearch.Action.OpenPage> openPage()

  Action type "open_page" - Opens a specific URL from search results.

• findInPage

   final Optional<ResponseFunctionWebSearch.Action.Find> findInPage()

  Action type "find_in_page": Searches for a pattern within a loaded page.

• isSearch

   final Boolean isSearch()

• isOpenPage

   final Boolean isOpenPage()

• isFind

   final Boolean isFind()

• asSearch

   final ResponseFunctionWebSearch.Action.Search asSearch()

  Action type "search" - Performs a web search query.

• asOpenPage

   final ResponseFunctionWebSearch.Action.OpenPage asOpenPage()

  Action type "open_page" - Opens a specific URL from search results.

• asFind

   final ResponseFunctionWebSearch.Action.Find asFind()

  Action type "find_in_page": Searches for a pattern within a loaded page.

• _json

   final Optional<JsonValue> _json()

• accept

   final <T extends Any> T accept(ResponseFunctionWebSearch.Action.Visitor<T> visitor)

  Maps this instance's current variant to a value of type T using the given visitor.

  Note that this method is not forwards compatible with new variants from the API, unless visitor overrides Visitor.unknown. To handle variants not known to this version of the SDK gracefully, consider overriding Visitor.unknown:

  import com.openai.core.JsonValue;
  import java.util.Optional;
  
  Optional<String> result = action.accept(new Action.Visitor<Optional<String>>() {
      @Override
      public Optional<String> visitSearch(Search search) {
          return Optional.of(search.toString());
      }
  
      // ...
  
      @Override
      public Optional<String> unknown(JsonValue json) {
          // Or inspect the `json`.
          return Optional.empty();
      }
  });

• validate

   final ResponseFunctionWebSearch.Action validate()

  Validates that the types of all values in this object match their expected types recursively.

  This method is not forwards compatible with new types from the API for existing fields.

• isValid

   final Boolean isValid()

• equals

   Boolean equals(Object other)

• hashCode

   Integer hashCode()

• toString

   String toString()

• ofSearch

   final static ResponseFunctionWebSearch.Action ofSearch(ResponseFunctionWebSearch.Action.Search search)

  Action type "search" - Performs a web search query.

• ofOpenPage

   final static ResponseFunctionWebSearch.Action ofOpenPage(ResponseFunctionWebSearch.Action.OpenPage openPage)

  Action type "open_page" - Opens a specific URL from search results.

• ofFind

   final static ResponseFunctionWebSearch.Action ofFind(ResponseFunctionWebSearch.Action.Find findInPage)

  Action type "find_in_page": Searches for a pattern within a loaded page.