Package version:

Interface MessagesOperations

Interface representing a Messages operations.

interface MessagesOperations {
    create: ((threadId: string, role: MessageRole, content: MessageInputContent, options?: MessagesCreateMessageOptionalParams) => Promise<ThreadMessage>);
    get: ((threadId: string, messageId: string, options?: MessagesGetMessageOptionalParams) => Promise<ThreadMessage>);
    list: ((threadId: string, options?: MessagesListMessagesOptionalParams) => PagedAsyncIterableIterator<ThreadMessage, {}, PageSettings>);
    update: ((threadId: string, messageId: string, options?: MessagesUpdateMessageOptionalParams) => Promise<ThreadMessage>);
}

Index

Properties

create get list update

Properties

create

create: ((threadId: string, role: MessageRole, content: MessageInputContent, options?: MessagesCreateMessageOptionalParams) => Promise<ThreadMessage>)

Creates a new message on a specified thread.

get

get: ((threadId: string, messageId: string, options?: MessagesGetMessageOptionalParams) => Promise<ThreadMessage>)

Retrieves an existing message.

list

list: ((threadId: string, options?: MessagesListMessagesOptionalParams) => PagedAsyncIterableIterator<ThreadMessage, {}, PageSettings>)

Gets a list of messages that exist on a thread.

update

update: ((threadId: string, messageId: string, options?: MessagesUpdateMessageOptionalParams) => Promise<ThreadMessage>)

Modifies an existing message on an existing thread.