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

AIControllerApi()

Initializes a new instance of the AIControllerApi class.

Declaration

public AIControllerApi()

AIControllerApi(string)

Initializes a new instance of the AIControllerApi class.

Declaration

public AIControllerApi(string basePath)

Parameters

Type	Name	Description
string	basePath

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

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

AsynchronousClient

The client for accessing this underlying API asynchronously.

Declaration

public IAsynchronousClient AsynchronousClient { get; set; }

Property Value

Type	Description
IAsynchronousClient

Client

The client for accessing this underlying API synchronously.

Declaration

public ISynchronousClient Client { get; set; }

Property Value

Type	Description
ISynchronousClient

Configuration

Gets or sets the configuration object

Declaration

public IReadableConfiguration Configuration { get; set; }

Property Value

Type	Description
IReadableConfiguration	An instance of the Configuration

ExceptionFactory

Provides a factory method hook for the creation of exceptions.

Declaration

public ExceptionFactory ExceptionFactory { get; set; }

Property Value

Type	Description
ExceptionFactory

Methods

CreateTransformer(AITranformCreateOptions, int?, int?, string, int)

List transformers List all AI transforms

Declaration

public PageAITransformProjection CreateTransformer(AITranformCreateOptions options, int? page = null, int? size = null, string sort = null, int operationIndex = 0)

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.

Returns

Type	Description
PageAITransformProjection	PageAITransformProjection

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

CreateTransformer1(AITranformCreateOptions, int)

Create a transformer for reuse in automations Save an AI transform instructions and schema for use with webhooks and automations

Declaration

public AITransformDto CreateTransformer1(AITranformCreateOptions aITranformCreateOptions, int operationIndex = 0)

Parameters

Type	Name	Description
AITranformCreateOptions	aITranformCreateOptions
int	operationIndex	Index associated with the operation.

Returns

Type	Description
AITransformDto	AITransformDto

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

CreateTransformer1Async(AITranformCreateOptions, int, CancellationToken)

Create a transformer for reuse in automations Save an AI transform instructions and schema for use with webhooks and automations

Declaration

public 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

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

CreateTransformer1WithHttpInfo(AITranformCreateOptions, int)

Create a transformer for reuse in automations Save an AI transform instructions and schema for use with webhooks and automations

Declaration

public ApiResponse<AITransformDto> CreateTransformer1WithHttpInfo(AITranformCreateOptions aITranformCreateOptions, int operationIndex = 0)

Parameters

Type	Name	Description
AITranformCreateOptions	aITranformCreateOptions
int	operationIndex	Index associated with the operation.

Returns

Type	Description
ApiResponse<AITransformDto>	ApiResponse of AITransformDto

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

CreateTransformer1WithHttpInfoAsync(AITranformCreateOptions, int, CancellationToken)

Create a transformer for reuse in automations Save an AI transform instructions and schema for use with webhooks and automations

Declaration

public 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)

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

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

List transformers List all AI transforms

Declaration

public 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

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

CreateTransformerMappings(CreateAITransformerMappingOptions, int)

Create transformer mapping Create AI transformer mappings to other entities

Declaration

public AITransformMappingDto CreateTransformerMappings(CreateAITransformerMappingOptions createAITransformerMappingOptions, int operationIndex = 0)

Parameters

Type	Name	Description
CreateAITransformerMappingOptions	createAITransformerMappingOptions
int	operationIndex	Index associated with the operation.

Returns

Type	Description
AITransformMappingDto	AITransformMappingDto

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

CreateTransformerMappingsAsync(CreateAITransformerMappingOptions, int, CancellationToken)

Create transformer mapping Create AI transformer mappings to other entities

Declaration

public 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

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

CreateTransformerMappingsWithHttpInfo(CreateAITransformerMappingOptions, int)

Create transformer mapping Create AI transformer mappings to other entities

Declaration

public ApiResponse<AITransformMappingDto> CreateTransformerMappingsWithHttpInfo(CreateAITransformerMappingOptions createAITransformerMappingOptions, int operationIndex = 0)

Parameters

Type	Name	Description
CreateAITransformerMappingOptions	createAITransformerMappingOptions
int	operationIndex	Index associated with the operation.

Returns

Type	Description
ApiResponse<AITransformMappingDto>	ApiResponse of AITransformMappingDto

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

CreateTransformerMappingsWithHttpInfoAsync(CreateAITransformerMappingOptions, int, CancellationToken)

Create transformer mapping Create AI transformer mappings to other entities

Declaration

