Show / Hide Table of Contents

Class AiChatTurnTableInfo

Table 'ai_chat_turn': Contains AI Chatbot history - contains whole chat, not just what is sent to the chatbot. History is ready ordered by timestamp

Inheritance
Object
TableInfo
AiChatTurnTableInfo
Implements
ICloneable
Inherited Members
TableInfo.ToString()
TableInfo.RegisterFields(FieldInfo[])
TableInfo.FieldInfoFromSoField(SoField)
TableInfo.Clone()
TableInfo.IsSameTable(TableInfo)
TableInfo.FindField(String)
TableInfo.ProtAll
TableInfo.HashCheckFields
TableInfo.TableName
TableInfo.DbName
TableInfo.IsDictionaryTable
TableInfo.All
TableInfo.Item[String]
TableInfo.PrimaryKeyField
Namespace: SuperOffice.CRM.Data
Assembly: SoDataBase.dll
Syntax
[DatabaseTable("ai_chat_turn")]
public class AiChatTurnTableInfo : TableInfo, ICloneable
Remarks

An instance of this class represents one instance of this table in an SQL statement. In most cases each table appears only once in a SELECT, but in cases where you need to self-join, or there are multiple occurrences for other reasons (typically additional restrictions in the joins), then you will need multiple instances.
Instances of this class are created by calling .

Fields

DictionaryTableName

Conceptual name of table AiChatTurn in the database dictionary: ai_chat_turn

Declaration
public const string DictionaryTableName = "ai_chat_turn"
Field Value
Type Description
String
Remarks

An instance of this class represents one instance of this table in an SQL statement. In most cases each table appears only once in a SELECT, but in cases where you need to self-join, or there are multiple occurrences for other reasons (typically additional restrictions in the joins), then you will need multiple instances.
Instances of this class are created by calling .

Properties

AiChatTurnId

Field 'ai_chat_turn_id' in table 'ai_chat_turn': Dictionary type PK, .NET type: Int32

Primary key
Declaration
public Int32FieldInfo AiChatTurnId { get; }
Property Value
Type Description
Int32FieldInfo
Remarks

An instance of this class represents one instance of this table in an SQL statement. In most cases each table appears only once in a SELECT, but in cases where you need to self-join, or there are multiple occurrences for other reasons (typically additional restrictions in the joins), then you will need multiple instances.
Instances of this class are created by calling .

AssociateId

Field 'associate_id' in table 'ai_chat_turn': Dictionary type FK, target: Associate, .NET type: Int32

User id that is chatting with the bot
Declaration
public Int32FieldInfo AssociateId { get; }
Property Value
Type Description
Int32FieldInfo
Remarks

An instance of this class represents one instance of this table in an SQL statement. In most cases each table appears only once in a SELECT, but in cases where you need to self-join, or there are multiple occurrences for other reasons (typically additional restrictions in the joins), then you will need multiple instances.
Instances of this class are created by calling .

AssociateId_InnerJoin_Associate

Generated join from the foreign key AssociateId in this table, to its target table AssociateTableInfo.

Declaration
public TargetedInnerJoin<AssociateTableInfo> AssociateId_InnerJoin_Associate { get; }
Property Value
Type Description
TargetedInnerJoin<AssociateTableInfo>
Remarks

An instance of this class represents one instance of this table in an SQL statement. In most cases each table appears only once in a SELECT, but in cases where you need to self-join, or there are multiple occurrences for other reasons (typically additional restrictions in the joins), then you will need multiple instances.
Instances of this class are created by calling .

Attachments

Field 'attachments' in table 'ai_chat_turn': Dictionary type Clob, .NET type: String

JSON Array of bot - NULL if not set
Declaration
public StringFieldInfo Attachments { get; }
Property Value
Type Description
StringFieldInfo
Remarks

An instance of this class represents one instance of this table in an SQL statement. In most cases each table appears only once in a SELECT, but in cases where you need to self-join, or there are multiple occurrences for other reasons (typically additional restrictions in the joins), then you will need multiple instances.
Instances of this class are created by calling .

BotActions

Field 'bot_actions' in table 'ai_chat_turn': Dictionary type Clob, .NET type: String

Suggested actions (string dictionary) in JSON. NULL if not set
Declaration
public StringFieldInfo BotActions { get; }
Property Value
Type Description
StringFieldInfo
Remarks

An instance of this class represents one instance of this table in an SQL statement. In most cases each table appears only once in a SELECT, but in cases where you need to self-join, or there are multiple occurrences for other reasons (typically additional restrictions in the joins), then you will need multiple instances.
Instances of this class are created by calling .

BotResponse

Field 'bot_response' in table 'ai_chat_turn': Dictionary type Clob, .NET type: String

AI Bot response to user_prompt - usually text
Declaration
public StringFieldInfo BotResponse { get; }
Property Value
Type Description
StringFieldInfo
Remarks

An instance of this class represents one instance of this table in an SQL statement. In most cases each table appears only once in a SELECT, but in cases where you need to self-join, or there are multiple occurrences for other reasons (typically additional restrictions in the joins), then you will need multiple instances.
Instances of this class are created by calling .

ChatId

Field 'chat_id' in table 'ai_chat_turn': Dictionary type String[41], .NET type: String

