genesys-language-understanding

Server path: /genesys-language-understanding | Type: Application | PCID required: Yes

Tools

Tool	Description
`genesys-language-understanding_delete_domain`	Delete an NLU Domain.
`genesys-language-understanding_delete_domain_feedback_item`	Delete the feedback on the NLU Domain Version.
`genesys-language-understanding_delete_domain_version`	Delete an NLU Domain Version
`genesys-language-understanding_get_domain`	Find an NLU Domain.
`genesys-language-understanding_get_domain_feedback`	Get all feedback in the given NLU Domain Version.
`genesys-language-understanding_get_domain_feedback_item`	Find a Feedback
`genesys-language-understanding_get_domain_version`	Find an NLU Domain Version.
`genesys-language-understanding_get_domain_version_report`	Retrieved quality report for the specified NLU Domain Version
`genesys-language-understanding_get_domain_versions`	Get all NLU Domain Versions for a given Domain.
`genesys-language-understanding_get_domains`	Get all NLU Domains.
`genesys-language-understanding_get_ignorephrase`	Get list of all ignored phrases of the specified language code
`genesys-language-understanding_get_ignoretopic`	Get list of all ignored topics of the specified language code
`genesys-language-understanding_get_settings`	Get Organization Configuration
`genesys-language-understanding_patch_domain`	Update an NLU Domain.
`genesys-language-understanding_post_domain_feedback`	Create feedback for the NLU Domain Version.
`genesys-language-understanding_post_domain_version_detect`	Detect intent, entities, etc. in the submitted text using the specified NLU domain version.
`genesys-language-understanding_post_domain_version_publish`	Publish the draft NLU Domain Version.
`genesys-language-understanding_post_domain_version_train`	Train the draft NLU Domain Version.
`genesys-language-understanding_post_domain_versions`	Create an NLU Domain Version.
`genesys-language-understanding_post_domains`	Create an NLU Domain.
`genesys-language-understanding_post_ignorephrase`	Add phrases to the ignored phrases list
`genesys-language-understanding_post_ignorephrase_remove`	Delete ignored phrases
`genesys-language-understanding_post_ignoretopic`	Add topics to the ignored topics list
`genesys-language-understanding_post_ignoretopic_remove`	Delete ignored topics
`genesys-language-understanding_put_domain_version`	Update an NLU Domain Version.

genesys-language-understanding_delete_domain

Delete an NLU Domain. Parameters:

Parameter	Type	Required	Default	Description
`domainId`	string	Yes	—	ID of the NLU domain.

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "domainId": {
      "type": "string",
      "description": "ID of the NLU domain."
    }
  },
  "required": [
    "PCID",
    "domainId"
  ]
}

genesys-language-understanding_delete_domain_feedback_item

Delete the feedback on the NLU Domain Version. Parameters:

Parameter	Type	Required	Default	Description
`domainId`	string	Yes	—	ID of the NLU domain.
`feedbackId`	string	Yes	—	ID of the Feedback

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "domainId": {
      "type": "string",
      "description": "ID of the NLU domain."
    },
    "feedbackId": {
      "type": "string",
      "description": "ID of the Feedback"
    }
  },
  "required": [
    "PCID",
    "domainId",
    "feedbackId"
  ]
}

genesys-language-understanding_delete_domain_version

Delete an NLU Domain Version Parameters:

Parameter	Type	Required	Default	Description
`domainId`	string	Yes	—	ID of the NLU domain.
`domainVersionId`	string	Yes	—	ID of the NLU domain version.

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "domainId": {
      "type": "string",
      "description": "ID of the NLU domain."
    },
    "domainVersionId": {
      "type": "string",
      "description": "ID of the NLU domain version."
    }
  },
  "required": [
    "PCID",
    "domainId",
    "domainVersionId"
  ]
}

genesys-language-understanding_get_domain

Find an NLU Domain. Parameters:

Parameter	Type	Required	Default	Description
`domainId`	string	Yes	—	ID of the NLU domain.

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "domainId": {
      "type": "string",
      "description": "ID of the NLU domain."
    }
  },
  "required": [
    "PCID",
    "domainId"
  ]
}

genesys-language-understanding_get_domain_feedback

Get all feedback in the given NLU Domain Version. Parameters:

