ExtractAIMessageOptions
in package
implements
ModelInterface, ArrayAccess, JsonSerializable
ExtractAIMessageOptions Class Doc Comment
Tags
Interfaces, Classes, Traits and Enums
- ModelInterface
- Interface abstracting model access.
- ArrayAccess
- JsonSerializable
Table of Contents
- DISCRIMINATOR = null
- EXTRACTION_PRESET_OTP_CODE = 'OTP_CODE'
- $attributeMap : array<string|int, string>
- Array of attributes where the key is the local name, and the value is the original name
- $container : array<string|int, mixed>
- Associative array for storing property values
- $getters : array<string|int, string>
- Array of attributes to getter functions (for serialization of requests)
- $openAPIFormats : array<string|int, string>
- Array of property to format mappings. Used for (de)serialization
- $openAPIModelName : string
- The original name of the model.
- $openAPINullables : array<string|int, mixed>
- Array of nullable properties. Used for (de)serialization
- $openAPINullablesSetToNull : array<string|int, mixed>
- If a nullable field gets set to null, insert it here
- $openAPITypes : array<string|int, string>
- Array of property to type mappings. Used for (de)serialization
- $setters : array<string|int, string>
- Array of attributes to setter functions (for deserialization of responses)
- __construct() : mixed
- Constructor
- __toString() : string
- Gets the string presentation of the object
- attributeMap() : array<string|int, mixed>
- Array of attributes where the key is the local name, and the value is the original name
- getAiOptions() : AIMessageAIOptions
- Gets ai_options
- getExtractionPreset() : string|null
- Gets extraction_preset
- getExtractionPresetAllowableValues() : array<string|int, string>
- Gets allowable values of the enum
- getInstructions() : string|null
- Gets instructions
- getMessage() : AIMessageReference
- Gets message
- getModelName() : string
- The original name of the model.
- getOutputSchema() : AIMessageExpectationOutputSchema|null
- Gets output_schema
- getters() : array<string|int, mixed>
- Array of attributes to getter functions (for serialization of requests)
- getTimeout() : int
- Gets timeout
- getTransformId() : string|null
- Gets transform_id
- isNullable() : bool
- Checks if a property is nullable
- isNullableSetToNull() : bool
- Checks if a nullable property is set to null.
- jsonSerialize() : mixed
- Serializes the object to a value that can be serialized natively by json_encode().
- listInvalidProperties() : array<string|int, mixed>
- Show all the invalid properties with reasons.
- offsetExists() : bool
- Returns true if offset exists. False otherwise.
- offsetGet() : mixed|null
- Gets offset.
- offsetSet() : void
- Sets value based on offset.
- offsetUnset() : void
- Unsets offset.
- openAPIFormats() : array<string|int, mixed>
- Array of property to format mappings. Used for (de)serialization
- openAPITypes() : array<string|int, mixed>
- Array of property to type mappings. Used for (de)serialization
- setAiOptions() : self
- Sets ai_options
- setExtractionPreset() : self
- Sets extraction_preset
- setInstructions() : self
- Sets instructions
- setMessage() : self
- Sets message
- setOutputSchema() : self
- Sets output_schema
- setters() : array<string|int, mixed>
- Array of attributes to setter functions (for deserialization of responses)
- setTimeout() : self
- Sets timeout
- setTransformId() : self
- Sets transform_id
- toHeaderValue() : string
- Gets a header-safe presentation of the object
- valid() : bool
- Validate all the properties in the model return true if all passed
- openAPINullables() : array<string|int, mixed>
- Array of nullable properties
- getOpenAPINullablesSetToNull() : array<string|int, bool>
- Array of nullable field names deliberately set to null
- setIfExists() : void
- Sets $this->container[$variableName] to the given data or to the given default Value; if $variableName is nullable and its value is set to null in the $fields array, then mark it as "set to null" in the $this->openAPINullablesSetToNull array
- setOpenAPINullablesSetToNull() : void
- Setter - Array of nullable field names deliberately set to null
Constants
DISCRIMINATOR
public
mixed
DISCRIMINATOR
= null
EXTRACTION_PRESET_OTP_CODE
public
mixed
EXTRACTION_PRESET_OTP_CODE
= 'OTP_CODE'
Properties
$attributeMap
Array of attributes where the key is the local name, and the value is the original name
protected
static array<string|int, string>
$attributeMap
= ['message' => 'message', 'output_schema' => 'outputSchema', 'transform_id' => 'transformId', 'instructions' => 'instructions', 'timeout' => 'timeout', 'ai_options' => 'aiOptions', 'extraction_preset' => 'extractionPreset']
$container
Associative array for storing property values
protected
array<string|int, mixed>
$container
= []
$getters
Array of attributes to getter functions (for serialization of requests)
protected
static array<string|int, string>
$getters
= ['message' => 'getMessage', 'output_schema' => 'getOutputSchema', 'transform_id' => 'getTransformId', 'instructions' => 'getInstructions', 'timeout' => 'getTimeout', 'ai_options' => 'getAiOptions', 'extraction_preset' => 'getExtractionPreset']
$openAPIFormats
Array of property to format mappings. Used for (de)serialization
protected
static array<string|int, string>
$openAPIFormats
= ['message' => null, 'output_schema' => null, 'transform_id' => 'uuid', 'instructions' => null, 'timeout' => 'int64', 'ai_options' => null, 'extraction_preset' => null]
Tags
$openAPIModelName
The original name of the model.
protected
static string
$openAPIModelName
= 'ExtractAIMessageOptions'
$openAPINullables
Array of nullable properties. Used for (de)serialization
protected
static array<string|int, mixed>
$openAPINullables
= ['message' => false, 'output_schema' => true, 'transform_id' => true, 'instructions' => true, 'timeout' => false, 'ai_options' => false, 'extraction_preset' => true]
$openAPINullablesSetToNull
If a nullable field gets set to null, insert it here
protected
array<string|int, mixed>
$openAPINullablesSetToNull
= []
$openAPITypes
Array of property to type mappings. Used for (de)serialization
protected
static array<string|int, string>
$openAPITypes
= ['message' => '\\MailSlurp\\Models\\AIMessageReference', 'output_schema' => '\\MailSlurp\\Models\\AIMessageExpectationOutputSchema', 'transform_id' => 'string', 'instructions' => 'string', 'timeout' => 'int', 'ai_options' => '\\MailSlurp\\Models\\AIMessageAIOptions', 'extraction_preset' => 'string']
$setters
Array of attributes to setter functions (for deserialization of responses)
protected
static array<string|int, string>
$setters
= ['message' => 'setMessage', 'output_schema' => 'setOutputSchema', 'transform_id' => 'setTransformId', 'instructions' => 'setInstructions', 'timeout' => 'setTimeout', 'ai_options' => 'setAiOptions', 'extraction_preset' => 'setExtractionPreset']
Methods
__construct()
Constructor
public
__construct([array<string|int, mixed> $data = null ]) : mixed
Parameters
- $data : array<string|int, mixed> = null
-
Associated array of property values initializing the model
Return values
mixed —__toString()
Gets the string presentation of the object
public
__toString() : string
Return values
string —attributeMap()
Array of attributes where the key is the local name, and the value is the original name
public
static attributeMap() : array<string|int, mixed>
Return values
array<string|int, mixed> —getAiOptions()
Gets ai_options
public
getAiOptions() : AIMessageAIOptions
Return values
AIMessageAIOptions —getExtractionPreset()
Gets extraction_preset
public
getExtractionPreset() : string|null
Return values
string|null —getExtractionPresetAllowableValues()
Gets allowable values of the enum
public
getExtractionPresetAllowableValues() : array<string|int, string>
Return values
array<string|int, string> —getInstructions()
Gets instructions
public
getInstructions() : string|null
Return values
string|null —getMessage()
Gets message
public
getMessage() : AIMessageReference
Return values
AIMessageReference —getModelName()
The original name of the model.
public
getModelName() : string
Return values
string —getOutputSchema()
Gets output_schema
public
getOutputSchema() : AIMessageExpectationOutputSchema|null
Return values
AIMessageExpectationOutputSchema|null —getters()
Array of attributes to getter functions (for serialization of requests)
public
static getters() : array<string|int, mixed>
Return values
array<string|int, mixed> —getTimeout()
Gets timeout
public
getTimeout() : int
Return values
int —getTransformId()
Gets transform_id
public
getTransformId() : string|null
Return values
string|null —isNullable()
Checks if a property is nullable
public
static isNullable(string $property) : bool
Parameters
- $property : string
Return values
bool —isNullableSetToNull()
Checks if a nullable property is set to null.
public
isNullableSetToNull(string $property) : bool
Parameters
- $property : string
Return values
bool —jsonSerialize()
Serializes the object to a value that can be serialized natively by json_encode().
public
jsonSerialize() : mixed
Tags
Return values
mixed —Returns data which can be serialized by json_encode(), which is a value of any type other than a resource.
listInvalidProperties()
Show all the invalid properties with reasons.
public
listInvalidProperties() : array<string|int, mixed>
Return values
array<string|int, mixed> —invalid properties with reasons
offsetExists()
Returns true if offset exists. False otherwise.
public
offsetExists(int $offset) : bool
Parameters
- $offset : int
-
Offset
Return values
bool —offsetGet()
Gets offset.
public
offsetGet(int $offset) : mixed|null
Parameters
- $offset : int
-
Offset
Return values
mixed|null —offsetSet()
Sets value based on offset.
public
offsetSet(int|null $offset, mixed $value) : void
Parameters
- $offset : int|null
-
Offset
- $value : mixed
-
Value to be set
Return values
void —offsetUnset()
Unsets offset.
public
offsetUnset(int $offset) : void
Parameters
- $offset : int
-
Offset
Return values
void —openAPIFormats()
Array of property to format mappings. Used for (de)serialization
public
static openAPIFormats() : array<string|int, mixed>
Return values
array<string|int, mixed> —openAPITypes()
Array of property to type mappings. Used for (de)serialization
public
static openAPITypes() : array<string|int, mixed>
Return values
array<string|int, mixed> —setAiOptions()
Sets ai_options
public
setAiOptions(AIMessageAIOptions $ai_options) : self
Parameters
- $ai_options : AIMessageAIOptions
-
ai_options
Return values
self —setExtractionPreset()
Sets extraction_preset
public
setExtractionPreset(string|null $extraction_preset) : self
Parameters
- $extraction_preset : string|null
-
Built-in extraction schema. OTP_CODE returns data.code as a verbatim string, preserving leading zeros and letter case. Missing or equally eligible codes are INCONCLUSIVE.
Return values
self —setInstructions()
Sets instructions
public
setInstructions(string|null $instructions) : self
Parameters
- $instructions : string|null
-
instructions
Return values
self —setMessage()
Sets message
public
setMessage(AIMessageReference $message) : self
Parameters
- $message : AIMessageReference
-
message
Return values
self —setOutputSchema()
Sets output_schema
public
setOutputSchema(AIMessageExpectationOutputSchema|null $output_schema) : self
Parameters
- $output_schema : AIMessageExpectationOutputSchema|null
-
output_schema
Return values
self —setters()
Array of attributes to setter functions (for deserialization of responses)
public
static setters() : array<string|int, mixed>
Return values
array<string|int, mixed> —setTimeout()
Sets timeout
public
setTimeout(int $timeout) : self
Parameters
- $timeout : int
-
timeout
Return values
self —setTransformId()
Sets transform_id
public
setTransformId(string|null $transform_id) : self
Parameters
- $transform_id : string|null
-
transform_id
Return values
self —toHeaderValue()
Gets a header-safe presentation of the object
public
toHeaderValue() : string
Return values
string —valid()
Validate all the properties in the model return true if all passed
public
valid() : bool
Return values
bool —True if all properties are valid
openAPINullables()
Array of nullable properties
protected
static openAPINullables() : array<string|int, mixed>
Return values
array<string|int, mixed> —getOpenAPINullablesSetToNull()
Array of nullable field names deliberately set to null
private
getOpenAPINullablesSetToNull() : array<string|int, bool>
Return values
array<string|int, bool> —setIfExists()
Sets $this->container[$variableName] to the given data or to the given default Value; if $variableName is nullable and its value is set to null in the $fields array, then mark it as "set to null" in the $this->openAPINullablesSetToNull array
private
setIfExists(string $variableName, array<string|int, mixed> $fields, mixed $defaultValue) : void
Parameters
- $variableName : string
- $fields : array<string|int, mixed>
- $defaultValue : mixed
Return values
void —setOpenAPINullablesSetToNull()
Setter - Array of nullable field names deliberately set to null
private
setOpenAPINullablesSetToNull(array<string|int, bool> $openAPINullablesSetToNull) : void
Parameters
- $openAPINullablesSetToNull : array<string|int, bool>