@salesforce/lds-adapters-service-einstein-copilot-bot 1.332.0-dev2 → 1.332.0-dev21

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/src/raml/api.raml CHANGED
@@ -601,7 +601,70 @@ types:
601
601
  type: array
602
602
  items:
603
603
  type: PlanTemplateRepresentation
604
-
604
+ AgentforceAgentBotInfoRepresentation:
605
+ description: User defined Agent metadata per agent type
606
+ type: object
607
+ properties:
608
+ errorMessage:
609
+ description: Error message for the failed get operation.
610
+ type: string
611
+ required: false
612
+ isSuccess:
613
+ description: Success indicator of the get operation.
614
+ type: boolean
615
+ botId:
616
+ description: ID of the internal Copilot bot ID - used in the URL when starting agent sessions
617
+ type: string
618
+ required: false
619
+ label:
620
+ description: display label of the agent
621
+ type: string
622
+ required: false
623
+ description:
624
+ description: display description of the agent
625
+ type: string
626
+ required: false
627
+ agentType:
628
+ description: internal agent type api name
629
+ type: string
630
+ required: false
631
+ AgentforceAgentBotInfoListRepresentation:
632
+ description: Represents the resultant list with agents per agent type including bot metadata
633
+ type: object
634
+ properties:
635
+ tenantGuid:
636
+ description: Core C2C tenant GUID - pass through x-sfdc-tenant-id header for SFAP
637
+ type: string
638
+ required: false
639
+ targetRegion:
640
+ description: Target runtime region - pass through x-salesforce-region header for SFAP
641
+ type: string
642
+ required: false
643
+ apiEndpoint:
644
+ description: Target runtime API endpoint - send traffic here. can be a targeted MESH endpoint, or an SFAP URL
645
+ type: string
646
+ required: false
647
+ errorMessage:
648
+ description: Error message for the failed get operation.
649
+ type: string
650
+ required: false
651
+ isSuccess:
652
+ description: Success indicator of the get operation.
653
+ type: boolean
654
+ required: true
655
+ falconInstance:
656
+ description: Indicates the falcon instance region code
657
+ type: string
658
+ required: false
659
+ sfapUrl:
660
+ description: Indicates the SFAP Url
661
+ type: string
662
+ required: false
663
+ agents:
664
+ description: List of agents
665
+ type: array
666
+ items:
667
+ type: AgentforceAgentBotInfoRepresentation
605
668
  /connect:
606
669
  /conversation-runtime-proxy:
607
670
  get:
@@ -772,3 +835,17 @@ types:
772
835
  sessionId:
773
836
  type: string
774
837
  required: false
838
+ /agentforce-agent-info:
839
+ get:
840
+ displayName: getAgents
841
+ description: Provides a list of Agentforce agents using the given list of agent types.
842
+ responses:
843
+ '200':
844
+ description: Success
845
+ body:
846
+ application/json:
847
+ type: AgentforceAgentBotInfoListRepresentation
848
+ queryParameters:
849
+ agentType:
850
+ type: string
851
+ required: true
@@ -45,6 +45,8 @@ types:
45
45
  (luvio.ttl): 900000
46
46
  WelcomeUtterancesRepresentation:
47
47
  (luvio.ttl): 100
48
+ AgentforceAgentBotInfoListRepresentation:
49
+ (luvio.ttl): 30000
48
50
 
49
51
  /connect:
50
52
  /conversation-runtime-proxy:
@@ -84,3 +86,7 @@ types:
84
86
  get:
85
87
  (luvio.adapter):
86
88
  name: getCopilotObjects
89
+ /agentforce-agent-info:
90
+ get:
91
+ (luvio.adapter):
92
+ name: getAgents