Class FunctionCreateParams
-
- All Implemented Interfaces:
-
com.braintrustdata.api.core.Params
public final class FunctionCreateParams implements Params
Create a new function. If there is an existing function in the project with the same slug as the one specified in the request, will return the existing function unmodified
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description public final classFunctionCreateParams.Bodypublic final classFunctionCreateParams.BuilderA builder for FunctionCreateParams.
public final classFunctionCreateParams.FunctionDatapublic final classFunctionCreateParams.FunctionSchemaJSON schema for the function's parameters and return type
public final classFunctionCreateParams.FunctionTypepublic final classFunctionCreateParams.Origin
-
Method Summary
Modifier and Type Method Description final FunctionCreateParams.FunctionDatafunctionData()final Stringname()Name of the prompt final StringprojectId()Unique identifier for the project that the prompt belongs under final Stringslug()Unique identifier for the prompt final Optional<String>description()Textual description of the prompt final Optional<FunctionCreateParams.FunctionSchema>functionSchema()JSON schema for the function's parameters and return type final Optional<FunctionCreateParams.FunctionType>functionType()final Optional<FunctionCreateParams.Origin>origin()final Optional<PromptData>promptData()The prompt, model, and its parameters final Optional<List<String>>tags()A list of tags for the prompt final JsonField<FunctionCreateParams.FunctionData>_functionData()Returns the raw JSON value of functionData. final JsonField<String>_name()Returns the raw JSON value of name. final JsonField<String>_projectId()Returns the raw JSON value of projectId. final JsonField<String>_slug()Returns the raw JSON value of slug. final JsonField<String>_description()Returns the raw JSON value of description. final JsonField<FunctionCreateParams.FunctionSchema>_functionSchema()Returns the raw JSON value of functionSchema. final JsonField<FunctionCreateParams.FunctionType>_functionType()Returns the raw JSON value of functionType. final JsonField<FunctionCreateParams.Origin>_origin()Returns the raw JSON value of origin. 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()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. final FunctionCreateParams.BuildertoBuilder()Booleanequals(Object other)IntegerhashCode()StringtoString()final static FunctionCreateParams.Builderbuilder()Returns a mutable builder for constructing an instance of FunctionCreateParams. -
-
Method Detail
-
functionData
final FunctionCreateParams.FunctionData functionData()
-
description
final Optional<String> description()
Textual description of the prompt
-
functionSchema
final Optional<FunctionCreateParams.FunctionSchema> functionSchema()
JSON schema for the function's parameters and return type
-
functionType
final Optional<FunctionCreateParams.FunctionType> functionType()
-
origin
final Optional<FunctionCreateParams.Origin> origin()
-
promptData
final Optional<PromptData> promptData()
The prompt, model, and its parameters
-
_functionData
final JsonField<FunctionCreateParams.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.
-
_projectId
final JsonField<String> _projectId()
Returns the raw JSON value of projectId.
Unlike projectId, this method doesn't throw if the JSON field has an unexpected type.
-
_slug
final JsonField<String> _slug()
Returns the raw JSON value of slug.
Unlike slug, this method doesn't throw if the JSON field has an unexpected type.
-
_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.
-
_functionSchema
final JsonField<FunctionCreateParams.FunctionSchema> _functionSchema()
Returns the raw JSON value of functionSchema.
Unlike functionSchema, this method doesn't throw if the JSON field has an unexpected type.
-
_functionType
final JsonField<FunctionCreateParams.FunctionType> _functionType()
Returns the raw JSON value of functionType.
Unlike functionType, this method doesn't throw if the JSON field has an unexpected type.
-
_origin
final JsonField<FunctionCreateParams.Origin> _origin()
Returns the raw JSON value of origin.
Unlike origin, 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()
-
_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.
-
toBuilder
final FunctionCreateParams.Builder toBuilder()
-
builder
final static FunctionCreateParams.Builder builder()
Returns a mutable builder for constructing an instance of FunctionCreateParams.
The following fields are required:
.functionData() .name() .projectId() .slug()
-
-
-
-