Class AIControllerApi

Represents a collection of functions to interact with the API endpoints

Inheritance

object

AIControllerApi

Implements

IAIControllerApi

IAIControllerApiSync

IAIControllerApiAsync

IApiAccessor

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Namespace: mailslurp.Api

Assembly: mailslurp.dll

Syntax

public class AIControllerApi : IAIControllerApi, IAIControllerApiSync, IAIControllerApiAsync, IApiAccessor

Constructors

View Source

AIControllerApi()

Initializes a new instance of the AIControllerApi class.

Declaration

public AIControllerApi()

View Source

AIControllerApi(string)

Initializes a new instance of the AIControllerApi class.

Declaration

public AIControllerApi(string basePath)

Parameters

Type	Name	Description
string	basePath

View Source

AIControllerApi(Configuration)

Initializes a new instance of the AIControllerApi class using Configuration object

Declaration

public AIControllerApi(Configuration configuration)

Parameters

Type	Name	Description
Configuration	configuration	An instance of Configuration

View Source

AIControllerApi(ISynchronousClient, IAsynchronousClient, IReadableConfiguration)

Initializes a new instance of the AIControllerApi class using a Configuration object and client instance.

Declaration

public AIControllerApi(ISynchronousClient client, IAsynchronousClient asyncClient, IReadableConfiguration configuration)

Parameters

Type	Name	Description
ISynchronousClient	client	The client interface for synchronous API access.
IAsynchronousClient	asyncClient	The client interface for asynchronous API access.
IReadableConfiguration	configuration	The configuration object.

Properties

View Source

AsynchronousClient

The client for accessing this underlying API asynchronously.

Declaration

public IAsynchronousClient AsynchronousClient { get; set; }

Property Value

Type	Description
IAsynchronousClient

View Source

Client

The client for accessing this underlying API synchronously.

Declaration

public ISynchronousClient Client { get; set; }

Property Value

Type	Description
ISynchronousClient

View Source

Configuration

Gets or sets the configuration object

Declaration

public IReadableConfiguration Configuration { get; set; }

Property Value

Type	Description
IReadableConfiguration	An instance of the Configuration

View Source

ExceptionFactory

Provides a factory method hook for the creation of exceptions.

Declaration

public ExceptionFactory ExceptionFactory { get; set; }

Property Value

Type	Description
ExceptionFactory

Methods

View Source

GenerateStructuredContentFromEmail(GenerateStructuredContentEmailOptions, int)

Generate structured content for an email Use output schemas to extract data from an email using AI

Declaration

public StructuredContentResult GenerateStructuredContentFromEmail(GenerateStructuredContentEmailOptions generateStructuredContentEmailOptions, int operationIndex = 0)

Parameters

Type	Name	Description
GenerateStructuredContentEmailOptions	generateStructuredContentEmailOptions
int	operationIndex	Index associated with the operation.

Returns

Type	Description
StructuredContentResult	StructuredContentResult

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

View Source

GenerateStructuredContentFromEmailAsync(GenerateStructuredContentEmailOptions, int, CancellationToken)

Generate structured content for an email Use output schemas to extract data from an email using AI

Declaration

