Constructor Detail

Method Detail

• functionId

   final FunctionInvokeParams.Builder functionId(String functionId)

  Function id

• body

   final FunctionInvokeParams.Builder body(FunctionInvokeParams.Body body)

  Sets the entire request body.

  This is generally only useful if you are already constructing the body separately. Otherwise, it's more convenient to use the top-level setters instead:

  • expected

  • input

  • messages

  • metadata

  • mode

  • etc.

• expected

   final FunctionInvokeParams.Builder expected(JsonValue expected)

  The expected output of the function

• input

   final FunctionInvokeParams.Builder input(JsonValue input)

  Argument to the function, which can be any JSON serializable value

• messages

   final FunctionInvokeParams.Builder messages(List<FunctionInvokeParams.Message> messages)

  If the function is an LLM, additional messages to pass along to it

• messages

   final FunctionInvokeParams.Builder messages(JsonField<List<FunctionInvokeParams.Message>> messages)

  Sets Builder.messages to an arbitrary JSON value.

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

• addMessage

   final FunctionInvokeParams.Builder addMessage(FunctionInvokeParams.Message message)

  Adds a single Message to messages.

• addMessage

   final FunctionInvokeParams.Builder addMessage(FunctionInvokeParams.Message.System system)

  Alias for calling addMessage with Message.ofSystem(system).

• addMessage

   final FunctionInvokeParams.Builder addMessage(FunctionInvokeParams.Message.User user)

  Alias for calling addMessage with Message.ofUser(user).

• addMessage

   final FunctionInvokeParams.Builder addMessage(FunctionInvokeParams.Message.Assistant assistant)

  Alias for calling addMessage with Message.ofAssistant(assistant).

• addMessage

   final FunctionInvokeParams.Builder addMessage(FunctionInvokeParams.Message.Tool tool)

  Alias for calling addMessage with Message.ofTool(tool).

• addMessage

   final FunctionInvokeParams.Builder addMessage(FunctionInvokeParams.Message.Function function)

  Alias for calling addMessage with Message.ofFunction(function).

• addMessage

   final FunctionInvokeParams.Builder addMessage(FunctionInvokeParams.Message.Fallback fallback)

  Alias for calling addMessage with Message.ofFallback(fallback).

• metadata

   final FunctionInvokeParams.Builder metadata(FunctionInvokeParams.Metadata metadata)

  Any relevant metadata

• metadata

   final FunctionInvokeParams.Builder metadata(Optional<FunctionInvokeParams.Metadata> metadata)

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

• metadata

   final FunctionInvokeParams.Builder metadata(JsonField<FunctionInvokeParams.Metadata> metadata)

  Sets Builder.metadata to an arbitrary JSON value.

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

• mode

   final FunctionInvokeParams.Builder mode(FunctionInvokeParams.Mode mode)

  The mode format of the returned value (defaults to 'auto')

• mode

   final FunctionInvokeParams.Builder mode(Optional<FunctionInvokeParams.Mode> mode)

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

• mode

   final FunctionInvokeParams.Builder mode(JsonField<FunctionInvokeParams.Mode> mode)

  Sets Builder.mode to an arbitrary JSON value.

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

• parent

   final FunctionInvokeParams.Builder parent(FunctionInvokeParams.Parent parent)

  Options for tracing the function call

• parent

   final FunctionInvokeParams.Builder parent(JsonField<FunctionInvokeParams.Parent> parent)

  Sets Builder.parent to an arbitrary JSON value.

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

• parent

   final FunctionInvokeParams.Builder parent(FunctionInvokeParams.Parent.SpanParentStruct spanParentStruct)

  Alias for calling parent with Parent.ofSpanParentStruct(spanParentStruct).

• parent

   final FunctionInvokeParams.Builder parent(String string)

  Alias for calling parent with Parent.ofString(string).

• stream

   final FunctionInvokeParams.Builder stream(Boolean stream)

  Whether to stream the response. If true, results will be returned in the Braintrust SSE format.

• stream

   final FunctionInvokeParams.Builder stream(Boolean stream)

  Alias for Builder.stream.

  This unboxed primitive overload exists for backwards compatibility.

• stream

   final FunctionInvokeParams.Builder stream(Optional<Boolean> stream)

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

• stream

   final FunctionInvokeParams.Builder stream(JsonField<Boolean> stream)

  Sets Builder.stream to an arbitrary JSON value.

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

