@rockrms/obsidian-framework 17.5.2 → 18.1.0

package/types/ViewModels/Blocks/AI/AIAgentDetail/agentSkillBag.d.ts

@@ -0,0 +1,51 @@
+//------------------------------------------------------------------------------
+// <auto-generated>
+//     This code was generated by the Rock.CodeGeneration project
+//     Changes to this file will be lost when the code is regenerated.
+// </auto-generated>
+//------------------------------------------------------------------------------
+// <copyright>
+// Copyright by the Spark Development Network
+//
+// Licensed under the Rock Community License (the "License");
+// you may not use this file except in compliance with the License.
+// You may obtain a copy of the License at
+//
+// http://www.rockrms.com/license
+//
+// Unless required by applicable law or agreed to in writing, software
+// distributed under the License is distributed on an "AS IS" BASIS,
+// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+// See the License for the specific language governing permissions and
+// limitations under the License.
+// </copyright>
+//
+
+import { Guid } from "@Obsidian/Types";
+
+/**
+ * Represents a single skill being viewed or edited in the Agent
+ * Detail block.
+ */
+export type AgentSkillBag = {
+    /** The configuration values for the skill. */
+    configurationValues?: Record<string, string> | null;
+
+    /** The user-friendly description of the skill being used by the agent. */
+    description?: string | null;
+
+    /** The list of tools that are enabled for the skill to use. */
+    enabledTools?: Guid[] | null;
+
+    /**
+     * The unique identifier of the agent skill record that links the
+     * agent to the skill.
+     */
+    guid: Guid;
+
+    /** The name of the skill being used by the agent. */
+    name?: string | null;
+
+    /** The unique identifier of the skill being used by the agent. */
+    skillGuid: Guid;
+};

package/types/ViewModels/Blocks/AI/AIAgentDetail/aiAgentBag.d.ts

@@ -0,0 +1,108 @@
+//------------------------------------------------------------------------------
+// <auto-generated>
+//     This code was generated by the Rock.CodeGeneration project
+//     Changes to this file will be lost when the code is regenerated.
+// </auto-generated>
+//------------------------------------------------------------------------------
+// <copyright>
+// Copyright by the Spark Development Network
+//
+// Licensed under the Rock Community License (the "License");
+// you may not use this file except in compliance with the License.
+// You may obtain a copy of the License at
+//
+// http://www.rockrms.com/license
+//
+// Unless required by applicable law or agreed to in writing, software
+// distributed under the License is distributed on an "AS IS" BASIS,
+// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+// See the License for the specific language governing permissions and
+// limitations under the License.
+// </copyright>
+//
+
+import { AgentType } from "@Obsidian/Enums/AI/Agent/agentType";
+import { AudienceType } from "@Obsidian/Enums/AI/Agent/audienceType";
+import { ModelServiceRole } from "@Obsidian/Enums/AI/Agent/modelServiceRole";
+import { AgentSkillBag } from "@Obsidian/ViewModels/Blocks/AI/AIAgentDetail/agentSkillBag";
+import { ListItemBag } from "@Obsidian/ViewModels/Utility/listItemBag";
+import { PublicAttributeBag } from "@Obsidian/ViewModels/Utility/publicAttributeBag";
+
+/** The item details for the AI Agent Detail block. */
+export type AIAgentBag = {
+    /** The type of agent represented by this instance. */
+    agentType: AgentType;
+
+    /** Gets or sets the attributes. */
+    attributes?: Record<string, PublicAttributeBag> | null;
+
+    /** Gets or sets the attribute values. */
+    attributeValues?: Record<string, string> | null;
+
+    /**
+     * The intended audience for this agent, which can be used to help
+     * determine the appropraite functionality to expose.
+     */
+    audienceType: AudienceType;
+
+    /**
+     * The token threshold before auto-summarization will be triggered
+     * when a new user message is added. This only applies to persisted
+     * sessions.
+     */
+    autoSummarizeThreshold: number;
+
+    /**
+     * The binary file that contains the image to use as the avatar to
+     * represent the agent. This will be used in the administrative UI and
+     * the chat UI to represent the agent visually.
+     */
+    avatarBinaryFile?: ListItemBag | null;
+
+    /**
+     * The Lava template that will be used to generate the current person
+     * details to be added to the system prompt of a chat agent. If blank
+     * then a default template will be used.
+     */
+    currentPersonTemplate?: string | null;
+
+    /**
+     * The description of the agent, which provides additional context or
+     * information about its intended purpose and functionality.
+     */
+    description?: string | null;
+
+    /** Gets or sets the identifier key of this entity. */
+    idKey?: string | null;
+
+    /**
+     * The instructions for the agent. This has different meanings
+     * depending on the type of agent.
+     */
+    instructions?: string | null;
+
+    /**
+     * Determines if system skills are excluded from this agent. These are
+     * standard skills and tools that would generally be considered
+     * required for other skills to operate correctly.
+     */
+    isExcludingSystemSkills: boolean;
+
+    /** The friendly name of the agent that will be used to identify it in the UI. */
+    name?: string | null;
+
+    /** The role that this agent uses when determining which AI model to use. */
+    role: ModelServiceRole;
+
+    /**
+     * A collection containing the Rock.Model.AIAgentSkill entities
+     * that represent the skills attached to this agent.
+     */
+    skills?: AgentSkillBag[] | null;
+
+    /**
+     * The URL friendly slug that will be used to uniquely identify this
+     * agent when used in MCP mode.
+     */
+    slug?: string | null;
+};

