Constructor Detail

Method Detail

• name

   final ChatCompletionCustomTool.Custom.Builder name(String name)

  The name of the custom tool, used to identify it in tool calls.

• name

   final ChatCompletionCustomTool.Custom.Builder name(JsonField<String> name)

  Sets Builder.name to an arbitrary JSON value.

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

• description

   final ChatCompletionCustomTool.Custom.Builder description(String description)

  Optional description of the custom tool, used to provide more context.

• description

   final ChatCompletionCustomTool.Custom.Builder description(JsonField<String> description)

  Sets Builder.description to an arbitrary JSON value.

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

• format

   final ChatCompletionCustomTool.Custom.Builder format(ChatCompletionCustomTool.Custom.Format format)

  The input format for the custom tool. Default is unconstrained text.

• format

   final ChatCompletionCustomTool.Custom.Builder format(JsonField<ChatCompletionCustomTool.Custom.Format> format)

  Sets Builder.format to an arbitrary JSON value.

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

• format

   final ChatCompletionCustomTool.Custom.Builder format(ChatCompletionCustomTool.Custom.Format.Grammar grammar)

  Alias for calling format with Format.ofGrammar(grammar).

• formatText

   final ChatCompletionCustomTool.Custom.Builder formatText()

  Alias for calling format with Format.ofText().

• grammarFormat

   final ChatCompletionCustomTool.Custom.Builder grammarFormat(ChatCompletionCustomTool.Custom.Format.Grammar.InnerGrammar grammar)

  Alias for calling format with the following:

  Format.Grammar.builder()
      .grammar(grammar)
      .build()

• additionalProperties

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

• putAdditionalProperty

   final ChatCompletionCustomTool.Custom.Builder putAdditionalProperty(String key, JsonValue value)

• putAllAdditionalProperties

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

• removeAdditionalProperty

   final ChatCompletionCustomTool.Custom.Builder removeAdditionalProperty(String key)

• removeAllAdditionalProperties

   final ChatCompletionCustomTool.Custom.Builder removeAllAdditionalProperties(Set<String> keys)

• build

   final ChatCompletionCustomTool.Custom build()

  Returns an immutable instance of Custom.

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

  The following fields are required:

  .name()