npm - @salesforce/afv-skills - Versions diffs - 1.22.0 → 1.24.0 - Mend

@salesforce/afv-skills 1.22.0 → 1.24.0

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.

Files changed (1675) hide show

package/skills/getting-metadata-api-context/data/metadata_api/AdvAccountForecastSet.json DELETED Viewed

@@ -1,261 +0,0 @@
-{
-  "sections": [
-    "title",
-    "description",
-    "file_information",
-    "directory_location",
-    "fields",
-    "sub_types",
-    "declarative_metadata_sample_definition"
-  ],
-  "title": "AdvAccountForecastSet - Metadata API",
-  "description": "Represents the forecast sets that define the forecast configurations for each business unit or different groups of accounts. With separate forecast sets at account or business unit level, you can focus on account-specific data and manage configuration updates for one business unit without impacting any other business unit’s data.",
-  "file_information": ".advAccountForecastSet",
-  "directory_location": "AdvAccountForecastSet",
-  "fields_columns": [
-    "type",
-    "description",
-    "required"
-  ],
-  "fields": {
-    "accountFieldName": {
-      "type": "string",
-      "description": "The field name for the account in the advanced account forecast fact record."
-    },
-    "calculationFrequency": {
-      "type": "AdvAcctFcstCalcFrequency (enumeration of type string)",
-      "description": "The frequency at which the forecast set is recalculated automatically.Possible values are: Monthly Quarterly Weekly Yearly The default value is Monthly."
-    },
-    "description": {
-      "type": "string",
-      "description": "The description of the advanced account forecast set record."
-    },
-    "dimensions": {
-      "type": "AdvAcctForecastDimension[]",
-      "description": "The dimensions selected for an advanced account forecast set to categorize the forecast data."
-    },
-    "displayGroups": {
-      "type": "AdvAcctFrcstDisplayGroup[]",
-      "description": "The information about the groups for the advanced account forecast set measures or dimensions."
-    },
-    "forecastAdjPeriods": {
-      "type": "AdvAcctForecastAdjPeriod[]",
-      "description": "The details about the adjustment period of the advanced account forecast values."
-    },
-    "forecastFactObjectName": {
-      "type": "string",
-      "required": true,
-      "description": "The API name of the object that contains the advanced forecast fact records."
-    },
-    "forecastFormulas": {
-      "type": "AdvAccountForecastFormula[]",
-      "description": "The formulas based on which forecast values are calculated."
-    },
-    "forecastPeriodGroupName": {
-      "type": "string",
-      "required": true,
-      "description": "The name of the advanced account forecast period group record."
-    },
-    "forecastQuantityFieldName": {
-      "type": "string",
-      "description": "The field name for the forecast quantity in the advanced account forecast fact record."
-    },
-    "forecastRevenueFieldName": {
-      "type": "string",
-      "description": "The field name for the forecast revenue in the advanced account forecast record."
-    },
-    "forecastSetFieldName": {
-      "type": "string",
-      "description": "The field name for the Forecast Set ID in the advanced account forecast fact record."
-    },
-    "forecastSetName": {
-      "type": "string",
-      "required": true,
-      "description": "The name of the advanced account forecast set record."
-    },
-    "forecastStatusFieldName": {
-      "type": "string",
-      "description": "The field name for the status in the advanced account forecast fact record."
-    },
-    "generationDpeDefName": {
-      "type": "string",
-      "description": "The name of the data processing engine (DPE) definition that’s used to generate advanced account forecast fact records."
-    },
-    "measureDefinitions": {
-      "type": "AdvAcctForecastMeasureDef[]",
-      "description": "The measures to display in the advanced account forecasts grid for the forecast set."
-    },
-    "periodFieldName": {
-      "type": "string",
-      "description": "The field name for the period in the advanced account forecast fact record."
-    },
-    "recalculateDpeDefName": {
-      "type": "string",
-      "description": "The name of the data processing engine definition that’s used to recalculate the advanced account forecast fact records."
-    },
-    "regenerationDpeDefName": {
-      "type": "string",
-      "description": "The name of the data processing engine definition that’s used to regenerate the advanced account forecast fact records."
-    },
-    "rolloverDpeDefName": {
-      "type": "string",
-      "description": "The data processing engine definition that’s used to generate the rollover advanced account forecast fact records."
-    },
-    "rolloverFrequency": {
-      "type": "AdvAcctFcstCalcFrequency (enumeration of type string)",
-      "description": "The frequency of rollover of the advanced account forecast records.Possible values are: Monthly Quarterly Weekly Yearly The default value is Monthly."
-    },
-    "status": {
-      "type": "AdvAccForecastSetStatus (enumeration of type string)",
-      "required": true,
-      "description": "The status of the advanced account forecast set.Possible values are: Active Inactive"
-    }
-  },
-  "sub_types": {
-    "AdvAccountForecastFormula": {
-      "endPeriod": {
-        "type": "int",
-        "required": true,
-        "description": "The period until when the forecast formula is applicable."
-      },
-      "formulaExpression": {
-        "type": "string",
-        "required": true,
-        "description": "The formula based on which forecast values are calculated."
-      },
-      "formulaType": {
-        "type": "AdvAcctFcstFormulaType (enumeration of type string)",
-        "required": true,
-        "description": "Specifies the calculation type for the formula.Possible values are: QUANTITY REVENUE The default value is QUANTITY."
-      },
-      "startPeriod": {
-        "type": "int",
-        "required": true,
-        "description": "The period from when the forecast formula is applicable."
-      }
-    },
-    "AdvAcctForecastAdjPeriod": {
-      "adjustmentDayCount": {
-        "type": "int",
-        "required": true,
-        "description": "The number of days during which you can make forecast adjustments."
-      },
-      "frequency": {
-        "type": "PeriodTypes (enumeration of type string)",
-        "required": true,
-        "description": "The frequency that’s applicable to make any forecast adjustments.Possible values are: Month Quarter Week Year The default value is Month."
-      },
-      "profileName": {
-        "type": "string",
-        "description": "The name of the profile with which you can adjust the forecast set."
-      },
-      "startDay": {
-        "type": "int",
-        "required": true,
-        "description": "The start date for forecast adjustments."
-      }
-    },
-    "AdvAcctForecastDimension": {
-      "advAcctForecastDimName": {
-        "type": "string",
-        "required": true,
-        "description": "The name of the advanced account forecast dimension."
-      },
-      "dimensionFieldName": {
-        "type": "string",
-        "required": true,
-        "description": "The API name of the field for the dimension in the custom object that contains the generated advanced account forecast records."
-      },
-      "dimensionSourceName": {
-        "type": "string",
-        "description": "The name of the dimension source associated with the advanced account forecast set dimension record."
-      },
-      "hierarchySequenceNumber": {
-        "type": "int",
-        "required": true,
-        "description": "The sequence number of the dimension source associated with the forecast set."
-      }
-    },
-    "AdvAcctForecastMeasureDef": {
-      "advAcctForecastMeasureDefName": {
-        "type": "string",
-        "required": true,
-        "description": "The name of the definition for the advanced account forecast measure."
-      },
-      "aggregationType": {
-        "type": "AdvAcctFcstAggregationType (enumeration of type string)",
-        "required": true,
-        "description": "The type of aggregation that’s used for calculating the advanced account forecast values.Possible values are: AVERAGE MAXIMUM MINIMUM SUM The default value is SUM."
-      },
-      "computationMethod": {
-        "type": "AdvAcctFcstComputationMethod (enumeration of type string)",
-        "required": true,
-        "description": "The method that’s used for calculating the advanced account forecast values.Values are: CUSTOM DATA_PROCESSING_ENGINE_DEFINITION FORMULA The default value is DATA_PROCESSING_ENGINE_DEFINITION."
-      },
-      "forecastDataMeasureName": {
-        "type": "string",
-        "required": true,
-        "description": "The field of the facts object used for the advanced account forecast measure."
-      },
-      "forecastMeasureName": {
-        "type": "string",
-        "required": true,
-        "description": "The name for the advanced account forecast measure to show on UI."
-      },
-      "forecastMeasureType": {
-        "type": "AdvAcctFcstMeasureType (enumeration of type string)",
-        "required": true,
-        "description": "The measure type that’s used for the generated advanced forecast values.Possible values are: QUANTITY REVENUE The default value is QUANTITY."
-      },
-      "isAdjustmentTracked": {
-        "type": "boolean",
-        "description": "Indicates whether the adjustments made to the advanced account forecast values for this metric are tracked (true) or not (false)."
-      }
-    },
-    "AdvAcctFrcstDisplayGroup": {
-      "advAcctFrcstDisplayGroupName": {
-        "type": "string",
-        "required": true,
-        "description": "The name of the advanced account forecast display group."
-      },
-      "displayGroupItems": {
-        "type": "AdvAcctFrcstDplyGroupItem[]",
-        "description": "The items associated with a display group for an advanced account forecast set."
-      },
-      "displayGroupType": {
-        "type": "AdvAcctFrcstDisplayGroupType (enumeration of type string)",
-        "description": "The category of the display group.Possible value is: MEASURE"
-      },
-      "isDefault": {
-        "type": "boolean",
-        "description": "Indicates whether the display group is the default group (true) or not (false)."
-      },
-      "userProfileName": {
-        "type": "string",
-        "description": "The name of the profile for which the display group is applicable."
-      }
-    },
-    "AdvAcctFrcstDplyGroupItem": {
-      "advAcctFrcstDplyGroupItemName": {
-        "type": "string",
-        "required": true,
-        "description": "The name of the advanced account forecast display group that’s associated with the group item."
-      },
-      "displayOrder": {
-        "type": "int",
-        "required": true,
-        "description": "The display order of the display group item."
-      },
-      "measureReferenceName": {
-        "type": "string",
-        "description": "The ID of the measure associated with the display group item."
-      }
-    }
-  },
-  "declarative_metadata_sample_definition": [
-    {
-      "description": "The following is an example of an AdvAccountForecastSet component.",
-      "code": "<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n<AdvAccountForecastSet xmlns=\"http://soap.sforce.com/2006/04/metadata\" xmlns:xsi=\"http://www.w3.org/2001/XMLSchema-instance\">\n    <calculationFrequency>Quarterly</calculationFrequency>\n    <forecastAdjPeriods>\n        <adjustmentDayCount>5</adjustmentDayCount>\n        <frequency>Quarter</frequency>\n        <profileName xsi:nil=\"true\"/>\n        <startDay>1</startDay>\n    </forecastAdjPeriods>\n    <forecastFormulas>\n        <endPeriod>12</endPeriod>\n        <formulaExpression>6</formulaExpression>\n        <startPeriod>2</startPeriod>\n        <formulaType>QUANTITY</formulaType>\n    </forecastFormulas>\n    <forecastPeriodGroupName>PeriodGroup1</forecastPeriodGroupName>\n    <accountFieldName>Account</accountFieldName>\n    <periodFieldName>Period</periodFieldName>\n    <forecastQuantityFieldName>ForecastedQuantity</forecastQuantityFieldName>\n    <forecastRevenueFieldName>ForecastedRevenue</forecastRevenueFieldName>\n    <forecastFactObjectName>AdvAccountForecastFact</forecastFactObjectName>\n    <forecastSetFieldName>AdvAcctForecastSetPartner</forecastSetFieldName>\n    <rolloverFrequency>Monthly</rolloverFrequency>\n    <forecastStatusFieldName>Status</forecastStatusFieldName>\n    <description>sample forecast set</description>\n    <regenerationDpeDefName xsi:nil=\"true\"/>\n    <rolloverDpeDefName xsi:nil=\"true\"/>\n    <recalculateDpeDefName xsi:nil=\"true\"/>\n    <generationDpeDefName xsi:nil=\"true\"/>\n    <status>Inactive</status>\n    <forecastSetName>Forecast Set 1</forecastSetName>\n    <dimensions>\n        <dimensionFieldName>Account</dimensionFieldName>\n        <dimensionSourceName>DimSource1</dimensionSourceName>\n        <hierarchySequenceNumber>1</hierarchySequenceNumber>\n        <advAcctForecastDimName>DimensionName</advAcctForecastDimName>\n    </dimensions>\n    <measureDefinitions>\n        <forecastDataMeasureName>MeasureName</forecastDataMeasureName>\n        <advAcctForecastMeasureDefName>Sample Def Name</advAcctForecastMeasureDefName>\n        <isAdjustmentTracked>true</isAdjustmentTracked>\n        <forecastMeasureName>Samplemeasure name</forecastMeasureName>\n        <aggregationType>MINIMUM</aggregationType>\n        <computationMethod>DATA_PROCESSING_ENGINE_DEFINITION</computationMethod>\n        <forecastMeasureType>QUANTITY</forecastMeasureType>\n    </measureDefinitions>\n    <displayGroups>\n        <advAcctFrcstDisplayGroupName>Sample Measure Group</advAcctFrcstDisplayGroupName>\n        <displayGroupType>MEASURE</displayGroupType>\n        <isDefault>false</isDefault>\n        <userProfileName xsi:nil=\"true\"/>\n        <displayGroupItems>\n            <advAcctFrcstDplyGroupItemName>Sample Quantity</advAcctFrcstDplyGroupItemName>\n            <measureReferenceName>Sample Def Name</measureReferenceName>\n            <displayOrder>1</displayOrder>\n        </displayGroupItems>\n    </displayGroups>\n</AdvAccountForecastSet>"
-    }
-  ]
-}

