Class FunctionUpdateParams
-
- All Implemented Interfaces:
-
com.braintrustdata.api.core.Params
public final class FunctionUpdateParams implements Params
Partially update a function object. Specify the fields to update in the payload. Any object-type fields will be deep-merged with existing content. Currently we do not support removing fields or setting them to null.
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description public final classFunctionUpdateParams.BuilderA builder for FunctionUpdateParams.
public final classFunctionUpdateParams.Bodypublic final classFunctionUpdateParams.FunctionData
-
Method Summary
Modifier and Type Method Description final StringfunctionId()Function id final Optional<String>description()Textual description of the prompt final Optional<FunctionUpdateParams.FunctionData>functionData()final Optional<String>name()Name of the prompt final Optional<PromptData>promptData()The prompt, model, and its parameters final Optional<List<String>>tags()A list of tags for the prompt final JsonField<String>_description()Returns the raw JSON value of description. final JsonField<FunctionUpdateParams.FunctionData>_functionData()Returns the raw JSON value of functionData. final JsonField<String>_name()Returns the raw JSON value of name. final JsonField<PromptData>_promptData()Returns the raw JSON value of promptData. final JsonField<List<String>>_tags()Returns the raw JSON value of tags. final Map<String, JsonValue>_additionalBodyProperties()final Headers_additionalHeaders()final QueryParams_additionalQueryParams()final FunctionUpdateParams.BuildertoBuilder()final FunctionUpdateParams.Body_body()final String_pathParam(Integer index)Headers_headers()The full set of headers in the parameters, including both fixed and additional headers. QueryParams_queryParams()The full set of query params in the parameters, including both fixed and additional query params. Booleanequals(Object other)IntegerhashCode()StringtoString()final static FunctionUpdateParams.Builderbuilder()Returns a mutable builder for constructing an instance of FunctionUpdateParams. -
-
Method Detail
-
functionId
final String functionId()
Function id
-
description
final Optional<String> description()
Textual description of the prompt
-
functionData
final Optional<FunctionUpdateParams.FunctionData> functionData()
-
promptData
final Optional<PromptData> promptData()
The prompt, model, and its parameters
-
_description
final JsonField<String> _description()
Returns the raw JSON value of description.
Unlike description, this method doesn't throw if the JSON field has an unexpected type.
-
_functionData
final JsonField<FunctionUpdateParams.FunctionData> _functionData()
Returns the raw JSON value of functionData.
Unlike functionData, this method doesn't throw if the JSON field has an unexpected type.
-
_name
final JsonField<String> _name()
Returns the raw JSON value of name.
Unlike name, this method doesn't throw if the JSON field has an unexpected type.
-
_promptData
final JsonField<PromptData> _promptData()
Returns the raw JSON value of promptData.
Unlike promptData, this method doesn't throw if the JSON field has an unexpected type.
-
_tags
final JsonField<List<String>> _tags()
Returns the raw JSON value of tags.
Unlike tags, this method doesn't throw if the JSON field has an unexpected type.
-
_additionalBodyProperties
final Map<String, JsonValue> _additionalBodyProperties()
-
_additionalHeaders
final Headers _additionalHeaders()
-
_additionalQueryParams
final QueryParams _additionalQueryParams()
-
toBuilder
final FunctionUpdateParams.Builder toBuilder()
-
_body
final FunctionUpdateParams.Body _body()
-
_pathParam
final String _pathParam(Integer index)
-
_headers
Headers _headers()
The full set of headers in the parameters, including both fixed and additional headers.
-
_queryParams
QueryParams _queryParams()
The full set of query params in the parameters, including both fixed and additional query params.
-
builder
final static FunctionUpdateParams.Builder builder()
Returns a mutable builder for constructing an instance of FunctionUpdateParams.
The following fields are required:
.functionId()
-
-
-
-