package/types/ViewModels/Blocks/AI/AIAgentDetail/aiAgentDetailOptionsBag.d.ts

@@ -0,0 +1,36 @@
+//------------------------------------------------------------------------------
+// <auto-generated>
+//     This code was generated by the Rock.CodeGeneration project
+//     Changes to this file will be lost when the code is regenerated.
+// </auto-generated>
+//------------------------------------------------------------------------------
+// <copyright>
+// Copyright by the Spark Development Network
+//
+// Licensed under the Rock Community License (the "License");
+// you may not use this file except in compliance with the License.
+// You may obtain a copy of the License at
+//
+// http://www.rockrms.com/license
+//
+// Unless required by applicable law or agreed to in writing, software
+// distributed under the License is distributed on an "AS IS" BASIS,
+// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+// See the License for the specific language governing permissions and
+// limitations under the License.
+// </copyright>
+//
+
+import { ListItemBag } from "@Obsidian/ViewModels/Utility/listItemBag";
+
+/** The additional configuration options for the AI Agent Detail block. */
+export type AIAgentDetailOptionsBag = {
+    /** The list of available skills that can be selected. */
+    availableSkills?: ListItemBag[] | null;
+
+    /**
+     * The list of system skills that are always present if they have not
+     * been excluded by the agent configuration.
+     */
+    systemSkills?: ListItemBag[] | null;
+};

package/types/ViewModels/Blocks/AI/AIAgentDetail/editSkillResponseBag.d.ts

@@ -0,0 +1,41 @@
+//------------------------------------------------------------------------------
+// <auto-generated>
+//     This code was generated by the Rock.CodeGeneration project
+//     Changes to this file will be lost when the code is regenerated.
+// </auto-generated>
+//------------------------------------------------------------------------------
+// <copyright>
+// Copyright by the Spark Development Network
+//
+// Licensed under the Rock Community License (the "License");
+// you may not use this file except in compliance with the License.
+// You may obtain a copy of the License at
+//
+// http://www.rockrms.com/license
+//
+// Unless required by applicable law or agreed to in writing, software
+// distributed under the License is distributed on an "AS IS" BASIS,
+// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+// See the License for the specific language governing permissions and
+// limitations under the License.
+// </copyright>
+//
+
+import { AgentSkillBag } from "@Obsidian/ViewModels/Blocks/AI/AIAgentDetail/agentSkillBag";
+import { DynamicComponentDefinitionBag } from "@Obsidian/ViewModels/Controls/dynamicComponentDefinitionBag";
+import { ListItemBag } from "@Obsidian/ViewModels/Utility/listItemBag";
+
+/** The response bag for editing a skill in the AI Agent Detail block. */
+export type EditSkillResponseBag = {
+    /** The tools that are available for the skill. */
+    availableTools?: ListItemBag[] | null;
+
+    /**
+     * The component definition for the skill that will be used to render
+     * the custom UI for the skill configuration.
+     */
+    componentDefinition?: DynamicComponentDefinitionBag | null;
+
+    /** Represents the current values for the skill being edited. */
+    skill?: AgentSkillBag | null;
+};

package/types/ViewModels/Blocks/AI/AIAgentDetail/getComponentDefinitionResponseBag.d.ts

