AI · GraphQL type

AiThread type

Type AiThread represents a conversation thread between a user and the AI system, containing metadata about the thread's purpose, associated object, and activity timestamp.

Fields

Field Name Description
id - AiThreadId! The thread ID.
name - String! The thread name.
threadType - AiThreadType! The thread type.
objectId - String The ID of the system object.
entries - [AiThreadEntry!]! Collection of AI thread entries.
timestamp - Time! The time of the recent thread activity

Returned by

  • aiThread query: Retrieves one of the caller's AI chat threads with its messages.
  • aiThreadClear query: Removes every message from one of the caller's AI chat threads and returns the now-empty thread.
  • aiThreadCreate query: Creates an AI chat thread of the requested type, or returns the existing one: a thread id is derived from the user, organization, thread type,…
  • aiThreads query: Lists the caller's AI chat threads in an organization that contain at least one message, most recently updated first.

Used by

  • AiThreadPayload type: Type AiThreadPayload serves as a container for retrieving multiple AI threads.

Related types

  • AiThreadEntry Type AiThreadEntry represents an individual message in an AI thread, acting as a base interface for different types of thread entries with common…

Example

Example

{
  "id": AiThreadId,
  "name": "abc123",
  "threadType": "GENERAL",
  "objectId": "xyz789",
  "entries": [AiThreadEntry],
  "timestamp": "2021-10-07T18:23:25.829Z"
}