AIControllerApi
in package
AIControllerApi Class Doc Comment
Tags
Table of Contents
- contentTypes = ['generateStructuredContentFromAttachment' => ['application/json'], 'generateStructuredContentFromEmail' => ['application/json'], 'validateStructuredOutputSchema' => ['application/json']]
- $client : ClientInterface
- $config : Configuration
- $headerSelector : HeaderSelector
- $hostIndex : int
- __construct() : mixed
- generateStructuredContentFromAttachment() : StructuredContentResult
- Operation generateStructuredContentFromAttachment
- generateStructuredContentFromAttachmentAsync() : PromiseInterface
- Operation generateStructuredContentFromAttachmentAsync
- generateStructuredContentFromAttachmentAsyncWithHttpInfo() : PromiseInterface
- Operation generateStructuredContentFromAttachmentAsyncWithHttpInfo
- generateStructuredContentFromAttachmentRequest() : Request
- Create request for operation 'generateStructuredContentFromAttachment'
- generateStructuredContentFromAttachmentWithHttpInfo() : array<string|int, mixed>
- Operation generateStructuredContentFromAttachmentWithHttpInfo
- generateStructuredContentFromEmail() : StructuredContentResult
- Operation generateStructuredContentFromEmail
- generateStructuredContentFromEmailAsync() : PromiseInterface
- Operation generateStructuredContentFromEmailAsync
- generateStructuredContentFromEmailAsyncWithHttpInfo() : PromiseInterface
- Operation generateStructuredContentFromEmailAsyncWithHttpInfo
- generateStructuredContentFromEmailRequest() : Request
- Create request for operation 'generateStructuredContentFromEmail'
- generateStructuredContentFromEmailWithHttpInfo() : array<string|int, mixed>
- Operation generateStructuredContentFromEmailWithHttpInfo
- getConfig() : Configuration
- getHostIndex() : int
- Get the host index
- setHostIndex() : void
- Set the host index
- validateStructuredOutputSchema() : StructuredOutputSchemaValidation
- Operation validateStructuredOutputSchema
- validateStructuredOutputSchemaAsync() : PromiseInterface
- Operation validateStructuredOutputSchemaAsync
- validateStructuredOutputSchemaAsyncWithHttpInfo() : PromiseInterface
- Operation validateStructuredOutputSchemaAsyncWithHttpInfo
- validateStructuredOutputSchemaRequest() : Request
- Create request for operation 'validateStructuredOutputSchema'
- validateStructuredOutputSchemaWithHttpInfo() : array<string|int, mixed>
- Operation validateStructuredOutputSchemaWithHttpInfo
- createHttpClientOption() : array<string|int, mixed>
- Create http client option
Constants
contentTypes
public
array<string|int, string>
contentTypes
= ['generateStructuredContentFromAttachment' => ['application/json'], 'generateStructuredContentFromEmail' => ['application/json'], 'validateStructuredOutputSchema' => ['application/json']]
Properties
$client
protected
ClientInterface
$client
$config
protected
Configuration
$config
$headerSelector
protected
HeaderSelector
$headerSelector
$hostIndex
protected
int
$hostIndex
Host index
Methods
__construct()
public
__construct([ClientInterface $client = null ][, Configuration $config = null ][, HeaderSelector $selector = null ], int $hostIndex) : mixed
Parameters
- $client : ClientInterface = null
- $config : Configuration = null
- $selector : HeaderSelector = null
- $hostIndex : int
-
(Optional) host index to select the list of hosts if defined in the OpenAPI spec
Return values
mixed —generateStructuredContentFromAttachment()
Operation generateStructuredContentFromAttachment
public
generateStructuredContentFromAttachment(GenerateStructuredContentAttachmentOptions $generate_structured_content_attachment_options[, string $contentType = self::contentTypes['generateStructuredContentFromAttachment'][0] ]) : StructuredContentResult
Generate structured content for an attachment
Parameters
- $generate_structured_content_attachment_options : GenerateStructuredContentAttachmentOptions
-
generate_structured_content_attachment_options (required)
- $contentType : string = self::contentTypes['generateStructuredContentFromAttachment'][0]
-
The value for the Content-Type header. Check self::contentTypes['generateStructuredContentFromAttachment'] to see the possible values for this operation
Tags
Return values
StructuredContentResult —generateStructuredContentFromAttachmentAsync()
Operation generateStructuredContentFromAttachmentAsync
public
generateStructuredContentFromAttachmentAsync(GenerateStructuredContentAttachmentOptions $generate_structured_content_attachment_options[, string $contentType = self::contentTypes['generateStructuredContentFromAttachment'][0] ]) : PromiseInterface
Generate structured content for an attachment
Parameters
- $generate_structured_content_attachment_options : GenerateStructuredContentAttachmentOptions
-
(required)
- $contentType : string = self::contentTypes['generateStructuredContentFromAttachment'][0]
-
The value for the Content-Type header. Check self::contentTypes['generateStructuredContentFromAttachment'] to see the possible values for this operation
Tags
Return values
PromiseInterface —generateStructuredContentFromAttachmentAsyncWithHttpInfo()
Operation generateStructuredContentFromAttachmentAsyncWithHttpInfo
public
generateStructuredContentFromAttachmentAsyncWithHttpInfo(GenerateStructuredContentAttachmentOptions $generate_structured_content_attachment_options[, string $contentType = self::contentTypes['generateStructuredContentFromAttachment'][0] ]) : PromiseInterface
Generate structured content for an attachment
Parameters
- $generate_structured_content_attachment_options : GenerateStructuredContentAttachmentOptions
-
(required)
- $contentType : string = self::contentTypes['generateStructuredContentFromAttachment'][0]
-
The value for the Content-Type header. Check self::contentTypes['generateStructuredContentFromAttachment'] to see the possible values for this operation
Tags
Return values
PromiseInterface —generateStructuredContentFromAttachmentRequest()
Create request for operation 'generateStructuredContentFromAttachment'
public
generateStructuredContentFromAttachmentRequest(GenerateStructuredContentAttachmentOptions $generate_structured_content_attachment_options[, string $contentType = self::contentTypes['generateStructuredContentFromAttachment'][0] ]) : Request
Parameters
- $generate_structured_content_attachment_options : GenerateStructuredContentAttachmentOptions
-
(required)
- $contentType : string = self::contentTypes['generateStructuredContentFromAttachment'][0]
-
The value for the Content-Type header. Check self::contentTypes['generateStructuredContentFromAttachment'] to see the possible values for this operation
Tags
Return values
Request —generateStructuredContentFromAttachmentWithHttpInfo()
Operation generateStructuredContentFromAttachmentWithHttpInfo
public
generateStructuredContentFromAttachmentWithHttpInfo(GenerateStructuredContentAttachmentOptions $generate_structured_content_attachment_options[, string $contentType = self::contentTypes['generateStructuredContentFromAttachment'][0] ]) : array<string|int, mixed>
Generate structured content for an attachment
Parameters
- $generate_structured_content_attachment_options : GenerateStructuredContentAttachmentOptions
-
(required)
- $contentType : string = self::contentTypes['generateStructuredContentFromAttachment'][0]
-
The value for the Content-Type header. Check self::contentTypes['generateStructuredContentFromAttachment'] to see the possible values for this operation
Tags
Return values
array<string|int, mixed> —of \MailSlurp\Models\StructuredContentResult, HTTP status code, HTTP response headers (array of strings)
generateStructuredContentFromEmail()
Operation generateStructuredContentFromEmail
public
generateStructuredContentFromEmail(GenerateStructuredContentEmailOptions $generate_structured_content_email_options[, string $contentType = self::contentTypes['generateStructuredContentFromEmail'][0] ]) : StructuredContentResult
Generate structured content for an email
Parameters
- $generate_structured_content_email_options : GenerateStructuredContentEmailOptions
-
generate_structured_content_email_options (required)
- $contentType : string = self::contentTypes['generateStructuredContentFromEmail'][0]
-
The value for the Content-Type header. Check self::contentTypes['generateStructuredContentFromEmail'] to see the possible values for this operation
Tags
Return values
StructuredContentResult —generateStructuredContentFromEmailAsync()
Operation generateStructuredContentFromEmailAsync
public
generateStructuredContentFromEmailAsync(GenerateStructuredContentEmailOptions $generate_structured_content_email_options[, string $contentType = self::contentTypes['generateStructuredContentFromEmail'][0] ]) : PromiseInterface
Generate structured content for an email
Parameters
- $generate_structured_content_email_options : GenerateStructuredContentEmailOptions
-
(required)
- $contentType : string = self::contentTypes['generateStructuredContentFromEmail'][0]
-
The value for the Content-Type header. Check self::contentTypes['generateStructuredContentFromEmail'] to see the possible values for this operation
Tags
Return values
PromiseInterface —generateStructuredContentFromEmailAsyncWithHttpInfo()
Operation generateStructuredContentFromEmailAsyncWithHttpInfo
public
generateStructuredContentFromEmailAsyncWithHttpInfo(GenerateStructuredContentEmailOptions $generate_structured_content_email_options[, string $contentType = self::contentTypes['generateStructuredContentFromEmail'][0] ]) : PromiseInterface
Generate structured content for an email
Parameters
- $generate_structured_content_email_options : GenerateStructuredContentEmailOptions
-
(required)
- $contentType : string = self::contentTypes['generateStructuredContentFromEmail'][0]
-
The value for the Content-Type header. Check self::contentTypes['generateStructuredContentFromEmail'] to see the possible values for this operation
Tags
Return values
PromiseInterface —generateStructuredContentFromEmailRequest()
Create request for operation 'generateStructuredContentFromEmail'
public
generateStructuredContentFromEmailRequest(GenerateStructuredContentEmailOptions $generate_structured_content_email_options[, string $contentType = self::contentTypes['generateStructuredContentFromEmail'][0] ]) : Request
Parameters
- $generate_structured_content_email_options : GenerateStructuredContentEmailOptions
-
(required)
- $contentType : string = self::contentTypes['generateStructuredContentFromEmail'][0]
-
The value for the Content-Type header. Check self::contentTypes['generateStructuredContentFromEmail'] to see the possible values for this operation
Tags
Return values
Request —generateStructuredContentFromEmailWithHttpInfo()
Operation generateStructuredContentFromEmailWithHttpInfo
public
generateStructuredContentFromEmailWithHttpInfo(GenerateStructuredContentEmailOptions $generate_structured_content_email_options[, string $contentType = self::contentTypes['generateStructuredContentFromEmail'][0] ]) : array<string|int, mixed>
Generate structured content for an email
Parameters
- $generate_structured_content_email_options : GenerateStructuredContentEmailOptions
-
(required)
- $contentType : string = self::contentTypes['generateStructuredContentFromEmail'][0]
-
The value for the Content-Type header. Check self::contentTypes['generateStructuredContentFromEmail'] to see the possible values for this operation
Tags
Return values
array<string|int, mixed> —of \MailSlurp\Models\StructuredContentResult, HTTP status code, HTTP response headers (array of strings)
getConfig()
public
getConfig() : Configuration
Return values
Configuration —getHostIndex()
Get the host index
public
getHostIndex() : int
Return values
int —Host index
setHostIndex()
Set the host index
public
setHostIndex(int $hostIndex) : void
Parameters
- $hostIndex : int
-
Host index (required)
Return values
void —validateStructuredOutputSchema()
Operation validateStructuredOutputSchema
public
validateStructuredOutputSchema(StructuredOutputSchema $structured_output_schema[, string $contentType = self::contentTypes['validateStructuredOutputSchema'][0] ]) : StructuredOutputSchemaValidation
Validate structured content schema
Parameters
- $structured_output_schema : StructuredOutputSchema
-
structured_output_schema (required)
- $contentType : string = self::contentTypes['validateStructuredOutputSchema'][0]
-
The value for the Content-Type header. Check self::contentTypes['validateStructuredOutputSchema'] to see the possible values for this operation
Tags
Return values
StructuredOutputSchemaValidation —validateStructuredOutputSchemaAsync()
Operation validateStructuredOutputSchemaAsync
public
validateStructuredOutputSchemaAsync(StructuredOutputSchema $structured_output_schema[, string $contentType = self::contentTypes['validateStructuredOutputSchema'][0] ]) : PromiseInterface
Validate structured content schema
Parameters
- $structured_output_schema : StructuredOutputSchema
-
(required)
- $contentType : string = self::contentTypes['validateStructuredOutputSchema'][0]
-
The value for the Content-Type header. Check self::contentTypes['validateStructuredOutputSchema'] to see the possible values for this operation
Tags
Return values
PromiseInterface —validateStructuredOutputSchemaAsyncWithHttpInfo()
Operation validateStructuredOutputSchemaAsyncWithHttpInfo
public
validateStructuredOutputSchemaAsyncWithHttpInfo(StructuredOutputSchema $structured_output_schema[, string $contentType = self::contentTypes['validateStructuredOutputSchema'][0] ]) : PromiseInterface
Validate structured content schema
Parameters
- $structured_output_schema : StructuredOutputSchema
-
(required)
- $contentType : string = self::contentTypes['validateStructuredOutputSchema'][0]
-
The value for the Content-Type header. Check self::contentTypes['validateStructuredOutputSchema'] to see the possible values for this operation
Tags
Return values
PromiseInterface —validateStructuredOutputSchemaRequest()
Create request for operation 'validateStructuredOutputSchema'
public
validateStructuredOutputSchemaRequest(StructuredOutputSchema $structured_output_schema[, string $contentType = self::contentTypes['validateStructuredOutputSchema'][0] ]) : Request
Parameters
- $structured_output_schema : StructuredOutputSchema
-
(required)
- $contentType : string = self::contentTypes['validateStructuredOutputSchema'][0]
-
The value for the Content-Type header. Check self::contentTypes['validateStructuredOutputSchema'] to see the possible values for this operation
Tags
Return values
Request —validateStructuredOutputSchemaWithHttpInfo()
Operation validateStructuredOutputSchemaWithHttpInfo
public
validateStructuredOutputSchemaWithHttpInfo(StructuredOutputSchema $structured_output_schema[, string $contentType = self::contentTypes['validateStructuredOutputSchema'][0] ]) : array<string|int, mixed>
Validate structured content schema
Parameters
- $structured_output_schema : StructuredOutputSchema
-
(required)
- $contentType : string = self::contentTypes['validateStructuredOutputSchema'][0]
-
The value for the Content-Type header. Check self::contentTypes['validateStructuredOutputSchema'] to see the possible values for this operation
Tags
Return values
array<string|int, mixed> —of \MailSlurp\Models\StructuredOutputSchemaValidation, HTTP status code, HTTP response headers (array of strings)
createHttpClientOption()
Create http client option
protected
createHttpClientOption() : array<string|int, mixed>
Tags
Return values
array<string|int, mixed> —of http client options