@@ -0,0 +1,44 @@
+//------------------------------------------------------------------------------
+// <auto-generated>
+//     This code was generated by the Rock.CodeGeneration project
+//     Changes to this file will be lost when the code is regenerated.
+// </auto-generated>
+//------------------------------------------------------------------------------
+// <copyright>
+// Copyright by the Spark Development Network
+//
+// Licensed under the Rock Community License (the "License");
+// you may not use this file except in compliance with the License.
+// You may obtain a copy of the License at
+//
+// http://www.rockrms.com/license
+//
+// Unless required by applicable law or agreed to in writing, software
+// distributed under the License is distributed on an "AS IS" BASIS,
+// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+// See the License for the specific language governing permissions and
+// limitations under the License.
+// </copyright>
+//
+
+import { DynamicComponentDefinitionBag } from "@Obsidian/ViewModels/Controls/dynamicComponentDefinitionBag";
+import { ListItemBag } from "@Obsidian/ViewModels/Utility/listItemBag";
+
+/**
+ * Represents the response data for retrieving a component definition. This
+ * contains the data required to display a custom Obsidian component in the
+ * UI when adding a skill to an AI agent.
+ */
+export type GetComponentDefinitionResponseBag = {
+    /** The list of tools defined on the skill that can be enabled. */
+    availableTools?: ListItemBag[] | null;
+
+    /**
+     * The component definition that will be used to render the UI
+     * for the skill.
+     */
+    componentDefinition?: DynamicComponentDefinitionBag | null;
+
+    /** The current configuration values for the skill. */
+    configurationValues?: Record<string, string> | null;
+};

package/types/ViewModels/Blocks/AI/AIAgentList/aiAgentListOptionsBag.d.ts

@@ -0,0 +1,26 @@
+//------------------------------------------------------------------------------
+// <auto-generated>
+//     This code was generated by the Rock.CodeGeneration project
+//     Changes to this file will be lost when the code is regenerated.
+// </auto-generated>
+//------------------------------------------------------------------------------
+// <copyright>
+// Copyright by the Spark Development Network
+//
+// Licensed under the Rock Community License (the "License");
+// you may not use this file except in compliance with the License.
+// You may obtain a copy of the License at
+//
+// http://www.rockrms.com/license
+//
+// Unless required by applicable law or agreed to in writing, software
+// distributed under the License is distributed on an "AS IS" BASIS,
+// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+// See the License for the specific language governing permissions and
+// limitations under the License.
+// </copyright>
+//
+
+/** The additional configuration options for the AI Agent List block. */
+export type AIAgentListOptionsBag = {
+};

package/types/ViewModels/Blocks/AI/AIProviderDetail/aiProviderBag.d.ts

@@ -0,0 +1,55 @@
+//------------------------------------------------------------------------------
+// <auto-generated>
+//     This code was generated by the Rock.CodeGeneration project
+//     Changes to this file will be lost when the code is regenerated.
+// </auto-generated>
+//------------------------------------------------------------------------------
+// <copyright>
+// Copyright by the Spark Development Network
+//
+// Licensed under the Rock Community License (the "License");
+// you may not use this file except in compliance with the License.
+// You may obtain a copy of the License at
+//
+// http://www.rockrms.com/license
+//
+// Unless required by applicable law or agreed to in writing, software
+// distributed under the License is distributed on an "AS IS" BASIS,
+// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+// See the License for the specific language governing permissions and
+// limitations under the License.
+// </copyright>
+//
+
+import { ListItemBag } from "@Obsidian/ViewModels/Utility/listItemBag";
+import { PublicAttributeBag } from "@Obsidian/ViewModels/Utility/publicAttributeBag";
+
+/** The item details for the AI Provider Detail block. */
+export type AIProviderBag = {
+    /** Gets or sets the attributes. */
+    attributes?: Record<string, PublicAttributeBag> | null;
+
+    /** Gets or sets the attribute values. */
+    attributeValues?: Record<string, string> | null;
+
+    /** Gets or sets the description. */
+    description?: string | null;
+
+    /** Gets or sets the identifier key of this entity. */
+    idKey?: string | null;
+
+    /** Gets or sets a flag indicating if this item is active or not. */
+    isActive: boolean;
+
+    /** Gets or sets a value indicating whether this instance is system. */
+    isSystem: boolean;
+
+    /** Gets or sets the name. */
+    name?: string | null;
+
+    /** Gets or sets the type of the entity. */
+    providerComponentEntityType?: ListItemBag | null;
+
+    /** Gets or sets the entity type identifier. */
+    providerComponentEntityTypeId?: number | null;
+};