Parameter	Type	Required	Default	Description
`domainId`	string	Yes	—	ID of the NLU domain.
`intentName`	string	No	—	The top intent name to retrieve feedback for.
`assessment`	string	No	—	The top assessment to retrieve feedback for.
`dateStart`	string	No	—	Begin of time window as ISO-8601 date.
`dateEnd`	string	No	—	End of time window as ISO-8601 date.
`includeDeleted`	boolean	No	—	Whether to include soft-deleted items in the result.
`language`	string	No	—	Whether to filter response based on the language, e.g. en-us, pt-br.
`pageNumber`	integer	No	—	Page number
`pageSize`	integer	No	—	Page size
`enableCursorPagination`	boolean	No	—	Enable Cursor Pagination
`includeTrainingUtterances`	boolean	No	—	Include Training Utterances. By default they’re included.
`after`	string	No	—	The cursor that points to the end of the set of entities that has been returned. This is considered only when enableCursorPagination=true
`fields`	string[]	No	—	Fields and properties to get, comma-separated

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "domainId": {
      "type": "string",
      "description": "ID of the NLU domain."
    },
    "intentName": {
      "type": "string",
      "description": "The top intent name to retrieve feedback for."
    },
    "assessment": {
      "type": "string",
      "description": "The top assessment to retrieve feedback for.",
      "enum": [
        "Incorrect",
        "Correct",
        "Unknown",
        "Disabled"
      ]
    },
    "dateStart": {
      "type": "string",
      "description": "Begin of time window as ISO-8601 date."
    },
    "dateEnd": {
      "type": "string",
      "description": "End of time window as ISO-8601 date."
    },
    "includeDeleted": {
      "type": "boolean",
      "description": "Whether to include soft-deleted items in the result."
    },
    "language": {
      "type": "string",
      "description": "Whether to filter response based on the language, e.g. en-us, pt-br."
    },
    "pageNumber": {
      "type": "integer",
      "description": "Page number"
    },
    "pageSize": {
      "type": "integer",
      "description": "Page size"
    },
    "enableCursorPagination": {
      "type": "boolean",
      "description": "Enable Cursor Pagination"
    },
    "includeTrainingUtterances": {
      "type": "boolean",
      "description": "Include Training Utterances. By default they're included."
    },
    "after": {
      "type": "string",
      "description": "The cursor that points to the end of the set of entities that has been returned. This is considered only when enableCursorPagination=true"
    },
    "fields": {
      "type": "array",
      "items": {
        "type": "string",
        "enum": [
          "version",
          "dateCreated",
          "text",
          "intents"
        ]
      },
      "description": "Fields and properties to get, comma-separated"
    }
  },
  "required": [
    "PCID",
    "domainId"
  ]
}

genesys-language-understanding_get_domain_feedback_item

Find a Feedback Parameters:

Parameter	Type	Required	Default	Description
`domainId`	string	Yes	—	ID of the NLU domain.
`feedbackId`	string	Yes	—	ID of the Feedback
`fields`	string[]	No	—	Fields and properties to get, comma-separated

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "domainId": {
      "type": "string",
      "description": "ID of the NLU domain."
    },
    "feedbackId": {
      "type": "string",
      "description": "ID of the Feedback"
    },
    "fields": {
      "type": "array",
      "items": {
        "type": "string",
        "enum": [
          "version",
          "dateCreated",
          "text",
          "intents"
        ]
      },
      "description": "Fields and properties to get, comma-separated"
    }
  },
  "required": [
    "PCID",
    "domainId",
    "feedbackId"
  ]
}

genesys-language-understanding_get_domain_version

Find an NLU Domain Version. Parameters:

Parameter	Type	Required	Default	Description
`domainId`	string	Yes	—	ID of the NLU domain.
`domainVersionId`	string	Yes	—	ID of the NLU domain version.
`includeUtterances`	boolean	No	—	Whether utterances for intent definition should be included when marshalling response.

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "domainId": {
      "type": "string",
      "description": "ID of the NLU domain."
    },
    "domainVersionId": {
      "type": "string",
      "description": "ID of the NLU domain version."
    },
    "includeUtterances": {
      "type": "boolean",
      "description": "Whether utterances for intent definition should be included when marshalling response."
    }
  },
  "required": [
    "PCID",
    "domainId",
    "domainVersionId"
  ]
}

genesys-language-understanding_get_domain_version_report

Retrieved quality report for the specified NLU Domain Version Parameters:

Parameter	Type	Required	Default	Description
`domainId`	string	Yes	—	ID of the NLU domain.
`domainVersionId`	string	Yes	—	ID of the NLU domain version.

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "domainId": {
      "type": "string",
      "description": "ID of the NLU domain."
    },
    "domainVersionId": {
      "type": "string",
      "description": "ID of the NLU domain version."
    }
  },
  "required": [
    "PCID",
    "domainId",
    "domainVersionId"
  ]
}

genesys-language-understanding_get_domain_versions

Get all NLU Domain Versions for a given Domain. Parameters:

Parameter	Type	Required	Default	Description
`domainId`	string	Yes	—	ID of the NLU domain.
`includeUtterances`	boolean	No	—	Whether utterances for intent definition should be included when marshalling response.
`pageNumber`	integer	No	—	Page number
`pageSize`	integer	No	—	Page size

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "domainId": {
      "type": "string",
      "description": "ID of the NLU domain."
    },
    "includeUtterances": {
      "type": "boolean",
      "description": "Whether utterances for intent definition should be included when marshalling response."
    },
    "pageNumber": {
      "type": "integer",
      "description": "Page number"
    },
    "pageSize": {
      "type": "integer",
      "description": "Page size"
    }
  },
  "required": [
    "PCID",
    "domainId"
  ]
}

genesys-language-understanding_get_domains

Get all NLU Domains. Parameters:

Parameter	Type	Required	Default	Description
`pageNumber`	integer	No	—	Page number
`pageSize`	integer	No	—	Page size

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "pageNumber": {
      "type": "integer",
      "description": "Page number"
    },
    "pageSize": {
      "type": "integer",
      "description": "Page size"
    }
  },
  "required": [
    "PCID"
  ]
}

genesys-language-understanding_get_ignorephrase

Get list of all ignored phrases of the specified language code Parameters:

