Package com.mypurecloud.sdk.v2.api

Class LanguageUnderstandingApi

java.lang.Object
com.mypurecloud.sdk.v2.api.LanguageUnderstandingApi
public class LanguageUnderstandingApi extends Object

  • Constructor Details

    • LanguageUnderstandingApi

      public LanguageUnderstandingApi()

    • LanguageUnderstandingApi

      public LanguageUnderstandingApi(ApiClient apiClient)

  • Method Details

    • deleteLanguageunderstandingDomain

      public void deleteLanguageunderstandingDomain(String domainId) throws IOException, ApiException
      Delete an NLU Domain.
      Parameters:
      domainId - ID of the NLU domain. (required)
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • deleteLanguageunderstandingDomainWithHttpInfo

      public ApiResponse<Void> deleteLanguageunderstandingDomainWithHttpInfo(String domainId) throws IOException
      Delete an NLU Domain.
      Parameters:
      domainId - ID of the NLU domain. (required)
      Throws:
      IOException - if the request fails to be processed

    • deleteLanguageunderstandingDomain

      public void deleteLanguageunderstandingDomain(DeleteLanguageunderstandingDomainRequest request) throws IOException, ApiException
      Delete an NLU Domain.
      Parameters:
      request - The request object
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • deleteLanguageunderstandingDomain

      public ApiResponse<Void> deleteLanguageunderstandingDomain(ApiRequest<Void> request) throws IOException
      Delete an NLU Domain.
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed

    • deleteLanguageunderstandingDomainFeedbackFeedbackId

      public void deleteLanguageunderstandingDomainFeedbackFeedbackId(String domainId, String feedbackId) throws IOException, ApiException
      Delete the feedback on the NLU Domain Version.
      Parameters:
      domainId - ID of the NLU domain. (required)
      feedbackId - ID of the Feedback (required)
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • deleteLanguageunderstandingDomainFeedbackFeedbackIdWithHttpInfo

      public ApiResponse<Void> deleteLanguageunderstandingDomainFeedbackFeedbackIdWithHttpInfo(String domainId, String feedbackId) throws IOException
      Delete the feedback on the NLU Domain Version.
      Parameters:
      domainId - ID of the NLU domain. (required)
      feedbackId - ID of the Feedback (required)
      Throws:
      IOException - if the request fails to be processed

    • deleteLanguageunderstandingDomainFeedbackFeedbackId

      public void deleteLanguageunderstandingDomainFeedbackFeedbackId(DeleteLanguageunderstandingDomainFeedbackFeedbackIdRequest request) throws IOException, ApiException
      Delete the feedback on the NLU Domain Version.
      Parameters:
      request - The request object
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • deleteLanguageunderstandingDomainFeedbackFeedbackId

      public ApiResponse<Void> deleteLanguageunderstandingDomainFeedbackFeedbackId(ApiRequest<Void> request) throws IOException
      Delete the feedback on the NLU Domain Version.
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed

    • deleteLanguageunderstandingDomainVersion

      public void deleteLanguageunderstandingDomainVersion(String domainId, String domainVersionId) throws IOException, ApiException
      Delete an NLU Domain Version
      Parameters:
      domainId - ID of the NLU domain. (required)
      domainVersionId - ID of the NLU domain version. (required)
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • deleteLanguageunderstandingDomainVersionWithHttpInfo

      public ApiResponse<Void> deleteLanguageunderstandingDomainVersionWithHttpInfo(String domainId, String domainVersionId) throws IOException
      Delete an NLU Domain Version
      Parameters:
      domainId - ID of the NLU domain. (required)
      domainVersionId - ID of the NLU domain version. (required)
      Throws:
      IOException - if the request fails to be processed

    • deleteLanguageunderstandingDomainVersion

      public void deleteLanguageunderstandingDomainVersion(DeleteLanguageunderstandingDomainVersionRequest request) throws IOException, ApiException
      Delete an NLU Domain Version
      Parameters:
      request - The request object
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • deleteLanguageunderstandingDomainVersion

      public ApiResponse<Void> deleteLanguageunderstandingDomainVersion(ApiRequest<Void> request) throws IOException
      Delete an NLU Domain Version
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed

    • deleteLanguageunderstandingMiner

      public void deleteLanguageunderstandingMiner(String minerId) throws IOException, ApiException
      Delete a miner.
      Parameters:
      minerId - Miner ID (required)
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • deleteLanguageunderstandingMinerWithHttpInfo

      public ApiResponse<Void> deleteLanguageunderstandingMinerWithHttpInfo(String minerId) throws IOException
      Delete a miner.
      Parameters:
      minerId - Miner ID (required)
      Throws:
      IOException - if the request fails to be processed

    • deleteLanguageunderstandingMiner

      public void deleteLanguageunderstandingMiner(DeleteLanguageunderstandingMinerRequest request) throws IOException, ApiException
      Delete a miner.
      Parameters:
      request - The request object
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • deleteLanguageunderstandingMiner

      public ApiResponse<Void> deleteLanguageunderstandingMiner(ApiRequest<Void> request) throws IOException
      Delete a miner.
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed

    • deleteLanguageunderstandingMinerDraft

      public void deleteLanguageunderstandingMinerDraft(String minerId, String draftId) throws IOException, ApiException
      Delete a draft
      Parameters:
      minerId - Miner ID (required)
      draftId - Draft ID (required)
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • deleteLanguageunderstandingMinerDraftWithHttpInfo

      public ApiResponse<Void> deleteLanguageunderstandingMinerDraftWithHttpInfo(String minerId, String draftId) throws IOException
      Delete a draft
      Parameters:
      minerId - Miner ID (required)
      draftId - Draft ID (required)
      Throws:
      IOException - if the request fails to be processed

    • deleteLanguageunderstandingMinerDraft

      public void deleteLanguageunderstandingMinerDraft(DeleteLanguageunderstandingMinerDraftRequest request) throws IOException, ApiException
      Delete a draft
      Parameters:
      request - The request object
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • deleteLanguageunderstandingMinerDraft

      public ApiResponse<Void> deleteLanguageunderstandingMinerDraft(ApiRequest<Void> request) throws IOException
      Delete a draft
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed

    • getLanguageunderstandingDomain

      public NluDomain getLanguageunderstandingDomain(String domainId) throws IOException, ApiException
      Find an NLU Domain.
      Parameters:
      domainId - ID of the NLU domain. (required)
      Returns:
      NluDomain
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • getLanguageunderstandingDomainWithHttpInfo

      public ApiResponse<NluDomain> getLanguageunderstandingDomainWithHttpInfo(String domainId) throws IOException
      Find an NLU Domain.
      Parameters:
      domainId - ID of the NLU domain. (required)
      Returns:
      NluDomain
      Throws:
      IOException - if the request fails to be processed

    • getLanguageunderstandingDomain

      public NluDomain getLanguageunderstandingDomain(GetLanguageunderstandingDomainRequest request) throws IOException, ApiException
      Find an NLU Domain.
      Parameters:
      request - The request object
      Returns:
      NluDomain
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • getLanguageunderstandingDomain

      public ApiResponse<NluDomain> getLanguageunderstandingDomain(ApiRequest<Void> request) throws IOException
      Find an NLU Domain.
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed

    • getLanguageunderstandingDomainFeedback

      public NluFeedbackListing getLanguageunderstandingDomainFeedback(String domainId, String intentName, String assessment, LocalDate dateStart, LocalDate dateEnd, Boolean includeDeleted, String language, Integer pageNumber, Integer pageSize, Boolean enableCursorPagination, Boolean includeTrainingUtterances, String after, List<String> fields) throws IOException, ApiException
      Get all feedback in the given NLU Domain Version.
      Parameters:
      domainId - ID of the NLU domain. (required)
      intentName - The top intent name to retrieve feedback for. (optional)
      assessment - The top assessment to retrieve feedback for. (optional)
      dateStart - Begin of time window as ISO-8601 date. (optional)
      dateEnd - End of time window as ISO-8601 date. (optional)
      includeDeleted - Whether to include soft-deleted items in the result. (optional)
      language - Whether to filter response based on the language, e.g. en-us, pt-br. (optional)
      pageNumber - Page number (optional, default to 1)
      pageSize - Page size (optional, default to 25)
      enableCursorPagination - Enable Cursor Pagination (optional, default to false)
      includeTrainingUtterances - Include Training Utterances. By default they're included. (optional, default to true)
      after - The cursor that points to the end of the set of entities that has been returned. This is considered only when enableCursorPagination=true (optional)
      fields - Fields and properties to get, comma-separated (optional)
      Returns:
      NluFeedbackListing
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • getLanguageunderstandingDomainFeedbackWithHttpInfo

      public ApiResponse<NluFeedbackListing> getLanguageunderstandingDomainFeedbackWithHttpInfo(String domainId, String intentName, String assessment, LocalDate dateStart, LocalDate dateEnd, Boolean includeDeleted, String language, Integer pageNumber, Integer pageSize, Boolean enableCursorPagination, Boolean includeTrainingUtterances, String after, List<String> fields) throws IOException
      Get all feedback in the given NLU Domain Version.
      Parameters:
      domainId - ID of the NLU domain. (required)
      intentName - The top intent name to retrieve feedback for. (optional)
      assessment - The top assessment to retrieve feedback for. (optional)
      dateStart - Begin of time window as ISO-8601 date. (optional)
      dateEnd - End of time window as ISO-8601 date. (optional)
      includeDeleted - Whether to include soft-deleted items in the result. (optional)
      language - Whether to filter response based on the language, e.g. en-us, pt-br. (optional)
      pageNumber - Page number (optional, default to 1)
      pageSize - Page size (optional, default to 25)
      enableCursorPagination - Enable Cursor Pagination (optional, default to false)
      includeTrainingUtterances - Include Training Utterances. By default they're included. (optional, default to true)
      after - The cursor that points to the end of the set of entities that has been returned. This is considered only when enableCursorPagination=true (optional)
      fields - Fields and properties to get, comma-separated (optional)
      Returns:
      NluFeedbackListing
      Throws:
      IOException - if the request fails to be processed

    • getLanguageunderstandingDomainFeedback

      public NluFeedbackListing getLanguageunderstandingDomainFeedback(GetLanguageunderstandingDomainFeedbackRequest request) throws IOException, ApiException
      Get all feedback in the given NLU Domain Version.
      Parameters:
      request - The request object
      Returns:
      NluFeedbackListing
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • getLanguageunderstandingDomainFeedback

      public ApiResponse<NluFeedbackListing> getLanguageunderstandingDomainFeedback(ApiRequest<Void> request) throws IOException
      Get all feedback in the given NLU Domain Version.
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed

    • getLanguageunderstandingDomainFeedbackFeedbackId

      public NluFeedbackResponse getLanguageunderstandingDomainFeedbackFeedbackId(String domainId, String feedbackId, List<String> fields) throws IOException, ApiException
      Find a Feedback
      Parameters:
      domainId - ID of the NLU domain. (required)
      feedbackId - ID of the Feedback (required)
      fields - Fields and properties to get, comma-separated (optional)
      Returns:
      NluFeedbackResponse
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • getLanguageunderstandingDomainFeedbackFeedbackIdWithHttpInfo

      public ApiResponse<NluFeedbackResponse> getLanguageunderstandingDomainFeedbackFeedbackIdWithHttpInfo(String domainId, String feedbackId, List<String> fields) throws IOException
      Find a Feedback
      Parameters:
      domainId - ID of the NLU domain. (required)
      feedbackId - ID of the Feedback (required)
      fields - Fields and properties to get, comma-separated (optional)
      Returns:
      NluFeedbackResponse
      Throws:
      IOException - if the request fails to be processed

    • getLanguageunderstandingDomainFeedbackFeedbackId

      public NluFeedbackResponse getLanguageunderstandingDomainFeedbackFeedbackId(GetLanguageunderstandingDomainFeedbackFeedbackIdRequest request) throws IOException, ApiException
      Find a Feedback
      Parameters:
      request - The request object
      Returns:
      NluFeedbackResponse
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • getLanguageunderstandingDomainFeedbackFeedbackId

      public ApiResponse<NluFeedbackResponse> getLanguageunderstandingDomainFeedbackFeedbackId(ApiRequest<Void> request) throws IOException
      Find a Feedback
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed

    • getLanguageunderstandingDomainVersion

      public NluDomainVersion getLanguageunderstandingDomainVersion(String domainId, String domainVersionId, Boolean includeUtterances) throws IOException, ApiException
      Find an NLU Domain Version.
      Parameters:
      domainId - ID of the NLU domain. (required)
      domainVersionId - ID of the NLU domain version. (required)
      includeUtterances - Whether utterances for intent definition should be included when marshalling response. (optional)
      Returns:
      NluDomainVersion
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • getLanguageunderstandingDomainVersionWithHttpInfo

      public ApiResponse<NluDomainVersion> getLanguageunderstandingDomainVersionWithHttpInfo(String domainId, String domainVersionId, Boolean includeUtterances) throws IOException
      Find an NLU Domain Version.
      Parameters:
      domainId - ID of the NLU domain. (required)
      domainVersionId - ID of the NLU domain version. (required)
      includeUtterances - Whether utterances for intent definition should be included when marshalling response. (optional)
      Returns:
      NluDomainVersion
      Throws:
      IOException - if the request fails to be processed

    • getLanguageunderstandingDomainVersion

      public NluDomainVersion getLanguageunderstandingDomainVersion(GetLanguageunderstandingDomainVersionRequest request) throws IOException, ApiException
      Find an NLU Domain Version.
      Parameters:
      request - The request object
      Returns:
      NluDomainVersion
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • getLanguageunderstandingDomainVersion

      public ApiResponse<NluDomainVersion> getLanguageunderstandingDomainVersion(ApiRequest<Void> request) throws IOException
      Find an NLU Domain Version.
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed

    • getLanguageunderstandingDomainVersionReport

      public NluDomainVersionQualityReport getLanguageunderstandingDomainVersionReport(String domainId, String domainVersionId) throws IOException, ApiException
      Retrieved quality report for the specified NLU Domain Version
      Parameters:
      domainId - ID of the NLU domain. (required)
      domainVersionId - ID of the NLU domain version. (required)
      Returns:
      NluDomainVersionQualityReport
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • getLanguageunderstandingDomainVersionReportWithHttpInfo

      public ApiResponse<NluDomainVersionQualityReport> getLanguageunderstandingDomainVersionReportWithHttpInfo(String domainId, String domainVersionId) throws IOException
      Retrieved quality report for the specified NLU Domain Version
      Parameters:
      domainId - ID of the NLU domain. (required)
      domainVersionId - ID of the NLU domain version. (required)
      Returns:
      NluDomainVersionQualityReport
      Throws:
      IOException - if the request fails to be processed

    • getLanguageunderstandingDomainVersionReport

      public NluDomainVersionQualityReport getLanguageunderstandingDomainVersionReport(GetLanguageunderstandingDomainVersionReportRequest request) throws IOException, ApiException
      Retrieved quality report for the specified NLU Domain Version
      Parameters:
      request - The request object
      Returns:
      NluDomainVersionQualityReport
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • getLanguageunderstandingDomainVersionReport

      public ApiResponse<NluDomainVersionQualityReport> getLanguageunderstandingDomainVersionReport(ApiRequest<Void> request) throws IOException
      Retrieved quality report for the specified NLU Domain Version
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed

    • getLanguageunderstandingDomainVersions

      public NluDomainVersionListing getLanguageunderstandingDomainVersions(String domainId, Boolean includeUtterances, Integer pageNumber, Integer pageSize) throws IOException, ApiException
      Get all NLU Domain Versions for a given Domain.
      Parameters:
      domainId - ID of the NLU domain. (required)
      includeUtterances - Whether utterances for intent definition should be included when marshalling response. (optional)
      pageNumber - Page number (optional, default to 1)
      pageSize - Page size (optional, default to 25)
      Returns:
      NluDomainVersionListing
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • getLanguageunderstandingDomainVersionsWithHttpInfo

      public ApiResponse<NluDomainVersionListing> getLanguageunderstandingDomainVersionsWithHttpInfo(String domainId, Boolean includeUtterances, Integer pageNumber, Integer pageSize) throws IOException
      Get all NLU Domain Versions for a given Domain.
      Parameters:
      domainId - ID of the NLU domain. (required)
      includeUtterances - Whether utterances for intent definition should be included when marshalling response. (optional)
      pageNumber - Page number (optional, default to 1)
      pageSize - Page size (optional, default to 25)
      Returns:
      NluDomainVersionListing
      Throws:
      IOException - if the request fails to be processed

    • getLanguageunderstandingDomainVersions

      public NluDomainVersionListing getLanguageunderstandingDomainVersions(GetLanguageunderstandingDomainVersionsRequest request) throws IOException, ApiException
      Get all NLU Domain Versions for a given Domain.
      Parameters:
      request - The request object
      Returns:
      NluDomainVersionListing
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • getLanguageunderstandingDomainVersions

      public ApiResponse<NluDomainVersionListing> getLanguageunderstandingDomainVersions(ApiRequest<Void> request) throws IOException
      Get all NLU Domain Versions for a given Domain.
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed

    • getLanguageunderstandingDomains

      public NluDomainListing getLanguageunderstandingDomains(Integer pageNumber, Integer pageSize) throws IOException, ApiException
      Get all NLU Domains.
      Parameters:
      pageNumber - Page number (optional, default to 1)
      pageSize - Page size (optional, default to 25)
      Returns:
      NluDomainListing
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • getLanguageunderstandingDomainsWithHttpInfo

      public ApiResponse<NluDomainListing> getLanguageunderstandingDomainsWithHttpInfo(Integer pageNumber, Integer pageSize) throws IOException
      Get all NLU Domains.
      Parameters:
      pageNumber - Page number (optional, default to 1)
      pageSize - Page size (optional, default to 25)
      Returns:
      NluDomainListing
      Throws:
      IOException - if the request fails to be processed

    • getLanguageunderstandingDomains

      public NluDomainListing getLanguageunderstandingDomains(GetLanguageunderstandingDomainsRequest request) throws IOException, ApiException
      Get all NLU Domains.
      Parameters:
      request - The request object
      Returns:
      NluDomainListing
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • getLanguageunderstandingDomains

      public ApiResponse<NluDomainListing> getLanguageunderstandingDomains(ApiRequest<Void> request) throws IOException
      Get all NLU Domains.
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed

    • getLanguageunderstandingIgnorephrase

      public IgnoredMinedPhraseListing getLanguageunderstandingIgnorephrase(String languageCode, Integer pageSize, Integer pageNumber, String text, String sortOrder, String sortBy) throws IOException, ApiException
      Get list of all ignored phrases of the specified language code
      Parameters:
      languageCode - Language Code (required)
      pageSize - The page size for the listing. The max that will be returned is 200. (optional, default to 25)
      pageNumber - The page number for the listing (optional, default to 1)
      text - The phrase text filter applied to the listing (optional)
      sortOrder - The sort order for the listing (optional, default to desc)
      sortBy - The field to sort by for the listing (optional, default to dateModified)
      Returns:
      IgnoredMinedPhraseListing
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • getLanguageunderstandingIgnorephraseWithHttpInfo

      public ApiResponse<IgnoredMinedPhraseListing> getLanguageunderstandingIgnorephraseWithHttpInfo(String languageCode, Integer pageSize, Integer pageNumber, String text, String sortOrder, String sortBy) throws IOException
      Get list of all ignored phrases of the specified language code
      Parameters:
      languageCode - Language Code (required)
      pageSize - The page size for the listing. The max that will be returned is 200. (optional, default to 25)
      pageNumber - The page number for the listing (optional, default to 1)
      text - The phrase text filter applied to the listing (optional)
      sortOrder - The sort order for the listing (optional, default to desc)
      sortBy - The field to sort by for the listing (optional, default to dateModified)
      Returns:
      IgnoredMinedPhraseListing
      Throws:
      IOException - if the request fails to be processed

    • getLanguageunderstandingIgnorephrase

      public IgnoredMinedPhraseListing getLanguageunderstandingIgnorephrase(GetLanguageunderstandingIgnorephraseRequest request) throws IOException, ApiException
      Get list of all ignored phrases of the specified language code
      Parameters:
      request - The request object
      Returns:
      IgnoredMinedPhraseListing
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • getLanguageunderstandingIgnorephrase

      public ApiResponse<IgnoredMinedPhraseListing> getLanguageunderstandingIgnorephrase(ApiRequest<Void> request) throws IOException
      Get list of all ignored phrases of the specified language code
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed

    • getLanguageunderstandingIgnoretopic

      public IgnoredMinedTopicListing getLanguageunderstandingIgnoretopic(String languageCode, Integer pageSize, Integer pageNumber, String text, String sortOrder, String sortBy) throws IOException, ApiException
      Get list of all ignored topics of the specified language code
      Parameters:
      languageCode - Language Code (required)
      pageSize - The page size for the listing. The max that will be returned is 200. (optional, default to 25)
      pageNumber - The page number for the listing (optional, default to 1)
      text - The topic text filter applied to the listing (optional)
      sortOrder - The sort order for the listing (optional, default to desc)
      sortBy - The field to sort by for the listing (optional, default to dateModified)
      Returns:
      IgnoredMinedTopicListing
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • getLanguageunderstandingIgnoretopicWithHttpInfo

      public ApiResponse<IgnoredMinedTopicListing> getLanguageunderstandingIgnoretopicWithHttpInfo(String languageCode, Integer pageSize, Integer pageNumber, String text, String sortOrder, String sortBy) throws IOException
      Get list of all ignored topics of the specified language code
      Parameters:
      languageCode - Language Code (required)
      pageSize - The page size for the listing. The max that will be returned is 200. (optional, default to 25)
      pageNumber - The page number for the listing (optional, default to 1)
      text - The topic text filter applied to the listing (optional)
      sortOrder - The sort order for the listing (optional, default to desc)
      sortBy - The field to sort by for the listing (optional, default to dateModified)
      Returns:
      IgnoredMinedTopicListing
      Throws:
      IOException - if the request fails to be processed

    • getLanguageunderstandingIgnoretopic

      public IgnoredMinedTopicListing getLanguageunderstandingIgnoretopic(GetLanguageunderstandingIgnoretopicRequest request) throws IOException, ApiException
      Get list of all ignored topics of the specified language code
      Parameters:
      request - The request object
      Returns:
      IgnoredMinedTopicListing
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • getLanguageunderstandingIgnoretopic

      public ApiResponse<IgnoredMinedTopicListing> getLanguageunderstandingIgnoretopic(ApiRequest<Void> request) throws IOException
      Get list of all ignored topics of the specified language code
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed

    • getLanguageunderstandingMiner

      public Miner getLanguageunderstandingMiner(String minerId) throws IOException, ApiException
      Get information about a miner.
      Parameters:
      minerId - Miner ID (required)
      Returns:
      Miner
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • getLanguageunderstandingMinerWithHttpInfo

      public ApiResponse<Miner> getLanguageunderstandingMinerWithHttpInfo(String minerId) throws IOException
      Get information about a miner.
      Parameters:
      minerId - Miner ID (required)
      Returns:
      Miner
      Throws:
      IOException - if the request fails to be processed

    • getLanguageunderstandingMiner

      public Miner getLanguageunderstandingMiner(GetLanguageunderstandingMinerRequest request) throws IOException, ApiException
      Get information about a miner.
      Parameters:
      request - The request object
      Returns:
      Miner
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • getLanguageunderstandingMiner

      public ApiResponse<Miner> getLanguageunderstandingMiner(ApiRequest<Void> request) throws IOException
      Get information about a miner.
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed

    • getLanguageunderstandingMinerDraft

      public Draft getLanguageunderstandingMinerDraft(String minerId, String draftId, String draftIntentId, String draftTopicId) throws IOException, ApiException
      Get information about a draft.
      Parameters:
      minerId - Miner ID (required)
      draftId - Draft ID (required)
      draftIntentId - Parameter to filter a specific intent. (optional)
      draftTopicId - Parameter to filter a specific topic. (optional)
      Returns:
      Draft
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • getLanguageunderstandingMinerDraftWithHttpInfo

      public ApiResponse<Draft> getLanguageunderstandingMinerDraftWithHttpInfo(String minerId, String draftId, String draftIntentId, String draftTopicId) throws IOException
      Get information about a draft.
      Parameters:
      minerId - Miner ID (required)
      draftId - Draft ID (required)
      draftIntentId - Parameter to filter a specific intent. (optional)
      draftTopicId - Parameter to filter a specific topic. (optional)
      Returns:
      Draft
      Throws:
      IOException - if the request fails to be processed

    • getLanguageunderstandingMinerDraft

      public Draft getLanguageunderstandingMinerDraft(GetLanguageunderstandingMinerDraftRequest request) throws IOException, ApiException
      Get information about a draft.
      Parameters:
      request - The request object
      Returns:
      Draft
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • getLanguageunderstandingMinerDraft

      public ApiResponse<Draft> getLanguageunderstandingMinerDraft(ApiRequest<Void> request) throws IOException
      Get information about a draft.
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed

    • getLanguageunderstandingMinerDrafts

      public DraftListing getLanguageunderstandingMinerDrafts(String minerId) throws IOException, ApiException
      Retrieve the list of drafts created.
      Parameters:
      minerId - Miner ID (required)
      Returns:
      DraftListing
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • getLanguageunderstandingMinerDraftsWithHttpInfo

      public ApiResponse<DraftListing> getLanguageunderstandingMinerDraftsWithHttpInfo(String minerId) throws IOException
      Retrieve the list of drafts created.
      Parameters:
      minerId - Miner ID (required)
      Returns:
      DraftListing
      Throws:
      IOException - if the request fails to be processed

    • getLanguageunderstandingMinerDrafts

      public DraftListing getLanguageunderstandingMinerDrafts(GetLanguageunderstandingMinerDraftsRequest request) throws IOException, ApiException
      Retrieve the list of drafts created.
      Parameters:
      request - The request object
      Returns:
      DraftListing
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • getLanguageunderstandingMinerDrafts

      public ApiResponse<DraftListing> getLanguageunderstandingMinerDrafts(ApiRequest<Void> request) throws IOException
      Retrieve the list of drafts created.
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed

    • getLanguageunderstandingMinerIntent

      public MinerIntent getLanguageunderstandingMinerIntent(String minerId, String intentId, String expand) throws IOException, ApiException
      Get information about a mined intent
      Parameters:
      minerId - Miner ID (required)
      intentId - The ID of the intent to be retrieved. (required)
      expand - Option to fetch utterances (optional)
      Returns:
      MinerIntent
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • getLanguageunderstandingMinerIntentWithHttpInfo

      public ApiResponse<MinerIntent> getLanguageunderstandingMinerIntentWithHttpInfo(String minerId, String intentId, String expand) throws IOException
      Get information about a mined intent
      Parameters:
      minerId - Miner ID (required)
      intentId - The ID of the intent to be retrieved. (required)
      expand - Option to fetch utterances (optional)
      Returns:
      MinerIntent
      Throws:
      IOException - if the request fails to be processed

    • getLanguageunderstandingMinerIntent

      public MinerIntent getLanguageunderstandingMinerIntent(GetLanguageunderstandingMinerIntentRequest request) throws IOException, ApiException
      Get information about a mined intent
      Parameters:
      request - The request object
      Returns:
      MinerIntent
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • getLanguageunderstandingMinerIntent

      public ApiResponse<MinerIntent> getLanguageunderstandingMinerIntent(ApiRequest<Void> request) throws IOException
      Get information about a mined intent
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed

    • getLanguageunderstandingMinerIntents

      public MinedIntentsListing getLanguageunderstandingMinerIntents(String minerId, String expand) throws IOException, ApiException
      Retrieve a list of mined intents.
      Parameters:
      minerId - Miner ID (required)
      expand - Option to fetch utterances. (optional)
      Returns:
      MinedIntentsListing
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • getLanguageunderstandingMinerIntentsWithHttpInfo

      public ApiResponse<MinedIntentsListing> getLanguageunderstandingMinerIntentsWithHttpInfo(String minerId, String expand) throws IOException
      Retrieve a list of mined intents.
      Parameters:
      minerId - Miner ID (required)
      expand - Option to fetch utterances. (optional)
      Returns:
      MinedIntentsListing
      Throws:
      IOException - if the request fails to be processed

    • getLanguageunderstandingMinerIntents

      public MinedIntentsListing getLanguageunderstandingMinerIntents(GetLanguageunderstandingMinerIntentsRequest request) throws IOException, ApiException
      Retrieve a list of mined intents.
      Parameters:
      request - The request object
      Returns:
      MinedIntentsListing
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • getLanguageunderstandingMinerIntents

      public ApiResponse<MinedIntentsListing> getLanguageunderstandingMinerIntents(ApiRequest<Void> request) throws IOException
      Retrieve a list of mined intents.
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed

    • getLanguageunderstandingMinerTopic

      public MinerTopic getLanguageunderstandingMinerTopic(String minerId, String topicId, String expand) throws IOException, ApiException
      Retrieves details of a particular topic.
      Parameters:
      minerId - Miner ID (required)
      topicId - The ID of the topic to be retrieved. (required)
      expand - Option to fetch phrases (optional)
      Returns:
      MinerTopic
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • getLanguageunderstandingMinerTopicWithHttpInfo

      public ApiResponse<MinerTopic> getLanguageunderstandingMinerTopicWithHttpInfo(String minerId, String topicId, String expand) throws IOException
      Retrieves details of a particular topic.
      Parameters:
      minerId - Miner ID (required)
      topicId - The ID of the topic to be retrieved. (required)
      expand - Option to fetch phrases (optional)
      Returns:
      MinerTopic
      Throws:
      IOException - if the request fails to be processed

    • getLanguageunderstandingMinerTopic

      public MinerTopic getLanguageunderstandingMinerTopic(GetLanguageunderstandingMinerTopicRequest request) throws IOException, ApiException
      Retrieves details of a particular topic.
      Parameters:
      request - The request object
      Returns:
      MinerTopic
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • getLanguageunderstandingMinerTopic

      public ApiResponse<MinerTopic> getLanguageunderstandingMinerTopic(ApiRequest<Void> request) throws IOException
      Retrieves details of a particular topic.
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed

    • getLanguageunderstandingMinerTopicPhrase

      public MinerTopicPhrase getLanguageunderstandingMinerTopicPhrase(String minerId, String topicId, String phraseId) throws IOException, ApiException
      Retrieves utterances related to a phrase in a topic.
      Parameters:
      minerId - Miner ID (required)
      topicId - The ID of the topic to be retrieved. (required)
      phraseId - The ID of the phrase to be retrieved. (required)
      Returns:
      MinerTopicPhrase
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • getLanguageunderstandingMinerTopicPhraseWithHttpInfo

      public ApiResponse<MinerTopicPhrase> getLanguageunderstandingMinerTopicPhraseWithHttpInfo(String minerId, String topicId, String phraseId) throws IOException
      Retrieves utterances related to a phrase in a topic.
      Parameters:
      minerId - Miner ID (required)
      topicId - The ID of the topic to be retrieved. (required)
      phraseId - The ID of the phrase to be retrieved. (required)
      Returns:
      MinerTopicPhrase
      Throws:
      IOException - if the request fails to be processed

    • getLanguageunderstandingMinerTopicPhrase

      public MinerTopicPhrase getLanguageunderstandingMinerTopicPhrase(GetLanguageunderstandingMinerTopicPhraseRequest request) throws IOException, ApiException
      Retrieves utterances related to a phrase in a topic.
      Parameters:
      request - The request object
      Returns:
      MinerTopicPhrase
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • getLanguageunderstandingMinerTopicPhrase

      public ApiResponse<MinerTopicPhrase> getLanguageunderstandingMinerTopicPhrase(ApiRequest<Void> request) throws IOException
      Retrieves utterances related to a phrase in a topic.
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed

    • getLanguageunderstandingMinerTopics

      public MinerTopicsListing getLanguageunderstandingMinerTopics(String minerId) throws IOException, ApiException
      Retrieve a list of mined topics.
      Parameters:
      minerId - Miner ID (required)
      Returns:
      MinerTopicsListing
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • getLanguageunderstandingMinerTopicsWithHttpInfo

      public ApiResponse<MinerTopicsListing> getLanguageunderstandingMinerTopicsWithHttpInfo(String minerId) throws IOException
      Retrieve a list of mined topics.
      Parameters:
      minerId - Miner ID (required)
      Returns:
      MinerTopicsListing
      Throws:
      IOException - if the request fails to be processed

    • getLanguageunderstandingMinerTopics

      public MinerTopicsListing getLanguageunderstandingMinerTopics(GetLanguageunderstandingMinerTopicsRequest request) throws IOException, ApiException
      Retrieve a list of mined topics.
      Parameters:
      request - The request object
      Returns:
      MinerTopicsListing
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • getLanguageunderstandingMinerTopics

      public ApiResponse<MinerTopicsListing> getLanguageunderstandingMinerTopics(ApiRequest<Void> request) throws IOException
      Retrieve a list of mined topics.
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed

    • getLanguageunderstandingMiners

      public MinerListing getLanguageunderstandingMiners(String minerType) throws IOException, ApiException
      Retrieve the list of miners created.
      Parameters:
      minerType - Type of miner, either intent or topic (optional)
      Returns:
      MinerListing
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • getLanguageunderstandingMinersWithHttpInfo

      public ApiResponse<MinerListing> getLanguageunderstandingMinersWithHttpInfo(String minerType) throws IOException
      Retrieve the list of miners created.
      Parameters:
      minerType - Type of miner, either intent or topic (optional)
      Returns:
      MinerListing
      Throws:
      IOException - if the request fails to be processed

    • getLanguageunderstandingMiners

      public MinerListing getLanguageunderstandingMiners(GetLanguageunderstandingMinersRequest request) throws IOException, ApiException
      Retrieve the list of miners created.
      Parameters:
      request - The request object
      Returns:
      MinerListing
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • getLanguageunderstandingMiners

      public ApiResponse<MinerListing> getLanguageunderstandingMiners(ApiRequest<Void> request) throws IOException
      Retrieve the list of miners created.
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed

    • getLanguageunderstandingSettings

      public NluOrganization getLanguageunderstandingSettings() throws IOException, ApiException
      Get Organization Configuration
      Returns:
      NluOrganization
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • getLanguageunderstandingSettingsWithHttpInfo

      public ApiResponse<NluOrganization> getLanguageunderstandingSettingsWithHttpInfo() throws IOException
      Get Organization Configuration
      Returns:
      NluOrganization
      Throws:
      IOException - if the request fails to be processed

    • getLanguageunderstandingSettings

      public NluOrganization getLanguageunderstandingSettings(GetLanguageunderstandingSettingsRequest request) throws IOException, ApiException
      Get Organization Configuration
      Parameters:
      request - The request object
      Returns:
      NluOrganization
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • getLanguageunderstandingSettings

      public ApiResponse<NluOrganization> getLanguageunderstandingSettings(ApiRequest<Void> request) throws IOException
      Get Organization Configuration
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed

    • patchLanguageunderstandingDomain

      public NluDomain patchLanguageunderstandingDomain(String domainId, NluDomain body) throws IOException, ApiException
      Update an NLU Domain.
      Parameters:
      domainId - ID of the NLU domain. (required)
      body - The updated NLU Domain. (required)
      Returns:
      NluDomain
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • patchLanguageunderstandingDomainWithHttpInfo

      public ApiResponse<NluDomain> patchLanguageunderstandingDomainWithHttpInfo(String domainId, NluDomain body) throws IOException
      Update an NLU Domain.
      Parameters:
      domainId - ID of the NLU domain. (required)
      body - The updated NLU Domain. (required)
      Returns:
      NluDomain
      Throws:
      IOException - if the request fails to be processed

    • patchLanguageunderstandingDomain

      public NluDomain patchLanguageunderstandingDomain(PatchLanguageunderstandingDomainRequest request) throws IOException, ApiException
      Update an NLU Domain.
      Parameters:
      request - The request object
      Returns:
      NluDomain
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • patchLanguageunderstandingDomain

      public ApiResponse<NluDomain> patchLanguageunderstandingDomain(ApiRequest<NluDomain> request) throws IOException
      Update an NLU Domain.
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed

    • patchLanguageunderstandingMinerDraft

      public Draft patchLanguageunderstandingMinerDraft(String minerId, String draftId, DraftRequest body) throws IOException, ApiException
      Save information for the draft. Either topic draft or intent draft should be sent.
      Parameters:
      minerId - Miner ID (required)
      draftId - Draft ID (required)
      body - (optional)
      Returns:
      Draft
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • patchLanguageunderstandingMinerDraftWithHttpInfo

      public ApiResponse<Draft> patchLanguageunderstandingMinerDraftWithHttpInfo(String minerId, String draftId, DraftRequest body) throws IOException
      Save information for the draft. Either topic draft or intent draft should be sent.
      Parameters:
      minerId - Miner ID (required)
      draftId - Draft ID (required)
      body - (optional)
      Returns:
      Draft
      Throws:
      IOException - if the request fails to be processed

    • patchLanguageunderstandingMinerDraft

      public Draft patchLanguageunderstandingMinerDraft(PatchLanguageunderstandingMinerDraftRequest request) throws IOException, ApiException
      Save information for the draft. Either topic draft or intent draft should be sent.
      Parameters:
      request - The request object
      Returns:
      Draft
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • patchLanguageunderstandingMinerDraft

      public ApiResponse<Draft> patchLanguageunderstandingMinerDraft(ApiRequest<DraftRequest> request) throws IOException
      Save information for the draft. Either topic draft or intent draft should be sent.
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed

    • postLanguageunderstandingDomainFeedback

      public NluFeedbackResponse postLanguageunderstandingDomainFeedback(String domainId, NluFeedbackRequest body) throws IOException, ApiException
      Create feedback for the NLU Domain Version.
      Parameters:
      domainId - ID of the NLU domain. (required)
      body - The Feedback to create. (required)
      Returns:
      NluFeedbackResponse
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • postLanguageunderstandingDomainFeedbackWithHttpInfo

      public ApiResponse<NluFeedbackResponse> postLanguageunderstandingDomainFeedbackWithHttpInfo(String domainId, NluFeedbackRequest body) throws IOException
      Create feedback for the NLU Domain Version.
      Parameters:
      domainId - ID of the NLU domain. (required)
      body - The Feedback to create. (required)
      Returns:
      NluFeedbackResponse
      Throws:
      IOException - if the request fails to be processed

    • postLanguageunderstandingDomainFeedback

      public NluFeedbackResponse postLanguageunderstandingDomainFeedback(PostLanguageunderstandingDomainFeedbackRequest request) throws IOException, ApiException
      Create feedback for the NLU Domain Version.
      Parameters:
      request - The request object
      Returns:
      NluFeedbackResponse
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • postLanguageunderstandingDomainFeedback

      public ApiResponse<NluFeedbackResponse> postLanguageunderstandingDomainFeedback(ApiRequest<NluFeedbackRequest> request) throws IOException
      Create feedback for the NLU Domain Version.
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed

    • postLanguageunderstandingDomainVersionDetect

      public NluDetectionResponse postLanguageunderstandingDomainVersionDetect(String domainId, String domainVersionId, NluDetectionRequest body) throws IOException, ApiException
      Detect intent, entities, etc. in the submitted text using the specified NLU domain version.
      Parameters:
      domainId - ID of the NLU domain. (required)
      domainVersionId - ID of the NLU domain version. (required)
      body - The input data to perform detection on. (required)
      Returns:
      NluDetectionResponse
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • postLanguageunderstandingDomainVersionDetectWithHttpInfo

      public ApiResponse<NluDetectionResponse> postLanguageunderstandingDomainVersionDetectWithHttpInfo(String domainId, String domainVersionId, NluDetectionRequest body) throws IOException
      Detect intent, entities, etc. in the submitted text using the specified NLU domain version.
      Parameters:
      domainId - ID of the NLU domain. (required)
      domainVersionId - ID of the NLU domain version. (required)
      body - The input data to perform detection on. (required)
      Returns:
      NluDetectionResponse
      Throws:
      IOException - if the request fails to be processed

    • postLanguageunderstandingDomainVersionDetect

      public NluDetectionResponse postLanguageunderstandingDomainVersionDetect(PostLanguageunderstandingDomainVersionDetectRequest request) throws IOException, ApiException
      Detect intent, entities, etc. in the submitted text using the specified NLU domain version.
      Parameters:
      request - The request object
      Returns:
      NluDetectionResponse
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • postLanguageunderstandingDomainVersionDetect

      public ApiResponse<NluDetectionResponse> postLanguageunderstandingDomainVersionDetect(ApiRequest<NluDetectionRequest> request) throws IOException
      Detect intent, entities, etc. in the submitted text using the specified NLU domain version.
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed

    • postLanguageunderstandingDomainVersionPublish

      public NluDomainVersion postLanguageunderstandingDomainVersionPublish(String domainId, String domainVersionId) throws IOException, ApiException
      Publish the draft NLU Domain Version.
      Parameters:
      domainId - ID of the NLU domain. (required)
      domainVersionId - ID of the NLU domain version. (required)
      Returns:
      NluDomainVersion
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • postLanguageunderstandingDomainVersionPublishWithHttpInfo

      public ApiResponse<NluDomainVersion> postLanguageunderstandingDomainVersionPublishWithHttpInfo(String domainId, String domainVersionId) throws IOException
      Publish the draft NLU Domain Version.
      Parameters:
      domainId - ID of the NLU domain. (required)
      domainVersionId - ID of the NLU domain version. (required)
      Returns:
      NluDomainVersion
      Throws:
      IOException - if the request fails to be processed

    • postLanguageunderstandingDomainVersionPublish

      public NluDomainVersion postLanguageunderstandingDomainVersionPublish(PostLanguageunderstandingDomainVersionPublishRequest request) throws IOException, ApiException
      Publish the draft NLU Domain Version.
      Parameters:
      request - The request object
      Returns:
      NluDomainVersion
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • postLanguageunderstandingDomainVersionPublish

      public ApiResponse<NluDomainVersion> postLanguageunderstandingDomainVersionPublish(ApiRequest<Void> request) throws IOException
      Publish the draft NLU Domain Version.
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed

    • postLanguageunderstandingDomainVersionTrain

      public NluDomainVersionTrainingResponse postLanguageunderstandingDomainVersionTrain(String domainId, String domainVersionId) throws IOException, ApiException
      Train the draft NLU Domain Version.
      Parameters:
      domainId - ID of the NLU domain. (required)
      domainVersionId - ID of the NLU domain version. (required)
      Returns:
      NluDomainVersionTrainingResponse
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • postLanguageunderstandingDomainVersionTrainWithHttpInfo

      public ApiResponse<NluDomainVersionTrainingResponse> postLanguageunderstandingDomainVersionTrainWithHttpInfo(String domainId, String domainVersionId) throws IOException
      Train the draft NLU Domain Version.
      Parameters:
      domainId - ID of the NLU domain. (required)
      domainVersionId - ID of the NLU domain version. (required)
      Returns:
      NluDomainVersionTrainingResponse
      Throws:
      IOException - if the request fails to be processed

    • postLanguageunderstandingDomainVersionTrain

      public NluDomainVersionTrainingResponse postLanguageunderstandingDomainVersionTrain(PostLanguageunderstandingDomainVersionTrainRequest request) throws IOException, ApiException
      Train the draft NLU Domain Version.
      Parameters:
      request - The request object
      Returns:
      NluDomainVersionTrainingResponse
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • postLanguageunderstandingDomainVersionTrain

      public ApiResponse<NluDomainVersionTrainingResponse> postLanguageunderstandingDomainVersionTrain(ApiRequest<Void> request) throws IOException
      Train the draft NLU Domain Version.
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed

    • postLanguageunderstandingDomainVersions

      public NluDomainVersion postLanguageunderstandingDomainVersions(String domainId, NluDomainVersion body, Boolean includeUtterances) throws IOException, ApiException
      Create an NLU Domain Version.
      Parameters:
      domainId - ID of the NLU domain. (required)
      body - The NLU Domain Version to create. (required)
      includeUtterances - Whether utterances for intent definition should be included when marshalling response. (optional)
      Returns:
      NluDomainVersion
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • postLanguageunderstandingDomainVersionsWithHttpInfo

      public ApiResponse<NluDomainVersion> postLanguageunderstandingDomainVersionsWithHttpInfo(String domainId, NluDomainVersion body, Boolean includeUtterances) throws IOException
      Create an NLU Domain Version.
      Parameters:
      domainId - ID of the NLU domain. (required)
      body - The NLU Domain Version to create. (required)
      includeUtterances - Whether utterances for intent definition should be included when marshalling response. (optional)
      Returns:
      NluDomainVersion
      Throws:
      IOException - if the request fails to be processed

    • postLanguageunderstandingDomainVersions

      public NluDomainVersion postLanguageunderstandingDomainVersions(PostLanguageunderstandingDomainVersionsRequest request) throws IOException, ApiException
      Create an NLU Domain Version.
      Parameters:
      request - The request object
      Returns:
      NluDomainVersion
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • postLanguageunderstandingDomainVersions

      public ApiResponse<NluDomainVersion> postLanguageunderstandingDomainVersions(ApiRequest<NluDomainVersion> request) throws IOException
      Create an NLU Domain Version.
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed

    • postLanguageunderstandingDomains

      public NluDomain postLanguageunderstandingDomains(NluDomain body) throws IOException, ApiException
      Create an NLU Domain.
      Parameters:
      body - The NLU Domain to create. (required)
      Returns:
      NluDomain
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • postLanguageunderstandingDomainsWithHttpInfo

      public ApiResponse<NluDomain> postLanguageunderstandingDomainsWithHttpInfo(NluDomain body) throws IOException
      Create an NLU Domain.
      Parameters:
      body - The NLU Domain to create. (required)
      Returns:
      NluDomain
      Throws:
      IOException - if the request fails to be processed

    • postLanguageunderstandingDomains

      public NluDomain postLanguageunderstandingDomains(PostLanguageunderstandingDomainsRequest request) throws IOException, ApiException
      Create an NLU Domain.
      Parameters:
      request - The request object
      Returns:
      NluDomain
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • postLanguageunderstandingDomains

      public ApiResponse<NluDomain> postLanguageunderstandingDomains(ApiRequest<NluDomain> request) throws IOException
      Create an NLU Domain.
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed

    • postLanguageunderstandingIgnorephrase

      public IgnorePhrasesResponse postLanguageunderstandingIgnorephrase(String languageCode, IgnorePhrasesRequest body) throws IOException, ApiException
      Add phrases to the ignored phrases list
      Parameters:
      languageCode - Language Code (required)
      body - Request body containing phrases to be ignored (required)
      Returns:
      IgnorePhrasesResponse
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • postLanguageunderstandingIgnorephraseWithHttpInfo

      public ApiResponse<IgnorePhrasesResponse> postLanguageunderstandingIgnorephraseWithHttpInfo(String languageCode, IgnorePhrasesRequest body) throws IOException
      Add phrases to the ignored phrases list
      Parameters:
      languageCode - Language Code (required)
      body - Request body containing phrases to be ignored (required)
      Returns:
      IgnorePhrasesResponse
      Throws:
      IOException - if the request fails to be processed

    • postLanguageunderstandingIgnorephrase

      public IgnorePhrasesResponse postLanguageunderstandingIgnorephrase(PostLanguageunderstandingIgnorephraseRequest request) throws IOException, ApiException
      Add phrases to the ignored phrases list
      Parameters:
      request - The request object
      Returns:
      IgnorePhrasesResponse
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • postLanguageunderstandingIgnorephrase

      public ApiResponse<IgnorePhrasesResponse> postLanguageunderstandingIgnorephrase(ApiRequest<IgnorePhrasesRequest> request) throws IOException
      Add phrases to the ignored phrases list
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed

    • postLanguageunderstandingIgnorephraseRemove

      public void postLanguageunderstandingIgnorephraseRemove(String languageCode, RemoveEntitiesRequest body) throws IOException, ApiException
      Delete ignored phrases
      Parameters:
      languageCode - Language Code (required)
      body - Request body containing entities to be removed (required)
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • postLanguageunderstandingIgnorephraseRemoveWithHttpInfo

      public ApiResponse<Void> postLanguageunderstandingIgnorephraseRemoveWithHttpInfo(String languageCode, RemoveEntitiesRequest body) throws IOException
      Delete ignored phrases
      Parameters:
      languageCode - Language Code (required)
      body - Request body containing entities to be removed (required)
      Throws:
      IOException - if the request fails to be processed

    • postLanguageunderstandingIgnorephraseRemove

      public void postLanguageunderstandingIgnorephraseRemove(PostLanguageunderstandingIgnorephraseRemoveRequest request) throws IOException, ApiException
      Delete ignored phrases
      Parameters:
      request - The request object
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • postLanguageunderstandingIgnorephraseRemove

      public ApiResponse<Void> postLanguageunderstandingIgnorephraseRemove(ApiRequest<RemoveEntitiesRequest> request) throws IOException
      Delete ignored phrases
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed

    • postLanguageunderstandingIgnoretopic

      public IgnoreTopicsResponse postLanguageunderstandingIgnoretopic(String languageCode, IgnoreTopicsRequest body) throws IOException, ApiException
      Add topics to the ignored topics list
      Parameters:
      languageCode - Language Code (required)
      body - Request body containing topics to be ignored (required)
      Returns:
      IgnoreTopicsResponse
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • postLanguageunderstandingIgnoretopicWithHttpInfo

      public ApiResponse<IgnoreTopicsResponse> postLanguageunderstandingIgnoretopicWithHttpInfo(String languageCode, IgnoreTopicsRequest body) throws IOException
      Add topics to the ignored topics list
      Parameters:
      languageCode - Language Code (required)
      body - Request body containing topics to be ignored (required)
      Returns:
      IgnoreTopicsResponse
      Throws:
      IOException - if the request fails to be processed

    • postLanguageunderstandingIgnoretopic

      public IgnoreTopicsResponse postLanguageunderstandingIgnoretopic(PostLanguageunderstandingIgnoretopicRequest request) throws IOException, ApiException
      Add topics to the ignored topics list
      Parameters:
      request - The request object
      Returns:
      IgnoreTopicsResponse
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • postLanguageunderstandingIgnoretopic

      public ApiResponse<IgnoreTopicsResponse> postLanguageunderstandingIgnoretopic(ApiRequest<IgnoreTopicsRequest> request) throws IOException
      Add topics to the ignored topics list
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed

    • postLanguageunderstandingIgnoretopicRemove

      public void postLanguageunderstandingIgnoretopicRemove(String languageCode, RemoveEntitiesRequest body) throws IOException, ApiException
      Delete ignored topics
      Parameters:
      languageCode - Language Code (required)
      body - Request body containing entities to be removed (required)
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • postLanguageunderstandingIgnoretopicRemoveWithHttpInfo

      public ApiResponse<Void> postLanguageunderstandingIgnoretopicRemoveWithHttpInfo(String languageCode, RemoveEntitiesRequest body) throws IOException
      Delete ignored topics
      Parameters:
      languageCode - Language Code (required)
      body - Request body containing entities to be removed (required)
      Throws:
      IOException - if the request fails to be processed

    • postLanguageunderstandingIgnoretopicRemove

      public void postLanguageunderstandingIgnoretopicRemove(PostLanguageunderstandingIgnoretopicRemoveRequest request) throws IOException, ApiException
      Delete ignored topics
      Parameters:
      request - The request object
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • postLanguageunderstandingIgnoretopicRemove

      public ApiResponse<Void> postLanguageunderstandingIgnoretopicRemove(ApiRequest<RemoveEntitiesRequest> request) throws IOException
      Delete ignored topics
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed

    • postLanguageunderstandingMinerDrafts

      public Draft postLanguageunderstandingMinerDrafts(String minerId, Draft body) throws IOException, ApiException
      Create a new draft resource.
      Parameters:
      minerId - Miner ID (required)
      body - Details for creating draft resource (required)
      Returns:
      Draft
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • postLanguageunderstandingMinerDraftsWithHttpInfo

      public ApiResponse<Draft> postLanguageunderstandingMinerDraftsWithHttpInfo(String minerId, Draft body) throws IOException
      Create a new draft resource.
      Parameters:
      minerId - Miner ID (required)
      body - Details for creating draft resource (required)
      Returns:
      Draft
      Throws:
      IOException - if the request fails to be processed

    • postLanguageunderstandingMinerDrafts

      public Draft postLanguageunderstandingMinerDrafts(PostLanguageunderstandingMinerDraftsRequest request) throws IOException, ApiException
      Create a new draft resource.
      Parameters:
      request - The request object
      Returns:
      Draft
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • postLanguageunderstandingMinerDrafts

      public ApiResponse<Draft> postLanguageunderstandingMinerDrafts(ApiRequest<Draft> request) throws IOException
      Create a new draft resource.
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed

    • postLanguageunderstandingMinerExecute

      public Miner postLanguageunderstandingMinerExecute(String minerId, MinerExecuteRequest body) throws IOException, ApiException
      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.
      Parameters:
      minerId - Miner ID (required)
      body - (optional)
      Returns:
      Miner
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • postLanguageunderstandingMinerExecuteWithHttpInfo

      public ApiResponse<Miner> postLanguageunderstandingMinerExecuteWithHttpInfo(String minerId, MinerExecuteRequest body) throws IOException
      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.
      Parameters:
      minerId - Miner ID (required)
      body - (optional)
      Returns:
      Miner
      Throws:
      IOException - if the request fails to be processed

    • postLanguageunderstandingMinerExecute

      public Miner postLanguageunderstandingMinerExecute(PostLanguageunderstandingMinerExecuteRequest request) throws IOException, ApiException
      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.
      Parameters:
      request - The request object
      Returns:
      Miner
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • postLanguageunderstandingMinerExecute

      public ApiResponse<Miner> postLanguageunderstandingMinerExecute(ApiRequest<MinerExecuteRequest> request) throws IOException
      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.
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed

    • postLanguageunderstandingMiners

      public Miner postLanguageunderstandingMiners(Miner body) throws IOException, ApiException
      Create a unique miner.
      Parameters:
      body - Details for creating a new miner resource. (required)
      Returns:
      Miner
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • postLanguageunderstandingMinersWithHttpInfo

      public ApiResponse<Miner> postLanguageunderstandingMinersWithHttpInfo(Miner body) throws IOException
      Create a unique miner.
      Parameters:
      body - Details for creating a new miner resource. (required)
      Returns:
      Miner
      Throws:
      IOException - if the request fails to be processed

    • postLanguageunderstandingMiners

      public Miner postLanguageunderstandingMiners(PostLanguageunderstandingMinersRequest request) throws IOException, ApiException
      Create a unique miner.
      Parameters:
      request - The request object
      Returns:
      Miner
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • postLanguageunderstandingMiners

      public ApiResponse<Miner> postLanguageunderstandingMiners(ApiRequest<Miner> request) throws IOException
      Create a unique miner.
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed

    • putLanguageunderstandingDomainVersion

      public NluDomainVersion putLanguageunderstandingDomainVersion(String domainId, String domainVersionId, NluDomainVersion body) throws IOException, ApiException
      Update an NLU Domain Version.
      Parameters:
      domainId - ID of the NLU domain. (required)
      domainVersionId - ID of the NLU domain version. (required)
      body - The updated NLU Domain Version. (required)
      Returns:
      NluDomainVersion
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • putLanguageunderstandingDomainVersionWithHttpInfo

      public ApiResponse<NluDomainVersion> putLanguageunderstandingDomainVersionWithHttpInfo(String domainId, String domainVersionId, NluDomainVersion body) throws IOException
      Update an NLU Domain Version.
      Parameters:
      domainId - ID of the NLU domain. (required)
      domainVersionId - ID of the NLU domain version. (required)
      body - The updated NLU Domain Version. (required)
      Returns:
      NluDomainVersion
      Throws:
      IOException - if the request fails to be processed

    • putLanguageunderstandingDomainVersion

      public NluDomainVersion putLanguageunderstandingDomainVersion(PutLanguageunderstandingDomainVersionRequest request) throws IOException, ApiException
      Update an NLU Domain Version.
      Parameters:
      request - The request object
      Returns:
      NluDomainVersion
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • putLanguageunderstandingDomainVersion

      public ApiResponse<NluDomainVersion> putLanguageunderstandingDomainVersion(ApiRequest<NluDomainVersion> request) throws IOException
      Update an NLU Domain Version.
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed