Skip to content

Latest commit

 

History

History
253 lines (182 loc) · 9.48 KB

Projects.AI.TrainingConversationMessages.md

File metadata and controls

253 lines (182 loc) · 9.48 KB
Raw
uid
Projects.AI.TrainingConversationMessages

Projects.AI.TrainingConversationMessages Entity

Namespace: Projects.AI

Message in a training conversation. Entity: Llm_Training_Conversation_Messages (Introduced in version 24.1.3.89)

Default Visualization

Default Display Text Format:
{ParticipantName}
Default Search Members:
ParticipantName
Name Data Member:
ParticipantName
Category: Definitions
Show in UI: ShownByDefault

Aggregate

An aggregate is a cluster of domain objects that can be treated as a single unit.

Aggregate Parent:
Projects.AI.TrainingConversations
Aggregate Root:
Projects.AI.TrainingConversations

Attributes

Name Type Description
Contents string (max) Contents of the message. Can be formatted using MarkDown. Required
DisplayText string Uses the repository DisplayTextFormat to build the display text from the attributes and references of current object.
Id guid
MessageNo int32 Message number within the conversation. Required Filter(eq)
MessageTimeUtc datetime Date and time, when the message was originally typed (or created). Required Default(NowUtc) Filter(ge;le)
ObjectVersion int32 The latest version of the extensible data object for the aggregate root for the time the object is loaded from the database. Can be used for optimistic locking.
ParticipantName string (64) nullable Name of the participant, who created the message. Name is optional, but gives more context to the message.
ParticipantRole ParticipantRole Role of the participant. Can be System - for system mood messages; User - for user messages; Assistant - for AI-created message. Required Default("U") Filter(multi eq)

References

Name Type Description
TrainingConversation TrainingConversations The to which this TrainingConversation
Message belongs. Required Filter(multi eq) Owner

Attribute Details

Contents

Contents of the message. Can be formatted using MarkDown. Required

Type: string (max)
Category: System
Supported Filters: NotFilterable
Supports Order By: False
Maximum Length: 2147483647
Show in UI: ShownByDefault

DisplayText

Uses the repository DisplayTextFormat to build the display text from the attributes and references of current object.

Type: string
Category: Calculated Attributes
Supported Filters: NotFilterable
Supports Order By: ****
Show in UI: HiddenByDefault

Id

Type: guid
Indexed: True
Category: System
Supported Filters: Equals, EqualsIn
Default Value: NewGuid
Show in UI: CannotBeShown

MessageNo

Message number within the conversation. Required Filter(eq)

Type: int32
Category: System
Supported Filters: Equals
Supports Order By: False
Show in UI: ShownByDefault

Back-End Default Expression:
( obj.TrainingConversation.Messages.Select( c => c.MessageNo).DefaultIfEmpty( 0).Max( ) + 1)

Front-End Recalc Expressions:
( obj.TrainingConversation.Messages.Select( c => c.MessageNo).DefaultIfEmpty( 0).Max( ) + 1)

MessageTimeUtc

Date and time, when the message was originally typed (or created). Required Default(NowUtc) Filter(ge;le)

Type: datetime
Category: System
Supported Filters: GreaterThanOrLessThan
Supports Order By: False
Default Value: CurrentDateTimeUtc
Show in UI: ShownByDefault

ObjectVersion

The latest version of the extensible data object for the aggregate root for the time the object is loaded from the database. Can be used for optimistic locking.

Type: int32
Category: Extensible Data Object
Supported Filters: NotFilterable
Supports Order By: ****
Show in UI: HiddenByDefault

ParticipantName

Name of the participant, who created the message. Name is optional, but gives more context to the message.

Type: string (64) nullable
Category: System
Supported Filters: NotFilterable
Supports Order By: False
Maximum Length: 64
Show in UI: ShownByDefault

ParticipantRole

Role of the participant. Can be System - for system mood messages; User - for user messages; Assistant - for AI-created message. Required Default("U") Filter(multi eq)

Type: ParticipantRole
Category: System
Allowed values for the ParticipantRole(Projects.AI.TrainingConversationMessages.md#participantrole) data attribute
Allowed Values (Projects.AI.TrainingConversationMessagesRepository.ParticipantRole Enum Members)

Value Description
System System. Stored as 'S'.
Database Value: 'S'
Model Value: 0
Domain API Value: 'System'
User User. Stored as 'U'.
Database Value: 'U'
Model Value: 1
Domain API Value: 'User'
Assistant Assistant. Stored as 'A'.
Database Value: 'A'
Model Value: 2
Domain API Value: 'Assistant'

Supported Filters: Equals, EqualsIn
Supports Order By: False
Default Value: User
Show in UI: ShownByDefault

Reference Details

TrainingConversation

The to which this TrainingConversationMessage belongs. Required Filter(multi eq) Owner

Type: TrainingConversations
Indexed: True
Category: System
Supported Filters: Equals, EqualsIn
Filterable Reference: True
Show in UI: ShownByDefault

API Methods

Methods that can be invoked in public APIs.

GetAllowedCustomPropertyValues

Gets the allowed values for the specified custom property for this entity object. If supported the result is ordered by property value. Some property value sources do not support ordering - in that case the result is not ordered.
Return Type: Collection Of CustomPropertyValue
Declaring Type: EntityObject
Domain API Request: GET

Parameters

  • customPropertyCode
    The code of the custom property
    Type: string

  • search
    The search text - searches by value or description. Can contain wildcard character %.
    Type: string
    Optional: True
    Default Value: null

  • exactMatch
    If true the search text should be equal to the property value
    Type: boolean
    Optional: True
    Default Value: False

  • orderByDescription
    If true the result is ordered by Description instead of Value. Note that ordering is not always possible.
    Type: boolean
    Optional: True
    Default Value: False

  • top
    The top clause - default is 10
    Type: int32
    Optional: True
    Default Value: 10

  • skip
    The skip clause - default is 0
    Type: int32
    Optional: True
    Default Value: 0

CreateNotification

Creates a notification and sends a real time event to the user.
Return Type: void
Declaring Type: EntityObject
Domain API Request: POST

Parameters

  • user
    The user.
    Type: Users

  • notificationClass
    The notification class.
    Type: string

  • subject
    The subject.
    Type: string

CreateCopy

Duplicates the object and its child objects belonging to the same aggregate. The duplicated objects are not saved to the data source but remain in the same transaction as the original object.
Return Type: EntityObject
Declaring Type: EntityObject
Domain API Request: POST

Business Rules

[!list limit=1000 erp.entity=Projects.AI.TrainingConversationMessages erp.type=business-rule default-text="None"]

Front-End Business Rules

[!list limit=1000 erp.entity=Projects.AI.TrainingConversationMessages erp.type=front-end-business-rule default-text="None"]

API

Domain API Query: https://demodb.my.erp.net/api/domain/odata/Projects_AI_TrainingConversationMessages?$top=10

Domain API Query Builder: https://demodb.my.erp.net/api/domain/querybuilder#Projects_AI_TrainingConversationMessages?$top=10