Parameter	Type	Required	Default	Description
`languageCode`	string	Yes	—	Language Code
`pageSize`	integer	No	—	The page size for the listing. The max that will be returned is 200.
`pageNumber`	integer	No	—	The page number for the listing
`text`	string	No	—	The phrase text filter applied to the listing
`sortOrder`	string	No	—	The sort order for the listing
`sortBy`	string	No	—	The field to sort by for the listing

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "languageCode": {
      "type": "string",
      "description": "Language Code"
    },
    "pageSize": {
      "type": "integer",
      "description": "The page size for the listing. The max that will be returned is 200."
    },
    "pageNumber": {
      "type": "integer",
      "description": "The page number for the listing"
    },
    "text": {
      "type": "string",
      "description": "The phrase text filter applied to the listing"
    },
    "sortOrder": {
      "type": "string",
      "description": "The sort order for the listing",
      "enum": [
        "asc",
        "desc"
      ]
    },
    "sortBy": {
      "type": "string",
      "description": "The field to sort by for the listing",
      "enum": [
        "dateModified",
        "text"
      ]
    }
  },
  "required": [
    "PCID",
    "languageCode"
  ]
}

genesys-language-understanding_get_ignoretopic

Get list of all ignored topics of the specified language code Parameters:

Parameter	Type	Required	Default	Description
`languageCode`	string	Yes	—	Language Code
`pageSize`	integer	No	—	The page size for the listing. The max that will be returned is 200.
`pageNumber`	integer	No	—	The page number for the listing
`text`	string	No	—	The topic text filter applied to the listing
`sortOrder`	string	No	—	The sort order for the listing
`sortBy`	string	No	—	The field to sort by for the listing

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "languageCode": {
      "type": "string",
      "description": "Language Code"
    },
    "pageSize": {
      "type": "integer",
      "description": "The page size for the listing. The max that will be returned is 200."
    },
    "pageNumber": {
      "type": "integer",
      "description": "The page number for the listing"
    },
    "text": {
      "type": "string",
      "description": "The topic text filter applied to the listing"
    },
    "sortOrder": {
      "type": "string",
      "description": "The sort order for the listing",
      "enum": [
        "asc",
        "desc"
      ]
    },
    "sortBy": {
      "type": "string",
      "description": "The field to sort by for the listing",
      "enum": [
        "dateModified",
        "text"
      ]
    }
  },
  "required": [
    "PCID",
    "languageCode"
  ]
}

genesys-language-understanding_get_settings

Get Organization Configuration

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    }
  },
  "required": [
    "PCID"
  ]
}

genesys-language-understanding_patch_domain

Update an NLU Domain. Parameters:

Parameter	Type	Required	Default	Description
`domainId`	string	Yes	—	ID of the NLU domain.
`dateCreated`	string	No	—	The date when the NLU domain was created. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z
`dateModified`	string	No	—	The date when the NLU domain was updated. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z
`draftVersion`	object	No	—	Draft Version
`engineVersion`	string	No	—	The version of the NLU engine to use.
`id`	string	No	—	The globally unique identifier for the object.
`language`	string	No	—	The language culture of the NLU domain, e.g. `en-us`, `de-de`.
`lastPublishedVersion`	object	No	—	Last Published Version
`name`	string	No	—	The name of the NLU domain.
`selfUri`	string	No	—	The URI for this object

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "domainId": {
      "type": "string",
      "description": "ID of the NLU domain."
    },
    "dateCreated": {
      "type": "string",
      "description": "The date when the NLU domain was created. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"
    },
    "dateModified": {
      "type": "string",
      "description": "The date when the NLU domain was updated. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"
    },
    "draftVersion": {
      "type": "object",
      "description": "Draft Version",
      "properties": {
        "id": {
          "type": "string",
          "description": "The globally unique identifier for the object."
        },
        "domain": {
          "type": "object",
          "description": "Circular schema reference: #/components/schemas/NluDomain"
        },
        "intents": {
          "type": "array",
          "items": {
            "type": "object"
          },
          "description": "The intents defined for this NLU domain version."
        },
        "selfUri": {
          "type": "string",
          "description": "The URI for this object"
        }
      }
    },
    "engineVersion": {
      "type": "string",
      "description": "The version of the NLU engine to use."
    },
    "id": {
      "type": "string",
      "description": "The globally unique identifier for the object."
    },
    "language": {
      "type": "string",
      "description": "The language culture of the NLU domain, e.g. `en-us`, `de-de`."
    },
    "lastPublishedVersion": {
      "type": "object",
      "description": "Last Published Version",
      "properties": {
        "id": {
          "type": "string",
          "description": "The globally unique identifier for the object."
        },
        "domain": {
          "type": "object",
          "description": "Circular schema reference: #/components/schemas/NluDomain"
        },
        "intents": {
          "type": "array",
          "items": {
            "type": "object"
          },
          "description": "The intents defined for this NLU domain version."
        },
        "selfUri": {
          "type": "string",
          "description": "The URI for this object"
        }
      }
    },
    "name": {
      "type": "string",
      "description": "The name of the NLU domain."
    },
    "selfUri": {
      "type": "string",
      "description": "The URI for this object"
    }
  },
  "required": [
    "PCID",
    "domainId"
  ]
}

genesys-language-understanding_post_domain_feedback

Create feedback for the NLU Domain Version. Parameters:

