Share via


ThreadInitializationMessage Class

Definition

A single message within an assistant thread, as provided during that thread's creation for its initial state.

public class ThreadInitializationMessage : System.ClientModel.Primitives.IJsonModel<Azure.AI.OpenAI.Assistants.ThreadInitializationMessage>, System.ClientModel.Primitives.IPersistableModel<Azure.AI.OpenAI.Assistants.ThreadInitializationMessage>
type ThreadInitializationMessage = class
    interface IJsonModel<ThreadInitializationMessage>
    interface IPersistableModel<ThreadInitializationMessage>
Public Class ThreadInitializationMessage
Implements IJsonModel(Of ThreadInitializationMessage), IPersistableModel(Of ThreadInitializationMessage)
Inheritance
ThreadInitializationMessage
Implements

Constructors

ThreadInitializationMessage(MessageRole, String)

Initializes a new instance of ThreadInitializationMessage.

Properties

Content

The textual content of the initial message. Currently, robust input including images and annotated text may only be provided via a separate call to the create message API.

FileIds

A list of file IDs that the assistant should use. Useful for tools like retrieval and code_interpreter that can access files.

Metadata

A set of up to 16 key/value pairs that can be attached to an object, used for storing additional information about that object in a structured format. Keys may be up to 64 characters in length and values may be up to 512 characters in length.

Role

The role associated with the assistant thread message. Currently, only 'user' is supported when providing initial messages to a new thread.

Explicit Interface Implementations

IJsonModel<ThreadInitializationMessage>.Create(Utf8JsonReader, ModelReaderWriterOptions)

Reads one JSON value (including objects or arrays) from the provided reader and converts it to a model.

IJsonModel<ThreadInitializationMessage>.Write(Utf8JsonWriter, ModelReaderWriterOptions)

Writes the model to the provided Utf8JsonWriter.

IPersistableModel<ThreadInitializationMessage>.Create(BinaryData, ModelReaderWriterOptions)

Converts the provided BinaryData into a model.

IPersistableModel<ThreadInitializationMessage>.GetFormatFromOptions(ModelReaderWriterOptions)

Gets the data interchange format (JSON, Xml, etc) that the model uses when communicating with the service.

IPersistableModel<ThreadInitializationMessage>.Write(ModelReaderWriterOptions)

Writes the model into a BinaryData.

Applies to