Package com.embabel.agent.web.rest

Class PlatformInfoController

  • All Implemented Interfaces:
    @RestController()@RequestMapping(value = {"/api/v1/platform-info"}) 
public final class PlatformInfoController

    Provides endpoints to retrieve general platform information, including agents, goals, actions, and conditions.

    • Nested Class Summary

      Nested Classes 
      Modifier and Type Class Description

    • Field Summary

      Fields 
      Modifier and Type Field Description

    • Enum Constant Summary

      Enum Constants 
      Enum Constant Description

    • Method Summary

      Modifier and Type Method Description
      final List<AgentMetadata> getAgents() Returns a list of all agents deployed on the platform.
      final Set<Goal> getGoals() Returns a list of all goals known to the platform (across all agents).
      final List<ActionMetadata> getActions() Returns a list of all actions available on the platform (across all agents).
      final PlatformInfoSummary getPlatformInfo() Returns general platform information, including the number of agents, actions, goals, and conditions.
      final Set<ConditionMetadata> getConditions() Returns a list of all conditions available on the platform (across all agents).
      final List<ModelMetadata> getModels() Returns a list of all models available on the platform (across all agents).
      final List<ToolGroupMetadata> getToolGroups()

      • Methods inherited from class java.lang.Object

        clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

    • Method Detail

      • getAgents

        @GetMapping(value = {"/agents"}) final List<AgentMetadata> getAgents()

        Returns a list of all agents deployed on the platform.

        Returns:

        List of agents with their details

      • getGoals

        @GetMapping(value = {"/goals"}) final Set<Goal> getGoals()

        Returns a list of all goals known to the platform (across all agents).

        Returns:

        List of goals

      • getActions

        @GetMapping(value = {"/actions"}) final List<ActionMetadata> getActions()

        Returns a list of all actions available on the platform (across all agents).

        Returns:

        List of actions

      • getPlatformInfo

        @GetMapping(value = {""}) final PlatformInfoSummary getPlatformInfo()

        Returns general platform information, including the number of agents, actions, goals, and conditions.

        Returns:

        Platform information summary

      • getConditions

        @GetMapping(value = {"/conditions"}) final Set<ConditionMetadata> getConditions()

        Returns a list of all conditions available on the platform (across all agents).

        Returns:

        List of conditions

      • getModels

        @GetMapping(value = {"/models"}) final List<ModelMetadata> getModels()

        Returns a list of all models available on the platform (across all agents).

        Returns:

        List of conditions