AIMessagesResult
in package
implements
ModelInterface, ArrayAccess, JsonSerializable
AIMessagesResult Class Doc Comment
Tags
Interfaces, Classes, Traits and Enums
- ModelInterface
- Interface abstracting model access.
- ArrayAccess
- JsonSerializable
Table of Contents
- DISCRIMINATOR = null
- STATUS_CANDIDATE_LIMIT = 'CANDIDATE_LIMIT'
- STATUS_EXTRACTED = 'EXTRACTED'
- STATUS_FAIL = 'FAIL'
- STATUS_INCONCLUSIVE = 'INCONCLUSIVE'
- STATUS_INVALID_OUTPUT = 'INVALID_OUTPUT'
- STATUS_MATCHED = 'MATCHED'
- STATUS_PASS = 'PASS'
- STATUS_PROVIDER_ERROR = 'PROVIDER_ERROR'
- STATUS_PROVIDER_TIMEOUT = 'PROVIDER_TIMEOUT'
- STATUS_TIMED_OUT = 'TIMED_OUT'
- STATUS_TOKEN_LIMIT = 'TOKEN_LIMIT'
- $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
- getElapsedMs() : int
- Gets elapsed_ms
- getEvaluationId() : string
- Gets evaluation_id
- getModelName() : string
- The original name of the model.
- getResults() : array<string|int, AIMessageExpectationResult>
- Gets results
- getStatus() : string
- Gets status
- getStatusAllowableValues() : array<string|int, string>
- Gets allowable values of the enum
- getSuccessful() : bool
- Gets successful
- getSummary() : string
- Gets summary
- getters() : array<string|int, mixed>
- Array of attributes to getter functions (for serialization of requests)
- getUnsatisfiedExpectationIds() : array<string|int, string>
- Gets unsatisfied_expectation_ids
- getUsage() : AIMessageUsage
- Gets usage
- 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
- setElapsedMs() : self
- Sets elapsed_ms
- setEvaluationId() : self
- Sets evaluation_id
- setResults() : self
- Sets results
- setStatus() : self
- Sets status
- setSuccessful() : self
- Sets successful
- setSummary() : self
- Sets summary
- setters() : array<string|int, mixed>
- Array of attributes to setter functions (for deserialization of responses)
- setUnsatisfiedExpectationIds() : self
- Sets unsatisfied_expectation_ids
- setUsage() : self
- Sets usage
- 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
STATUS_CANDIDATE_LIMIT
public
mixed
STATUS_CANDIDATE_LIMIT
= 'CANDIDATE_LIMIT'
STATUS_EXTRACTED
public
mixed
STATUS_EXTRACTED
= 'EXTRACTED'
STATUS_FAIL
public
mixed
STATUS_FAIL
= 'FAIL'
STATUS_INCONCLUSIVE
public
mixed
STATUS_INCONCLUSIVE
= 'INCONCLUSIVE'
STATUS_INVALID_OUTPUT
public
mixed
STATUS_INVALID_OUTPUT
= 'INVALID_OUTPUT'
STATUS_MATCHED
public
mixed
STATUS_MATCHED
= 'MATCHED'
STATUS_PASS
public
mixed
STATUS_PASS
= 'PASS'
STATUS_PROVIDER_ERROR
public
mixed
STATUS_PROVIDER_ERROR
= 'PROVIDER_ERROR'
STATUS_PROVIDER_TIMEOUT
public
mixed
STATUS_PROVIDER_TIMEOUT
= 'PROVIDER_TIMEOUT'
STATUS_TIMED_OUT
public
mixed
STATUS_TIMED_OUT
= 'TIMED_OUT'
STATUS_TOKEN_LIMIT
public
mixed
STATUS_TOKEN_LIMIT
= 'TOKEN_LIMIT'
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
= ['evaluation_id' => 'evaluationId', 'status' => 'status', 'results' => 'results', 'usage' => 'usage', 'elapsed_ms' => 'elapsedMs', 'summary' => 'summary', 'successful' => 'successful', 'unsatisfied_expectation_ids' => 'unsatisfiedExpectationIds']
$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
= ['evaluation_id' => 'getEvaluationId', 'status' => 'getStatus', 'results' => 'getResults', 'usage' => 'getUsage', 'elapsed_ms' => 'getElapsedMs', 'summary' => 'getSummary', 'successful' => 'getSuccessful', 'unsatisfied_expectation_ids' => 'getUnsatisfiedExpectationIds']
$openAPIFormats
Array of property to format mappings. Used for (de)serialization
protected
static array<string|int, string>
$openAPIFormats
= ['evaluation_id' => 'uuid', 'status' => null, 'results' => null, 'usage' => null, 'elapsed_ms' => 'int64', 'summary' => null, 'successful' => null, 'unsatisfied_expectation_ids' => null]
Tags
$openAPIModelName
The original name of the model.
protected
static string
$openAPIModelName
= 'AIMessagesResult'
$openAPINullables
Array of nullable properties. Used for (de)serialization
protected
static array<string|int, mixed>
$openAPINullables
= ['evaluation_id' => false, 'status' => false, 'results' => false, 'usage' => false, 'elapsed_ms' => false, 'summary' => false, 'successful' => false, 'unsatisfied_expectation_ids' => false]
$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
= ['evaluation_id' => 'string', 'status' => 'string', 'results' => '\\MailSlurp\\Models\\AIMessageExpectationResult[]', 'usage' => '\\MailSlurp\\Models\\AIMessageUsage', 'elapsed_ms' => 'int', 'summary' => 'string', 'successful' => 'bool', 'unsatisfied_expectation_ids' => 'string[]']
$setters
Array of attributes to setter functions (for deserialization of responses)
protected
static array<string|int, string>
$setters
= ['evaluation_id' => 'setEvaluationId', 'status' => 'setStatus', 'results' => 'setResults', 'usage' => 'setUsage', 'elapsed_ms' => 'setElapsedMs', 'summary' => 'setSummary', 'successful' => 'setSuccessful', 'unsatisfied_expectation_ids' => 'setUnsatisfiedExpectationIds']
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> —getElapsedMs()
Gets elapsed_ms
public
getElapsedMs() : int
Return values
int —getEvaluationId()
Gets evaluation_id
public
getEvaluationId() : string
Return values
string —getModelName()
The original name of the model.
public
getModelName() : string
Return values
string —getResults()
Gets results
public
getResults() : array<string|int, AIMessageExpectationResult>
Return values
array<string|int, AIMessageExpectationResult> —getStatus()
Gets status
public
getStatus() : string
Return values
string —getStatusAllowableValues()
Gets allowable values of the enum
public
getStatusAllowableValues() : array<string|int, string>
Return values
array<string|int, string> —getSuccessful()
Gets successful
public
getSuccessful() : bool
Return values
bool —getSummary()
Gets summary
public
getSummary() : string
Return values
string —getters()
Array of attributes to getter functions (for serialization of requests)
public
static getters() : array<string|int, mixed>
Return values
array<string|int, mixed> —getUnsatisfiedExpectationIds()
Gets unsatisfied_expectation_ids
public
getUnsatisfiedExpectationIds() : array<string|int, string>
Return values
array<string|int, string> —getUsage()
Gets usage
public
getUsage() : AIMessageUsage
Return values
AIMessageUsage —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> —setElapsedMs()
Sets elapsed_ms
public
setElapsedMs(int $elapsed_ms) : self
Parameters
- $elapsed_ms : int
-
elapsed_ms
Return values
self —setEvaluationId()
Sets evaluation_id
public
setEvaluationId(string $evaluation_id) : self
Parameters
- $evaluation_id : string
-
evaluation_id
Return values
self —setResults()
Sets results
public
setResults(array<string|int, AIMessageExpectationResult> $results) : self
Parameters
- $results : array<string|int, AIMessageExpectationResult>
-
results
Return values
self —setStatus()
Sets status
public
setStatus(string $status) : self
Parameters
- $status : string
-
status
Return values
self —setSuccessful()
Sets successful
public
setSuccessful(bool $successful) : self
Parameters
- $successful : bool
-
successful
Return values
self —setSummary()
Sets summary
public
setSummary(string $summary) : self
Parameters
- $summary : string
-
summary
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> —setUnsatisfiedExpectationIds()
Sets unsatisfied_expectation_ids
public
setUnsatisfiedExpectationIds(array<string|int, string> $unsatisfied_expectation_ids) : self
Parameters
- $unsatisfied_expectation_ids : array<string|int, string>
-
unsatisfied_expectation_ids
Return values
self —setUsage()
Sets usage
public
setUsage(AIMessageUsage $usage) : self
Parameters
- $usage : AIMessageUsage
-
usage
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>