Class GenerateStructuredContentEmailOptions

Options for generating structured content output from an email

Inheritance
object
GenerateStructuredContentEmailOptions
Implements
Inherited Members
Namespace: mailslurp.Model
Assembly: mailslurp.dll
Syntax
[DataContract(Name = "GenerateStructuredContentEmailOptions")]
public class GenerateStructuredContentEmailOptions : IValidatableObject

Constructors

View Source

GenerateStructuredContentEmailOptions()

Initializes a new instance of the GenerateStructuredContentEmailOptions class.

Declaration
[JsonConstructor]
protected GenerateStructuredContentEmailOptions()
View Source

GenerateStructuredContentEmailOptions(Guid, ContentSelectorEnum?, string, StructuredOutputSchema)

Initializes a new instance of the GenerateStructuredContentEmailOptions class.

Declaration
public GenerateStructuredContentEmailOptions(Guid emailId = default, GenerateStructuredContentEmailOptions.ContentSelectorEnum? contentSelector = null, string instructions = null, StructuredOutputSchema outputSchema = null)
Parameters
Type Name Description
Guid emailId

Email ID to read and pass to AI (required).
GenerateStructuredContentEmailOptions.ContentSelectorEnum? contentSelector

Content selector to select part of email to operate on.
string instructions

Optional instructions for the AI to follow. Try to be precise and clear. You can include examples and hints..
StructuredOutputSchema outputSchema

outputSchema (required).

Properties

View Source

ContentSelector

Content selector to select part of email to operate on

Declaration
[DataMember(Name = "contentSelector", EmitDefaultValue = false)]
public GenerateStructuredContentEmailOptions.ContentSelectorEnum? ContentSelector { get; set; }
Property Value
Type Description
GenerateStructuredContentEmailOptions.ContentSelectorEnum?

Content selector to select part of email to operate on
View Source

EmailId

Email ID to read and pass to AI

Declaration
[DataMember(Name = "emailId", IsRequired = true, EmitDefaultValue = true)]
public Guid EmailId { get; set; }
Property Value
Type Description
Guid

Email ID to read and pass to AI
View Source

Instructions

Optional instructions for the AI to follow. Try to be precise and clear. You can include examples and hints.

Declaration
[DataMember(Name = "instructions", EmitDefaultValue = false)]
public string Instructions { get; set; }
Property Value
Type Description
string

Optional instructions for the AI to follow. Try to be precise and clear. You can include examples and hints.
View Source

OutputSchema

Gets or Sets OutputSchema

Declaration
[DataMember(Name = "outputSchema", IsRequired = true, EmitDefaultValue = true)]
public StructuredOutputSchema OutputSchema { get; set; }
Property Value
Type Description
StructuredOutputSchema

Methods

View Source

ToJson()

Returns the JSON string presentation of the object

Declaration
public virtual string ToJson()
Returns
Type Description
string

JSON string presentation of the object
View Source

ToString()

Returns the string presentation of the object

Declaration
public override string ToString()
Returns
Type Description
string

String presentation of the object
Overrides

Implements