All Implemented Interfaces:
```
public final class ResponsePrompt

                    
```
Reference to a prompt template and its variables. Learn more.

Nested Class Summary

Nested Classes
Modifier and Type	Class	Description
`public final class`	`ResponsePrompt.Builder`	A builder for ResponsePrompt.
`public final class`	`ResponsePrompt.Variables`	Optional map of values to substitute in for variables in your prompt. The substitution values can either be strings, or other Response input types like images or files.

Field Summary

Fields
Modifier and Type	Field	Description

Constructor Summary

Constructors
Constructor	Description

Enum Constant Summary

Enum Constants
Enum Constant	Description

Method Summary

Modifier and Type	Method	Description
`final String`	`id()`	The unique identifier of the prompt template to use.
`final Optional<ResponsePrompt.Variables>`	`variables()`	Optional map of values to substitute in for variables in your prompt.
`final Optional<String>`	`version()`	Optional version of the prompt template.
`final JsonField<String>`	`_id()`	Returns the raw JSON value of id.
`final JsonField<ResponsePrompt.Variables>`	`_variables()`	Returns the raw JSON value of variables.
`final JsonField<String>`	`_version()`	Returns the raw JSON value of version.
`final Map<String, JsonValue>`	`_additionalProperties()`
`final ResponsePrompt.Builder`	`toBuilder()`
`final ResponsePrompt`	`validate()`
`final Boolean`	`isValid()`
`Boolean`	`equals(Object other)`
`Integer`	`hashCode()`
`String`	`toString()`
`final static ResponsePrompt.Builder`	`builder()`	Returns a mutable builder for constructing an instance of ResponsePrompt.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
- Method Detail
  - id
```
 final String id()
```
    The unique identifier of the prompt template to use.
  - variables
```
 final Optional<ResponsePrompt.Variables> variables()
```
    Optional map of values to substitute in for variables in your prompt. The substitution values can either be strings, or other Response input types like images or files.
  - version
```
 final Optional<String> version()
```
    Optional version of the prompt template.
  - _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.
  - _variables
```
 final JsonField<ResponsePrompt.Variables> _variables()
```
    Returns the raw JSON value of variables.
    Unlike variables, this method doesn't throw if the JSON field has an unexpected type.
  - _version
```
 final JsonField<String> _version()
```
    Returns the raw JSON value of version.
    Unlike version, this method doesn't throw if the JSON field has an unexpected type.
  - _additionalProperties
```
 final Map<String, JsonValue> _additionalProperties()
```
  - toBuilder
```
 final ResponsePrompt.Builder toBuilder()
```
  - validate
```
 final ResponsePrompt validate()
```
  - isValid
```
 final Boolean isValid()
```
  - equals
```
 Boolean equals(Object other)
```
  - hashCode
```
 Integer hashCode()
```
  - toString
```
 String toString()
```
  - builder
```
 final static ResponsePrompt.Builder builder()
```
    Returns a mutable builder for constructing an instance of ResponsePrompt.
    The following fields are required:
    .id()

Class ResponsePrompt

Nested Class Summary

Field Summary

Constructor Summary

Enum Constant Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

Method Detail

id

variables

version

_id

_variables

_version

_additionalProperties

toBuilder

validate

isValid

equals

hashCode

toString

builder