Parameter	Type	Required	Default	Description
`domainId`	string	Yes	—	ID of the NLU domain.
`intents`	object[]	Yes	—	Detected intent of the utterance
`language`	string	No	—	The language of the version to which feedback is linked, e.g. en-us, de-de
`text`	string	Yes	—	The feedback text.
`versionId`	string	Yes	—	The domain version ID of the feedback.

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "domainId": {
      "type": "string",
      "description": "ID of the NLU domain."
    },
    "intents": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "name": {
            "type": "string",
            "description": "The name of the detected intent."
          },
          "probability": {
            "type": "number",
            "format": "double",
            "description": "The probability of the detected intent."
          },
          "entities": {
            "type": "array",
            "items": {
              "type": "object",
              "properties": {
                "name": {
                  "type": "string",
                  "description": "The name of the detected named entity."
                },
                "entityType": {
                  "type": "string",
                  "description": "The type of the detected named entity."
                },
                "probability": {
                  "type": "number",
                  "description": "The probability of the detected named entity."
                },
                "value": {
                  "type": "object"
                }
              }
            },
            "description": "The collection of named entities detected."
          },
          "assessment": {
            "type": "string",
            "enum": [
              "Incorrect",
              "Correct",
              "Unknown",
              "Disabled"
            ],
            "description": "The assessment on the detection for feedback text."
          }
        }
      },
      "description": "Detected intent of the utterance"
    },
    "language": {
      "type": "string",
      "description": "The language of the version to which feedback is linked, e.g. en-us, de-de"
    },
    "text": {
      "type": "string",
      "description": "The feedback text."
    },
    "versionId": {
      "type": "string",
      "description": "The domain version ID of the feedback."
    }
  },
  "required": [
    "PCID",
    "domainId",
    "intents",
    "text",
    "versionId"
  ]
}

genesys-language-understanding_post_domain_version_detect

Detect intent, entities, etc. in the submitted text using the specified NLU domain version. Parameters:

Parameter	Type	Required	Default	Description
`domainId`	string	Yes	—	ID of the NLU domain.
`domainVersionId`	string	Yes	—	ID of the NLU domain version.
`context`	object	No	—	The context value
`input`	object	Yes	—	The input value

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "domainId": {
      "type": "string",
      "description": "ID of the NLU domain."
    },
    "domainVersionId": {
      "type": "string",
      "description": "ID of the NLU domain version."
    },
    "context": {
      "type": "object",
      "description": "The context value",
      "properties": {
        "intent": {
          "type": "object",
          "description": "The intent value"
        },
        "entity": {
          "type": "object",
          "description": "The entity value"
        }
      }
    },
    "input": {
      "type": "object",
      "description": "The input value",
      "properties": {
        "text": {
          "type": "string",
          "description": "The text to perform NLU detection on."
        },
        "language": {
          "type": "string",
          "description": "Language of the version for multilingual detection, e.g. `en-us`, `de-de`"
        }
      },
      "required": [
        "text"
      ]
    }
  },
  "required": [
    "PCID",
    "domainId",
    "domainVersionId",
    "input"
  ]
}

genesys-language-understanding_post_domain_version_publish

Publish the draft NLU Domain Version. Parameters:

Parameter	Type	Required	Default	Description
`domainId`	string	Yes	—	ID of the NLU domain.
`domainVersionId`	string	Yes	—	ID of the NLU domain version.

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "domainId": {
      "type": "string",
      "description": "ID of the NLU domain."
    },
    "domainVersionId": {
      "type": "string",
      "description": "ID of the NLU domain version."
    }
  },
  "required": [
    "PCID",
    "domainId",
    "domainVersionId"
  ]
}

genesys-language-understanding_post_domain_version_train

Train the draft NLU Domain Version. Parameters:

Parameter	Type	Required	Default	Description
`domainId`	string	Yes	—	ID of the NLU domain.
`domainVersionId`	string	Yes	—	ID of the NLU domain version.

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "domainId": {
      "type": "string",
      "description": "ID of the NLU domain."
    },
    "domainVersionId": {
      "type": "string",
      "description": "ID of the NLU domain version."
    }
  },
  "required": [
    "PCID",
    "domainId",
    "domainVersionId"
  ]
}

genesys-language-understanding_post_domain_versions

Create an NLU Domain Version. Parameters:

