Table of Contents

Projects.AI.TrainingConversations Entity

Namespace: Projects.AI

One piece of training data for fine-tuning AI models. Entity: Llm_Training_Conversations (Introduced in version 24.1.3.89)

Default Visualization

Default Display Text Format:
{Id}: {ModelId}
Default Search Members:
__
Category: Definitions
Show in UI: ShownByDefault

Track Changes

Min level: 0 - Do not track changes
Max level: 4 - Track object attribute and blob changes

Aggregate

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

Aggregate Tree

Attributes

Name Type Description
CreationTimeUtc datetime The date and time (UTC) when the conversation was created. Required Default(NowUtc) Filter(ge;le) ReadOnly
DisplayText string Uses the repository DisplayTextFormat to build the display text from the attributes and references of current object.
Id guid
LastUpdateTimeUtc datetime Time when the conversation or any messages in it were created or last modified. Can be used to track changes to the whole aggregate. Required Filter(ge;le) ORD ReadOnly
Notes string (max) nullable Notes for this training conversation.
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.
Origin Origin Denotes how (based on what other object) was the conversation initially created. Possible values - User-entered, Chat, Calendar, etc. Required Default("USR") Filter(multi eq) ReadOnly

References

Name Type Description
Model Models The model, which is being trained. Required Filter(multi eq)
OriginDataObject ExtensibleDataObjects (nullable) The object, whose data was used to initially create the conversation. null means the object is unknown or not a data object. Filter(multi eq) ReadOnly

Child Collections

Name Type Description
Messages TrainingConversationMessages List of TrainingConversation<br />Message(Projects.AI.TrainingConversation
Messages.md) child objects, based on the Projects.AI.TrainingConversation<br />Message.TrainingConversation(Projects.AI.TrainingConversation
Messages.md#trainingconversation) back reference

Attribute Details

CreationTimeUtc

The date and time (UTC) when the conversation was created. Required Default(NowUtc) Filter(ge;le) ReadOnly

Type: datetime
Category: System
Supported Filters: GreaterThanOrLessThan
Supports Order By: False
Default Value: CurrentDateTimeUtc
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

LastUpdateTimeUtc

Time when the conversation or any messages in it were created or last modified. Can be used to track changes to the whole aggregate. Required Filter(ge;le) ORD ReadOnly

Type: datetime
Indexed: True
Category: System
Supported Filters: GreaterThanOrLessThan
Supports Order By: True
Show in UI: ShownByDefault

Notes

Notes for this training conversation.

Type: string (max) nullable
Category: System
Supported Filters: NotFilterable
Supports Order By: False
Maximum Length: 2147483647
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

Origin

Denotes how (based on what other object) was the conversation initially created. Possible values - User-entered, Chat, Calendar, etc. Required Default("USR") Filter(multi eq) ReadOnly

Type: Origin
Category: System
Allowed values for the Origin(Projects.AI.TrainingConversations.md#origin) data attribute
Allowed Values (Projects.AI.TrainingConversationsRepository.Origin Enum Members)

Value Description
UserEntered User-entered. Stored as 'USR'.
Database Value: 'USR'
Model Value: 0
Domain API Value: 'UserEntered'
Chat Chat. Stored as 'CHT'.
Database Value: 'CHT'
Model Value: 1
Domain API Value: 'Chat'
Calendar Calendar. Stored as 'CAL'.
Database Value: 'CAL'
Model Value: 2
Domain API Value: 'Calendar'
Case Case. Stored as 'CAS'.
Database Value: 'CAS'
Model Value: 3
Domain API Value: 'Case'
ToDo To Do. Stored as 'TOD'.
Database Value: 'TOD'
Model Value: 4
Domain API Value: 'ToDo'

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

Reference Details

Model

The model, which is being trained. Required Filter(multi eq)

Type: Models
Indexed: True
Category: System
Supported Filters: Equals, EqualsIn
Show in UI: ShownByDefault

OriginDataObject

The object, whose data was used to initially create the conversation. null means the object is unknown or not a data object. Filter(multi eq) ReadOnly

Type: ExtensibleDataObjects (nullable)
Indexed: True
Category: System
Supported Filters: Equals, EqualsIn
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

Create a notification immediately in a separate transaction, and send 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 notification 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

Front-End Business Rules

None

API

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

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