AIMessageAIOptions
in package
implements
ModelInterface, ArrayAccess, JsonSerializable
AIMessageAIOptions Class Doc Comment
Tags
Interfaces, Classes, Traits and Enums
- ModelInterface
- Interface abstracting model access.
- ArrayAccess
- JsonSerializable
Table of Contents
- DISCRIMINATOR = null
- MODEL_BALANCED_V1 = 'BALANCED_V1'
- MODEL_FLASH_LATEST = 'FLASH_LATEST'
- MODEL_QUALITY_V1 = 'QUALITY_V1'
- $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
- getMaxCandidates() : int
- Gets max_candidates
- getMaxOutputTokens() : int
- Gets max_output_tokens
- getMaxTokens() : int
- Gets max_tokens
- getMinimumConfidence() : float|null
- Gets minimum_confidence
- getModel() : string
- Gets model
- getModelAllowableValues() : array<string|int, string>
- Gets allowable values of the enum
- getModelName() : string
- The original name of the model.
- getters() : array<string|int, mixed>
- Array of attributes to getter functions (for serialization of requests)
- 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
- setMaxCandidates() : self
- Sets max_candidates
- setMaxOutputTokens() : self
- Sets max_output_tokens
- setMaxTokens() : self
- Sets max_tokens
- setMinimumConfidence() : self
- Sets minimum_confidence
- setModel() : self
- Sets model
- setters() : array<string|int, mixed>
- Array of attributes to setter functions (for deserialization of responses)
- 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
MODEL_BALANCED_V1
public
mixed
MODEL_BALANCED_V1
= 'BALANCED_V1'
MODEL_FLASH_LATEST
public
mixed
MODEL_FLASH_LATEST
= 'FLASH_LATEST'
MODEL_QUALITY_V1
public
mixed
MODEL_QUALITY_V1
= 'QUALITY_V1'
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
= ['model' => 'model', 'max_tokens' => 'maxTokens', 'max_candidates' => 'maxCandidates', 'max_output_tokens' => 'maxOutputTokens', 'minimum_confidence' => 'minimumConfidence']
$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
= ['model' => 'getModel', 'max_tokens' => 'getMaxTokens', 'max_candidates' => 'getMaxCandidates', 'max_output_tokens' => 'getMaxOutputTokens', 'minimum_confidence' => 'getMinimumConfidence']
$openAPIFormats
Array of property to format mappings. Used for (de)serialization
protected
static array<string|int, string>
$openAPIFormats
= ['model' => null, 'max_tokens' => 'int64', 'max_candidates' => 'int32', 'max_output_tokens' => 'int32', 'minimum_confidence' => 'double']
Tags
$openAPIModelName
The original name of the model.
protected
static string
$openAPIModelName
= 'AIMessageAIOptions'
$openAPINullables
Array of nullable properties. Used for (de)serialization
protected
static array<string|int, mixed>
$openAPINullables
= ['model' => false, 'max_tokens' => false, 'max_candidates' => false, 'max_output_tokens' => false, 'minimum_confidence' => 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
= ['model' => 'string', 'max_tokens' => 'int', 'max_candidates' => 'int', 'max_output_tokens' => 'int', 'minimum_confidence' => 'float']
$setters
Array of attributes to setter functions (for deserialization of responses)
protected
static array<string|int, string>
$setters
= ['model' => 'setModel', 'max_tokens' => 'setMaxTokens', 'max_candidates' => 'setMaxCandidates', 'max_output_tokens' => 'setMaxOutputTokens', 'minimum_confidence' => 'setMinimumConfidence']
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> —getMaxCandidates()
Gets max_candidates
public
getMaxCandidates() : int
Return values
int —getMaxOutputTokens()
Gets max_output_tokens
public
getMaxOutputTokens() : int
Return values
int —getMaxTokens()
Gets max_tokens
public
getMaxTokens() : int
Return values
int —getMinimumConfidence()
Gets minimum_confidence
public
getMinimumConfidence() : float|null
Return values
float|null —getModel()
Gets model
public
getModel() : string
Return values
string —getModelAllowableValues()
Gets allowable values of the enum
public
getModelAllowableValues() : array<string|int, string>
Return values
array<string|int, string> —getModelName()
The original name of the model.
public
getModelName() : 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> —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> —setMaxCandidates()
Sets max_candidates
public
setMaxCandidates(int $max_candidates) : self
Parameters
- $max_candidates : int
-
max_candidates
Return values
self —setMaxOutputTokens()
Sets max_output_tokens
public
setMaxOutputTokens(int $max_output_tokens) : self
Parameters
- $max_output_tokens : int
-
max_output_tokens
Return values
self —setMaxTokens()
Sets max_tokens
public
setMaxTokens(int $max_tokens) : self
Parameters
- $max_tokens : int
-
max_tokens
Return values
self —setMinimumConfidence()
Sets minimum_confidence
public
setMinimumConfidence(float|null $minimum_confidence) : self
Parameters
- $minimum_confidence : float|null
-
Optional advanced abstention threshold for model-reported confidence. Below it the decision is INCONCLUSIVE. It does not guarantee accuracy or cause reevaluation.
Return values
self —setModel()
Sets model
public
setModel(string $model) : self
Parameters
- $model : string
-
model
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> —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>