Parameter	Type	Required	Default	Description
`domainId`	string	Yes	—	ID of the NLU domain.
`includeUtterances`	boolean	No	—	Whether utterances for intent definition should be included when marshalling response.
`dateCreated`	string	No	—	The date when the NLU domain version was created. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z
`dateModified`	string	No	—	The date when the NLU domain version was updated. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z
`datePublished`	string	No	—	The date when the NLU domain version was published. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z
`dateTrained`	string	No	—	The date when the NLU domain version was trained. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z
`description`	string	No	—	The description of the NLU domain version.
`domain`	object	No	—	The domain value
`entities`	object[]	No	—	The entities defined for this NLU domain version.This field is mutually exclusive with entityTypeBindings
`entityTypes`	object[]	No	—	The entity types defined for this NLU domain version.
`evaluationStatus`	string	No	—	The evaluation status of the NLU domain version.
`id`	string	No	—	The globally unique identifier for the object.
`intents`	object[]	No	—	The intents defined for this NLU domain version.
`language`	string	Yes	—	The language that the NLU domain version supports.
`languageVersions`	object	No	—	Map of language code to NLU domain version UUID for multilingual domains.
`published`	boolean	No	—	Whether this NLU domain version has been published.
`selfUri`	string	No	—	The URI for this object
`trainingStatus`	string	No	—	The training status of the NLU domain version.

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "domainId": {
      "type": "string",
      "description": "ID of the NLU domain."
    },
    "includeUtterances": {
      "type": "boolean",
      "description": "Whether utterances for intent definition should be included when marshalling response."
    },
    "dateCreated": {
      "type": "string",
      "description": "The date when the NLU domain version was created. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"
    },
    "dateModified": {
      "type": "string",
      "description": "The date when the NLU domain version was updated. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"
    },
    "datePublished": {
      "type": "string",
      "description": "The date when the NLU domain version was published. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"
    },
    "dateTrained": {
      "type": "string",
      "description": "The date when the NLU domain version was trained. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"
    },
    "description": {
      "type": "string",
      "description": "The description of the NLU domain version."
    },
    "domain": {
      "type": "object",
      "description": "The domain value",
      "properties": {
        "id": {
          "type": "string",
          "description": "The globally unique identifier for the object."
        },
        "name": {
          "type": "string",
          "description": "The name of the NLU domain."
        },
        "language": {
          "type": "string",
          "description": "The language culture of the NLU domain, e.g. `en-us`, `de-de`."
        },
        "draftVersion": {
          "type": "object",
          "description": "Draft Version"
        },
        "lastPublishedVersion": {
          "type": "object",
          "description": "Last Published Version"
        },
        "dateCreated": {
          "type": "string",
          "description": "The date when the NLU domain was created. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"
        },
        "dateModified": {
          "type": "string",
          "description": "The date when the NLU domain was updated. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"
        },
        "engineVersion": {
          "type": "string",
          "description": "The version of the NLU engine to use."
        },
        "selfUri": {
          "type": "string",
          "description": "The URI for this object"
        }
      },
      "required": [
        "name"
      ]
    },
    "entities": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "name": {
            "type": "string",
            "description": "The name of the entity."
          },
          "type": {
            "type": "string",
            "description": "The name of the entity type."
          }
        },
        "required": [
          "name",
          "type"
        ]
      },
      "description": "The entities defined for this NLU domain version.This field is mutually exclusive with entityTypeBindings"
    },
    "entityTypes": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "name": {
            "type": "string",
            "description": "The name of the entity type."
          },
          "description": {
            "type": "string",
            "description": "Description of the of the named entity type."
          },
          "mechanism": {
            "type": "object",
            "description": "The mechanism value"
          }
        },
        "required": [
          "mechanism",
          "name"
        ]
      },
      "description": "The entity types defined for this NLU domain version."
    },
    "evaluationStatus": {
      "type": "string",
      "description": "The evaluation status of the NLU domain version.",
      "enum": [
        "Unevaluated",
        "Evaluating",
        "Evaluated",
        "Error"
      ]
    },
    "id": {
      "type": "string",
      "description": "The globally unique identifier for the object."
    },
    "intents": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "id": {
            "type": "string",
            "description": "ID of the intent."
          },
          "name": {
            "type": "string",
            "description": "The name of the intent."
          },
          "description": {
            "type": "string",
            "description": "The description of the intent."
          },
          "entityTypeBindings": {
            "type": "array",
            "items": {
              "type": "object",
              "properties": {
                "entityType": {
                  "type": "string",
                  "description": "The named entity type of the binding. It can be a built-in one such as builtin:number or a custom entity type such as BeverageType."
                },
                "entityName": {
                  "type": "string",
                  "description": "The name that this named entity type is bound to."
                }
              }
            },
            "description": "The bindings for the named entity types used in this intent.This field is mutually exclusive with entityNameReferences and entities"
          },
          "entityNameReferences": {
            "type": "array",
            "items": {
              "type": "string"
            },
            "description": "The references for the named entity used in this intent.This field is mutually exclusive with entityTypeBindings"
          },
          "utterances": {
            "type": "array",
            "items": {
              "type": "object",
              "properties": {
                "id": {
                  "type": "string",
                  "description": "ID of the utterance."
                },
                "source": {
                  "type": "string",
                  "description": "The source of the utterance."
                },
                "segments": {
                  "type": "array",
                  "description": "The list of segments that that constitute this utterance for the given intent."
                }
              }
            },
            "description": "The utterances that act as training phrases for the intent."
          },
          "additionalLanguages": {
            "type": "object",
            "description": "Additional languages for intents"
          }
        },
        "required": [
          "name",
          "utterances"
        ]
      },
      "description": "The intents defined for this NLU domain version."
    },
    "language": {
      "type": "string",
      "description": "The language that the NLU domain version supports."
    },
    "languageVersions": {
      "type": "object",
      "description": "Map of language code to NLU domain version UUID for multilingual domains."
    },
    "published": {
      "type": "boolean",
      "description": "Whether this NLU domain version has been published."
    },
    "selfUri": {
      "type": "string",
      "description": "The URI for this object"
    },
    "trainingStatus": {
      "type": "string",
      "description": "The training status of the NLU domain version.",
      "enum": [
        "Untrained",
        "Training",
        "Trained",
        "Error",
        "Unknown"
      ]
    }
  },
  "required": [
    "PCID",
    "domainId",
    "language"
  ]
}

