Constructor Detail

Method Detail

• id

   final BetaResponseFunctionWebSearch.Builder id(String id)

  The unique ID of the web search tool call.

• id

   final BetaResponseFunctionWebSearch.Builder id(JsonField<String> id)

  Sets Builder.id to an arbitrary JSON value.

  You should usually call Builder.id with a well-typed String value instead. This method is primarily for setting the field to an undocumented or not yet supported value.

• action

   final BetaResponseFunctionWebSearch.Builder action(BetaResponseFunctionWebSearch.Action action)

  An object describing the specific action taken in this web search call. Includes details on how the model used the web (search, open_page, find_in_page).

• action

   final BetaResponseFunctionWebSearch.Builder action(JsonField<BetaResponseFunctionWebSearch.Action> action)

  Sets Builder.action to an arbitrary JSON value.

  You should usually call Builder.action with a well-typed Action value instead. This method is primarily for setting the field to an undocumented or not yet supported value.

• action

   final BetaResponseFunctionWebSearch.Builder action(BetaResponseFunctionWebSearch.Action.Search search)

  Alias for calling action with Action.ofSearch(search).

• action

   final BetaResponseFunctionWebSearch.Builder action(BetaResponseFunctionWebSearch.Action.OpenPage openPage)

  Alias for calling action with Action.ofOpenPage(openPage).

• action

   final BetaResponseFunctionWebSearch.Builder action(BetaResponseFunctionWebSearch.Action.FindInPage findInPage)

  Alias for calling action with Action.ofFindInPage(findInPage).

• status

   final BetaResponseFunctionWebSearch.Builder status(BetaResponseFunctionWebSearch.Status status)

  The status of the web search tool call.

• status

   final BetaResponseFunctionWebSearch.Builder status(JsonField<BetaResponseFunctionWebSearch.Status> status)

  Sets Builder.status to an arbitrary JSON value.

  You should usually call Builder.status with a well-typed Status value instead. This method is primarily for setting the field to an undocumented or not yet supported value.

• type

   final BetaResponseFunctionWebSearch.Builder type(JsonValue type)

  Sets the field to an arbitrary JSON value.

  It is usually unnecessary to call this method because the field defaults to the following:

  JsonValue.from("web_search_call")

  This method is primarily for setting the field to an undocumented or not yet supported value.

• agent

   final BetaResponseFunctionWebSearch.Builder agent(BetaResponseFunctionWebSearch.Agent agent)

  The agent that produced this item.

• agent

   final BetaResponseFunctionWebSearch.Builder agent(Optional<BetaResponseFunctionWebSearch.Agent> agent)

  Alias for calling Builder.agent with agent.orElse(null).

• agent

   final BetaResponseFunctionWebSearch.Builder agent(JsonField<BetaResponseFunctionWebSearch.Agent> agent)

  Sets Builder.agent to an arbitrary JSON value.

  You should usually call Builder.agent with a well-typed Agent value instead. This method is primarily for setting the field to an undocumented or not yet supported value.

• additionalProperties

   final BetaResponseFunctionWebSearch.Builder additionalProperties(Map<String, JsonValue> additionalProperties)

• putAdditionalProperty

   final BetaResponseFunctionWebSearch.Builder putAdditionalProperty(String key, JsonValue value)

• putAllAdditionalProperties

   final BetaResponseFunctionWebSearch.Builder putAllAdditionalProperties(Map<String, JsonValue> additionalProperties)

• removeAdditionalProperty

   final BetaResponseFunctionWebSearch.Builder removeAdditionalProperty(String key)

• removeAllAdditionalProperties

   final BetaResponseFunctionWebSearch.Builder removeAllAdditionalProperties(Set<String> keys)

• build

   final BetaResponseFunctionWebSearch build()

  Returns an immutable instance of BetaResponseFunctionWebSearch.

  Further updates to this Builder will not mutate the returned instance.

  The following fields are required:

  .id()
  .action()
  .status()