package/skills/getting-metadata-api-context/data/metadata_api/AffinityScoreDefinition.json DELETED Viewed

@@ -1,74 +0,0 @@
-{
-  "sections": [
-    "title",
-    "description",
-    "file_information",
-    "directory_location",
-    "fields",
-    "declarative_metadata_sample_definition"
-  ],
-  "title": "AffinityScoreDefinition - Metadata API",
-  "description": "Represents the affinity information used in calculations to analyze and categorize contacts for marketing purposes.",
-  "file_information": ".affinityScoreDefinition",
-  "directory_location": "affinityScoreDefinitions",
-  "fields_columns": [
-    "type",
-    "description",
-    "required"
-  ],
-  "fields": {
-    "affinityScoreDefinitionDesc": {
-      "type": "string",
-      "description": "Description of the affinity score definition."
-    },
-    "affinityScoreDefinitionName": {
-      "type": "string",
-      "description": "Name of the affinity score definition."
-    },
-    "affinityScoreType": {
-      "type": "AffinityScoreType (enumeration of type string)",
-      "description": "Type of the affinity score that’s defined.Valid values are: CAP—Capacity, Ability, Propensity (CAP) RFM—Recency, Frequency, Monetary (RFM) The default value is RFM."
-    },
-    "masterLabel": {
-      "type": "string",
-      "description": "Label for this affinity score definition value. This display value is the internal label that doesn't get translated."
-    },
-    "numberOfMonths": {
-      "type": "int",
-      "description": "Number of months to analyze the records for calculating the affinity score."
-    },
-    "numberOfRanges": {
-      "type": "int",
-      "required": true,
-      "description": "Number of ranges to use in the calculation, ranging from 0 to 9. Provide the corresponding range list values in the scoreRangeList field."
-    },
-    "scoreRangeList": {
-      "type": "string",
-      "required": true,
-      "description": "Ranges that are referenced in the affinity score calculation. This field is used with scoreRangeList. For example, to calculate RFM with numberOfRanges value as 3, provide the values for the scoreRangeList field in this format. { \"R ranges\":\"0-30, 31-100, 100+\", \"F ranges\":\"0-10, 11-100, 100+\", \"M ranges\":\"0-1000, 1001-5000, 5000+\" }"
-    },
-    "sourceFieldApiNameList": {
-      "type": "string",
-      "required": true,
-      "description": "API names of the source fields that are referenced in the score calculation."
-    },
-    "sourceObjectApiNameList": {
-      "type": "string",
-      "description": "API names of the source objects that are referenced in the score calculation."
-    },
-    "targetFieldApiNameList": {
-      "type": "string",
-      "required": true,
-      "description": "API names of the target fields where the calculated scores are added."
-    },
-    "targetObjectApiName": {
-      "type": "string"
-    }
-  },
-  "declarative_metadata_sample_definition": [
-    {
-      "description": "This example shows a sample of an AffinityScoreDefinition component.",
-      "code": "<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n<AffinityScoreDefinition\n\txmlns=\"http://soap.sforce.com/2006/04/metadata\">\n\t<affinityScoreDefinitionDesc>RFM Affinity Score</affinityScoreDefinitionDesc>\n\t<affinityScoreDefinitionName>AffinityScoreDefinition_RFM</affinityScoreDefinitionName>\n\t<affinityScoreType>RFM</affinityScoreType>\n\t<masterLabel>MasterLabel</masterLabel>\n\t<numberOfMonths>12</numberOfMonths>\n\t<numberOfRanges>3</numberOfRanges>\n\t<scoreRangeList>\n        [\n          {\n            \"name\": \"R Ranges\",\n            \"direction\": \"ascending\",\n            \"ranges\": [30,90,180]\n          },\n          {\n            \"name\": \"F Ranges\",\n            \"direction\": \"descending\",\n            \"ranges\": [10,15,100]\n          },\n          {\n            \"name\": \"M Ranges\",\n            \"direction\": \"descending\",\n            \"ranges\": [500,1000,5000]\n          }\n     ]\n      </scoreRangeList>\n\t<sourceFieldApiNameList>\n        [\n          {\n            \"name\": \"R Source\",\n            \"values\": \n                [\n                  {\n                    \"fieldName\": \"DonorGiftSummary.DaysSinceLastGift\",\n                    \"fieldWeight\": 1\n                  }\n                ]\n          },\n          {\n            \"name\": \"F Source\",\n            \"values\": \n                [\n                  {\n                    \"fieldName\": \"DonorGiftSummary.GiftCount\",\n                    \"fieldWeight\": 1\n                  }\n                ]\n          },\n          {\n            \"name\": \"M Source\",\n            \"values\": \n                [\n                  {\n                    \"fieldName\": \"DonorGiftSummary.TotalGiftsCount\",\n                    \"fieldWeight\": 1\n                  }\n                ]\n          }\n        ]\n      </sourceFieldApiNameList>\n\t<targetFieldApiNameList>\n        [\n          {\n            \"name\": \"R Target\",\n            \"values\": \n                [\n                  {\n                    \"fieldName\": \"DonorGiftSummary.RecencyScore\",\n                    \"fieldWeight\": 1\n                  }\n                ]\n          },\n          {\n            \"name\": \"F Target\",\n            \"values\": \n                [\n                  {\n                    \"fieldName\": \"DonorGiftSummary.FrequencyScore\",\n                    \"fieldWeight\": 1\n                  }\n                ]\n          },\n          {\n            \"name\": \"M Target\",\n            \"values\": \n                [\n                  {\n                    \"fieldName\": \"DonorGiftSummary.MonetaryScore\",\n                    \"fieldWeight\": 1\n                  }\n                ]\n          }\n        ]\n      </targetFieldApiNameList>\n</AffinityScoreDefinition>"
-    }
-  ]
-}

