Interface IAIControllerApiSync

Represents a collection of functions to interact with the API endpoints

Inherited Members

IApiAccessor.Configuration

IApiAccessor.GetBasePath()

IApiAccessor.ExceptionFactory

Namespace: mailslurp.Api

Assembly: mailslurp.dll

Syntax

public interface IAIControllerApiSync : IApiAccessor

Methods

GenerateStructuredContentFromEmail(GenerateStructuredContentEmailOptions, int)

Generate structured content for an email

Declaration

StructuredContentResult GenerateStructuredContentFromEmail(GenerateStructuredContentEmailOptions generateStructuredContentEmailOptions, int operationIndex = 0)

Parameters

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

Returns

Type	Description
StructuredContentResult	StructuredContentResult

Remarks

Use output schemas to extract data from an email using AI

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

GenerateStructuredContentFromEmailWithHttpInfo(GenerateStructuredContentEmailOptions, int)

Generate structured content for an email

Declaration

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

Parameters

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

Returns

Type	Description
ApiResponse<StructuredContentResult>	ApiResponse of StructuredContentResult

Remarks

Use output schemas to extract data from an email using AI

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

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

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