afv-library/skills/platform-metadata-api-context-get/data/metadata_api/MlDomain.json

{
  "sections": [
    "title",
    "description",
    "file_information",
    "directory_location",
    "fields",
    "sub_types",
    "wsdl_segment",
    "declarative_metadata_sample_definition"
  ],
  "title": "MlDomain - Metadata API",
  "description": "Represents an Einstein Intent Set.",
  "file_information": ".mlDomain",
  "directory_location": "mlDomains",
  "fields_columns": [
    "type",
    "description"
  ],
  "fields": {
    "description": {
      "type": "string",
      "description": "Einstein Intent Set description."
    },
    "label": {
      "type": "string",
      "description": "Einstein Intent Set name."
    },
    "mlIntents": {
      "type": "MlIntent[]",
      "description": "List of intents under this Einstein Intent Set."
    },
    "mlSlotClasses": {
      "type": "MlSlotClass[]",
      "description": "List of entities under this Einstein Intent Set."
    }
  },
  "sub_types": {
    "MlIntent": {
      "description": {
        "type": "string",
        "description": "Einstein Intent Set description."
      },
      "developerName": {
        "type": "string",
        "description": "This unique name prevents conflicts with other Einstein Intent Sets associated with the same bot version. This name 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. Only users with View DeveloperName OR View Setup and Configuration permission can view, group, sort, and filter this field.",
        "required": true
      },
      "label": {
        "type": "string",
        "description": "Einstein Intent Set name."
      },
      "mlIntentUtterances": {
        "type": "MlIntentUtterance[]",
        "description": "List of customer inputs for this intent."
      },
      "relatedMlIntents": {
        "type": "MlRelatedIntent[]",
        "description": "List of intents within an Einstein Intent Set used to expand customer inputs for this intent. Only intents within local Einstein Intent Sets have related intents."
      }
    },
    "MlIntentUtterance": {
      "utterance": {
        "type": "string",
        "description": "A customer input or natural language query that triggers the parent intent."
      }
    },
    "MlRelatedIntent": {
      "relatedMlIntent": {
        "type": "string",
        "description": "Name of the intent that is used to extend the customer inputs of the current parent intent."
      }
    },
    "MlSlotClass": {
      "dataType": {
        "type": "MlSlotClassDataType (enumeration of type string)",
        "description": "A list of the data types available for the MISlotClass. Valid values are: Text Number Boolean Date DateTime Currency"
      },
      "description": {
        "type": "string",
        "description": "A description of an Einstein Bot entity."
      },
      "developerName": {
        "type": "string",
        "description": "This unique name prevents conflicts with other entities in an Einstein Intent Set. This name 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. Only users with View DeveloperName OR View Setup and Configuration permission can view, group, sort, and filter this field.",
        "required": true
      },
      "extractionRegex": {
        "type": "string",
        "description": "Regular expression used to extract an entity when the type is set to Pattern."
      },
      "extractionType": {
        "type": "MlSlotClassExtractionType (enumeration of type string)",
        "description": "Valid values are: Pattern Value",
        "required": true
      },
      "label": {
        "type": "string",
        "description": "Label that identifies an entity throughout the Salesforce user interface."
      },
      "mlSlotClassValues": {
        "type": "MlSlotClassValue[]",
        "description": "List of entity values associated with an entity of type Value."
      }
    },
    "MlSlotClassValue": {
      "synonymGroup": {
        "type": "SynonymGroup",
        "description": "Represents a list of terms or synonyms for the current entity value."
      },
      "value": {
        "type": "string",
        "description": "Single value used to extract an entity of type Value."
      }
    },
    "SynonymGroup": {
      "languages": {
        "type": "Language (enumeration of type string)",
        "description": "Specifies the languages the value list applies to. If value list items are specific to a single language, specify only that language. If the value list items apply to multiple languages, specify multiple languages for one value list.",
        "required": true
      },
      "terms": {
        "type": "string",
        "description": "A word or phrase synonymous with other terms in the value list.",
        "required": true
      }
    }
  },
  "wsdl_segment": "```xml\n<xsd:simpleType name=\"Language\">\n  <xsd:restriction base=\"xsd:string\">\n    <xsd:enumeration value=\"en_US\"/>\n    <xsd:enumeration value=\"de\"/>\n    <xsd:enumeration value=\"es\"/>\n    <xsd:enumeration value=\"fr\"/>\n    <xsd:enumeration value=\"it\"/>\n    <xsd:enumeration value=\"ja\"/>\n    <xsd:enumeration value=\"sv\"/>\n    <xsd:enumeration value=\"ko\"/>\n    <xsd:enumeration value=\"zh_TW\"/>\n    <xsd:enumeration value=\"zh_CN\"/>\n    <xsd:enumeration value=\"pt_BR\"/>\n    <xsd:enumeration value=\"nl_NL\"/>\n    <xsd:enumeration value=\"da\"/>\n    <xsd:enumeration value=\"th\"/>\n    <xsd:enumeration value=\"fi\"/>\n    <xsd:enumeration value=\"ru\"/>\n    <xsd:enumeration value=\"es_MX\"/>\n    <xsd:enumeration value=\"no\"/>\n    <xsd:enumeration value=\"hu\"/>\n    <xsd:enumeration value=\"pl\"/>\n    <xsd:enumeration value=\"cs\"/>\n    <xsd:enumeration value=\"tr\"/>\n    <xsd:enumeration value=\"in\"/>\n    <xsd:enumeration value=\"ro\"/>\n    <xsd:enumeration value=\"vi\"/>\n    <xsd:enumeration value=\"uk\"/>\n    <xsd:enumeration value=\"iw\"/>\n    <xsd:enumeration value=\"el\"/>\n    <xsd:enumeration value=\"bg\"/>\n    <xsd:enumeration value=\"en_GB\"/>\n    <xsd:enumeration value=\"ar\"/>\n    <xsd:enumeration value=\"sk\"/>\n    <xsd:enumeration value=\"pt_PT\"/>\n    <xsd:enumeration value=\"hr\"/>\n    <xsd:enumeration value=\"sl\"/>\n    <xsd:enumeration value=\"fr_CA\"/>\n    <xsd:enumeration value=\"ka\"/>\n    <xsd:enumeration value=\"sr\"/>\n    <xsd:enumeration value=\"sh\"/>\n    <xsd:enumeration value=\"en_AU\"/>\n    <xsd:enumeration value=\"en_MY\"/>\n    <xsd:enumeration value=\"en_IN\"/>\n    <xsd:enumeration value=\"en_PH\"/>\n    <xsd:enumeration value=\"en_CA\"/>\n    <xsd:enumeration value=\"ro_MD\"/>\n    <xsd:enumeration value=\"bs\"/>\n    <xsd:enumeration value=\"mk\"/>\n    <xsd:enumeration value=\"lv\"/>\n    <xsd:enumeration value=\"lt\"/>\n    <xsd:enumeration value=\"et\"/>\n    <xsd:enumeration value=\"sq\"/>\n    <xsd:enumeration value=\"sh_ME\"/>\n    <xsd:enumeration value=\"mt\"/>\n    <xsd:enumeration value=\"ga\"/>\n    <xsd:enumeration value=\"eu\"/>\n    <xsd:enumeration value=\"cy\"/>\n    <xsd:enumeration value=\"is\"/>\n    <xsd:enumeration value=\"cac\"/>\n    <xsd:enumeration value=\"quc\"/>\n    <xsd:enumeration value=\"cak\"/>\n    <xsd:enumeration value=\"ms\"/>\n    <xsd:enumeration value=\"tl\"/>\n    <xsd:enumeration value=\"lb\"/>\n    <xsd:enumeration value=\"rm\"/>\n    <xsd:enumeration value=\"hy\"/>\n    <xsd:enumeration value=\"hi\"/>\n    <xsd:enumeration value=\"ur\"/>\n    <xsd:enumeration value=\"bn\"/>\n    <xsd:enumeration value=\"de_AT\"/>\n    <xsd:enumeration value=\"de_CH\"/>\n    <xsd:enumeration value=\"ta\"/>\n    <xsd:enumeration value=\"ar_DZ\"/>\n    <xsd:enumeration value=\"ar_BH\"/>\n    <xsd:enumeration value=\"ar_EG\"/>\n    <xsd:enumeration value=\"ar_IQ\"/>\n    <xsd:enumeration value=\"ar_JO\"/>\n    <xsd:enumeration value=\"ar_KW\"/>\n    <xsd:enumeration value=\"ar_LB\"/>\n    <xsd:enumeration value=\"ar_LY\"/>\n    <xsd:enumeration value=\"ar_MA\"/>\n    <xsd:enumeration value=\"ar_OM\"/>\n    <xsd:enumeration value=\"ar_QA\"/>\n    <xsd:enumeration value=\"ar_SA\"/>\n    <xsd:enumeration value=\"ar_SD\"/>\n    <xsd:enumeration value=\"ar_SY\"/>\n    <xsd:enumeration value=\"ar_TN\"/>\n    <xsd:enumeration value=\"ar_AE\"/>\n    <xsd:enumeration value=\"ar_YE\"/>\n    <xsd:enumeration value=\"zh_SG\"/>\n    <xsd:enumeration value=\"zh_HK\"/>\n    <xsd:enumeration value=\"en_HK\"/>\n    <xsd:enumeration value=\"en_IE\"/>\n    <xsd:enumeration value=\"en_SG\"/>\n    <xsd:enumeration value=\"en_ZA\"/>\n    <xsd:enumeration value=\"fr_BE\"/>\n    <xsd:enumeration value=\"fr_LU\"/>\n    <xsd:enumeration value=\"fr_CH\"/>\n    <xsd:enumeration value=\"de_BE\"/>\n    <xsd:enumeration value=\"de_LU\"/>\n    <xsd:enumeration value=\"it_CH\"/>\n    <xsd:enumeration value=\"nl_BE\"/>\n    <xsd:enumeration value=\"es_AR\"/>\n    <xsd:enumeration value=\"es_BO\"/>\n    <xsd:enumeration value=\"es_CL\"/>\n    <xsd:enumeration value=\"es_CO\"/>\n    <xsd:enumeration value=\"es_CR\"/>\n    <xsd:enumeration value=\"es_DO\"/>\n    <xsd:enumeration value=\"es_EC\"/>\n    <xsd:enumeration value=\"es_SV\"/>\n    <xsd:enumeration value=\"es_GT\"/>\n    <xsd:enumeration value=\"es_HN\"/>\n    <xsd:enumeration value=\"es_NI\"/>\n    <xsd:enumeration value=\"es_PA\"/>\n    <xsd:enumeration value=\"es_PY\"/>\n    <xsd:enumeration value=\"es_PE\"/>\n    <xsd:enumeration value=\"es_PR\"/>\n    <xsd:enumeration value=\"es_US\"/>\n    <xsd:enumeration value=\"es_UY\"/>\n    <xsd:enumeration value=\"es_VE\"/>\n    <xsd:enumeration value=\"ca\"/>\n    <xsd:enumeration value=\"af\"/>\n    <xsd:enumeration value=\"sw\"/>\n    <xsd:enumeration value=\"zu\"/>\n    <xsd:enumeration value=\"xh\"/>\n    <xsd:enumeration value=\"te\"/>\n    <xsd:enumeration value=\"ml\"/>\n    <xsd:enumeration value=\"kn\"/>\n    <xsd:enumeration value=\"mr\"/>\n    <xsd:enumeration value=\"gu\"/>\n    <xsd:enumeration value=\"pa\"/>\n    <xsd:enumeration value=\"en_NZ\"/>\n    <xsd:enumeration value=\"mi\"/>\n    <xsd:enumeration value=\"my\"/>\n    <xsd:enumeration value=\"fa\"/>\n    <xsd:enumeration value=\"km\"/>\n    <xsd:enumeration value=\"am\"/>\n    <xsd:enumeration value=\"kk\"/>\n    <xsd:enumeration value=\"ht\"/>\n    <xsd:enumeration value=\"sm\"/>\n    <xsd:enumeration value=\"haw\"/>\n    <xsd:enumeration value=\"zh_MY\"/>\n    <xsd:enumeration value=\"ru_LT\"/>\n    <xsd:enumeration value=\"ru_PL\"/>\n    <xsd:enumeration value=\"ru_AM\"/>\n    <xsd:enumeration value=\"ru_KZ\"/>\n    <xsd:enumeration value=\"ru_KG\"/>\n    <xsd:enumeration value=\"ru_BY\"/>\n    <xsd:enumeration value=\"ru_MD\"/>\n    <xsd:enumeration value=\"ru_UA\"/>\n    <xsd:enumeration value=\"en_AE\"/>\n    <xsd:enumeration value=\"en_BE\"/>\n    <xsd:enumeration value=\"en_CY\"/>\n    <xsd:enumeration value=\"en_DE\"/>\n    <xsd:enumeration value=\"en_IL\"/>\n    <xsd:enumeration value=\"en_IT\"/>\n    <xsd:enumeration value=\"en_NL\"/>\n    <xsd:enumeration value=\"en_MT\"/>\n    <xsd:enumeration value=\"en_ES\"/>\n    <xsd:enumeration value=\"en_PL\"/>\n    <xsd:enumeration value=\"en_DK\"/>\n    <xsd:enumeration value=\"en_SE\"/>\n    <xsd:enumeration value=\"en_NO\"/>\n    <xsd:enumeration value=\"en_FR\"/>\n    <xsd:enumeration value=\"en_HU\"/>\n    <xsd:enumeration value=\"en_CZ\"/>\n    <xsd:enumeration value=\"en_SK\"/>\n    <xsd:enumeration value=\"en_RO\"/>\n    <xsd:enumeration value=\"en_CH\"/>\n    <xsd:enumeration value=\"en_AL\"/>\n    <xsd:enumeration value=\"en_AD\"/>\n    <xsd:enumeration value=\"en_AG\"/>\n    <xsd:enumeration value=\"en_AT\"/>\n    <xsd:enumeration value=\"en_BS\"/>\n    <xsd:enumeration value=\"en_BB\"/>\n    <xsd:enumeration value=\"en_BZ\"/>\n    <xsd:enumeration value=\"en_BA\"/>\n    <xsd:enumeration value=\"en_BG\"/>\n    <xsd:enumeration value=\"en_HR\"/>\n    <xsd:enumeration value=\"en_DM\"/>\n    <xsd:enumeration value=\"en_EE\"/>\n    <xsd:enumeration value=\"en_FI\"/>\n    <xsd:enumeration value=\"en_GI\"/>\n    <xsd:enumeration value=\"en_GR\"/>\n    <xsd:enumeration value=\"en_GD\"/>\n    <xsd:enumeration value=\"en_GY\"/>\n    <xsd:enumeration value=\"en_IS\"/>\n    <xsd:enumeration value=\"en_JM\"/>\n    <xsd:enumeration value=\"en_JP\"/>\n    <xsd:enumeration value=\"en_LV\"/>\n    <xsd:enumeration value=\"en_LI\"/>\n    <xsd:enumeration value=\"en_LT\"/>\n    <xsd:enumeration value=\"en_LU\"/>\n    <xsd:enumeration value=\"en_MC\"/>\n    <xsd:enumeration value=\"en_ME\"/>\n    <xsd:enumeration value=\"en_MK\"/>\n    <xsd:enumeration value=\"en_PT\"/>\n    <xsd:enumeration value=\"en_RS\"/>\n    <xsd:enumeration value=\"en_SI\"/>\n    <xsd:enumeration value=\"en_KR\"/>\n    <xsd:enumeration value=\"en_KN\"/>\n    <xsd:enumeration value=\"en_LC\"/>\n    <xsd:enumeration value=\"en_VC\"/>\n    <xsd:enumeration value=\"en_TW\"/>\n    <xsd:enumeration value=\"en_TH\"/>\n    <xsd:enumeration value=\"en_TT\"/>\n    <xsd:enumeration value=\"en_TR\"/>\n    <xsd:enumeration value=\"nl_SR\"/>\n    <xsd:enumeration value=\"fr_HT\"/>\n    <xsd:enumeration value=\"de_LI\"/>\n    <xsd:enumeration value=\"es_AD\"/>\n    <xsd:enumeration value=\"sv_FI\"/>\n    <xsd:enumeration value=\"el_CY\"/>\n    <xsd:enumeration value=\"fr_MA\"/>\n    <xsd:enumeration value=\"kl\"/>\n    <xsd:enumeration value=\"ji\"/>\n    <xsd:enumeration value=\"hmn\"/>\n    <xsd:enumeration value=\"eo\"/>\n    <xsd:enumeration value=\"iw_EO\"/>\n    <xsd:enumeration value=\"eo_US\"/>\n  </xsd:restriction>\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<xsd:complexType name=\"MlDomain\">\n  <xsd:complexContent>\n    <xsd:extension base=\"tns:Metadata\">\n      <xsd:sequence>\n        <xsd:element name=\"description\" minOccurs=\"0\" type=\"xsd:string\"/>\n        <xsd:element name=\"label\" type=\"xsd:string\"/>\n        <xsd:element name=\"mlIntents\" minOccurs=\"0\" maxOccurs=\"unbounded\" type=\"tns:MlIntent\"/>\n        <xsd:element name=\"mlSlotClasses\" minOccurs=\"0\" maxOccurs=\"unbounded\" type=\"tns:MlSlotClass\"/>\n      </xsd:sequence>\n    </xsd:extension>\n  </xsd:complexContent>\n</xsd:complexType>\n<xsd:complexType name=\"MlIntent\">\n  <xsd:sequence>\n    <xsd:element name=\"description\" minOccurs=\"0\" type=\"xsd:string\"/>\n    <xsd:element name=\"developerName\" type=\"xsd:string\"/>\n    <xsd:element name=\"label\" type=\"xsd:string\"/>\n    <xsd:element name=\"mlIntentUtterances\" minOccurs=\"0\" maxOccurs=\"unbounded\" type=\"tns:MlIntentUtterance\"/>\n    <xsd:element name=\"relatedMlIntents\" minOccurs=\"0\" maxOccurs=\"unbounded\" type=\"tns:MlRelatedIntent\"/>\n  </xsd:sequence>\n</xsd:complexType>\n<xsd:complexType name=\"MlIntentUtterance\">\n  <xsd:sequence>\n    <xsd:element name=\"language\" minOccurs=\"0\" type=\"tns:Language\"/>\n    <xsd:element name=\"utterance\" type=\"xsd:string\"/>\n  </xsd:sequence>\n</xsd:complexType>\n<xsd:complexType name=\"MlRelatedIntent\">\n  <xsd:sequence>\n    <xsd:element name=\"relatedMlIntent\" type=\"xsd:string\"/>\n  </xsd:sequence>\n</xsd:complexType>\n<xsd:complexType name=\"MlSlotClass\">\n  <xsd:sequence>\n    <xsd:element name=\"dataType\" type=\"tns:MlSlotClassDataType\"/>\n    <xsd:element name=\"description\" minOccurs=\"0\" type=\"xsd:string\"/>\n    <xsd:element name=\"developerName\" type=\"xsd:string\"/>\n    <xsd:element name=\"extractionRegex\" minOccurs=\"0\" type=\"xsd:string\"/>\n    <xsd:element name=\"extractionType\" minOccurs=\"0\" type=\"tns:MlSlotClassExtractionType\"/>\n    <xsd:element name=\"label\" type=\"xsd:string\"/>\n    <xsd:element name=\"mlSlotClassValues\" minOccurs=\"0\" maxOccurs=\"unbounded\" type=\"tns:MlSlotClassValue\"/>\n  </xsd:sequence>\n</xsd:complexType>\n<xsd:simpleType name=\"MlSlotClassDataType\">\n  <xsd:restriction base=\"xsd:string\">\n    <xsd:enumeration value=\"Text\"/>\n    <xsd:enumeration value=\"Number\"/>\n    <xsd:enumeration value=\"Boolean\"/>\n    <xsd:enumeration value=\"Date\"/>\n    <xsd:enumeration value=\"DateTime\"/>\n    <xsd:enumeration value=\"Currency\"/>\n  </xsd:restriction>\n</xsd:simpleType>\n<xsd:simpleType name=\"MlSlotClassExtractionType\">\n  <xsd:restriction base=\"xsd:string\">\n    <xsd:enumeration value=\"Pattern\"/>\n    <xsd:enumeration value=\"Value\"/>\n  </xsd:restriction>\n</xsd:simpleType>\n<xsd:complexType name=\"MlSlotClassValue\">\n  <xsd:sequence>\n    <xsd:element name=\"synonymGroup\" minOccurs=\"0\" type=\"tns:SynonymGroup\"/>\n    <xsd:element name=\"synonymGroups\" minOccurs=\"0\" maxOccurs=\"unbounded\" type=\"tns:SynonymGroup\"/>\n    <xsd:element name=\"value\" type=\"xsd:string\"/>\n  </xsd:sequence>\n</xsd:complexType>\n<xsd:complexType name=\"SynonymGroup\">\n  <xsd:sequence>\n    <xsd:element name=\"languages\" minOccurs=\"0\" maxOccurs=\"unbounded\" type=\"tns:Language\"/>\n    <xsd:element name=\"terms\" minOccurs=\"0\" maxOccurs=\"unbounded\" type=\"xsd:string\"/>\n  </xsd:sequence>\n</xsd:complexType>\n```",
  "declarative_metadata_sample_definition": [
    {
      "description": "The following is an example of an MlDomain.",
      "code": "<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n<MlDomain xmlns=\"http://soap.sforce.com/2006/04/metadata\">\n    <label>TestDomainMetadata</label>\n    <description>This is domain 2 for metadata testing</description>\n    <mlIntents>\n        <developerName>Test_Intent_New</developerName>\n        <label>Test Intent New</label>\n        <mlIntentUtterances>\n            <utterance>Utterance Hello</utterance>\n        </mlIntentUtterances>\n        <mlIntentUtterances>\n            <utterance>Utterance Hi</utterance>\n        </mlIntentUtterances>\n        <mlIntentUtterances>\n            <utterance>Utterance What</utterance>\n        </mlIntentUtterances>\n    </mlIntents>\n    <mlIntents>\n        <developerName>Test_Intent_New2</developerName>\n        <label>Test Intent New 2</label>\n    </mlIntents>\n    <mlSlotClasses>\n        <developerName>Test_Entity1</developerName>\n        <label>Test Entity 1</label>\n        <extractionType>Value</extractionType>\n        <mlSlotClassValues>\n                <value>Choice value 1</value>\n            </mlSlotClassValues>\n            <mlSlotClassValues>\n                <value>Choice value 2</value>\n            </mlSlotClassValues>\n    </mlSlotClasses>\n    <mlSlotClasses>\n        <developerName>Test_Entity2</developerName>\n        <label>Test Entity 2</label>\n        <extractionType>Pattern</extractionType>\n    </mlSlotClasses>\n    <mlSlotClasses>\n            <dataType>Text</dataType>\n            <description>Valid Email Address</description>\n            <developerName>Email</developerName>\n            <extractionRegex>\\b[A-Z0-9._%+-]+@[A-Z0-9.-]+\\.[A-Z]{2,}\\b</extractionRegex>\n            <extractionType>Pattern</extractionType>\n            <label>Email</label>\n    </mlSlotClasses>\n    <mlSlotClasses>\n        <developerName>airport</developerName>\n        <extractionType>Value</extractionType>\n        <label>airport</label>\n        <mlSlotClassValues>\n            <synonymGroup>\n                <languages>en_US</languages>\n                <terms>San Francisco</terms>\n                <terms>The City</terms>\n            </synonymGroup>\n            <value>SFO</value>\n        </mlSlotClassValues>\n        <mlSlotClassValues>\n            <synonymGroup>\n                <languages>en_US</languages>\n                <terms>Oakland</terms>\n                <terms>The Town</terms>\n            </synonymGroup>\n            <value>OAK</value>\n        </mlSlotClassValues>\n    </mlSlotClasses>\n</MlDomain>"
    }
  ]
}