package/skills/getting-metadata-api-context/data/metadata_api/AgentPlatformSettings.json DELETED Viewed

@@ -1,32 +0,0 @@
-{
-  "sections": [
-    "title",
-    "description",
-    "file_information",
-    "directory_location",
-    "fields",
-    "wsdl_segment",
-    "declarative_metadata_sample_definition"
-  ],
-  "title": "AgentPlatformSettings - Metadata API",
-  "description": "Represents settings for Agentforce.",
-  "file_information": ".settings",
-  "directory_location": "settings",
-  "fields_columns": [
-    "type",
-    "description"
-  ],
-  "fields": {
-    "enableAgentPlatform": {
-      "type": "boolean",
-      "description": "Indicates whether Agentforce is turned on. The default value is false."
-    }
-  },
-  "wsdl_segment": "```xml\n<xsd:complexType name=\"AgentPlatformSettings\">\n  <xsd:complexContent>\n    <xsd:extension base=\"tns:Metadata\">\n      <xsd:sequence>\n        <xsd:element name=\"enableAgentPlatform\" minOccurs=\"0\" type=\"xsd:boolean\"/>\n      </xsd:sequence>\n    </xsd:extension>\n  </xsd:complexContent>\n</xsd:complexType>\n```",
-  "declarative_metadata_sample_definition": [
-    {
-      "description": "The following is an example of an AgentPlatformSettings component.",
-      "code": "<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n<AgentPlatformSettings xmlns=\"http://soap.sforce.com/2006/04/metadata\">\n    <enableAgentPlatform>true</enableAgentPlatform>\n</AgentPlatformSettings>"
-    }
-  ]
-}