public 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)

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

CreateTransformerWithHttpInfo(AITranformCreateOptions, int?, int?, string, int)

List transformers List all AI transforms

Declaration

public ApiResponse<PageAITransformProjection> CreateTransformerWithHttpInfo(AITranformCreateOptions options, int? page = null, int? size = null, string sort = null, int operationIndex = 0)

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.

Returns

Type	Description
ApiResponse<PageAITransformProjection>	ApiResponse of PageAITransformProjection

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

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

List transformers List all AI transforms

Declaration

public 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)

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

DeleteTransformer(Guid, int)

Delete a transformer Delete an AI transformer and schemas by ID

Declaration

public void DeleteTransformer(Guid id, int operationIndex = 0)

Parameters

Type	Name	Description
Guid	id
int	operationIndex	Index associated with the operation.

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

DeleteTransformerAsync(Guid, int, CancellationToken)

Delete a transformer Delete an AI transformer and schemas by ID

Declaration

public 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

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

DeleteTransformerMapping(Guid, int)

Delete transformer mapping Delete an AI transformer mapping

Declaration

public void DeleteTransformerMapping(Guid id, int operationIndex = 0)

Parameters

Type	Name	Description
Guid	id	ID of transform mapping
int	operationIndex	Index associated with the operation.

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

DeleteTransformerMappingAsync(Guid, int, CancellationToken)

Delete transformer mapping Delete an AI transformer mapping

Declaration

public 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

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

DeleteTransformerMappingWithHttpInfo(Guid, int)

Delete transformer mapping Delete an AI transformer mapping

Declaration

public ApiResponse<object> DeleteTransformerMappingWithHttpInfo(Guid id, int operationIndex = 0)

Parameters

Type	Name	Description
Guid	id	ID of transform mapping
int	operationIndex	Index associated with the operation.

Returns

Type	Description
ApiResponse<object>	ApiResponse of Object(void)

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

DeleteTransformerMappingWithHttpInfoAsync(Guid, int, CancellationToken)

Delete transformer mapping Delete an AI transformer mapping

Declaration

public 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

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

DeleteTransformerWithHttpInfo(Guid, int)

Delete a transformer Delete an AI transformer and schemas by ID

Declaration

public ApiResponse<object> DeleteTransformerWithHttpInfo(Guid id, int operationIndex = 0)

Parameters

Type	Name	Description
Guid	id
int	operationIndex	Index associated with the operation.

Returns

Type	Description
ApiResponse<object>	ApiResponse of Object(void)

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

DeleteTransformerWithHttpInfoAsync(Guid, int, CancellationToken)

Delete a transformer Delete an AI transformer and schemas by ID

Declaration

public 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

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

DeleteTransformers(int)

Delete all transformers Delete all AI transformers and schemas

Declaration

public void DeleteTransformers(int operationIndex = 0)

Parameters

Type	Name	Description
int	operationIndex	Index associated with the operation.

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

DeleteTransformersAsync(int, CancellationToken)

Delete all transformers Delete all AI transformers and schemas

Declaration

public 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

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

DeleteTransformersWithHttpInfo(int)

Delete all transformers Delete all AI transformers and schemas

Declaration

public ApiResponse<object> DeleteTransformersWithHttpInfo(int operationIndex = 0)

Parameters

Type	Name	Description
int	operationIndex	Index associated with the operation.

Returns

Type	Description
ApiResponse<object>	ApiResponse of Object(void)

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

DeleteTransformersWithHttpInfoAsync(int, CancellationToken)

Delete all transformers Delete all AI transformers and schemas

Declaration

public 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

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

GenerateStructuredContentFromAttachment(GenerateStructuredContentAttachmentOptions, int)

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

Declaration

public StructuredContentResultDto GenerateStructuredContentFromAttachment(GenerateStructuredContentAttachmentOptions generateStructuredContentAttachmentOptions, int operationIndex = 0)

Parameters

Type	Name	Description
GenerateStructuredContentAttachmentOptions	generateStructuredContentAttachmentOptions
int	operationIndex	Index associated with the operation.

Returns

Type	Description
StructuredContentResultDto	StructuredContentResultDto

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

GenerateStructuredContentFromAttachmentAsync(GenerateStructuredContentAttachmentOptions, int, CancellationToken)

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

Declaration

public 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

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

GenerateStructuredContentFromAttachmentWithHttpInfo(GenerateStructuredContentAttachmentOptions, int)

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

Declaration

