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

CreateTransformer1Async(AITranformCreateOptions, int, CancellationToken)

Create a transformer for reuse in automations

Declaration

Task<AITransformDto> CreateTransformer1Async(AITranformCreateOptions aITranformCreateOptions, int operationIndex = 0, CancellationToken cancellationToken = default)

Parameters

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

Returns

Type	Description
Task<AITransformDto>	Task of AITransformDto

Remarks

Save an AI transform instructions and schema for use with webhooks and automations

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

View Source

CreateTransformer1WithHttpInfoAsync(AITranformCreateOptions, int, CancellationToken)

Create a transformer for reuse in automations

Declaration

Task<ApiResponse<AITransformDto>> CreateTransformer1WithHttpInfoAsync(AITranformCreateOptions aITranformCreateOptions, int operationIndex = 0, CancellationToken cancellationToken = default)

Parameters

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

Returns

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

Remarks

Save an AI transform instructions and schema for use with webhooks and automations

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

View Source

CreateTransformerAsync(AITranformCreateOptions, int?, int?, string, int, CancellationToken)

List transformers

Declaration

Task<PageAITransformProjection> CreateTransformerAsync(AITranformCreateOptions options, int? page = null, int? size = null, string sort = null, int operationIndex = 0, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
AITranformCreateOptions	options
int?	page	(optional, default to 0)
int?	size	Optional page size in SMS list pagination. Maximum size is 100. Use page index and sort to page through larger results (optional, default to 20)
string	sort	Optional createdAt sort direction ASC or DESC (optional, default to ASC)
int	operationIndex	Index associated with the operation.
CancellationToken	cancellationToken	Cancellation Token to cancel the request.

Returns

Type	Description
Task<PageAITransformProjection>	Task of PageAITransformProjection

Remarks

List all AI transforms

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

View Source

CreateTransformerMappingsAsync(CreateAITransformerMappingOptions, int, CancellationToken)

Create transformer mapping

Declaration

Task<AITransformMappingDto> CreateTransformerMappingsAsync(CreateAITransformerMappingOptions createAITransformerMappingOptions, int operationIndex = 0, CancellationToken cancellationToken = default)

Parameters

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

Returns

Type	Description
Task<AITransformMappingDto>	Task of AITransformMappingDto

Remarks

Create AI transformer mappings to other entities

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

View Source

CreateTransformerMappingsWithHttpInfoAsync(CreateAITransformerMappingOptions, int, CancellationToken)

Create transformer mapping

Declaration

Task<ApiResponse<AITransformMappingDto>> CreateTransformerMappingsWithHttpInfoAsync(CreateAITransformerMappingOptions createAITransformerMappingOptions, int operationIndex = 0, CancellationToken cancellationToken = default)

Parameters

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

Returns

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

Remarks

Create AI transformer mappings to other entities

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

View Source

CreateTransformerWithHttpInfoAsync(AITranformCreateOptions, int?, int?, string, int, CancellationToken)

List transformers

Declaration

Task<ApiResponse<PageAITransformProjection>> CreateTransformerWithHttpInfoAsync(AITranformCreateOptions options, int? page = null, int? size = null, string sort = null, int operationIndex = 0, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
AITranformCreateOptions	options
int?	page	(optional, default to 0)
int?	size	Optional page size in SMS list pagination. Maximum size is 100. Use page index and sort to page through larger results (optional, default to 20)
string	sort	Optional createdAt sort direction ASC or DESC (optional, default to ASC)
int	operationIndex	Index associated with the operation.
CancellationToken	cancellationToken	Cancellation Token to cancel the request.

Returns

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

Remarks

List all AI transforms

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

View Source

DeleteTransformerAsync(Guid, int, CancellationToken)

Delete a transformer

Declaration

Task DeleteTransformerAsync(Guid id, int operationIndex = 0, CancellationToken cancellationToken = default)

Parameters

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

Returns

Type	Description
Task	Task of void

Remarks

Delete an AI transformer and schemas by ID

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

View Source

DeleteTransformerMappingAsync(Guid, int, CancellationToken)

Delete transformer mapping

Declaration

Task DeleteTransformerMappingAsync(Guid id, int operationIndex = 0, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
Guid	id	ID of transform mapping
int	operationIndex	Index associated with the operation.
CancellationToken	cancellationToken	Cancellation Token to cancel the request.

Returns

Type	Description
Task	Task of void

Remarks

Delete an AI transformer mapping

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

View Source

DeleteTransformerMappingWithHttpInfoAsync(Guid, int, CancellationToken)

Delete transformer mapping

Declaration

Task<ApiResponse<object>> DeleteTransformerMappingWithHttpInfoAsync(Guid id, int operationIndex = 0, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
Guid	id	ID of transform mapping
int	operationIndex	Index associated with the operation.
CancellationToken	cancellationToken	Cancellation Token to cancel the request.

Returns

Type	Description
Task<ApiResponse<object>>	Task of ApiResponse

Remarks

Delete an AI transformer mapping

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

View Source

DeleteTransformerWithHttpInfoAsync(Guid, int, CancellationToken)

Delete a transformer

Declaration

Task<ApiResponse<object>> DeleteTransformerWithHttpInfoAsync(Guid id, int operationIndex = 0, CancellationToken cancellationToken = default)

Parameters

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

Returns

Type	Description
Task<ApiResponse<object>>	Task of ApiResponse

Remarks

Delete an AI transformer and schemas by ID

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

View Source

DeleteTransformersAsync(int, CancellationToken)

Delete all transformers

Declaration

Task DeleteTransformersAsync(int operationIndex = 0, CancellationToken cancellationToken = default)

Parameters

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

Returns

Type	Description
Task	Task of void

Remarks

Delete all AI transformers and schemas

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

View Source

DeleteTransformersWithHttpInfoAsync(int, CancellationToken)

Delete all transformers

Declaration

Task<ApiResponse<object>> DeleteTransformersWithHttpInfoAsync(int operationIndex = 0, CancellationToken cancellationToken = default)

Parameters

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

Returns

Type	Description
Task<ApiResponse<object>>	Task of ApiResponse

Remarks

Delete all AI transformers and schemas

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

View Source

GenerateStructuredContentFromAttachmentAsync(GenerateStructuredContentAttachmentOptions, int, CancellationToken)

Generate structured content for an attachment

Declaration

Task<StructuredContentResultDto> GenerateStructuredContentFromAttachmentAsync(GenerateStructuredContentAttachmentOptions generateStructuredContentAttachmentOptions, int operationIndex = 0, CancellationToken cancellationToken = default)

Parameters

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

Returns

Type	Description
Task<StructuredContentResultDto>	Task of StructuredContentResultDto

Remarks

Use output schemas to extract data from an attachment using AI

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

View Source

GenerateStructuredContentFromAttachmentWithHttpInfoAsync(GenerateStructuredContentAttachmentOptions, int, CancellationToken)

Generate structured content for an attachment

Declaration

Task<ApiResponse<StructuredContentResultDto>> GenerateStructuredContentFromAttachmentWithHttpInfoAsync(GenerateStructuredContentAttachmentOptions generateStructuredContentAttachmentOptions, int operationIndex = 0, CancellationToken cancellationToken = default)

Parameters

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

Returns

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

Remarks

Use output schemas to extract data from an attachment using AI

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

View Source

GenerateStructuredContentFromEmailAsync(GenerateStructuredContentEmailOptions, int, CancellationToken)

Generate structured content for an email

Declaration

Task<StructuredContentResultDto> 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<StructuredContentResultDto>	Task of StructuredContentResultDto

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<StructuredContentResultDto>> 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<StructuredContentResultDto>>	Task of ApiResponse (StructuredContentResultDto)

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

GenerateStructuredContentFromSmsAsync(GenerateStructuredContentSmsOptions, int, CancellationToken)

Generate structured content for a TXT message

Declaration

Task<StructuredContentResultDto> GenerateStructuredContentFromSmsAsync(GenerateStructuredContentSmsOptions generateStructuredContentSmsOptions, int operationIndex = 0, CancellationToken cancellationToken = default)

Parameters

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

Returns

Type	Description
Task<StructuredContentResultDto>	Task of StructuredContentResultDto

Remarks

Use output schemas to extract data from an SMS using AI

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

View Source

GenerateStructuredContentFromSmsWithHttpInfoAsync(GenerateStructuredContentSmsOptions, int, CancellationToken)

Generate structured content for a TXT message

Declaration

Task<ApiResponse<StructuredContentResultDto>> GenerateStructuredContentFromSmsWithHttpInfoAsync(GenerateStructuredContentSmsOptions generateStructuredContentSmsOptions, int operationIndex = 0, CancellationToken cancellationToken = default)

Parameters

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

Returns

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

Remarks

Use output schemas to extract data from an SMS using AI

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

View Source

GetTransformerAsync(Guid, int, CancellationToken)

Get a transformer

Declaration

Task<AITransformDto> GetTransformerAsync(Guid id, int operationIndex = 0, CancellationToken cancellationToken = default)

Parameters

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

Returns

Type	Description
Task<AITransformDto>	Task of AITransformDto

Remarks

Get AI transformer and schemas by ID

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

View Source

GetTransformerMappingAsync(Guid, int, CancellationToken)

Get transformer mapping

Declaration

Task<AITransformMappingDto> GetTransformerMappingAsync(Guid id, int operationIndex = 0, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
Guid	id	ID of transform mapping
int	operationIndex	Index associated with the operation.
CancellationToken	cancellationToken	Cancellation Token to cancel the request.

Returns

Type	Description
Task<AITransformMappingDto>	Task of AITransformMappingDto

Remarks

Get an AI transformer mapping

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

View Source

GetTransformerMappingWithHttpInfoAsync(Guid, int, CancellationToken)

Get transformer mapping

Declaration

Task<ApiResponse<AITransformMappingDto>> GetTransformerMappingWithHttpInfoAsync(Guid id, int operationIndex = 0, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
Guid	id	ID of transform mapping
int	operationIndex	Index associated with the operation.
CancellationToken	cancellationToken	Cancellation Token to cancel the request.

Returns

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

Remarks

Get an AI transformer mapping

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

View Source

GetTransformerMappingsAsync(Guid?, Guid?, string, int?, int?, string, int, CancellationToken)

Get transformer mappings

Declaration

Task<PageAITransformMappingProjection> GetTransformerMappingsAsync(Guid? aiTransformId = null, Guid? entityId = null, string entityType = null, int? page = null, int? size = null, string sort = null, int operationIndex = 0, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
Guid?	aiTransformId	(optional)
Guid?	entityId	(optional)
string	entityType	(optional)
int?	page	(optional, default to 0)
int?	size	Optional page size. Maximum size is 100. Use page index and sort to page through larger results (optional, default to 20)
string	sort	Optional createdAt sort direction ASC or DESC (optional, default to ASC)
int	operationIndex	Index associated with the operation.
CancellationToken	cancellationToken	Cancellation Token to cancel the request.

Returns

Type	Description
Task<PageAITransformMappingProjection>	Task of PageAITransformMappingProjection

Remarks

Get AI transformer mappings to other entities

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

View Source

GetTransformerMappingsWithHttpInfoAsync(Guid?, Guid?, string, int?, int?, string, int, CancellationToken)

Get transformer mappings

Declaration

Task<ApiResponse<PageAITransformMappingProjection>> GetTransformerMappingsWithHttpInfoAsync(Guid? aiTransformId = null, Guid? entityId = null, string entityType = null, int? page = null, int? size = null, string sort = null, int operationIndex = 0, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
Guid?	aiTransformId	(optional)
Guid?	entityId	(optional)
string	entityType	(optional)
int?	page	(optional, default to 0)
int?	size	Optional page size. Maximum size is 100. Use page index and sort to page through larger results (optional, default to 20)
string	sort	Optional createdAt sort direction ASC or DESC (optional, default to ASC)
int	operationIndex	Index associated with the operation.
CancellationToken	cancellationToken	Cancellation Token to cancel the request.

Returns

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

Remarks

Get AI transformer mappings to other entities

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

View Source

GetTransformerResultAsync(Guid, int, CancellationToken)

Get transformer result

Declaration

Task<AITransformResultDto> GetTransformerResultAsync(Guid id, int operationIndex = 0, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
Guid	id	ID of transform result
int	operationIndex	Index associated with the operation.
CancellationToken	cancellationToken	Cancellation Token to cancel the request.

Returns

Type	Description
Task<AITransformResultDto>	Task of AITransformResultDto

Remarks

Get AI transformer result

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

View Source

GetTransformerResultWithHttpInfoAsync(Guid, int, CancellationToken)

Get transformer result

Declaration

Task<ApiResponse<AITransformResultDto>> GetTransformerResultWithHttpInfoAsync(Guid id, int operationIndex = 0, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
Guid	id	ID of transform result
int	operationIndex	Index associated with the operation.
CancellationToken	cancellationToken	Cancellation Token to cancel the request.

Returns

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

Remarks

Get AI transformer result

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

View Source

GetTransformerResultsAsync(Guid?, Guid?, Guid?, string, int?, int?, string, int, CancellationToken)

Get transformer results

Declaration

Task<PageAITransformResultProjection> GetTransformerResultsAsync(Guid? aiTransformId = null, Guid? aiTransformMappingId = null, Guid? entityId = null, string entityType = null, int? page = null, int? size = null, string sort = null, int operationIndex = 0, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
Guid?	aiTransformId	(optional)
Guid?	aiTransformMappingId	(optional)
Guid?	entityId	(optional)
string	entityType	(optional)
int?	page	(optional, default to 0)
int?	size	Optional page size. Maximum size is 100. Use page index and sort to page through larger results (optional, default to 20)
string	sort	Optional createdAt sort direction ASC or DESC (optional, default to ASC)
int	operationIndex	Index associated with the operation.
CancellationToken	cancellationToken	Cancellation Token to cancel the request.

Returns

Type	Description
Task<PageAITransformResultProjection>	Task of PageAITransformResultProjection

Remarks

Get AI transformer results

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

View Source

GetTransformerResultsWithHttpInfoAsync(Guid?, Guid?, Guid?, string, int?, int?, string, int, CancellationToken)

Get transformer results

Declaration

Task<ApiResponse<PageAITransformResultProjection>> GetTransformerResultsWithHttpInfoAsync(Guid? aiTransformId = null, Guid? aiTransformMappingId = null, Guid? entityId = null, string entityType = null, int? page = null, int? size = null, string sort = null, int operationIndex = 0, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
Guid?	aiTransformId	(optional)
Guid?	aiTransformMappingId	(optional)
Guid?	entityId	(optional)
string	entityType	(optional)
int?	page	(optional, default to 0)
int?	size	Optional page size. Maximum size is 100. Use page index and sort to page through larger results (optional, default to 20)
string	sort	Optional createdAt sort direction ASC or DESC (optional, default to ASC)
int	operationIndex	Index associated with the operation.
CancellationToken	cancellationToken	Cancellation Token to cancel the request.

Returns

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

Remarks

Get AI transformer results

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

View Source

GetTransformerWithHttpInfoAsync(Guid, int, CancellationToken)

Get a transformer

Declaration

Task<ApiResponse<AITransformDto>> GetTransformerWithHttpInfoAsync(Guid id, int operationIndex = 0, CancellationToken cancellationToken = default)

Parameters

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

Returns

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

Remarks

Get AI transformer and schemas by ID

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