Class PromptCreateParams
-
- All Implemented Interfaces:
-
com.braintrustdata.api.core.Params
public final class PromptCreateParams implements Params
Create a new prompt. If there is an existing prompt in the project with the same slug as the one specified in the request, will return the existing prompt unmodified
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description public final classPromptCreateParams.Bodypublic final classPromptCreateParams.BuilderA builder for PromptCreateParams.
public final classPromptCreateParams.FunctionType
-
Method Summary
Modifier and Type Method Description 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<PromptCreateParams.FunctionType>functionType()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>_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<PromptCreateParams.FunctionType>_functionType()Returns the raw JSON value of functionType. 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 PromptCreateParams.BuildertoBuilder()Booleanequals(Object other)IntegerhashCode()StringtoString()final static PromptCreateParams.Builderbuilder()Returns a mutable builder for constructing an instance of PromptCreateParams. -
-
Method Detail
-
description
final Optional<String> description()
Textual description of the prompt
-
functionType
final Optional<PromptCreateParams.FunctionType> functionType()
-
promptData
final Optional<PromptData> promptData()
The prompt, model, and its parameters
-
_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.
-
_functionType
final JsonField<PromptCreateParams.FunctionType> _functionType()
Returns the raw JSON value of functionType.
Unlike functionType, 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 PromptCreateParams.Builder toBuilder()
-
builder
final static PromptCreateParams.Builder builder()
Returns a mutable builder for constructing an instance of PromptCreateParams.
The following fields are required:
.name() .projectId() .slug()
-
-
-
-