Interface IAIControllerApiAsync

Represents a collection of functions to interact with the API endpoints

Inherited Members
Namespace: mailslurp.Api
Assembly: mailslurp.dll
Syntax
public interface IAIControllerApiAsync : IApiAccessor

Methods

View Source

GenerateStructuredContentFromEmailAsync(GenerateStructuredContentEmailOptions, int, CancellationToken)

Generate structured content for an email

Declaration
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
Remarks

Use output schemas to extract data from an email using AI

Exceptions
Type Condition
ApiException

Thrown when fails to make API call
View Source

GenerateStructuredContentFromEmailWithHttpInfoAsync(GenerateStructuredContentEmailOptions, int, CancellationToken)

Generate structured content for an email

Declaration
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)
Remarks

Use output schemas to extract data from an email using AI

Exceptions
Type Condition
ApiException

Thrown when fails to make API call
View Source

ValidateStructuredOutputSchemaAsync(StructuredOutputSchema, int, CancellationToken)

Validate structured content schema

Declaration
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
Remarks

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

Exceptions
Type Condition
ApiException

Thrown when fails to make API call
View Source

ValidateStructuredOutputSchemaWithHttpInfoAsync(StructuredOutputSchema, int, CancellationToken)

Validate structured content schema

Declaration
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)
Remarks

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

Exceptions
Type Condition
ApiException

Thrown when fails to make API call