genesys-language-understanding_post_domains

Create an NLU Domain. Parameters:

Parameter	Type	Required	Default	Description
`dateCreated`	string	No	—	The date when the NLU domain was created. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z
`dateModified`	string	No	—	The date when the NLU domain was updated. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z
`draftVersion`	object	No	—	Draft Version
`engineVersion`	string	No	—	The version of the NLU engine to use.
`id`	string	No	—	The globally unique identifier for the object.
`language`	string	No	—	The language culture of the NLU domain, e.g. `en-us`, `de-de`.
`lastPublishedVersion`	object	No	—	Last Published Version
`name`	string	Yes	—	The name of the NLU domain.
`selfUri`	string	No	—	The URI for this object

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "dateCreated": {
      "type": "string",
      "description": "The date when the NLU domain was created. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"
    },
    "dateModified": {
      "type": "string",
      "description": "The date when the NLU domain was updated. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"
    },
    "draftVersion": {
      "type": "object",
      "description": "Draft Version",
      "properties": {
        "id": {
          "type": "string",
          "description": "The globally unique identifier for the object."
        },
        "domain": {
          "type": "object",
          "description": "Circular schema reference: #/components/schemas/NluDomain"
        },
        "intents": {
          "type": "array",
          "items": {
            "type": "object"
          },
          "description": "The intents defined for this NLU domain version."
        },
        "selfUri": {
          "type": "string",
          "description": "The URI for this object"
        }
      }
    },
    "engineVersion": {
      "type": "string",
      "description": "The version of the NLU engine to use."
    },
    "id": {
      "type": "string",
      "description": "The globally unique identifier for the object."
    },
    "language": {
      "type": "string",
      "description": "The language culture of the NLU domain, e.g. `en-us`, `de-de`."
    },
    "lastPublishedVersion": {
      "type": "object",
      "description": "Last Published Version",
      "properties": {
        "id": {
          "type": "string",
          "description": "The globally unique identifier for the object."
        },
        "domain": {
          "type": "object",
          "description": "Circular schema reference: #/components/schemas/NluDomain"
        },
        "intents": {
          "type": "array",
          "items": {
            "type": "object"
          },
          "description": "The intents defined for this NLU domain version."
        },
        "selfUri": {
          "type": "string",
          "description": "The URI for this object"
        }
      }
    },
    "name": {
      "type": "string",
      "description": "The name of the NLU domain."
    },
    "selfUri": {
      "type": "string",
      "description": "The URI for this object"
    }
  },
  "required": [
    "PCID",
    "name"
  ]
}

genesys-language-understanding_post_ignorephrase

Add phrases to the ignored phrases list Parameters:

Parameter	Type	Required	Default	Description
`languageCode`	string	Yes	—	Language Code
`phrases`	object[]	Yes	—	List of phrases to be ignored

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "languageCode": {
      "type": "string",
      "description": "Language Code"
    },
    "phrases": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "text": {
            "type": "string",
            "description": "Text of the phrase to be ignored"
          },
          "participant": {
            "type": "string",
            "enum": [
              "Customer",
              "Agent",
              "Both"
            ],
            "description": "Type of participant"
          },
          "mediaType": {
            "type": "string",
            "enum": [
              "Chat",
              "Call",
              "Message",
              "Email"
            ],
            "description": "Media Type for the entity (Optional)"
          }
        },
        "required": [
          "participant",
          "text"
        ]
      },
      "description": "List of phrases to be ignored"
    }
  },
  "required": [
    "PCID",
    "languageCode",
    "phrases"
  ]
}

genesys-language-understanding_post_ignorephrase_remove

Delete ignored phrases Parameters:

Parameter	Type	Required	Default	Description
`languageCode`	string	Yes	—	Language Code
`entities`	object[]	Yes	—	List of entities to be removed

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "languageCode": {
      "type": "string",
      "description": "Language Code"
    },
    "entities": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "id": {
            "type": "string",
            "description": "Unique identifier of the entity to be removed"
          }
        },
        "required": [
          "id"
        ]
      },
      "description": "List of entities to be removed"
    }
  },
  "required": [
    "PCID",
    "languageCode",
    "entities"
  ]
}

genesys-language-understanding_post_ignoretopic

Add topics to the ignored topics list Parameters:

Parameter	Type	Required	Default	Description
`languageCode`	string	Yes	—	Language Code
`topics`	object[]	Yes	—	List of topics to be ignored

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "languageCode": {
      "type": "string",
      "description": "Language Code"
    },
    "topics": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "text": {
            "type": "string",
            "description": "Text of the topic to be ignored"
          },
          "participant": {
            "type": "string",
            "enum": [
              "Customer",
              "Agent",
              "Both"
            ],
            "description": "Type of participant"
          },
          "mediaType": {
            "type": "string",
            "enum": [
              "Chat",
              "Call",
              "Message",
              "Email"
            ],
            "description": "Media Type for the entity (Optional)"
          }
        },
        "required": [
          "participant",
          "text"
        ]
      },
      "description": "List of topics to be ignored"
    }
  },
  "required": [
    "PCID",
    "languageCode",
    "topics"
  ]
}

genesys-language-understanding_post_ignoretopic_remove

Delete ignored topics Parameters:

Parameter	Type	Required	Default	Description
`languageCode`	string	Yes	—	Language Code
`entities`	object[]	Yes	—	List of entities to be removed

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "languageCode": {
      "type": "string",
      "description": "Language Code"
    },
    "entities": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "id": {
            "type": "string",
            "description": "Unique identifier of the entity to be removed"
          }
        },
        "required": [
          "id"
        ]
      },
      "description": "List of entities to be removed"
    }
  },
  "required": [
    "PCID",
    "languageCode",
    "entities"
  ]
}

genesys-language-understanding_put_domain_version

Update an NLU Domain Version. Parameters:

Parameter	Type	Required	Default	Description
`domainId`	string	Yes	—	ID of the NLU domain.
`domainVersionId`	string	Yes	—	ID of the NLU domain version.
`dateCreated`	string	No	—	The date when the NLU domain version was created. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z
`dateModified`	string	No	—	The date when the NLU domain version was updated. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z
`datePublished`	string	No	—	The date when the NLU domain version was published. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z
`dateTrained`	string	No	—	The date when the NLU domain version was trained. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z
`description`	string	No	—	The description of the NLU domain version.
`domain`	object	No	—	The domain value
`entities`	object[]	No	—	The entities defined for this NLU domain version.This field is mutually exclusive with entityTypeBindings
`entityTypes`	object[]	No	—	The entity types defined for this NLU domain version.
`evaluationStatus`	string	No	—	The evaluation status of the NLU domain version.
`id`	string	No	—	The globally unique identifier for the object.
`intents`	object[]	No	—	The intents defined for this NLU domain version.
`language`	string	No	—	The language that the NLU domain version supports.
`languageVersions`	object	No	—	Map of language code to NLU domain version UUID for multilingual domains.
`published`	boolean	No	—	Whether this NLU domain version has been published.
`selfUri`	string	No	—	The URI for this object
`trainingStatus`	string	No	—	The training status of the NLU domain version.

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "domainId": {
      "type": "string",
      "description": "ID of the NLU domain."
    },
    "domainVersionId": {
      "type": "string",
      "description": "ID of the NLU domain version."
    },
    "dateCreated": {
      "type": "string",
      "description": "The date when the NLU domain version was created. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"
    },
    "dateModified": {
      "type": "string",
      "description": "The date when the NLU domain version was updated. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"
    },
    "datePublished": {
      "type": "string",
      "description": "The date when the NLU domain version was published. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"
    },
    "dateTrained": {
      "type": "string",
      "description": "The date when the NLU domain version was trained. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"
    },
    "description": {
      "type": "string",
      "description": "The description of the NLU domain version."
    },
    "domain": {
      "type": "object",
      "description": "The domain value",
      "properties": {
        "id": {
          "type": "string",
          "description": "The globally unique identifier for the object."
        },
        "name": {
          "type": "string",
          "description": "The name of the NLU domain."
        },
        "language": {
          "type": "string",
          "description": "The language culture of the NLU domain, e.g. `en-us`, `de-de`."
        },
        "draftVersion": {
          "type": "object",
          "description": "Draft Version"
        },
        "lastPublishedVersion": {
          "type": "object",
          "description": "Last Published Version"
        },
        "dateCreated": {
          "type": "string",
          "description": "The date when the NLU domain was created. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"
        },
        "dateModified": {
          "type": "string",
          "description": "The date when the NLU domain was updated. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"
        },
        "engineVersion": {
          "type": "string",
          "description": "The version of the NLU engine to use."
        },
        "selfUri": {
          "type": "string",
          "description": "The URI for this object"
        }
      },
      "required": [
        "name"
      ]
    },
    "entities": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "name": {
            "type": "string",
            "description": "The name of the entity."
          },
          "type": {
            "type": "string",
            "description": "The name of the entity type."
          }
        },
        "required": [
          "name",
          "type"
        ]
      },
      "description": "The entities defined for this NLU domain version.This field is mutually exclusive with entityTypeBindings"
    },
    "entityTypes": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "name": {
            "type": "string",
            "description": "The name of the entity type."
          },
          "description": {
            "type": "string",
            "description": "Description of the of the named entity type."
          },
          "mechanism": {
            "type": "object",
            "description": "The mechanism value"
          }
        },
        "required": [
          "mechanism",
          "name"
        ]
      },
      "description": "The entity types defined for this NLU domain version."
    },
    "evaluationStatus": {
      "type": "string",
      "description": "The evaluation status of the NLU domain version.",
      "enum": [
        "Unevaluated",
        "Evaluating",
        "Evaluated",
        "Error"
      ]
    },
    "id": {
      "type": "string",
      "description": "The globally unique identifier for the object."
    },
    "intents": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "id": {
            "type": "string",
            "description": "ID of the intent."
          },
          "name": {
            "type": "string",
            "description": "The name of the intent."
          },
          "description": {
            "type": "string",
            "description": "The description of the intent."
          },
          "entityTypeBindings": {
            "type": "array",
            "items": {
              "type": "object",
              "properties": {
                "entityType": {
                  "type": "string",
                  "description": "The named entity type of the binding. It can be a built-in one such as builtin:number or a custom entity type such as BeverageType."
                },
                "entityName": {
                  "type": "string",
                  "description": "The name that this named entity type is bound to."
                }
              }
            },
            "description": "The bindings for the named entity types used in this intent.This field is mutually exclusive with entityNameReferences and entities"
          },
          "entityNameReferences": {
            "type": "array",
            "items": {
              "type": "string"
            },
            "description": "The references for the named entity used in this intent.This field is mutually exclusive with entityTypeBindings"
          },
          "utterances": {
            "type": "array",
            "items": {
              "type": "object",
              "properties": {
                "id": {
                  "type": "string",
                  "description": "ID of the utterance."
                },
                "source": {
                  "type": "string",
                  "description": "The source of the utterance."
                },
                "segments": {
                  "type": "array",
                  "description": "The list of segments that that constitute this utterance for the given intent."
                }
              }
            },
            "description": "The utterances that act as training phrases for the intent."
          },
          "additionalLanguages": {
            "type": "object",
            "description": "Additional languages for intents"
          }
        },
        "required": [
          "name",
          "utterances"
        ]
      },
      "description": "The intents defined for this NLU domain version."
    },
    "language": {
      "type": "string",
      "description": "The language that the NLU domain version supports."
    },
    "languageVersions": {
      "type": "object",
      "description": "Map of language code to NLU domain version UUID for multilingual domains."
    },
    "published": {
      "type": "boolean",
      "description": "Whether this NLU domain version has been published."
    },
    "selfUri": {
      "type": "string",
      "description": "The URI for this object"
    },
    "trainingStatus": {
      "type": "string",
      "description": "The training status of the NLU domain version.",
      "enum": [
        "Untrained",
        "Training",
        "Trained",
        "Error",
        "Unknown"
      ]
    }
  },
  "required": [
    "PCID",
    "domainId",
    "domainVersionId"
  ]
}

