Class GenerateStructuredContentEmailOptions
Options for generating structured content output from an email
Implements
Inherited Members
Namespace: mailslurp.Model
Assembly: mailslurp.dll
Syntax
[DataContract(Name = "GenerateStructuredContentEmailOptions")]
public class GenerateStructuredContentEmailOptions : IValidatableObject
Constructors
View SourceGenerateStructuredContentEmailOptions()
Initializes a new instance of the Generate
Declaration
[JsonConstructor]
protected GenerateStructuredContentEmailOptions()
GenerateStructuredContentEmailOptions(Guid, ContentSelectorEnum?, string, StructuredOutputSchema, Guid?)
Initializes a new instance of the Generate
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). |
Generate |
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.. |
Structured |
outputSchema | outputSchema. |
Guid? | transformId | ID of transformer to apply. |
Properties
View SourceContentSelector
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 |
---|---|
Generate |
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 |
---|---|
Structured |
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
View SourceToJson()
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 |