• version

   final FunctionInvokeParams.Builder version(String version)

  The version of the function

• version

   final FunctionInvokeParams.Builder version(JsonField<String> version)

  Sets Builder.version to an arbitrary JSON value.

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

• additionalBodyProperties

   final FunctionInvokeParams.Builder additionalBodyProperties(Map<String, JsonValue> additionalBodyProperties)

• putAdditionalBodyProperty

   final FunctionInvokeParams.Builder putAdditionalBodyProperty(String key, JsonValue value)

• putAllAdditionalBodyProperties

   final FunctionInvokeParams.Builder putAllAdditionalBodyProperties(Map<String, JsonValue> additionalBodyProperties)

• removeAdditionalBodyProperty

   final FunctionInvokeParams.Builder removeAdditionalBodyProperty(String key)

• removeAllAdditionalBodyProperties

   final FunctionInvokeParams.Builder removeAllAdditionalBodyProperties(Set<String> keys)

• additionalHeaders

   final FunctionInvokeParams.Builder additionalHeaders(Headers additionalHeaders)

• additionalHeaders

   final FunctionInvokeParams.Builder additionalHeaders(Map<String, Iterable<String>> additionalHeaders)

• putAdditionalHeader

   final FunctionInvokeParams.Builder putAdditionalHeader(String name, String value)

• putAdditionalHeaders

   final FunctionInvokeParams.Builder putAdditionalHeaders(String name, Iterable<String> values)

• putAllAdditionalHeaders

   final FunctionInvokeParams.Builder putAllAdditionalHeaders(Headers additionalHeaders)

• putAllAdditionalHeaders

   final FunctionInvokeParams.Builder putAllAdditionalHeaders(Map<String, Iterable<String>> additionalHeaders)

• replaceAdditionalHeaders

   final FunctionInvokeParams.Builder replaceAdditionalHeaders(String name, String value)

• replaceAdditionalHeaders

   final FunctionInvokeParams.Builder replaceAdditionalHeaders(String name, Iterable<String> values)

• replaceAllAdditionalHeaders

   final FunctionInvokeParams.Builder replaceAllAdditionalHeaders(Headers additionalHeaders)

• replaceAllAdditionalHeaders

   final FunctionInvokeParams.Builder replaceAllAdditionalHeaders(Map<String, Iterable<String>> additionalHeaders)

• removeAdditionalHeaders

   final FunctionInvokeParams.Builder removeAdditionalHeaders(String name)

• removeAllAdditionalHeaders

   final FunctionInvokeParams.Builder removeAllAdditionalHeaders(Set<String> names)

• additionalQueryParams

   final FunctionInvokeParams.Builder additionalQueryParams(QueryParams additionalQueryParams)

• additionalQueryParams

   final FunctionInvokeParams.Builder additionalQueryParams(Map<String, Iterable<String>> additionalQueryParams)

• putAdditionalQueryParam

   final FunctionInvokeParams.Builder putAdditionalQueryParam(String key, String value)

• putAdditionalQueryParams

   final FunctionInvokeParams.Builder putAdditionalQueryParams(String key, Iterable<String> values)

• putAllAdditionalQueryParams

   final FunctionInvokeParams.Builder putAllAdditionalQueryParams(QueryParams additionalQueryParams)

• putAllAdditionalQueryParams

   final FunctionInvokeParams.Builder putAllAdditionalQueryParams(Map<String, Iterable<String>> additionalQueryParams)

• replaceAdditionalQueryParams

   final FunctionInvokeParams.Builder replaceAdditionalQueryParams(String key, String value)

• replaceAdditionalQueryParams

   final FunctionInvokeParams.Builder replaceAdditionalQueryParams(String key, Iterable<String> values)

• replaceAllAdditionalQueryParams

   final FunctionInvokeParams.Builder replaceAllAdditionalQueryParams(QueryParams additionalQueryParams)

• replaceAllAdditionalQueryParams

   final FunctionInvokeParams.Builder replaceAllAdditionalQueryParams(Map<String, Iterable<String>> additionalQueryParams)

• removeAdditionalQueryParams

   final FunctionInvokeParams.Builder removeAdditionalQueryParams(String key)

• removeAllAdditionalQueryParams

   final FunctionInvokeParams.Builder removeAllAdditionalQueryParams(Set<String> keys)

• build

   final FunctionInvokeParams build()

  Returns an immutable instance of FunctionInvokeParams.

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

  The following fields are required:

  .functionId()