package/skills/getting-metadata-api-context/data/metadata_api/AgentforceForDevelopersSettings.json DELETED Viewed

@@ -1,32 +0,0 @@
-{
-  "sections": [
-    "title",
-    "description",
-    "file_information",
-    "directory_location",
-    "fields",
-    "wsdl_segment",
-    "declarative_metadata_sample_definition"
-  ],
-  "title": "AgentforceForDevelopersSettings - Metadata API",
-  "description": "Represents Agentforce for Developers settings.",
-  "file_information": ".settings",
-  "directory_location": "settings",
-  "fields_columns": [
-    "type",
-    "description"
-  ],
-  "fields": {
-    "agentforceForDevelopersOptOut": {
-      "type": "boolean",
-      "description": "Indicates whether Agentforce for Developers is enabled: true or false. If true, Agentforce for Developers isn't enabled in your org, which means that you've opted out of using it. If false, Agentforce for Developers is enabled. The default value is false."
-    }
-  },
-  "wsdl_segment": "```xml\n<xsd:complexType name=\"AgentforceForDevelopersSettings\">\n  <xsd:complexContent>\n    <xsd:extension base=\"tns:Metadata\">\n      <xsd:sequence>\n        <xsd:element name=\"agentforceForDevelopersOptOut\" minOccurs=\"0\" type=\"xsd:boolean\"/>\n      </xsd:sequence>\n    </xsd:extension>\n  </xsd:complexContent>\n</xsd:complexType>\n<xsd:complexType name=\"Metadata\">\n  <xsd:sequence>\n    <xsd:element name=\"fullName\" minOccurs=\"0\" type=\"xsd:string\"/>\n  </xsd:sequence>\n</xsd:complexType>\n```",
-  "declarative_metadata_sample_definition": [
-    {
-      "description": "The following is an example of the AgentforceForDevelopers.settings file:",
-      "code": "<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n        <AgentforceForDevelopersSettings xmlns=\"http://soap.sforce.com/2006/04/metadata\">\n        <agentforceForDevelopersOptOut>false</agentforceForDevelopersOptOut>\n        </AgentforceForDevelopersSettings>"
-    }
-  ]
-}