The name of this chat topic - usually soproto + id (contact-123, sale-43, diary) but could also be an arbitrary name
Declaration
public StringFieldInfo ChatId { get; }
Property Value
Type Description
StringFieldInfo
Remarks

An instance of this class represents one instance of this table in an SQL statement. In most cases each table appears only once in a SELECT, but in cases where you need to self-join, or there are multiple occurrences for other reasons (typically additional restrictions in the joins), then you will need multiple instances.
Instances of this class are created by calling .

Definition

Definition of the table as described in the deployed runtime dictionary

Declaration
public override SoTable Definition { get; }
Property Value
Type Description
SoTable
Overrides
TableInfo.Definition
Remarks

An instance of this class represents one instance of this table in an SQL statement. In most cases each table appears only once in a SELECT, but in cases where you need to self-join, or there are multiple occurrences for other reasons (typically additional restrictions in the joins), then you will need multiple instances.
Instances of this class are created by calling .

DictionaryTableNumber

Table number for table AiChatTurn in the database dictionary; potentially changes between databases, but always the same over the lifetime of any single database

Declaration
public int DictionaryTableNumber { get; }
Property Value
Type Description
Int32
Remarks

An instance of this class represents one instance of this table in an SQL statement. In most cases each table appears only once in a SELECT, but in cases where you need to self-join, or there are multiple occurrences for other reasons (typically additional restrictions in the joins), then you will need multiple instances.
Instances of this class are created by calling .

RuntimeDefinition

Definition of the table as described in the deployed runtime dictionary

Declaration
public static SoTable RuntimeDefinition { get; }
Property Value
Type Description
SoTable
Remarks

An instance of this class represents one instance of this table in an SQL statement. In most cases each table appears only once in a SELECT, but in cases where you need to self-join, or there are multiple occurrences for other reasons (typically additional restrictions in the joins), then you will need multiple instances.
Instances of this class are created by calling .

Timestamp

Field 'timestamp' in table 'ai_chat_turn': Dictionary type UtcDateTime, .NET type: DateTime

When the chat happened (UTC)
Declaration
public DateTimeFieldInfo Timestamp { get; }
Property Value
Type Description
DateTimeFieldInfo
Remarks

An instance of this class represents one instance of this table in an SQL statement. In most cases each table appears only once in a SELECT, but in cases where you need to self-join, or there are multiple occurrences for other reasons (typically additional restrictions in the joins), then you will need multiple instances.
Instances of this class are created by calling .

UserDisplaytext

Field 'user_displaytext' in table 'ai_chat_turn': Dictionary type Clob, .NET type: String

Display this text instead of the prompt (if set) - could be set by action
Declaration
public StringFieldInfo UserDisplaytext { get; }
Property Value
Type Description
StringFieldInfo
Remarks

An instance of this class represents one instance of this table in an SQL statement. In most cases each table appears only once in a SELECT, but in cases where you need to self-join, or there are multiple occurrences for other reasons (typically additional restrictions in the joins), then you will need multiple instances.
Instances of this class are created by calling .

UserPrompt

Field 'user_prompt' in table 'ai_chat_turn': Dictionary type Clob, .NET type: String

What the user typed
Declaration
public StringFieldInfo UserPrompt { get; }
Property Value
Type Description
StringFieldInfo
Remarks

An instance of this class represents one instance of this table in an SQL statement. In most cases each table appears only once in a SELECT, but in cases where you need to self-join, or there are multiple occurrences for other reasons (typically additional restrictions in the joins), then you will need multiple instances.
Instances of this class are created by calling .

Methods

IdxAssociateId(Int32)

Shortcut method for looking up using the database index AssociateId, which spans the following fields:

FieldDescription
AssociateIdUser id that is chatting with the bot
Declaration
public Restriction IdxAssociateId(int associateId)
Parameters
Type Name Description
Int32 associateId
Returns
Type Description
Restriction
Remarks

An instance of this class represents one instance of this table in an SQL statement. In most cases each table appears only once in a SELECT, but in cases where you need to self-join, or there are multiple occurrences for other reasons (typically additional restrictions in the joins), then you will need multiple instances.
Instances of this class are created by calling .

IdxAssociateIdChatId(Int32, String)

Shortcut method for looking up using the database index AssociateIdChatId, which spans the following fields:

FieldDescription
AssociateIdUser id that is chatting with the bot
ChatIdThe name of this chat topic - usually soproto + id (contact-123, sale-43, diary) but could also be an arbitrary name
Declaration
public Restriction IdxAssociateIdChatId(int associateId, string chatId)
Parameters
Type Name Description
Int32 associateId
String chatId
Returns
Type Description
Restriction
Remarks

An instance of this class represents one instance of this table in an SQL statement. In most cases each table appears only once in a SELECT, but in cases where you need to self-join, or there are multiple occurrences for other reasons (typically additional restrictions in the joins), then you will need multiple instances.
Instances of this class are created by calling .

Implements

System.ICloneable

Extension Methods

EnumUtil.MapEnums<From, To>(From)
Converters.MapEnums<From, To>(From)
© SuperOffice. All rights reserved.
SuperOffice |  Community |  Release Notes |  Privacy |  Site feedback |  Search Docs |  About Docs |  Contribute |  Back to top