Table of Contents

Projects.AI.Compilations Entity

Namespace: Projects.AI

Compilation is created, when a Model is being compiled through the AI provider into a conversational model. Entity: Llm_Compilations (Introduced in version 24.1.2.4)

Default Visualization

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

Aggregate

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

Aggregate Tree

Attributes

Name Type Description
BuildLog string (max) nullable Detailed log of the build process of the compilation. ReadOnly
CompiledModelName string (256) nullable The name of the model, which was created in the providers space, as a result of the compilation. Filter(eq;like) ReadOnly
CompletionTimeUtc datetime nullable The time, when the compilation has completed. Filter(eq;ge;le) ORD ReadOnly
DisplayText string Uses the repository DisplayTextFormat to build the display text from the attributes and references of current object.
ErrorMessage string (max) nullable Human-readable error message indicating the problem, when a build is not successful. ReadOnly
Id guid
IsSuccessful boolean Indicated whether the build process was successful and the compilation can be used for conversations. Required Default(false) Filter(eq) ReadOnly
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.
StartTimeUtc datetime The time, when the compilation was started. Required Default(NowUtc) Filter(eq;ge;le) ORD ReadOnly
Status Status The status of the build job of the compilation. Building the compilation runs through New, Running and Completed. Deleting the compilation from the providers space marks it as Deleted. Required Default("N") Filter(multi eq) ReadOnly

References

Name Type Description
Model Models The model, on which the compilation is based. Required Filter(multi eq) ReadOnly
User Users The user, who started the compilation. Required Filter(multi eq) ReadOnly

Child Collections

Name Type Description
Assets CompilationAssets List of CompilationAsset(Projects.AI.CompilationAssets.md) child objects, based on the Projects.AI.CompilationAsset.Compilation(Projects.AI.CompilationAssets.md#compilation) back reference

Attribute Details

BuildLog

Detailed log of the build process of the compilation. ReadOnly

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

CompiledModelName

The name of the model, which was created in the providers space, as a result of the compilation. Filter(eq;like) ReadOnly

Type: string (256) nullable
Category: System
Supported Filters: Equals, Like
Supports Order By: False
Maximum Length: 256
Show in UI: ShownByDefault

CompletionTimeUtc

The time, when the compilation has completed. Filter(eq;ge;le) ORD ReadOnly

Type: datetime nullable
Category: System
Supported Filters: Equals, GreaterThanOrLessThan
Supports Order By: True
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

ErrorMessage

Human-readable error message indicating the problem, when a build is not successful. ReadOnly

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

Id

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

IsSuccessful

Indicated whether the build process was successful and the compilation can be used for conversations. Required Default(false) Filter(eq) ReadOnly

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

StartTimeUtc

The time, when the compilation was started. Required Default(NowUtc) Filter(eq;ge;le) ORD ReadOnly

Type: datetime
Indexed: True
Category: System
Supported Filters: Equals, GreaterThanOrLessThan
Supports Order By: True
Default Value: CurrentDateTimeUtc
Show in UI: ShownByDefault

Status

The status of the build job of the compilation. Building the compilation runs through New, Running and Completed. Deleting the compilation from the providers space marks it as Deleted. Required Default("N") Filter(multi eq) ReadOnly

Type: Status
Category: System
Allowed values for the Status(Projects.AI.Compilations.md#status) data attribute
Allowed Values (Projects.AI.CompilationsRepository.Status Enum Members)

Value Description
New New value. Stored as 'N'.
Database Value: 'N'
Model Value: 0
Domain API Value: 'New'
Running Running value. Stored as 'R'.
Database Value: 'R'
Model Value: 1
Domain API Value: 'Running'
Completed Completed value. Stored as 'C'.
Database Value: 'C'
Model Value: 2
Domain API Value: 'Completed'
Deleted Deleted value. Stored as 'D'.
Database Value: 'D'
Model Value: 3
Domain API Value: 'Deleted'

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

Reference Details

Model

The model, on which the compilation is based. Required Filter(multi eq) ReadOnly

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

User

The user, who started the compilation. Required Filter(multi eq) ReadOnly

Type: Users
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

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

Front-End Business Rules

None

API

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

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