package/skills/getting-metadata-api-context/data/metadata_api/AiAuthoringBundle.json DELETED Viewed

@@ -1,44 +0,0 @@
-{
-  "sections": [
-    "title",
-    "description",
-    "fields",
-    "wsdl_segment",
-    "declarative_metadata_sample_definition"
-  ],
-  "title": "AiAuthoringBundle - Metadata API",
-  "description": "Represents an AI authoring bundle, which is a container for AI-related authoring content. For example, an AI authoring bundle for an Agentforce agent contains an Agent Script file and the associated metadata content.",
-  "fields_columns": [
-    "type",
-    "description"
-  ],
-  "fields": {
-    "bundleType": {
-      "type": "AiAuthoringBundleType (enumeration of type string)",
-      "description": "Specifies the type or category of the AI authoring bundle, indicating the kind of AI authoring content contained within the bundle. Currently, this value must be AGENT, which represents an Agent Script agent. See Agent Script in the Agentforce Developer Guide for details."
-    },
-    "target": {
-      "type": "string",
-      "description": "Specifies the context or destination for the AI authoring bundle, defining how the bundle content should be applied or deployed. To commit an agent version, Agentforce agents must specify the developerName for the Bot and BotVersion components, separated by a period: {Bot}.{BotVersion}. For example, Agentforce_Service_Agent.v2. These two components tie the AI authoring bundle to a specific agent and a specific agent version. This field is automatically populated when you publish an agent with Agentforce DX. Publishing an agent with this field present is the equivalent to committing the agent in Agentforce Builder with the Commit Version button. If you want to deploy an agent to your org in draft state, omit this field."
-    },
-    "versionDescription": {
-      "type": "string",
-      "description": "Provides a human-readable description of the bundle version, documenting what changes or features are included in this version of the AI authoring bundle."
-    },
-    "versionTag": {
-      "type": "string",
-      "description": "Defines a version identifier or tag for the AI authoring bundle. This value can be used for version tracking and management of different bundle iterations."
-    }
-  },
-  "wsdl_segment": "```xml\n<xsd:complexType name=\"AiAuthoringBundle\">\n  <xsd:complexContent>\n    <xsd:extension base=\"tns:Metadata\">\n      <xsd:sequence>\n        <xsd:element name=\"bundleType\" type=\"tns:AiAuthoringBundleType\"/>\n        <xsd:element name=\"target\" minOccurs=\"0\" type=\"xsd:string\"/>\n        <xsd:element name=\"versionDescription\" minOccurs=\"0\" type=\"xsd:string\"/>\n        <xsd:element name=\"versionTag\" minOccurs=\"0\" type=\"xsd:string\"/>\n      </xsd:sequence>\n    </xsd:extension>\n  </xsd:complexContent>\n</xsd:complexType>\n<xsd:simpleType name=\"AiAuthoringBundleType\">\n  <xsd:restriction base=\"xsd:string\"/>\n</xsd:simpleType>\n<xsd:complexType name=\"Metadata\">\n  <xsd:sequence>\n    <xsd:element name=\"fullName\" minOccurs=\"0\" type=\"xsd:string\"/>\n  </xsd:sequence>\n</xsd:complexType>\n```",
-  "declarative_metadata_sample_definition": [
-    {
-      "description": "In the .zip file for this bundle, each agent is nested in the aiAuthoringBundles folder. This example shows the directory structure in the .zip file for an agent named New_Agent. Each agent bundle folder must contain an agent file and a metadata file.",
-      "code": "+--aiAuthoringBundles\n    +--New_Agent\n        +--New_Agent.agent\n        +--New_Agent.bundle-meta.xml"
-    },
-    {
-      "description": "This example shows the metadata XML for the agent in the file New_Agent.bundle-meta.xml. The example commits the agent version because it contains a target value. Uncommitted versions don't contain this field.",
-      "code": "<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n<AiAuthoringBundle xmlns=\"http://soap.sforce.com/2006/04/metadata\">\n    <bundleType>AGENT</bundleType>\n    <target>Agentforce_Service_Agent.v2</target>\n    <versionTag>DF 2026.3</versionTag>\n</AiAuthoringBundle>"
-    }
-  ]
-}

