messages

Creates, updates, deletes, gets or lists a messages resource.

Overview

Name	messages
Type	Resource
Id	openai.assistants.messages

Fields

Name	Datatype	Description
id	string	The identifier, which can be referenced in API endpoints.
assistant_id	string	If applicable, the ID of the assistant that authored this message.
attachments	array	A list of files attached to the message, and the tools they were added to.
completed_at	integer	The Unix timestamp (in seconds) for when the message was completed.
content	array	The content of the message in array of text and/or images.
created_at	integer	The Unix timestamp (in seconds) for when the message was created.
incomplete_at	integer	The Unix timestamp (in seconds) for when the message was marked as incomplete.
incomplete_details	object	On an incomplete message, details about why the message is incomplete.
metadata	object	Set of 16 key-value pairs that can be attached to an object. This can be useful for storing additional information about the object in a structured format. Keys can be a maximum of 64 characters long and values can be a maximum of 512 characters long.
object	string	The object type, which is always thread.message.
role	string	The entity that produced the message. One of user or assistant.
run_id	string	The ID of the run associated with the creation of this message. Value is null when messages are created manually using the create message or create thread endpoints.
status	string	The status of the message, which can be either in_progress, incomplete, or completed.
thread_id	string	The thread ID that this message belongs to.

Methods

Name	Accessible by	Required Params	Description
get_message	SELECT	message_id, thread_id
list_messages	SELECT	thread_id
create_message	INSERT	thread_id, data__content, data__role
delete_message	DELETE	message_id, thread_id
modify_message	UPDATE	message_id, thread_id

SELECT examples

SELECT
id,
assistant_id,
attachments,
completed_at,
content,
created_at,
incomplete_at,
incomplete_details,
metadata,
object,
role,
run_id,
status,
thread_id
FROM openai.assistants.messages
WHERE thread_id = '{{ thread_id }}';

INSERT example

Use the following StackQL query and manifest file to create a new messages resource.

Required Properties

/*+ create */
INSERT INTO openai.assistants.messages (
data__role,
data__content,
data__attachments,
data__metadata,
thread_id
)
SELECT 
'{{ role }}',
'{{ content }}',
'{{ attachments }}',
'{{ metadata }}',
'{{ thread_id }}'
;

All Properties

/*+ create */
INSERT INTO openai.assistants.messages (
data__role,
data__content,
thread_id
)
SELECT 
'{{ role }}',
'{{ content }}',
'{{ thread_id }}'
;

Manifest

- name: messages
  props:
    - name: thread_id
      value: string
    - name: data__content
      value: string
    - name: data__role
      value: string
    - name: role
      value: string
    - name: content
      value: string
    - name: attachments
      value: array
      props:
        - name: file_id
          value: string
        - name: tools
          value: array
          props:
            - name: type
              value: string
    - name: metadata
      value: object

UPDATE example

Updates a messages resource.

/*+ update */
UPDATE openai.assistants.messages
SET 
metadata = '{{ metadata }}'
WHERE 
message_id = '{{ message_id }}'
AND thread_id = '{{ thread_id }}';

DELETE example

Deletes the specified messages resource.

/*+ delete */
DELETE FROM openai.assistants.messages
WHERE message_id = '{{ message_id }}'
AND thread_id = '{{ thread_id }}';