Platform API

Embedded MCP Servers

Application MCP Servers

Triggers API

Tools

genesys-language-understanding_delete_domain

genesys-language-understanding_delete_domain_feedback_item

genesys-language-understanding_delete_domain_version

genesys-language-understanding_get_domain

genesys-language-understanding_get_domain_feedback

genesys-language-understanding_get_domain_feedback_item

genesys-language-understanding_get_domain_version

genesys-language-understanding_get_domain_version_report

genesys-language-understanding_get_domain_versions

genesys-language-understanding_get_domains

genesys-language-understanding_get_ignorephrase

genesys-language-understanding_get_ignoretopic

genesys-language-understanding_get_settings

genesys-language-understanding_patch_domain

genesys-language-understanding_post_domain_feedback

genesys-language-understanding_post_domain_version_detect

genesys-language-understanding_post_domain_version_publish

genesys-language-understanding_post_domain_version_train

genesys-language-understanding_post_domain_versions

genesys-language-understanding_post_domains

genesys-language-understanding_post_ignorephrase

genesys-language-understanding_post_ignorephrase_remove

genesys-language-understanding_post_ignoretopic

genesys-language-understanding_post_ignoretopic_remove

genesys-language-understanding_put_domain_version

​Tools

​genesys-language-understanding_delete_domain

​genesys-language-understanding_delete_domain_feedback_item

​genesys-language-understanding_delete_domain_version

​genesys-language-understanding_get_domain

​genesys-language-understanding_get_domain_feedback

​genesys-language-understanding_get_domain_feedback_item

​genesys-language-understanding_get_domain_version

​genesys-language-understanding_get_domain_version_report

​genesys-language-understanding_get_domain_versions

​genesys-language-understanding_get_domains

​genesys-language-understanding_get_ignorephrase

​genesys-language-understanding_get_ignoretopic

​genesys-language-understanding_get_settings

​genesys-language-understanding_patch_domain

​genesys-language-understanding_post_domain_feedback

​genesys-language-understanding_post_domain_version_detect

​genesys-language-understanding_post_domain_version_publish

​genesys-language-understanding_post_domain_version_train

​genesys-language-understanding_post_domain_versions

​genesys-language-understanding_post_domains

​genesys-language-understanding_post_ignorephrase

​genesys-language-understanding_post_ignorephrase_remove

​genesys-language-understanding_post_ignoretopic

​genesys-language-understanding_post_ignoretopic_remove

​genesys-language-understanding_put_domain_version

Tools

genesys-language-understanding_delete_domain

genesys-language-understanding_delete_domain_feedback_item

genesys-language-understanding_delete_domain_version

genesys-language-understanding_get_domain

genesys-language-understanding_get_domain_feedback

genesys-language-understanding_get_domain_feedback_item

genesys-language-understanding_get_domain_version

genesys-language-understanding_get_domain_version_report

genesys-language-understanding_get_domain_versions

genesys-language-understanding_get_domains

genesys-language-understanding_get_ignorephrase

genesys-language-understanding_get_ignoretopic

genesys-language-understanding_get_settings

genesys-language-understanding_patch_domain

genesys-language-understanding_post_domain_feedback

genesys-language-understanding_post_domain_version_detect

genesys-language-understanding_post_domain_version_publish

genesys-language-understanding_post_domain_version_train

genesys-language-understanding_post_domain_versions

genesys-language-understanding_post_domains

genesys-language-understanding_post_ignorephrase

genesys-language-understanding_post_ignorephrase_remove

genesys-language-understanding_post_ignoretopic

genesys-language-understanding_post_ignoretopic_remove

genesys-language-understanding_put_domain_version