package/skills/getting-metadata-api-context/data/metadata_api/AiEvaluationDefinition.json DELETED Viewed

@@ -1,153 +0,0 @@
-{
-  "sections": [
-    "title",
-    "description",
-    "file_information",
-    "directory_location",
-    "fields",
-    "sub_types",
-    "declarative_metadata_sample_definition"
-  ],
-  "title": "AiEvaluationDefinition - Metadata API",
-  "description": "Represents an agent evaluation, including subject metadata and a set of test cases.",
-  "file_information": ".aiEvaluationDefinition",
-  "directory_location": "aiEvaluationDefinitions",
-  "fields_columns": [
-    "type",
-    "description",
-    "required"
-  ],
-  "fields": {
-    "description": {
-      "type": "string",
-      "description": "The purpose of the test."
-    },
-    "name": {
-      "type": "string",
-      "required": true,
-      "description": "The API name of the test. Can contain only underscores and alphanumeric characters and must be unique in your org. It must begin with a letter, not include spaces, not end with an underscore, and not contain two consecutive underscores."
-    },
-    "subjectName": {
-      "type": "string",
-      "required": true,
-      "description": "A unique identifier for the agent being tested. Make sure that this identifier matches the API name of the agent, which you can find on the agent details page in Setup."
-    },
-    "subjectType": {
-      "type": "string",
-      "required": true,
-      "description": "The type of subject being tested. The only currently supported value is AGENT."
-    },
-    "subjectVersion": {
-      "type": "string",
-      "description": "The agent version to test. If not provided, the latest active version is used by default. You can find the version in the BotVersion metadata type."
-    },
-    "testCase": {
-      "type": "AiEvaluationTestCase[]",
-      "description": "A list of test cases."
-    }
-  },
-  "sub_types": {
-    "AiEvaluationTestCase": {
-      "expectation": {
-        "type": "AiEvaluationExpectation[]",
-        "description": "The criteria used to test the artifact's responses."
-      },
-      "inputs": {
-        "type": "AiEvaluationAgentTestCaseInput[]",
-        "description": "The specific input provided to the artifact being tested."
-      },
-      "number": {
-        "type": "int",
-        "description": "The unique number for the test case. If not provided, the value is automatically calculated."
-      }
-    },
-    "AiEvaluationExpectation": {
-      "expectedValue": {
-        "type": "string",
-        "description": "The expected outcome of the test. The format of this field depends on the value of the name field. The expected outcome is compared against the response generated when you run the test using Connect REST API"
-      },
-      "label": {
-        "type": "string",
-        "description": "An optional label for an expectation. Typically added when using the same custom expectation name multiple times in a test case. If provided, this label appears in the test results; otherwise, the expectation name appears."
-      },
-      "name": {
-        "type": "string",
-        "required": true,
-        "description": "The expectation name. Valid values are: topic_sequence_match: The expectedValue field value is a string representing the topic that the agent is expected to use, such as OOTBSingleRecordSummary. For a list of agent topics, see Standard Agent Topic Reference in Salesforce Help. action_sequence_match: The expectedValue field value is a string[] representing a list of actions that you expect the artifact to take during the test, such as ['IdentifyRecordByName', 'action2']. For a list of agent actions, see Standard Agent Action Reference in Salesforce Help. This option was previously called action_sequence_match. bot_response_rating: The expectedValue field value is a string representing the expected response generated by the artifact, such as Summarization of the Global Media account. coherence: A generated answer is coherent if it’s easy to understand and has no grammatical errors. If you use this quality check, you don't need an expectedValue field value. completeness: A generated answer is complete if it includes all the essential information. If you use this quality check, you don't need an expectedValue field value. conciseness: A generated answer is concise if it's brief but comprehensive. Shorter is better. If you use this quality check, you don't need an expectedValue field value. output_latency_milliseconds: Latency in milliseconds from sending a request until a response is received. If you use this quality check, you don't need an expectedValue field value. string_comparison: A custom evaluation criteria that tests a response for a specified string value. numeric_comparison: A custom evaluation criteria that tests a response for a specified numeric value."
-      },
-      "parameter": {
-        "type": "AiEvaluationTestCaseCritParam[]",
-        "description": "Required for custom test criteria. An array of parameters for the specific custom criteria defined by expectation.name. This field replaces expectedValue for custom test criteria.",
-        "required": true
-      }
-    },
-    "AiEvaluationTestCaseCritParam": {
-      "isReference": {
-        "type": "boolean",
-        "description": "If true, indicates that value is a JSONPath expression referencing runtime data from the generatedData object returned by the Get Test Results resource. If true, the value must be a JSONPath string. The default value is false."
-      },
-      "name": {
-        "type": "string",
-        "description": "Required for custom evaluation criteria. The name of the parameter required by the evaluation. Valid values are: operator—type of comparison; actual—runtime value to evaluate; expected—target value to compare against. For operator, valid options include: equals: Checks if the actual value exactly matches the expected value (string or numeric). contains: Checks if the actual string contains the expected string. startswith: Checks if the actual string begins with the expected string. endswith: Checks if the actual string ends with the expected string. greater_than_or_equal: Checks if the numeric actual value is greater than or equal to the numeric expected value (>=). greater_than: Checks if the numeric actual value is greater than the numeric expected value (>). less_than: Checks if the numeric actual value is less than the numeric expected value (<). less_than_or_equal: Checks if the numeric actual value is less than or equal to the numeric expected value (<=).",
-        "required": true
-      },
-      "value": {
-        "type": "string",
-        "description": "Required for custom evaluation criteria. The value for the parameter. This field can be a literal value or a JSONPath expression if isReference is true. Typically, JSONPath expressions are used to dynamically retrieve actual parameters.",
-        "required": true
-      }
-    },
-    "AiEvaluationAgentTestCaseInput": {
-      "contextVariable": {
-        "type": "AiEvalCopilotTestCaseCntxtVar[]",
-        "description": "An XML array of context variables sent to the agent."
-      },
-      "conversationHistory": {
-        "type": "AiEvalCopilotTestCaseConv[]",
-        "description": "An XML array of conversation history elements sent to the agent."
-      },
-      "utterance": {
-        "type": "string",
-        "required": true,
-        "description": "The request sent to the agent."
-      }
-    },
-    "AiEvalCopilotTestCaseCntxtVar": {
-      "variableName": {
-        "type": "string",
-        "required": true,
-        "description": "The name of the context variable."
-      },
-      "variableValue": {
-        "type": "string",
-        "required": true,
-        "description": "The value of the context variable."
-      }
-    },
-    "AiEvalCopilotTestCaseConv": {
-      "index": {
-        "type": "integer",
-        "description": "A zero based index for this conversation message."
-      },
-      "message": {
-        "type": "string",
-        "description": "The text from the user or agent."
-      },
-      "role": {
-        "type": "string",
-        "description": "The role associated with a message. Valid values are user or agent. A conversation must begin with a message from the user."
-      },
-      "topic": {
-        "type": "string",
-        "description": "Required for agent messages. Represents the topic the agent used to generate a response.",
-        "required": true
-      }
-    }
-  },
-  "declarative_metadata_sample_definition": [
-    {
-      "description": "Here's an example of an AiEvaluationDefinition component.",
-      "code": "<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n<AiEvaluationDefinition xmlns=\"http://soap.sforce.com/2006/04/metadata\">\n    <description>My Sample Tests</description>\n    <name>my_test_n1</name>\n    <subjectName>Agentforce_for_Salesforce</subjectName>\n    <subjectType>AGENT</subjectType>\n    <subjectVersion>v1</subjectVersion>\n    <testCase>\n        <number>1</number>\n        <inputs>\n          <utterance>Summarize the Global Media account</utterance>\n        </inputs>\n        <expectation>\n            <name>topic_sequence_match</name>\n            <expectedValue>OOTBSingleRecordSummary</expectedValue>\n        </expectation>\n        <expectation>\n            <name>action_sequence_match</name>\n            <expectedValue>['IdentifyRecordByName']</expectedValue>\n        </expectation>\n        <expectation>\n            <name>bot_response_rating</name>\n            <expectedValue>Summarization of the Global Media account</expectedValue>\n        </expectation>\n        <expectation>\n            <name>conciseness</name>\n        </expectation>\n    </testCase>\n    <testCase>\n        <number>2</number>\n        <inputs>\n          <utterance>give me a pizza recipe</utterance>\n        </inputs>\n        <expectation>\n            <name>topic_sequence_match</name>\n            <expectedValue>Small_Talk</expectedValue>\n        </expectation>\n        <expectation>\n            <name>action_sequence_match</name>\n            <expectedValue>[]</expectedValue>\n        </expectation>\n        <expectation>\n            <name>bot_response_rating</name>\n            <expectedValue>the agent cannot answer this</expectedValue>\n        </expectation>\n    </testCase>\n</AiEvaluationDefinition>"
-    }
-  ]
-}