Class GenerateStructuredContentEmailOptions

Options for generating structured content output from an email

Inheritance

object

GenerateStructuredContentEmailOptions

Implements

IValidatableObject

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

Namespace: mailslurp.Model

Assembly: mailslurp.dll

Syntax

[DataContract(Name = "GenerateStructuredContentEmailOptions")]
public class GenerateStructuredContentEmailOptions : IValidatableObject

Constructors

GenerateStructuredContentEmailOptions()

Initializes a new instance of the GenerateStructuredContentEmailOptions class.

Declaration

[JsonConstructor]
protected GenerateStructuredContentEmailOptions()

GenerateStructuredContentEmailOptions(Guid, ContentSelectorEnum?, string, StructuredOutputSchema, Guid?)

Initializes a new instance of the GenerateStructuredContentEmailOptions class.

Declaration

public GenerateStructuredContentEmailOptions(Guid emailId = default, GenerateStructuredContentEmailOptions.ContentSelectorEnum? contentSelector = null, string instructions = null, StructuredOutputSchema outputSchema = null, Guid? transformId = 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.
Guid?	transformId	ID of transformer to apply.

Properties

ContentSelector

Content selector to select part of email to operate on

Declaration

[DataMember(Name = "contentSelector", EmitDefaultValue = true)]
public GenerateStructuredContentEmailOptions.ContentSelectorEnum? ContentSelector { get; set; }

Property Value

Type	Description
GenerateStructuredContentEmailOptions.ContentSelectorEnum?	Content selector to select part of email to operate on

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

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 = true)]
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.

OutputSchema

Gets or Sets OutputSchema

Declaration

[DataMember(Name = "outputSchema", EmitDefaultValue = false)]
public StructuredOutputSchema OutputSchema { get; set; }

Property Value

Type	Description
StructuredOutputSchema

TransformId

ID of transformer to apply

Declaration

[DataMember(Name = "transformId", EmitDefaultValue = true)]
public Guid? TransformId { get; set; }

Property Value

Type	Description
Guid?	ID of transformer to apply

Methods

ToJson()

Returns the JSON string presentation of the object

Declaration

public virtual string ToJson()

Returns

Type	Description
string	JSON string presentation of the object

ToString()

Returns the string presentation of the object

Declaration

public override string ToString()

Returns

Type	Description
string	String presentation of the object

Overrides

object.ToString()

Implements

IValidatableObject