Class Function
-
- All Implemented Interfaces:
public final class Function
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description public final classFunction.BuilderA builder for Function.
public final classFunction.FunctionDatapublic final classFunction.LogIdA literal 'p' which identifies the object as a project prompt
public final classFunction.FunctionSchemaJSON schema for the function's parameters and return type
public final classFunction.FunctionTypepublic final classFunction.MetadataUser-controlled metadata about the prompt
public final classFunction.Origin
-
Method Summary
Modifier and Type Method Description final Stringid()Unique identifier for the prompt final String_xactId()The transaction id of an event is unique to the network operation that processed the event insertion. final Function.FunctionDatafunctionData()final Function.LogIdlogId()A literal 'p' which identifies the object as a project prompt final Stringname()Name of the prompt final StringorgId()Unique identifier for the organization final StringprojectId()Unique identifier for the project that the prompt belongs under final Stringslug()Unique identifier for the prompt final Optional<OffsetDateTime>created()Date of prompt creation final Optional<String>description()Textual description of the prompt final Optional<Function.FunctionSchema>functionSchema()JSON schema for the function's parameters and return type final Optional<Function.FunctionType>functionType()final Optional<Function.Metadata>metadata()User-controlled metadata about the prompt final Optional<Function.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<String>_id()Returns the raw JSON value of id. final JsonField<String>__xactId()Returns the raw JSON value of _xactId. final JsonField<Function.FunctionData>_functionData()Returns the raw JSON value of functionData. final JsonField<Function.LogId>_logId()Returns the raw JSON value of logId. final JsonField<String>_name()Returns the raw JSON value of name. final JsonField<String>_orgId()Returns the raw JSON value of orgId. final JsonField<String>_projectId()Returns the raw JSON value of projectId. final JsonField<String>_slug()Returns the raw JSON value of slug. final JsonField<OffsetDateTime>_created()Returns the raw JSON value of created. final JsonField<String>_description()Returns the raw JSON value of description. final JsonField<Function.FunctionSchema>_functionSchema()Returns the raw JSON value of functionSchema. final JsonField<Function.FunctionType>_functionType()Returns the raw JSON value of functionType. final JsonField<Function.Metadata>_metadata()Returns the raw JSON value of metadata. final JsonField<Function.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>_additionalProperties()final Function.BuildertoBuilder()final Functionvalidate()final BooleanisValid()Booleanequals(Object other)IntegerhashCode()StringtoString()final static Function.Builderbuilder()Returns a mutable builder for constructing an instance of Function. -
-
Method Detail
-
_xactId
final String _xactId()
The transaction id of an event is unique to the network operation that processed the event insertion. Transaction ids are monotonically increasing over time and can be used to retrieve a versioned snapshot of the prompt (see the
versionparameter)
-
functionData
final Function.FunctionData functionData()
-
logId
final Function.LogId logId()
A literal 'p' which identifies the object as a project prompt
-
created
final Optional<OffsetDateTime> created()
Date of prompt creation
-
description
final Optional<String> description()
Textual description of the prompt
-
functionSchema
final Optional<Function.FunctionSchema> functionSchema()
JSON schema for the function's parameters and return type
-
functionType
final Optional<Function.FunctionType> functionType()
-
metadata
final Optional<Function.Metadata> metadata()
User-controlled metadata about the prompt
-
origin
final Optional<Function.Origin> origin()
-
promptData
final Optional<PromptData> promptData()
The prompt, model, and its parameters
-
_id
final JsonField<String> _id()
Returns the raw JSON value of id.
Unlike id, this method doesn't throw if the JSON field has an unexpected type.
-
__xactId
final JsonField<String> __xactId()
Returns the raw JSON value of _xactId.
Unlike _xactId, this method doesn't throw if the JSON field has an unexpected type.
-
_functionData
final JsonField<Function.FunctionData> _functionData()
Returns the raw JSON value of functionData.
Unlike functionData, this method doesn't throw if the JSON field has an unexpected type.
-
_logId
final JsonField<Function.LogId> _logId()
Returns the raw JSON value of logId.
Unlike logId, 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.
-
_orgId
final JsonField<String> _orgId()
Returns the raw JSON value of orgId.
Unlike orgId, 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.
-
_created
final JsonField<OffsetDateTime> _created()
Returns the raw JSON value of created.
Unlike created, 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<Function.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<Function.FunctionType> _functionType()
Returns the raw JSON value of functionType.
Unlike functionType, this method doesn't throw if the JSON field has an unexpected type.
-
_metadata
final JsonField<Function.Metadata> _metadata()
Returns the raw JSON value of metadata.
Unlike metadata, this method doesn't throw if the JSON field has an unexpected type.
-
_origin
final JsonField<Function.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.
-
_additionalProperties
final Map<String, JsonValue> _additionalProperties()
-
toBuilder
final Function.Builder toBuilder()
-
builder
final static Function.Builder builder()
Returns a mutable builder for constructing an instance of Function.
The following fields are required:
.id() ._xactId() .functionData() .logId() .name() .orgId() .projectId() .slug()
-
-
-
-