public ApiResponse<StructuredContentResultDto> GenerateStructuredContentFromAttachmentWithHttpInfo(GenerateStructuredContentAttachmentOptions generateStructuredContentAttachmentOptions, int operationIndex = 0)

Parameters

Type	Name	Description
GenerateStructuredContentAttachmentOptions	generateStructuredContentAttachmentOptions
int	operationIndex	Index associated with the operation.

Returns

Type	Description
ApiResponse<StructuredContentResultDto>	ApiResponse of StructuredContentResultDto

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

GenerateStructuredContentFromAttachmentWithHttpInfoAsync(GenerateStructuredContentAttachmentOptions, int, CancellationToken)

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

Declaration

public 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)

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

GenerateStructuredContentFromEmail(GenerateStructuredContentEmailOptions, int)

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

Declaration

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

Parameters

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

Returns

Type	Description
StructuredContentResultDto	StructuredContentResultDto

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

GenerateStructuredContentFromEmailAsync(GenerateStructuredContentEmailOptions, int, CancellationToken)

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

Declaration

public 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

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

GenerateStructuredContentFromEmailWithHttpInfo(GenerateStructuredContentEmailOptions, int)

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

Declaration

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

Parameters

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

Returns

Type	Description
ApiResponse<StructuredContentResultDto>	ApiResponse of StructuredContentResultDto

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

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

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

GenerateStructuredContentFromSms(GenerateStructuredContentSmsOptions, int)

Generate structured content for a TXT message Use output schemas to extract data from an SMS using AI

Declaration

public StructuredContentResultDto GenerateStructuredContentFromSms(GenerateStructuredContentSmsOptions generateStructuredContentSmsOptions, int operationIndex = 0)

Parameters

Type	Name	Description
GenerateStructuredContentSmsOptions	generateStructuredContentSmsOptions
int	operationIndex	Index associated with the operation.

Returns

Type	Description
StructuredContentResultDto	StructuredContentResultDto

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

GenerateStructuredContentFromSmsAsync(GenerateStructuredContentSmsOptions, int, CancellationToken)

Generate structured content for a TXT message Use output schemas to extract data from an SMS using AI

Declaration

public 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

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

GenerateStructuredContentFromSmsWithHttpInfo(GenerateStructuredContentSmsOptions, int)

Generate structured content for a TXT message Use output schemas to extract data from an SMS using AI

Declaration

public ApiResponse<StructuredContentResultDto> GenerateStructuredContentFromSmsWithHttpInfo(GenerateStructuredContentSmsOptions generateStructuredContentSmsOptions, int operationIndex = 0)

Parameters

Type	Name	Description
GenerateStructuredContentSmsOptions	generateStructuredContentSmsOptions
int	operationIndex	Index associated with the operation.

Returns

Type	Description
ApiResponse<StructuredContentResultDto>	ApiResponse of StructuredContentResultDto

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

GenerateStructuredContentFromSmsWithHttpInfoAsync(GenerateStructuredContentSmsOptions, int, CancellationToken)

Generate structured content for a TXT message Use output schemas to extract data from an SMS using AI

Declaration

public 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)

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

GetBasePath()

Gets the base path of the API client.

Declaration

public string GetBasePath()

Returns

Type	Description
string	The base path

GetTransformer(Guid, int)

Get a transformer Get AI transformer and schemas by ID

Declaration

public AITransformDto GetTransformer(Guid id, int operationIndex = 0)

Parameters

Type	Name	Description
Guid	id
int	operationIndex	Index associated with the operation.

Returns

Type	Description
AITransformDto	AITransformDto

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

GetTransformerAsync(Guid, int, CancellationToken)

Get a transformer Get AI transformer and schemas by ID

Declaration

public 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

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

GetTransformerMapping(Guid, int)

Get transformer mapping Get an AI transformer mapping

Declaration

public AITransformMappingDto GetTransformerMapping(Guid id, int operationIndex = 0)

Parameters

Type	Name	Description
Guid	id	ID of transform mapping
int	operationIndex	Index associated with the operation.

Returns

Type	Description
AITransformMappingDto	AITransformMappingDto

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

GetTransformerMappingAsync(Guid, int, CancellationToken)

Get transformer mapping Get an AI transformer mapping

Declaration

public 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

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

GetTransformerMappingWithHttpInfo(Guid, int)

Get transformer mapping Get an AI transformer mapping

Declaration

public ApiResponse<AITransformMappingDto> GetTransformerMappingWithHttpInfo(Guid id, int operationIndex = 0)

Parameters

