{
  "opencollection": "1.0.0",
  "info": {
    "name": "PureCloud Platform Agent Assistants Language Understanding API",
    "version": "v2"
  },
  "items": [
    {
      "info": {
        "name": "Language Understanding",
        "type": "folder"
      },
      "items": [
        {
          "info": {
            "name": "Find an NLU Domain.",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "{{baseUrl}}/api/v2/languageunderstanding/domains/:domainId",
            "params": [
              {
                "name": "domainId",
                "value": "",
                "type": "path",
                "description": "ID of the NLU domain."
              }
            ]
          },
          "docs": "Find an NLU Domain."
        },
        {
          "info": {
            "name": "Update an NLU Domain.",
            "type": "http"
          },
          "http": {
            "method": "PATCH",
            "url": "{{baseUrl}}/api/v2/languageunderstanding/domains/:domainId",
            "params": [
              {
                "name": "domainId",
                "value": "",
                "type": "path",
                "description": "ID of the NLU domain."
              }
            ]
          },
          "docs": "Update an NLU Domain."
        },
        {
          "info": {
            "name": "Delete an NLU Domain.",
            "type": "http"
          },
          "http": {
            "method": "DELETE",
            "url": "{{baseUrl}}/api/v2/languageunderstanding/domains/:domainId",
            "params": [
              {
                "name": "domainId",
                "value": "",
                "type": "path",
                "description": "ID of the NLU domain."
              }
            ]
          },
          "docs": "Delete an NLU Domain."
        },
        {
          "info": {
            "name": "Get all NLU Domains.",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "{{baseUrl}}/api/v2/languageunderstanding/domains",
            "params": [
              {
                "name": "pageNumber",
                "value": "",
                "type": "query",
                "description": "Page number"
              },
              {
                "name": "pageSize",
                "value": "",
                "type": "query",
                "description": "Page size"
              }
            ]
          },
          "docs": "Get all NLU Domains."
        },
        {
          "info": {
            "name": "Create an NLU Domain.",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "{{baseUrl}}/api/v2/languageunderstanding/domains"
          },
          "docs": "Create an NLU Domain."
        },
        {
          "info": {
            "name": "Find a Feedback",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "{{baseUrl}}/api/v2/languageunderstanding/domains/:domainId/feedback/:feedbackId",
            "params": [
              {
                "name": "domainId",
                "value": "",
                "type": "path",
                "description": "ID of the NLU domain."
              },
              {
                "name": "feedbackId",
                "value": "",
                "type": "path",
                "description": "ID of the Feedback"
              },
              {
                "name": "fields",
                "value": "",
                "type": "query",
                "description": "Fields and properties to get, comma-separated"
              }
            ]
          },
          "docs": "Find a Feedback"
        },
        {
          "info": {
            "name": "Delete the feedback on the NLU Domain Version.",
            "type": "http"
          },
          "http": {
            "method": "DELETE",
            "url": "{{baseUrl}}/api/v2/languageunderstanding/domains/:domainId/feedback/:feedbackId",
            "params": [
              {
                "name": "domainId",
                "value": "",
                "type": "path",
                "description": "ID of the NLU domain."
              },
              {
                "name": "feedbackId",
                "value": "",
                "type": "path",
                "description": "ID of the Feedback"
              }
            ]
          },
          "docs": "Delete the feedback on the NLU Domain Version."
        },
        {
          "info": {
            "name": "Get all feedback in the given NLU Domain Version.",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "{{baseUrl}}/api/v2/languageunderstanding/domains/:domainId/feedback",
            "params": [
              {
                "name": "domainId",
                "value": "",
                "type": "path",
                "description": "ID of the NLU domain."
              },
              {
                "name": "intentName",
                "value": "",
                "type": "query",
                "description": "The top intent name to retrieve feedback for."
              },
              {
                "name": "assessment",
                "value": "",
                "type": "query",
                "description": "The top assessment to retrieve feedback for."
              },
              {
                "name": "dateStart",
                "value": "",
                "type": "query",
                "description": "Begin of time window as ISO-8601 date."
              },
              {
                "name": "dateEnd",
                "value": "",
                "type": "query",
                "description": "End of time window as ISO-8601 date."
              },
              {
                "name": "includeDeleted",
                "value": "",
                "type": "query",
                "description": "Whether to include soft-deleted items in the result."
              },
              {
                "name": "language",
                "value": "",
                "type": "query",
                "description": "Whether to filter response based on the language, e.g. en-us, pt-br."
              },
              {
                "name": "pageNumber",
                "value": "",
                "type": "query",
                "description": "Page number"
              },
              {
                "name": "pageSize",
                "value": "",
                "type": "query",
                "description": "Page size"
              },
              {
                "name": "enableCursorPagination",
                "value": "",
                "type": "query",
                "description": "Enable Cursor Pagination"
              },
              {
                "name": "includeTrainingUtterances",
                "value": "",
                "type": "query",
                "description": "Include Training Utterances. By default they're included."
              },
              {
                "name": "after",
                "value": "",
                "type": "query",
                "description": "The cursor that points to the end of the set of entities that has been returned. This is considered only when enableCursorPagination=true"
              },
              {
                "name": "fields",
                "value": "",
                "type": "query",
                "description": "Fields and properties to get, comma-separated"
              }
            ]
          },
          "docs": "Get all feedback in the given NLU Domain Version."
        },
        {
          "info": {
            "name": "Create feedback for the NLU Domain Version.",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "{{baseUrl}}/api/v2/languageunderstanding/domains/:domainId/feedback",
            "params": [
              {
                "name": "domainId",
                "value": "",
                "type": "path",
                "description": "ID of the NLU domain."
              }
            ]
          },
          "docs": "Create feedback for the NLU Domain Version."
        },
        {
          "info": {
            "name": "Get information about a draft.",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "{{baseUrl}}/api/v2/languageunderstanding/miners/:minerId/drafts/:draftId",
            "params": [
              {
                "name": "minerId",
                "value": "",
                "type": "path",
                "description": "Miner ID"
              },
              {
                "name": "draftId",
                "value": "",
                "type": "path",
                "description": "Draft ID"
              },
              {
                "name": "draftIntentId",
                "value": "",
                "type": "query",
                "description": "Parameter to filter a specific intent."
              },
              {
                "name": "draftTopicId",
                "value": "",
                "type": "query",
                "description": "Parameter to filter a specific topic."
              }
            ]
          },
          "docs": "Get information about a draft."
        },
        {
          "info": {
            "name": "Save information for the draft. Either topic draft or intent draft should be sent.",
            "type": "http"
          },
          "http": {
            "method": "PATCH",
            "url": "{{baseUrl}}/api/v2/languageunderstanding/miners/:minerId/drafts/:draftId",
            "params": [
              {
                "name": "minerId",
                "value": "",
                "type": "path",
                "description": "Miner ID"
              },
              {
                "name": "draftId",
                "value": "",
                "type": "path",
                "description": "Draft ID"
              }
            ]
          },
          "docs": "Save information for the draft. Either topic draft or intent draft should be sent."
        },
        {
          "info": {
            "name": "Delete a draft",
            "type": "http"
          },
          "http": {
            "method": "DELETE",
            "url": "{{baseUrl}}/api/v2/languageunderstanding/miners/:minerId/drafts/:draftId",
            "params": [
              {
                "name": "minerId",
                "value": "",
                "type": "path",
                "description": "Miner ID"
              },
              {
                "name": "draftId",
                "value": "",
                "type": "path",
                "description": "Draft ID"
              }
            ]
          },
          "docs": "Delete a draft"
        },
        {
          "info": {
            "name": "Retrieve the list of drafts created.",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "{{baseUrl}}/api/v2/languageunderstanding/miners/:minerId/drafts",
            "params": [
              {
                "name": "minerId",
                "value": "",
                "type": "path",
                "description": "Miner ID"
              }
            ]
          },
          "docs": "Retrieve the list of drafts created."
        },
        {
          "info": {
            "name": "Create a new draft resource.",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "{{baseUrl}}/api/v2/languageunderstanding/miners/:minerId/drafts",
            "params": [
              {
                "name": "minerId",
                "value": "",
                "type": "path",
                "description": "Miner ID"
              }
            ]
          },
          "docs": "Create a new draft resource."
        },
        {
          "info": {
            "name": "Get list of all ignored phrases of the specified language code",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "{{baseUrl}}/api/v2/languageunderstanding/ignorephrases/:languageCode",
            "params": [
              {
                "name": "languageCode",
                "value": "",
                "type": "path",
                "description": "Language Code"
              },
              {
                "name": "pageSize",
                "value": "",
                "type": "query",
                "description": "The page size for the listing. The max that will be returned is 200."
              },
              {
                "name": "pageNumber",
                "value": "",
                "type": "query",
                "description": "The page number for the listing"
              },
              {
                "name": "text",
                "value": "",
                "type": "query",
                "description": "The phrase text filter applied to the listing"
              },
              {
                "name": "sortOrder",
                "value": "",
                "type": "query",
                "description": "The sort order for the listing"
              },
              {
                "name": "sortBy",
                "value": "",
                "type": "query",
                "description": "The field to sort by for the listing"
              }
            ]
          },
          "docs": "Get list of all ignored phrases of the specified language code"
        },
        {
          "info": {
            "name": "Add phrases to the ignored phrases list",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "{{baseUrl}}/api/v2/languageunderstanding/ignorephrases/:languageCode",
            "params": [
              {
                "name": "languageCode",
                "value": "",
                "type": "path",
                "description": "Language Code"
              }
            ]
          },
          "docs": "Add phrases to the ignored phrases list"
        },
        {
          "info": {
            "name": "Delete ignored phrases",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "{{baseUrl}}/api/v2/languageunderstanding/ignorephrases/:languageCode/remove",
            "params": [
              {
                "name": "languageCode",
                "value": "",
                "type": "path",
                "description": "Language Code"
              }
            ]
          },
          "docs": "Delete ignored phrases"
        },
        {
          "info": {
            "name": "Get list of all ignored topics of the specified language code",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "{{baseUrl}}/api/v2/languageunderstanding/ignoretopics/:languageCode",
            "params": [
              {
                "name": "languageCode",
                "value": "",
                "type": "path",
                "description": "Language Code"
              },
              {
                "name": "pageSize",
                "value": "",
                "type": "query",
                "description": "The page size for the listing. The max that will be returned is 200."
              },
              {
                "name": "pageNumber",
                "value": "",
                "type": "query",
                "description": "The page number for the listing"
              },
              {
                "name": "text",
                "value": "",
                "type": "query",
                "description": "The topic text filter applied to the listing"
              },
              {
                "name": "sortOrder",
                "value": "",
                "type": "query",
                "description": "The sort order for the listing"
              },
              {
                "name": "sortBy",
                "value": "",
                "type": "query",
                "description": "The field to sort by for the listing"
              }
            ]
          },
          "docs": "Get list of all ignored topics of the specified language code"
        },
        {
          "info": {
            "name": "Add topics to the ignored topics list",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "{{baseUrl}}/api/v2/languageunderstanding/ignoretopics/:languageCode",
            "params": [
              {
                "name": "languageCode",
                "value": "",
                "type": "path",
                "description": "Language Code"
              }
            ]
          },
          "docs": "Add topics to the ignored topics list"
        },
        {
          "info": {
            "name": "Delete ignored topics",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "{{baseUrl}}/api/v2/languageunderstanding/ignoretopics/:languageCode/remove",
            "params": [
              {
                "name": "languageCode",
                "value": "",
                "type": "path",
                "description": "Language Code"
              }
            ]
          },
          "docs": "Delete ignored topics"
        },
        {
          "info": {
            "name": "Get information about a mined intent",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "{{baseUrl}}/api/v2/languageunderstanding/miners/:minerId/intents/:intentId",
            "params": [
              {
                "name": "minerId",
                "value": "",
                "type": "path",
                "description": "Miner ID"
              },
              {
                "name": "intentId",
                "value": "",
                "type": "path",
                "description": "The ID of the intent to be retrieved."
              },
              {
                "name": "expand",
                "value": "",
                "type": "query",
                "description": "Option to fetch utterances"
              }
            ]
          },
          "docs": "Get information about a mined intent"
        },
        {
          "info": {
            "name": "Retrieve a list of mined intents.",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "{{baseUrl}}/api/v2/languageunderstanding/miners/:minerId/intents",
            "params": [
              {
                "name": "minerId",
                "value": "",
                "type": "path",
                "description": "Miner ID"
              },
              {
                "name": "expand",
                "value": "",
                "type": "query",
                "description": "Option to fetch utterances."
              }
            ]
          },
          "docs": "Retrieve a list of mined intents."
        },
        {
          "info": {
            "name": "Get information about a miner.",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "{{baseUrl}}/api/v2/languageunderstanding/miners/:minerId",
            "params": [
              {
                "name": "minerId",
                "value": "",
                "type": "path",
                "description": "Miner ID"
              }
            ]
          },
          "docs": "Get information about a miner."
        },
        {
          "info": {
            "name": "Delete a miner.",
            "type": "http"
          },
          "http": {
            "method": "DELETE",
            "url": "{{baseUrl}}/api/v2/languageunderstanding/miners/:minerId",
            "params": [
              {
                "name": "minerId",
                "value": "",
                "type": "path",
                "description": "Miner ID"
              }
            ]
          },
          "docs": "Delete a miner."
        },
        {
          "info": {
            "name": "Start the mining process. Specify date range pair with mediaType, queueIds, participantType for mining data from Genesys Cloud. Specify only uploadKey for mining through an external file.",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "{{baseUrl}}/api/v2/languageunderstanding/miners/:minerId/execute",
            "params": [
              {
                "name": "minerId",
                "value": "",
                "type": "path",
                "description": "Miner ID"
              }
            ]
          },
          "docs": "Start the mining process. Specify date range pair with mediaType, queueIds, participantType for mining data from Genesys Cloud. Specify only uploadKey for mining through an external file."
        },
        {
          "info": {
            "name": "Retrieve the list of miners created.",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "{{baseUrl}}/api/v2/languageunderstanding/miners",
            "params": [
              {
                "name": "minerType",
                "value": "",
                "type": "query",
                "description": "Type of miner, either intent or topic"
              }
            ]
          },
          "docs": "Retrieve the list of miners created."
        },
        {
          "info": {
            "name": "Create a unique miner.",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "{{baseUrl}}/api/v2/languageunderstanding/miners"
          },
          "docs": "Create a unique miner."
        },
        {
          "info": {
            "name": "Retrieves details of a particular topic.",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "{{baseUrl}}/api/v2/languageunderstanding/miners/:minerId/topics/:topicId",
            "params": [
              {
                "name": "minerId",
                "value": "",
                "type": "path",
                "description": "Miner ID"
              },
              {
                "name": "topicId",
                "value": "",
                "type": "path",
                "description": "The ID of the topic to be retrieved."
              },
              {
                "name": "expand",
                "value": "",
                "type": "query",
                "description": "Option to fetch phrases"
              }
            ]
          },
          "docs": "Retrieves details of a particular topic."
        },
        {
          "info": {
            "name": "Retrieve a list of mined topics.",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "{{baseUrl}}/api/v2/languageunderstanding/miners/:minerId/topics",
            "params": [
              {
                "name": "minerId",
                "value": "",
                "type": "path",
                "description": "Miner ID"
              }
            ]
          },
          "docs": "Retrieve a list of mined topics."
        },
        {
          "info": {
            "name": "Retrieves utterances related to a phrase in a topic.",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "{{baseUrl}}/api/v2/languageunderstanding/miners/:minerId/topics/:topicId/phrases/:phraseId",
            "params": [
              {
                "name": "minerId",
                "value": "",
                "type": "path",
                "description": "Miner ID"
              },
              {
                "name": "topicId",
                "value": "",
                "type": "path",
                "description": "The ID of the topic to be retrieved."
              },
              {
                "name": "phraseId",
                "value": "",
                "type": "path",
                "description": "The ID of the phrase to be retrieved."
              }
            ]
          },
          "docs": "Retrieves utterances related to a phrase in a topic."
        },
        {
          "info": {
            "name": "Get Organization Configuration",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "{{baseUrl}}/api/v2/languageunderstanding/settings"
          },
          "docs": "Get Organization Configuration"
        },
        {
          "info": {
            "name": "Retrieved quality report for the specified NLU Domain Version",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "{{baseUrl}}/api/v2/languageunderstanding/domains/:domainId/versions/:domainVersionId/report",
            "params": [
              {
                "name": "domainId",
                "value": "",
                "type": "path",
                "description": "ID of the NLU domain."
              },
              {
                "name": "domainVersionId",
                "value": "",
                "type": "path",
                "description": "ID of the NLU domain version."
              }
            ]
          },
          "docs": "Retrieved quality report for the specified NLU Domain Version"
        },
        {
          "info": {
            "name": "Find an NLU Domain Version.",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "{{baseUrl}}/api/v2/languageunderstanding/domains/:domainId/versions/:domainVersionId",
            "params": [
              {
                "name": "domainId",
                "value": "",
                "type": "path",
                "description": "ID of the NLU domain."
              },
              {
                "name": "domainVersionId",
                "value": "",
                "type": "path",
                "description": "ID of the NLU domain version."
              },
              {
                "name": "includeUtterances",
                "value": "",
                "type": "query",
                "description": "Whether utterances for intent definition should be included when marshalling response."
              }
            ]
          },
          "docs": "Find an NLU Domain Version."
        },
        {
          "info": {
            "name": "Update an NLU Domain Version.",
            "type": "http"
          },
          "http": {
            "method": "PUT",
            "url": "{{baseUrl}}/api/v2/languageunderstanding/domains/:domainId/versions/:domainVersionId",
            "params": [
              {
                "name": "domainId",
                "value": "",
                "type": "path",
                "description": "ID of the NLU domain."
              },
              {
                "name": "domainVersionId",
                "value": "",
                "type": "path",
                "description": "ID of the NLU domain version."
              }
            ]
          },
          "docs": "Update an NLU Domain Version."
        },
        {
          "info": {
            "name": "Delete an NLU Domain Version",
            "type": "http"
          },
          "http": {
            "method": "DELETE",
            "url": "{{baseUrl}}/api/v2/languageunderstanding/domains/:domainId/versions/:domainVersionId",
            "params": [
              {
                "name": "domainId",
                "value": "",
                "type": "path",
                "description": "ID of the NLU domain."
              },
              {
                "name": "domainVersionId",
                "value": "",
                "type": "path",
                "description": "ID of the NLU domain version."
              }
            ]
          },
          "docs": "Delete an NLU Domain Version"
        },
        {
          "info": {
            "name": "Publish the draft NLU Domain Version.",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "{{baseUrl}}/api/v2/languageunderstanding/domains/:domainId/versions/:domainVersionId/publish",
            "params": [
              {
                "name": "domainId",
                "value": "",
                "type": "path",
                "description": "ID of the NLU domain."
              },
              {
                "name": "domainVersionId",
                "value": "",
                "type": "path",
                "description": "ID of the NLU domain version."
              }
            ]
          },
          "docs": "Publish the draft NLU Domain Version."
        },
        {
          "info": {
            "name": "Train the draft NLU Domain Version.",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "{{baseUrl}}/api/v2/languageunderstanding/domains/:domainId/versions/:domainVersionId/train",
            "params": [
              {
                "name": "domainId",
                "value": "",
                "type": "path",
                "description": "ID of the NLU domain."
              },
              {
                "name": "domainVersionId",
                "value": "",
                "type": "path",
                "description": "ID of the NLU domain version."
              }
            ]
          },
          "docs": "Train the draft NLU Domain Version."
        },
        {
          "info": {
            "name": "Detect intent, entities, etc. in the submitted text using the specified NLU domain version.",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "{{baseUrl}}/api/v2/languageunderstanding/domains/:domainId/versions/:domainVersionId/detect",
            "params": [
              {
                "name": "domainId",
                "value": "",
                "type": "path",
                "description": "ID of the NLU domain."
              },
              {
                "name": "domainVersionId",
                "value": "",
                "type": "path",
                "description": "ID of the NLU domain version."
              }
            ]
          },
          "docs": "Detect intent, entities, etc. in the submitted text using the specified NLU domain version."
        },
        {
          "info": {
            "name": "Get all NLU Domain Versions for a given Domain.",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "{{baseUrl}}/api/v2/languageunderstanding/domains/:domainId/versions",
            "params": [
              {
                "name": "domainId",
                "value": "",
                "type": "path",
                "description": "ID of the NLU domain."
              },
              {
                "name": "includeUtterances",
                "value": "",
                "type": "query",
                "description": "Whether utterances for intent definition should be included when marshalling response."
              },
              {
                "name": "pageNumber",
                "value": "",
                "type": "query",
                "description": "Page number"
              },
              {
                "name": "pageSize",
                "value": "",
                "type": "query",
                "description": "Page size"
              }
            ]
          },
          "docs": "Get all NLU Domain Versions for a given Domain."
        },
        {
          "info": {
            "name": "Create an NLU Domain Version.",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "{{baseUrl}}/api/v2/languageunderstanding/domains/:domainId/versions",
            "params": [
              {
                "name": "domainId",
                "value": "",
                "type": "path",
                "description": "ID of the NLU domain."
              },
              {
                "name": "includeUtterances",
                "value": "",
                "type": "query",
                "description": "Whether utterances for intent definition should be included when marshalling response."
              }
            ]
          },
          "docs": "Create an NLU Domain Version."
        }
      ]
    }
  ],
  "bundled": true
}