Class GenerateStructuredContentAttachmentOptions

Options for generating structured content output from an attachment

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

Constructors

View Source

GenerateStructuredContentAttachmentOptions()

Initializes a new instance of the GenerateStructuredContentAttachmentOptions class.

Declaration
[JsonConstructor]
protected GenerateStructuredContentAttachmentOptions()
View Source

GenerateStructuredContentAttachmentOptions(string, string, StructuredOutputSchema, Guid?, Guid?)

Initializes a new instance of the GenerateStructuredContentAttachmentOptions class.

Declaration
public GenerateStructuredContentAttachmentOptions(string attachmentId = null, string instructions = null, StructuredOutputSchema outputSchema = null, Guid? transformId = null, Guid? emailId = null)
Parameters
Type Name Description
string attachmentId

Attachment ID to read and pass to AI (required).
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.
Guid? emailId

Optional email ID for more context.

Properties

View Source

AttachmentId

Attachment ID to read and pass to AI

Declaration
[DataMember(Name = "attachmentId", IsRequired = true, EmitDefaultValue = true)]
public string AttachmentId { get; set; }
Property Value
Type Description
string

Attachment ID to read and pass to AI
View Source

EmailId

Optional email ID for more context

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

Optional email ID for more context
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 = 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.
View Source

OutputSchema

Gets or Sets OutputSchema

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

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 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