package/types/ViewModels/Blocks/AI/AIProviderDetail/aiProviderDetailOptionsBag.d.ts

@@ -0,0 +1,26 @@
+//------------------------------------------------------------------------------
+// <auto-generated>
+//     This code was generated by the Rock.CodeGeneration project
+//     Changes to this file will be lost when the code is regenerated.
+// </auto-generated>
+//------------------------------------------------------------------------------
+// <copyright>
+// Copyright by the Spark Development Network
+//
+// Licensed under the Rock Community License (the "License");
+// you may not use this file except in compliance with the License.
+// You may obtain a copy of the License at
+//
+// http://www.rockrms.com/license
+//
+// Unless required by applicable law or agreed to in writing, software
+// distributed under the License is distributed on an "AS IS" BASIS,
+// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+// See the License for the specific language governing permissions and
+// limitations under the License.
+// </copyright>
+//
+
+/** The additional configuration options for the AI Provider Detail block. */
+export type AIProviderDetailOptionsBag = {
+};

package/types/ViewModels/Blocks/AI/AIProviderList/aiProviderListOptionsBag.d.ts

@@ -0,0 +1,26 @@
+//------------------------------------------------------------------------------
+// <auto-generated>
+//     This code was generated by the Rock.CodeGeneration project
+//     Changes to this file will be lost when the code is regenerated.
+// </auto-generated>
+//------------------------------------------------------------------------------
+// <copyright>
+// Copyright by the Spark Development Network
+//
+// Licensed under the Rock Community License (the "License");
+// you may not use this file except in compliance with the License.
+// You may obtain a copy of the License at
+//
+// http://www.rockrms.com/license
+//
+// Unless required by applicable law or agreed to in writing, software
+// distributed under the License is distributed on an "AS IS" BASIS,
+// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+// See the License for the specific language governing permissions and
+// limitations under the License.
+// </copyright>
+//
+
+/** The additional configuration options for the AI Provider List block. */
+export type AIProviderListOptionsBag = {
+};

package/types/ViewModels/Blocks/AI/AISettings/aiSettingsBag.d.ts

@@ -0,0 +1,28 @@
+//------------------------------------------------------------------------------
+// <auto-generated>
+//     This code was generated by the Rock.CodeGeneration project
+//     Changes to this file will be lost when the code is regenerated.
+// </auto-generated>
+//------------------------------------------------------------------------------
+// <copyright>
+// Copyright by the Spark Development Network
+//
+// Licensed under the Rock Community License (the "License");
+// you may not use this file except in compliance with the License.
+// You may obtain a copy of the License at
+//
+// http://www.rockrms.com/license
+//
+// Unless required by applicable law or agreed to in writing, software
+// distributed under the License is distributed on an "AS IS" BASIS,
+// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+// See the License for the specific language governing permissions and
+// limitations under the License.
+// </copyright>
+//
+
+/** Contains the settings that can be edited for the AI Settings block. */
+export type AISettingsBag = {
+    /** The standard prompt to use for all agents in this organization. */
+    organizationPrompt?: string | null;
+};

package/types/ViewModels/Blocks/AI/AISettings/aiSettingsOptionsBag.d.ts

@@ -0,0 +1,33 @@
+//------------------------------------------------------------------------------
+// <auto-generated>
+//     This code was generated by the Rock.CodeGeneration project
+//     Changes to this file will be lost when the code is regenerated.
+// </auto-generated>
+//------------------------------------------------------------------------------
+// <copyright>
+// Copyright by the Spark Development Network
+//
+// Licensed under the Rock Community License (the "License");
+// you may not use this file except in compliance with the License.
+// You may obtain a copy of the License at
+//
+// http://www.rockrms.com/license
+//
+// Unless required by applicable law or agreed to in writing, software
+// distributed under the License is distributed on an "AS IS" BASIS,
+// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+// See the License for the specific language governing permissions and
+// limitations under the License.
+// </copyright>
+//
+
+import { AISettingsBag } from "@Obsidian/ViewModels/Blocks/AI/AISettings/aiSettingsBag";
+
+/** The options that define the behavior of the AI Settings block. */
+export type AISettingsOptionsBag = {
+    /** The URL to return to after saving settings. */
+    returnUrl?: string | null;
+
+    /** The settings that can be edited. */
+    settings?: AISettingsBag | null;
+};

