Interface IAIControllerApiSync

Represents a collection of functions to interact with the API endpoints

Inherited Members

Namespace: mailslurp.Api

Assembly: mailslurp.dll

Syntax

public interface IAIControllerApiSync : IApiAccessor

Methods

View Source

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

List transformers

Declaration

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

Remarks

List all AI transforms

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

View Source

CreateTransformer1(AITranformCreateOptions, int)

Create a transformer for reuse in automations

Declaration

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

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

CreateTransformer1WithHttpInfo(AITranformCreateOptions, int)

Create a transformer for reuse in automations

Declaration

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

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

CreateTransformerMappings(CreateAITransformerMappingOptions, int)

Create transformer mapping

Declaration

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

Remarks

Create AI transformer mappings to other entities

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

View Source

CreateTransformerMappingsWithHttpInfo(CreateAITransformerMappingOptions, int)

Create transformer mapping

Declaration

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

Remarks

Create AI transformer mappings to other entities

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

View Source

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

List transformers

Declaration

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

Remarks

List all AI transforms

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

View Source

DeleteTransformer(Guid, int)

Delete a transformer

Declaration

void DeleteTransformer(Guid id, int operationIndex = 0)

Parameters

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

Remarks

Delete an AI transformer and schemas by ID

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

View Source

DeleteTransformerMapping(Guid, int)

Delete transformer mapping

Declaration

void DeleteTransformerMapping(Guid id, int operationIndex = 0)

Parameters

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

Remarks

Delete an AI transformer mapping

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

View Source

DeleteTransformerMappingWithHttpInfo(Guid, int)

Delete transformer mapping

Declaration

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)

Remarks

Delete an AI transformer mapping

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

View Source

DeleteTransformerWithHttpInfo(Guid, int)

Delete a transformer

Declaration

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)

Remarks

Delete an AI transformer and schemas by ID

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

View Source

DeleteTransformers(int)

Delete all transformers

Declaration

void DeleteTransformers(int operationIndex = 0)

Parameters

Type	Name	Description
int	operationIndex	Index associated with the operation.

Remarks

Delete all AI transformers and schemas

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

View Source

DeleteTransformersWithHttpInfo(int)

Delete all transformers

Declaration

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)

Remarks

Delete all AI transformers and schemas

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

View Source

GenerateStructuredContentFromAttachment(GenerateStructuredContentAttachmentOptions, int)

Generate structured content for an attachment

Declaration

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

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

GenerateStructuredContentFromAttachmentWithHttpInfo(GenerateStructuredContentAttachmentOptions, int)

Generate structured content for an attachment

Declaration

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

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

GenerateStructuredContentFromEmail(GenerateStructuredContentEmailOptions, int)

Generate structured content for an email

Declaration

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

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

GenerateStructuredContentFromEmailWithHttpInfo(GenerateStructuredContentEmailOptions, int)

Generate structured content for an email

Declaration

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

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

GenerateStructuredContentFromSms(GenerateStructuredContentSmsOptions, int)

Generate structured content for a TXT message

Declaration

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

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

GenerateStructuredContentFromSmsWithHttpInfo(GenerateStructuredContentSmsOptions, int)

Generate structured content for a TXT message

Declaration

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

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

GetTransformer(Guid, int)

Get a transformer

Declaration

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

Remarks

Get AI transformer and schemas by ID

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

View Source

GetTransformerMapping(Guid, int)

Get transformer mapping

Declaration

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

Remarks

Get an AI transformer mapping

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

View Source

GetTransformerMappingWithHttpInfo(Guid, int)

Get transformer mapping

Declaration

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

Remarks

Get an AI transformer mapping

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

View Source

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

Get transformer mappings

Declaration

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

Remarks

Get AI transformer mappings to other entities

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

View Source

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

Get transformer mappings

Declaration

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

Remarks

Get AI transformer mappings to other entities

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

View Source

GetTransformerResult(Guid, int)

Get transformer result

Declaration

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

Remarks

Get AI transformer result

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

View Source

GetTransformerResultWithHttpInfo(Guid, int)

Get transformer result

Declaration

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

Remarks

Get AI transformer result

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

View Source

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

Get transformer results

Declaration

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

Remarks

Get AI transformer results

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

View Source

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

Get transformer results

Declaration

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

Remarks

Get AI transformer results

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

View Source

GetTransformerWithHttpInfo(Guid, int)

Get a transformer

Declaration

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

Remarks

Get AI transformer and schemas by ID

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

View Source

ValidateStructuredOutputSchema(StructuredOutputSchema, int)

Validate structured content schema

Declaration

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

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

ValidateStructuredOutputSchemaWithHttpInfo(StructuredOutputSchema, int)

Validate structured content schema

Declaration

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

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