Constructor Detail

Method Detail

• id

   final ResponseFunctionWebSearch.Builder id(String id)

  The unique ID of the web search tool call.

• id

   final ResponseFunctionWebSearch.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 ResponseFunctionWebSearch.Builder action(ResponseFunctionWebSearch.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).

• action

   final ResponseFunctionWebSearch.Builder action(JsonField<ResponseFunctionWebSearch.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 ResponseFunctionWebSearch.Builder action(ResponseFunctionWebSearch.Action.Search search)

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

• action

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

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

• action

   final ResponseFunctionWebSearch.Builder action(ResponseFunctionWebSearch.Action.Find find)

  Alias for calling action with Action.ofFind(find).

• searchAction

   final ResponseFunctionWebSearch.Builder searchAction(String query)

  Alias for calling action with the following:

  Action.Search.builder()
      .query(query)
      .build()

• openPageAction

   final ResponseFunctionWebSearch.Builder openPageAction(String url)

  Alias for calling action with the following:

  Action.OpenPage.builder()
      .url(url)
      .build()

• status

   final ResponseFunctionWebSearch.Builder status(ResponseFunctionWebSearch.Status status)

  The status of the web search tool call.

• status

   final ResponseFunctionWebSearch.Builder status(JsonField<ResponseFunctionWebSearch.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 ResponseFunctionWebSearch.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.

• additionalProperties

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

• putAdditionalProperty

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

• putAllAdditionalProperties

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

• removeAdditionalProperty

   final ResponseFunctionWebSearch.Builder removeAdditionalProperty(String key)

• removeAllAdditionalProperties

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

• build

   final ResponseFunctionWebSearch build()

  Returns an immutable instance of ResponseFunctionWebSearch.

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

  The following fields are required:

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