package/types/ViewModels/Blocks/AI/AISkillDetail/aiSkillBag.d.ts

@@ -0,0 +1,63 @@
+//------------------------------------------------------------------------------
+// <auto-generated>
+//     This code was generated by the Rock.CodeGeneration project
+//     Changes to this file will be lost when the code is regenerated.
+// </auto-generated>
+//------------------------------------------------------------------------------
+// <copyright>
+// Copyright by the Spark Development Network
+//
+// Licensed under the Rock Community License (the "License");
+// you may not use this file except in compliance with the License.
+// You may obtain a copy of the License at
+//
+// http://www.rockrms.com/license
+//
+// Unless required by applicable law or agreed to in writing, software
+// distributed under the License is distributed on an "AS IS" BASIS,
+// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+// See the License for the specific language governing permissions and
+// limitations under the License.
+// </copyright>
+//
+
+import { ListItemBag } from "@Obsidian/ViewModels/Utility/listItemBag";
+import { PublicAttributeBag } from "@Obsidian/ViewModels/Utility/publicAttributeBag";
+
+/** The item details for the AI Skill Detail block. */
+export type AISkillBag = {
+    /** Gets or sets the attributes. */
+    attributes?: Record<string, PublicAttributeBag> | null;
+
+    /** Gets or sets the attribute values. */
+    attributeValues?: Record<string, string> | null;
+
+    /**
+     * The entity type that represents the C# class that implements the
+     * tools for this skill. If this is not null then the skill and
+     * related tools should not allow editing beyond enabling or
+     * disabling them.
+     */
+    codeEntityType?: ListItemBag | null;
+
+    /**
+     * The description of the skill, which provides additional context or
+     * information about its intended purpose and functionality.
+     */
+    description?: string | null;
+
+    /** Gets or sets the identifier key of this entity. */
+    idKey?: string | null;
+
+    /**
+     * The instructions that provide context about when and how this
+     * skill should be used.
+     */
+    instructions?: ListItemBag[] | null;
+
+    /**
+     * The friendly name of the skill that will be used to identify it in
+     * the UI.
+     */
+    name?: string | null;
+};

package/types/ViewModels/Blocks/AI/AISkillDetail/aiSkillDetailOptionsBag.d.ts

@@ -0,0 +1,26 @@
+//------------------------------------------------------------------------------
+// <auto-generated>
+//     This code was generated by the Rock.CodeGeneration project
+//     Changes to this file will be lost when the code is regenerated.
+// </auto-generated>
+//------------------------------------------------------------------------------
+// <copyright>
+// Copyright by the Spark Development Network
+//
+// Licensed under the Rock Community License (the "License");
+// you may not use this file except in compliance with the License.
+// You may obtain a copy of the License at
+//
+// http://www.rockrms.com/license
+//
+// Unless required by applicable law or agreed to in writing, software
+// distributed under the License is distributed on an "AS IS" BASIS,
+// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+// See the License for the specific language governing permissions and
+// limitations under the License.
+// </copyright>
+//
+
+/** The additional configuration options for the AI Skill Detail block. */
+export type AISkillDetailOptionsBag = {
+};

package/types/ViewModels/Blocks/AI/AISkillList/aiSkillListOptionsBag.d.ts

@@ -0,0 +1,26 @@
+//------------------------------------------------------------------------------
+// <auto-generated>
+//     This code was generated by the Rock.CodeGeneration project
+//     Changes to this file will be lost when the code is regenerated.
+// </auto-generated>
+//------------------------------------------------------------------------------
+// <copyright>
+// Copyright by the Spark Development Network
+//
+// Licensed under the Rock Community License (the "License");
+// you may not use this file except in compliance with the License.
+// You may obtain a copy of the License at
+//
+// http://www.rockrms.com/license
+//
+// Unless required by applicable law or agreed to in writing, software
+// distributed under the License is distributed on an "AS IS" BASIS,
+// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+// See the License for the specific language governing permissions and
+// limitations under the License.
+// </copyright>
+//
+
+/** The additional configuration options for the AI Skill List block. */
+export type AISkillListOptionsBag = {
+};