public Task<StructuredContentResult> GenerateStructuredContentFromEmailAsync(GenerateStructuredContentEmailOptions generateStructuredContentEmailOptions, int operationIndex = 0, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
GenerateStructuredContentEmailOptions	generateStructuredContentEmailOptions
int	operationIndex	Index associated with the operation.
CancellationToken	cancellationToken	Cancellation Token to cancel the request.

Returns

Type	Description
Task<StructuredContentResult>	Task of StructuredContentResult

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

View Source

GenerateStructuredContentFromEmailWithHttpInfo(GenerateStructuredContentEmailOptions, int)

Generate structured content for an email Use output schemas to extract data from an email using AI

Declaration

public ApiResponse<StructuredContentResult> GenerateStructuredContentFromEmailWithHttpInfo(GenerateStructuredContentEmailOptions generateStructuredContentEmailOptions, int operationIndex = 0)

Parameters

Type	Name	Description
GenerateStructuredContentEmailOptions	generateStructuredContentEmailOptions
int	operationIndex	Index associated with the operation.

Returns

Type	Description
ApiResponse<StructuredContentResult>	ApiResponse of StructuredContentResult

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

View Source

GenerateStructuredContentFromEmailWithHttpInfoAsync(GenerateStructuredContentEmailOptions, int, CancellationToken)

Generate structured content for an email Use output schemas to extract data from an email using AI

Declaration

public Task<ApiResponse<StructuredContentResult>> GenerateStructuredContentFromEmailWithHttpInfoAsync(GenerateStructuredContentEmailOptions generateStructuredContentEmailOptions, int operationIndex = 0, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
GenerateStructuredContentEmailOptions	generateStructuredContentEmailOptions
int	operationIndex	Index associated with the operation.
CancellationToken	cancellationToken	Cancellation Token to cancel the request.

Returns

Type	Description
Task<ApiResponse<StructuredContentResult>>	Task of ApiResponse (StructuredContentResult)

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

View Source

GetBasePath()

Gets the base path of the API client.

Declaration

public string GetBasePath()

Returns

Type	Description
string	The base path

View Source

ValidateStructuredOutputSchema(StructuredOutputSchema, int)

Validate structured content schema Check if a schema is valid and can be used to extract data using AI

Declaration

public StructuredOutputSchemaValidation ValidateStructuredOutputSchema(StructuredOutputSchema structuredOutputSchema, int operationIndex = 0)

Parameters

Type	Name	Description
StructuredOutputSchema	structuredOutputSchema
int	operationIndex	Index associated with the operation.

Returns

Type	Description
StructuredOutputSchemaValidation	StructuredOutputSchemaValidation

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

View Source

ValidateStructuredOutputSchemaAsync(StructuredOutputSchema, int, CancellationToken)

Validate structured content schema Check if a schema is valid and can be used to extract data using AI

Declaration

public Task<StructuredOutputSchemaValidation> ValidateStructuredOutputSchemaAsync(StructuredOutputSchema structuredOutputSchema, int operationIndex = 0, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
StructuredOutputSchema	structuredOutputSchema
int	operationIndex	Index associated with the operation.
CancellationToken	cancellationToken	Cancellation Token to cancel the request.

Returns

Type	Description
Task<StructuredOutputSchemaValidation>	Task of StructuredOutputSchemaValidation

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

View Source

ValidateStructuredOutputSchemaWithHttpInfo(StructuredOutputSchema, int)

Validate structured content schema Check if a schema is valid and can be used to extract data using AI

Declaration

public ApiResponse<StructuredOutputSchemaValidation> ValidateStructuredOutputSchemaWithHttpInfo(StructuredOutputSchema structuredOutputSchema, int operationIndex = 0)

Parameters

Type	Name	Description
StructuredOutputSchema	structuredOutputSchema
int	operationIndex	Index associated with the operation.

Returns

Type	Description
ApiResponse<StructuredOutputSchemaValidation>	ApiResponse of StructuredOutputSchemaValidation

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

View Source

ValidateStructuredOutputSchemaWithHttpInfoAsync(StructuredOutputSchema, int, CancellationToken)

Validate structured content schema Check if a schema is valid and can be used to extract data using AI

Declaration

public Task<ApiResponse<StructuredOutputSchemaValidation>> ValidateStructuredOutputSchemaWithHttpInfoAsync(StructuredOutputSchema structuredOutputSchema, int operationIndex = 0, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
StructuredOutputSchema	structuredOutputSchema
int	operationIndex	Index associated with the operation.
CancellationToken	cancellationToken	Cancellation Token to cancel the request.

Returns

Type	Description
Task<ApiResponse<StructuredOutputSchemaValidation>>	Task of ApiResponse (StructuredOutputSchemaValidation)

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

Implements

IAIControllerApi

IAIControllerApiSync

IAIControllerApiAsync

IApiAccessor