Type	Name	Description
Guid	id	ID of transform mapping
int	operationIndex	Index associated with the operation.

Returns

Type	Description
ApiResponse<AITransformMappingDto>	ApiResponse of AITransformMappingDto

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

GetTransformerMappingWithHttpInfoAsync(Guid, int, CancellationToken)

Get transformer mapping Get an AI transformer mapping

Declaration

public 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)

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

GetTransformerMappings(Guid?, Guid?, string, int?, int?, string, int)

Get transformer mappings Get AI transformer mappings to other entities

Declaration

public PageAITransformMappingProjection GetTransformerMappings(Guid? aiTransformId = null, Guid? entityId = null, string entityType = null, int? page = null, int? size = null, string sort = null, int operationIndex = 0)

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.

Returns

Type	Description
PageAITransformMappingProjection	PageAITransformMappingProjection

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

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

Get transformer mappings Get AI transformer mappings to other entities

Declaration

public 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

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

GetTransformerMappingsWithHttpInfo(Guid?, Guid?, string, int?, int?, string, int)

Get transformer mappings Get AI transformer mappings to other entities

Declaration

public ApiResponse<PageAITransformMappingProjection> GetTransformerMappingsWithHttpInfo(Guid? aiTransformId = null, Guid? entityId = null, string entityType = null, int? page = null, int? size = null, string sort = null, int operationIndex = 0)

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.

Returns

Type	Description
ApiResponse<PageAITransformMappingProjection>	ApiResponse of PageAITransformMappingProjection

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

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

Get transformer mappings Get AI transformer mappings to other entities

Declaration

public 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)

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

GetTransformerResult(Guid, int)

Get transformer result Get AI transformer result

Declaration

public AITransformResultDto GetTransformerResult(Guid id, int operationIndex = 0)

Parameters

Type	Name	Description
Guid	id	ID of transform result
int	operationIndex	Index associated with the operation.

Returns

Type	Description
AITransformResultDto	AITransformResultDto

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

GetTransformerResultAsync(Guid, int, CancellationToken)

Get transformer result Get AI transformer result

Declaration

public 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

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

GetTransformerResultWithHttpInfo(Guid, int)

Get transformer result Get AI transformer result

Declaration

public ApiResponse<AITransformResultDto> GetTransformerResultWithHttpInfo(Guid id, int operationIndex = 0)

Parameters

Type	Name	Description
Guid	id	ID of transform result
int	operationIndex	Index associated with the operation.

Returns

Type	Description
ApiResponse<AITransformResultDto>	ApiResponse of AITransformResultDto

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

GetTransformerResultWithHttpInfoAsync(Guid, int, CancellationToken)

Get transformer result Get AI transformer result

Declaration

public 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)

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

GetTransformerResults(Guid?, Guid?, Guid?, string, int?, int?, string, int)

Get transformer results Get AI transformer results

Declaration

public PageAITransformResultProjection GetTransformerResults(Guid? aiTransformId = null, Guid? aiTransformMappingId = null, Guid? entityId = null, string entityType = null, int? page = null, int? size = null, string sort = null, int operationIndex = 0)

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.

Returns

Type	Description
PageAITransformResultProjection	PageAITransformResultProjection

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

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

Get transformer results Get AI transformer results

Declaration

public 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

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

GetTransformerResultsWithHttpInfo(Guid?, Guid?, Guid?, string, int?, int?, string, int)

Get transformer results Get AI transformer results

Declaration

public ApiResponse<PageAITransformResultProjection> GetTransformerResultsWithHttpInfo(Guid? aiTransformId = null, Guid? aiTransformMappingId = null, Guid? entityId = null, string entityType = null, int? page = null, int? size = null, string sort = null, int operationIndex = 0)

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.

Returns

Type	Description
ApiResponse<PageAITransformResultProjection>	ApiResponse of PageAITransformResultProjection

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

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

Get transformer results Get AI transformer results

Declaration

public 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)

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

GetTransformerWithHttpInfo(Guid, int)

Get a transformer Get AI transformer and schemas by ID

Declaration

public ApiResponse<AITransformDto> GetTransformerWithHttpInfo(Guid id, int operationIndex = 0)

Parameters

Type	Name	Description
Guid	id
int	operationIndex	Index associated with the operation.

Returns

Type	Description
ApiResponse<AITransformDto>	ApiResponse of AITransformDto

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

GetTransformerWithHttpInfoAsync(Guid, int, CancellationToken)

Get a transformer Get AI transformer and schemas by ID

Declaration

public 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)

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

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

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

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

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