Models Interface

Package:

com.microsoft.azure.cognitiveservices.language.luis.authoring

public interface Models

An instance of this class provides access to all the operations defined in Models.

Method Summary

Modifier and Type	Method and Description
UUID	addClosedList(UUID appId, String versionId, ClosedListModelCreateObject closedListModelCreateObject) Adds a list entity model to a version of the application.
Observable<UUID>	addClosedListAsync(UUID appId, String versionId, ClosedListModelCreateObject closedListModelCreateObject) Adds a list entity model to a version of the application.
ModelsAddCompositeEntityChildDefinitionStages.WithAppId	addCompositeEntityChild() Creates a single child in an existing composite entity model in a version of the application.
UUID	addCompositeEntityChild(UUID appId, String versionId, UUID cEntityId, AddCompositeEntityChildOptionalParameter addCompositeEntityChildOptionalParameter) Creates a single child in an existing composite entity model in a version of the application.
Observable<UUID>	addCompositeEntityChildAsync(UUID appId, String versionId, UUID cEntityId, AddCompositeEntityChildOptionalParameter addCompositeEntityChildOptionalParameter) Creates a single child in an existing composite entity model in a version of the application.
ModelsAddCustomPrebuiltDomainDefinitionStages.WithAppId	addCustomPrebuiltDomain() Adds a customizable prebuilt domain along with all of its intent and entity models in a version of the application.
List<UUID>	addCustomPrebuiltDomain(UUID appId, String versionId, AddCustomPrebuiltDomainModelsOptionalParameter addCustomPrebuiltDomainOptionalParameter) Adds a customizable prebuilt domain along with all of its intent and entity models in a version of the application.
Observable<List<UUID>>	addCustomPrebuiltDomainAsync(UUID appId, String versionId, AddCustomPrebuiltDomainModelsOptionalParameter addCustomPrebuiltDomainOptionalParameter) Adds a customizable prebuilt domain along with all of its intent and entity models in a version of the application.
UUID	addCustomPrebuiltEntity(UUID appId, String versionId, PrebuiltDomainModelCreateObject prebuiltDomainModelCreateObject) Adds a prebuilt entity model to a version of the application.
Observable<UUID>	addCustomPrebuiltEntityAsync(UUID appId, String versionId, PrebuiltDomainModelCreateObject prebuiltDomainModelCreateObject) Adds a prebuilt entity model to a version of the application.
UUID	addCustomPrebuiltIntent(UUID appId, String versionId, PrebuiltDomainModelCreateObject prebuiltDomainModelCreateObject) Adds a customizable prebuilt intent model to a version of the application.
Observable<UUID>	addCustomPrebuiltIntentAsync(UUID appId, String versionId, PrebuiltDomainModelCreateObject prebuiltDomainModelCreateObject) Adds a customizable prebuilt intent model to a version of the application.
UUID	addEntity(UUID appId, String versionId, EntityModelCreateObject entityModelCreateObject) Adds an entity extractor to a version of the application.
Observable<UUID>	addEntityAsync(UUID appId, String versionId, EntityModelCreateObject entityModelCreateObject) Adds an entity extractor to a version of the application.
UUID	addEntityChild(UUID appId, String versionId, UUID entityId, ChildEntityModelCreateObject childEntityModelCreateObject) Creates a single child in an existing entity model hierarchy in a version of the application.
Observable<UUID>	addEntityChildAsync(UUID appId, String versionId, UUID entityId, ChildEntityModelCreateObject childEntityModelCreateObject) Creates a single child in an existing entity model hierarchy in a version of the application.
ModelsAddExplicitListItemDefinitionStages.WithAppId	addExplicitListItem() Add a new exception to the explicit list for the Pattern.Any entity in a version of the application.
int	addExplicitListItem(UUID appId, String versionId, UUID entityId, AddExplicitListItemOptionalParameter addExplicitListItemOptionalParameter) Add a new exception to the explicit list for the Pattern.Any entity in a version of the application.
Observable<Integer>	addExplicitListItemAsync(UUID appId, String versionId, UUID entityId, AddExplicitListItemOptionalParameter addExplicitListItemOptionalParameter) Add a new exception to the explicit list for the Pattern.Any entity in a version of the application.
ModelsAddIntentDefinitionStages.WithAppId	addIntent() Adds an intent to a version of the application.
UUID	addIntent(UUID appId, String versionId, AddIntentOptionalParameter addIntentOptionalParameter) Adds an intent to a version of the application.
Observable<UUID>	addIntentAsync(UUID appId, String versionId, AddIntentOptionalParameter addIntentOptionalParameter) Adds an intent to a version of the application.
List<PrebuiltEntityExtractor>	addPrebuilt(UUID appId, String versionId, List<String> prebuiltExtractorNames) Adds a list of prebuilt entities to a version of the application.
Observable<List<PrebuiltEntityExtractor>>	addPrebuiltAsync(UUID appId, String versionId, List<String> prebuiltExtractorNames) Adds a list of prebuilt entities to a version of the application.
long	addSubList(UUID appId, String versionId, UUID clEntityId, WordListObject wordListCreateObject) Adds a sublist to an existing list entity in a version of the application.
Observable<Long>	addSubListAsync(UUID appId, String versionId, UUID clEntityId, WordListObject wordListCreateObject) Adds a sublist to an existing list entity in a version of the application.
ModelsCreateClosedListEntityRoleDefinitionStages.WithAppId	createClosedListEntityRole() Create a role for a list entity in a version of the application.
UUID	createClosedListEntityRole(UUID appId, String versionId, UUID entityId, CreateClosedListEntityRoleOptionalParameter createClosedListEntityRoleOptionalParameter) Create a role for a list entity in a version of the application.
Observable<UUID>	createClosedListEntityRoleAsync(UUID appId, String versionId, UUID entityId, CreateClosedListEntityRoleOptionalParameter createClosedListEntityRoleOptionalParameter) Create a role for a list entity in a version of the application.
ModelsCreateCompositeEntityRoleDefinitionStages.WithAppId	createCompositeEntityRole() Create a role for a composite entity in a version of the application.
UUID	createCompositeEntityRole(UUID appId, String versionId, UUID cEntityId, CreateCompositeEntityRoleOptionalParameter createCompositeEntityRoleOptionalParameter) Create a role for a composite entity in a version of the application.
Observable<UUID>	createCompositeEntityRoleAsync(UUID appId, String versionId, UUID cEntityId, CreateCompositeEntityRoleOptionalParameter createCompositeEntityRoleOptionalParameter) Create a role for a composite entity in a version of the application.
ModelsCreateCustomPrebuiltEntityRoleDefinitionStages.WithAppId	createCustomPrebuiltEntityRole() Create a role for a prebuilt entity in a version of the application.
UUID	createCustomPrebuiltEntityRole(UUID appId, String versionId, UUID entityId, CreateCustomPrebuiltEntityRoleOptionalParameter createCustomPrebuiltEntityRoleOptionalParameter) Create a role for a prebuilt entity in a version of the application.
Observable<UUID>	createCustomPrebuiltEntityRoleAsync(UUID appId, String versionId, UUID entityId, CreateCustomPrebuiltEntityRoleOptionalParameter createCustomPrebuiltEntityRoleOptionalParameter) Create a role for a prebuilt entity in a version of the application.
ModelsCreateEntityRoleDefinitionStages.WithAppId	createEntityRole() Create an entity role in a version of the application.
UUID	createEntityRole(UUID appId, String versionId, UUID entityId, CreateEntityRoleOptionalParameter createEntityRoleOptionalParameter) Create an entity role in a version of the application.
Observable<UUID>	createEntityRoleAsync(UUID appId, String versionId, UUID entityId, CreateEntityRoleOptionalParameter createEntityRoleOptionalParameter) Create an entity role in a version of the application.
ModelsCreateHierarchicalEntityRoleDefinitionStages.WithAppId	createHierarchicalEntityRole() Create a role for an hierarchical entity in a version of the application.
UUID	createHierarchicalEntityRole(UUID appId, String versionId, UUID hEntityId, CreateHierarchicalEntityRoleOptionalParameter createHierarchicalEntityRoleOptionalParameter) Create a role for an hierarchical entity in a version of the application.
Observable<UUID>	createHierarchicalEntityRoleAsync(UUID appId, String versionId, UUID hEntityId, CreateHierarchicalEntityRoleOptionalParameter createHierarchicalEntityRoleOptionalParameter) Create a role for an hierarchical entity in a version of the application.
UUID	createPatternAnyEntityModel(UUID appId, String versionId, PatternAnyModelCreateObject extractorCreateObject) Adds a pattern.any entity extractor to a version of the application.
Observable<UUID>	createPatternAnyEntityModelAsync(UUID appId, String versionId, PatternAnyModelCreateObject extractorCreateObject) Adds a pattern.any entity extractor to a version of the application.
ModelsCreatePatternAnyEntityRoleDefinitionStages.WithAppId	createPatternAnyEntityRole() Create a role for an Pattern.any entity in a version of the application.
UUID	createPatternAnyEntityRole(UUID appId, String versionId, UUID entityId, CreatePatternAnyEntityRoleOptionalParameter createPatternAnyEntityRoleOptionalParameter) Create a role for an Pattern.any entity in a version of the application.
Observable<UUID>	createPatternAnyEntityRoleAsync(UUID appId, String versionId, UUID entityId, CreatePatternAnyEntityRoleOptionalParameter createPatternAnyEntityRoleOptionalParameter) Create a role for an Pattern.any entity in a version of the application.
ModelsCreatePrebuiltEntityRoleDefinitionStages.WithAppId	createPrebuiltEntityRole() Create a role for a prebuilt entity in a version of the application.
UUID	createPrebuiltEntityRole(UUID appId, String versionId, UUID entityId, CreatePrebuiltEntityRoleOptionalParameter createPrebuiltEntityRoleOptionalParameter) Create a role for a prebuilt entity in a version of the application.
Observable<UUID>	createPrebuiltEntityRoleAsync(UUID appId, String versionId, UUID entityId, CreatePrebuiltEntityRoleOptionalParameter createPrebuiltEntityRoleOptionalParameter) Create a role for a prebuilt entity in a version of the application.
UUID	createRegexEntityModel(UUID appId, String versionId, RegexModelCreateObject regexEntityExtractorCreateObj) Adds a regular expression entity model to a version of the application.
Observable<UUID>	createRegexEntityModelAsync(UUID appId, String versionId, RegexModelCreateObject regexEntityExtractorCreateObj) Adds a regular expression entity model to a version of the application.
ModelsCreateRegexEntityRoleDefinitionStages.WithAppId	createRegexEntityRole() Create a role for an regular expression entity in a version of the application.
UUID	createRegexEntityRole(UUID appId, String versionId, UUID entityId, CreateRegexEntityRoleOptionalParameter createRegexEntityRoleOptionalParameter) Create a role for an regular expression entity in a version of the application.
Observable<UUID>	createRegexEntityRoleAsync(UUID appId, String versionId, UUID entityId, CreateRegexEntityRoleOptionalParameter createRegexEntityRoleOptionalParameter) Create a role for an regular expression entity in a version of the application.
OperationStatus	deleteClosedList(UUID appId, String versionId, UUID clEntityId) Deletes a list entity model from a version of the application.
Observable<OperationStatus>	deleteClosedListAsync(UUID appId, String versionId, UUID clEntityId) Deletes a list entity model from a version of the application.
OperationStatus	deleteClosedListEntityRole(UUID appId, String versionId, UUID entityId, UUID roleId) Delete a role for a given list entity in a version of the application.
Observable<OperationStatus>	deleteClosedListEntityRoleAsync(UUID appId, String versionId, UUID entityId, UUID roleId) Delete a role for a given list entity in a version of the application.
OperationStatus	deleteCompositeEntity(UUID appId, String versionId, UUID cEntityId) Deletes a composite entity from a version of the application.
Observable<OperationStatus>	deleteCompositeEntityAsync(UUID appId, String versionId, UUID cEntityId) Deletes a composite entity from a version of the application.
OperationStatus	deleteCompositeEntityChild(UUID appId, String versionId, UUID cEntityId, UUID cChildId) Deletes a composite entity extractor child from a version of the application.
Observable<OperationStatus>	deleteCompositeEntityChildAsync(UUID appId, String versionId, UUID cEntityId, UUID cChildId) Deletes a composite entity extractor child from a version of the application.
OperationStatus	deleteCompositeEntityRole(UUID appId, String versionId, UUID cEntityId, UUID roleId) Delete a role for a given composite entity in a version of the application.
Observable<OperationStatus>	deleteCompositeEntityRoleAsync(UUID appId, String versionId, UUID cEntityId, UUID roleId) Delete a role for a given composite entity in a version of the application.
OperationStatus	deleteCustomEntityRole(UUID appId, String versionId, UUID entityId, UUID roleId) Delete a role for a given prebuilt entity in a version of the application.
Observable<OperationStatus>	deleteCustomEntityRoleAsync(UUID appId, String versionId, UUID entityId, UUID roleId) Delete a role for a given prebuilt entity in a version of the application.
OperationStatus	deleteCustomPrebuiltDomain(UUID appId, String versionId, String domainName) Deletes a prebuilt domain's models in a version of the application.
Observable<OperationStatus>	deleteCustomPrebuiltDomainAsync(UUID appId, String versionId, String domainName) Deletes a prebuilt domain's models in a version of the application.
OperationStatus	deleteEntity(UUID appId, String versionId, UUID entityId) Deletes an entity or a child from a version of the application.
Observable<OperationStatus>	deleteEntityAsync(UUID appId, String versionId, UUID entityId) Deletes an entity or a child from a version of the application.
OperationStatus	deleteEntityFeature(UUID appId, String versionId, UUID entityId, ModelFeatureInformation featureRelationDeleteObject) Deletes a relation from the feature relations used by the entity in a version of the application.
Observable<OperationStatus>	deleteEntityFeatureAsync(UUID appId, String versionId, UUID entityId, ModelFeatureInformation featureRelationDeleteObject) Deletes a relation from the feature relations used by the entity in a version of the application.
OperationStatus	deleteEntityRole(UUID appId, String versionId, UUID entityId, UUID roleId) Delete an entity role in a version of the application.
Observable<OperationStatus>	deleteEntityRoleAsync(UUID appId, String versionId, UUID entityId, UUID roleId) Delete an entity role in a version of the application.
OperationStatus	deleteExplicitListItem(UUID appId, String versionId, UUID entityId, long itemId) Delete an item from the explicit (exception) list for a Pattern.any entity in a version of the application.
Observable<OperationStatus>	deleteExplicitListItemAsync(UUID appId, String versionId, UUID entityId, long itemId) Delete an item from the explicit (exception) list for a Pattern.any entity in a version of the application.
OperationStatus	deleteHierarchicalEntity(UUID appId, String versionId, UUID hEntityId) Deletes a hierarchical entity from a version of the application.
Observable<OperationStatus>	deleteHierarchicalEntityAsync(UUID appId, String versionId, UUID hEntityId) Deletes a hierarchical entity from a version of the application.
OperationStatus	deleteHierarchicalEntityChild(UUID appId, String versionId, UUID hEntityId, UUID hChildId) Deletes a hierarchical entity extractor child in a version of the application.
Observable<OperationStatus>	deleteHierarchicalEntityChildAsync(UUID appId, String versionId, UUID hEntityId, UUID hChildId) Deletes a hierarchical entity extractor child in a version of the application.
OperationStatus	deleteHierarchicalEntityRole(UUID appId, String versionId, UUID hEntityId, UUID roleId) Delete a role for a given hierarchical role in a version of the application.
Observable<OperationStatus>	deleteHierarchicalEntityRoleAsync(UUID appId, String versionId, UUID hEntityId, UUID roleId) Delete a role for a given hierarchical role in a version of the application.
ModelsDeleteIntentDefinitionStages.WithAppId	deleteIntent() Deletes an intent from a version of the application.
OperationStatus	deleteIntent(UUID appId, String versionId, UUID intentId, DeleteIntentOptionalParameter deleteIntentOptionalParameter) Deletes an intent from a version of the application.
Observable<OperationStatus>	deleteIntentAsync(UUID appId, String versionId, UUID intentId, DeleteIntentOptionalParameter deleteIntentOptionalParameter) Deletes an intent from a version of the application.
OperationStatus	deleteIntentFeature(UUID appId, String versionId, UUID intentId, ModelFeatureInformation featureRelationDeleteObject) Deletes a relation from the feature relations used by the intent in a version of the application.
Observable<OperationStatus>	deleteIntentFeatureAsync(UUID appId, String versionId, UUID intentId, ModelFeatureInformation featureRelationDeleteObject) Deletes a relation from the feature relations used by the intent in a version of the application.
OperationStatus	deletePatternAnyEntityModel(UUID appId, String versionId, UUID entityId) Deletes a Pattern.Any entity extractor from a version of the application.
Observable<OperationStatus>	deletePatternAnyEntityModelAsync(UUID appId, String versionId, UUID entityId) Deletes a Pattern.Any entity extractor from a version of the application.
OperationStatus	deletePatternAnyEntityRole(UUID appId, String versionId, UUID entityId, UUID roleId) Delete a role for a given Pattern.any entity in a version of the application.
Observable<OperationStatus>	deletePatternAnyEntityRoleAsync(UUID appId, String versionId, UUID entityId, UUID roleId) Delete a role for a given Pattern.any entity in a version of the application.
OperationStatus	deletePrebuilt(UUID appId, String versionId, UUID prebuiltId) Deletes a prebuilt entity extractor from a version of the application.
Observable<OperationStatus>	deletePrebuiltAsync(UUID appId, String versionId, UUID prebuiltId) Deletes a prebuilt entity extractor from a version of the application.
OperationStatus	deletePrebuiltEntityRole(UUID appId, String versionId, UUID entityId, UUID roleId) Delete a role in a prebuilt entity in a version of the application.
Observable<OperationStatus>	deletePrebuiltEntityRoleAsync(UUID appId, String versionId, UUID entityId, UUID roleId) Delete a role in a prebuilt entity in a version of the application.
OperationStatus	deleteRegexEntityModel(UUID appId, String versionId, UUID regexEntityId) Deletes a regular expression entity from a version of the application.
Observable<OperationStatus>	deleteRegexEntityModelAsync(UUID appId, String versionId, UUID regexEntityId) Deletes a regular expression entity from a version of the application.
OperationStatus	deleteRegexEntityRole(UUID appId, String versionId, UUID entityId, UUID roleId) Delete a role for a given regular expression in a version of the application.
Observable<OperationStatus>	deleteRegexEntityRoleAsync(UUID appId, String versionId, UUID entityId, UUID roleId) Delete a role for a given regular expression in a version of the application.
OperationStatus	deleteSubList(UUID appId, String versionId, UUID clEntityId, long subListId) Deletes a sublist of a specific list entity model from a version of the application.
Observable<OperationStatus>	deleteSubListAsync(UUID appId, String versionId, UUID clEntityId, long subListId) Deletes a sublist of a specific list entity model from a version of the application.
ModelsExamplesMethodDefinitionStages.WithAppId	examplesMethod() Gets the example utterances for the given intent or entity model in a version of the application.
List<LabelTextObject>	examplesMethod(UUID appId, String versionId, String modelId, ExamplesMethodOptionalParameter examplesMethodOptionalParameter) Gets the example utterances for the given intent or entity model in a version of the application.
Observable<List<LabelTextObject>>	examplesMethodAsync(UUID appId, String versionId, String modelId, ExamplesMethodOptionalParameter examplesMethodOptionalParameter) Gets the example utterances for the given intent or entity model in a version of the application.
ClosedListEntityExtractor	getClosedList(UUID appId, String versionId, UUID clEntityId) Gets information about a list entity in a version of the application.
Observable<ClosedListEntityExtractor>	getClosedListAsync(UUID appId, String versionId, UUID clEntityId) Gets information about a list entity in a version of the application.
EntityRole	getClosedListEntityRole(UUID appId, String versionId, UUID entityId, UUID roleId) Get one role for a given list entity in a version of the application.
Observable<EntityRole>	getClosedListEntityRoleAsync(UUID appId, String versionId, UUID entityId, UUID roleId) Get one role for a given list entity in a version of the application.
CompositeEntityExtractor	getCompositeEntity(UUID appId, String versionId, UUID cEntityId) Gets information about a composite entity in a version of the application.
Observable<CompositeEntityExtractor>	getCompositeEntityAsync(UUID appId, String versionId, UUID cEntityId) Gets information about a composite entity in a version of the application.
EntityRole	getCompositeEntityRole(UUID appId, String versionId, UUID cEntityId, UUID roleId) Get one role for a given composite entity in a version of the application.
Observable<EntityRole>	getCompositeEntityRoleAsync(UUID appId, String versionId, UUID cEntityId, UUID roleId) Get one role for a given composite entity in a version of the application.
EntityRole	getCustomEntityRole(UUID appId, String versionId, UUID entityId, UUID roleId) Get one role for a given prebuilt entity in a version of the application.
Observable<EntityRole>	getCustomEntityRoleAsync(UUID appId, String versionId, UUID entityId, UUID roleId) Get one role for a given prebuilt entity in a version of the application.
NDepthEntityExtractor	getEntity(UUID appId, String versionId, UUID entityId) Gets information about an entity model in a version of the application.
Observable<NDepthEntityExtractor>	getEntityAsync(UUID appId, String versionId, UUID entityId) Gets information about an entity model in a version of the application.
List<ModelFeatureInformation>	getEntityFeatures(UUID appId, String versionId, UUID entityId) Gets the information of the features used by the entity in a version of the application.
Observable<List<ModelFeatureInformation>>	getEntityFeaturesAsync(UUID appId, String versionId, UUID entityId) Gets the information of the features used by the entity in a version of the application.
EntityRole	getEntityRole(UUID appId, String versionId, UUID entityId, UUID roleId) Get one role for a given entity in a version of the application.
Observable<EntityRole>	getEntityRoleAsync(UUID appId, String versionId, UUID entityId, UUID roleId) Get one role for a given entity in a version of the application.
List<ExplicitListItem>	getExplicitList(UUID appId, String versionId, UUID entityId) Get the explicit (exception) list of the pattern.any entity in a version of the application.
Observable<List<ExplicitListItem>>	getExplicitListAsync(UUID appId, String versionId, UUID entityId) Get the explicit (exception) list of the pattern.any entity in a version of the application.
ExplicitListItem	getExplicitListItem(UUID appId, String versionId, UUID entityId, long itemId) Get the explicit (exception) list of the pattern.any entity in a version of the application.
Observable<ExplicitListItem>	getExplicitListItemAsync(UUID appId, String versionId, UUID entityId, long itemId) Get the explicit (exception) list of the pattern.any entity in a version of the application.
HierarchicalEntityExtractor	getHierarchicalEntity(UUID appId, String versionId, UUID hEntityId) Gets information about a hierarchical entity in a version of the application.
Observable<HierarchicalEntityExtractor>	getHierarchicalEntityAsync(UUID appId, String versionId, UUID hEntityId) Gets information about a hierarchical entity in a version of the application.
HierarchicalChildEntity	getHierarchicalEntityChild(UUID appId, String versionId, UUID hEntityId, UUID hChildId) Gets information about the child's model contained in an hierarchical entity child model in a version of the application.
Observable<HierarchicalChildEntity>	getHierarchicalEntityChildAsync(UUID appId, String versionId, UUID hEntityId, UUID hChildId) Gets information about the child's model contained in an hierarchical entity child model in a version of the application.
EntityRole	getHierarchicalEntityRole(UUID appId, String versionId, UUID hEntityId, UUID roleId) Get one role for a given hierarchical entity in a version of the application.
Observable<EntityRole>	getHierarchicalEntityRoleAsync(UUID appId, String versionId, UUID hEntityId, UUID roleId) Get one role for a given hierarchical entity in a version of the application.
IntentClassifier	getIntent(UUID appId, String versionId, UUID intentId) Gets information about the intent model in a version of the application.
Observable<IntentClassifier>	getIntentAsync(UUID appId, String versionId, UUID intentId) Gets information about the intent model in a version of the application.
List<ModelFeatureInformation>	getIntentFeatures(UUID appId, String versionId, UUID intentId) Gets the information of the features used by the intent in a version of the application.
Observable<List<ModelFeatureInformation>>	getIntentFeaturesAsync(UUID appId, String versionId, UUID intentId) Gets the information of the features used by the intent in a version of the application.
PatternAnyEntityExtractor	getPatternAnyEntityInfo(UUID appId, String versionId, UUID entityId) Gets information about the Pattern.Any model in a version of the application.
Observable<PatternAnyEntityExtractor>	getPatternAnyEntityInfoAsync(UUID appId, String versionId, UUID entityId) Gets information about the Pattern.Any model in a version of the application.
EntityRole	getPatternAnyEntityRole(UUID appId, String versionId, UUID entityId, UUID roleId) Get one role for a given Pattern.any entity in a version of the application.
Observable<EntityRole>	getPatternAnyEntityRoleAsync(UUID appId, String versionId, UUID entityId, UUID roleId) Get one role for a given Pattern.any entity in a version of the application.
PrebuiltEntityExtractor	getPrebuilt(UUID appId, String versionId, UUID prebuiltId) Gets information about a prebuilt entity model in a version of the application.
Observable<PrebuiltEntityExtractor>	getPrebuiltAsync(UUID appId, String versionId, UUID prebuiltId) Gets information about a prebuilt entity model in a version of the application.
EntityRole	getPrebuiltEntityRole(UUID appId, String versionId, UUID entityId, UUID roleId) Get one role for a given prebuilt entity in a version of the application.
Observable<EntityRole>	getPrebuiltEntityRoleAsync(UUID appId, String versionId, UUID entityId, UUID roleId) Get one role for a given prebuilt entity in a version of the application.
RegexEntityExtractor	getRegexEntityEntityInfo(UUID appId, String versionId, UUID regexEntityId) Gets information about a regular expression entity in a version of the application.
Observable<RegexEntityExtractor>	getRegexEntityEntityInfoAsync(UUID appId, String versionId, UUID regexEntityId) Gets information about a regular expression entity in a version of the application.
EntityRole	getRegexEntityRole(UUID appId, String versionId, UUID entityId, UUID roleId) Get one role for a given regular expression entity in a version of the application.
Observable<EntityRole>	getRegexEntityRoleAsync(UUID appId, String versionId, UUID entityId, UUID roleId) Get one role for a given regular expression entity in a version of the application.
List<EntityRole>	listClosedListEntityRoles(UUID appId, String versionId, UUID entityId) Get all roles for a list entity in a version of the application.
Observable<List<EntityRole>>	listClosedListEntityRolesAsync(UUID appId, String versionId, UUID entityId) Get all roles for a list entity in a version of the application.
ModelsListClosedListsDefinitionStages.WithAppId	listClosedLists() Gets information about all the list entity models in a version of the application.
List<ClosedListEntityExtractor>	listClosedLists(UUID appId, String versionId, ListClosedListsOptionalParameter listClosedListsOptionalParameter) Gets information about all the list entity models in a version of the application.
Observable<List<ClosedListEntityExtractor>>	listClosedListsAsync(UUID appId, String versionId, ListClosedListsOptionalParameter listClosedListsOptionalParameter) Gets information about all the list entity models in a version of the application.
ModelsListCompositeEntitiesDefinitionStages.WithAppId	listCompositeEntities() Gets information about all the composite entity models in a version of the application.
List<CompositeEntityExtractor>	listCompositeEntities(UUID appId, String versionId, ListCompositeEntitiesOptionalParameter listCompositeEntitiesOptionalParameter) Gets information about all the composite entity models in a version of the application.
Observable<List<CompositeEntityExtractor>>	listCompositeEntitiesAsync(UUID appId, String versionId, ListCompositeEntitiesOptionalParameter listCompositeEntitiesOptionalParameter) Gets information about all the composite entity models in a version of the application.
List<EntityRole>	listCompositeEntityRoles(UUID appId, String versionId, UUID cEntityId) Get all roles for a composite entity in a version of the application.
Observable<List<EntityRole>>	listCompositeEntityRolesAsync(UUID appId, String versionId, UUID cEntityId) Get all roles for a composite entity in a version of the application.
List<EntityExtractor>	listCustomPrebuiltEntities(UUID appId, String versionId) Gets all prebuilt entities used in a version of the application.
Observable<List<EntityExtractor>>	listCustomPrebuiltEntitiesAsync(UUID appId, String versionId) Gets all prebuilt entities used in a version of the application.
List<EntityRole>	listCustomPrebuiltEntityRoles(UUID appId, String versionId, UUID entityId) Get all roles for a prebuilt entity in a version of the application.
Observable<List<EntityRole>>	listCustomPrebuiltEntityRolesAsync(UUID appId, String versionId, UUID entityId) Get all roles for a prebuilt entity in a version of the application.
List<IntentClassifier>	listCustomPrebuiltIntents(UUID appId, String versionId) Gets information about customizable prebuilt intents added to a version of the application.
Observable<List<IntentClassifier>>	listCustomPrebuiltIntentsAsync(UUID appId, String versionId) Gets information about customizable prebuilt intents added to a version of the application.
List<CustomPrebuiltModel>	listCustomPrebuiltModels(UUID appId, String versionId) Gets all prebuilt intent and entity model information used in a version of this application.
Observable<List<CustomPrebuiltModel>>	listCustomPrebuiltModelsAsync(UUID appId, String versionId) Gets all prebuilt intent and entity model information used in a version of this application.
ModelsListEntitiesDefinitionStages.WithAppId	listEntities() Gets information about all the simple entity models in a version of the application.
List<NDepthEntityExtractor>	listEntities(UUID appId, String versionId, ListEntitiesOptionalParameter listEntitiesOptionalParameter) Gets information about all the simple entity models in a version of the application.
Observable<List<NDepthEntityExtractor>>	listEntitiesAsync(UUID appId, String versionId, ListEntitiesOptionalParameter listEntitiesOptionalParameter) Gets information about all the simple entity models in a version of the application.
List<EntityRole>	listEntityRoles(UUID appId, String versionId, UUID entityId) Get all roles for an entity in a version of the application.
Observable<List<EntityRole>>	listEntityRolesAsync(UUID appId, String versionId, UUID entityId) Get all roles for an entity in a version of the application.
ModelsListEntitySuggestionsDefinitionStages.WithAppId	listEntitySuggestions() Get suggested example utterances that would improve the accuracy of the entity model in a version of the application.
List<EntitiesSuggestionExample>	listEntitySuggestions(UUID appId, String versionId, UUID entityId, ListEntitySuggestionsOptionalParameter listEntitySuggestionsOptionalParameter) Get suggested example utterances that would improve the accuracy of the entity model in a version of the application.
Observable<List<EntitiesSuggestionExample>>	listEntitySuggestionsAsync(UUID appId, String versionId, UUID entityId, ListEntitySuggestionsOptionalParameter listEntitySuggestionsOptionalParameter) Get suggested example utterances that would improve the accuracy of the entity model in a version of the application.
ModelsListHierarchicalEntitiesDefinitionStages.WithAppId	listHierarchicalEntities() Gets information about all the hierarchical entity models in a version of the application.
List<HierarchicalEntityExtractor>	listHierarchicalEntities(UUID appId, String versionId, ListHierarchicalEntitiesOptionalParameter listHierarchicalEntitiesOptionalParameter) Gets information about all the hierarchical entity models in a version of the application.
Observable<List<HierarchicalEntityExtractor>>	listHierarchicalEntitiesAsync(UUID appId, String versionId, ListHierarchicalEntitiesOptionalParameter listHierarchicalEntitiesOptionalParameter) Gets information about all the hierarchical entity models in a version of the application.
List<EntityRole>	listHierarchicalEntityRoles(UUID appId, String versionId, UUID hEntityId) Get all roles for a hierarchical entity in a version of the application.
Observable<List<EntityRole>>	listHierarchicalEntityRolesAsync(UUID appId, String versionId, UUID hEntityId) Get all roles for a hierarchical entity in a version of the application.
ModelsListIntentsDefinitionStages.WithAppId	listIntents() Gets information about the intent models in a version of the application.
List<IntentClassifier>	listIntents(UUID appId, String versionId, ListIntentsOptionalParameter listIntentsOptionalParameter) Gets information about the intent models in a version of the application.
Observable<List<IntentClassifier>>	listIntentsAsync(UUID appId, String versionId, ListIntentsOptionalParameter listIntentsOptionalParameter) Gets information about the intent models in a version of the application.
ModelsListIntentSuggestionsDefinitionStages.WithAppId	listIntentSuggestions() Suggests example utterances that would improve the accuracy of the intent model in a version of the application.
List<IntentsSuggestionExample>	listIntentSuggestions(UUID appId, String versionId, UUID intentId, ListIntentSuggestionsOptionalParameter listIntentSuggestionsOptionalParameter) Suggests example utterances that would improve the accuracy of the intent model in a version of the application.
Observable<List<IntentsSuggestionExample>>	listIntentSuggestionsAsync(UUID appId, String versionId, UUID intentId, ListIntentSuggestionsOptionalParameter listIntentSuggestionsOptionalParameter) Suggests example utterances that would improve the accuracy of the intent model in a version of the application.
ModelsListModelsDefinitionStages.WithAppId	listModels() Gets information about all the intent and entity models in a version of the application.
List<ModelInfoResponse>	listModels(UUID appId, String versionId, ListModelsOptionalParameter listModelsOptionalParameter) Gets information about all the intent and entity models in a version of the application.
Observable<List<ModelInfoResponse>>	listModelsAsync(UUID appId, String versionId, ListModelsOptionalParameter listModelsOptionalParameter) Gets information about all the intent and entity models in a version of the application.
ModelsListPatternAnyEntityInfosDefinitionStages.WithAppId	listPatternAnyEntityInfos() Get information about the Pattern.Any entity models in a version of the application.
List<PatternAnyEntityExtractor>	listPatternAnyEntityInfos(UUID appId, String versionId, ListPatternAnyEntityInfosOptionalParameter listPatternAnyEntityInfosOptionalParameter) Get information about the Pattern.Any entity models in a version of the application.
Observable<List<PatternAnyEntityExtractor>>	listPatternAnyEntityInfosAsync(UUID appId, String versionId, ListPatternAnyEntityInfosOptionalParameter listPatternAnyEntityInfosOptionalParameter) Get information about the Pattern.Any entity models in a version of the application.
List<EntityRole>	listPatternAnyEntityRoles(UUID appId, String versionId, UUID entityId) Get all roles for a Pattern.any entity in a version of the application.
Observable<List<EntityRole>>	listPatternAnyEntityRolesAsync(UUID appId, String versionId, UUID entityId) Get all roles for a Pattern.any entity in a version of the application.
List<AvailablePrebuiltEntityModel>	listPrebuiltEntities(UUID appId, String versionId) Gets all the available prebuilt entities in a version of the application.
Observable<List<AvailablePrebuiltEntityModel>>	listPrebuiltEntitiesAsync(UUID appId, String versionId) Gets all the available prebuilt entities in a version of the application.
List<EntityRole>	listPrebuiltEntityRoles(UUID appId, String versionId, UUID entityId) Get a prebuilt entity's roles in a version of the application.
Observable<List<EntityRole>>	listPrebuiltEntityRolesAsync(UUID appId, String versionId, UUID entityId) Get a prebuilt entity's roles in a version of the application.
ModelsListPrebuiltsDefinitionStages.WithAppId	listPrebuilts() Gets information about all the prebuilt entities in a version of the application.
List<PrebuiltEntityExtractor>	listPrebuilts(UUID appId, String versionId, ListPrebuiltsOptionalParameter listPrebuiltsOptionalParameter) Gets information about all the prebuilt entities in a version of the application.
Observable<List<PrebuiltEntityExtractor>>	listPrebuiltsAsync(UUID appId, String versionId, ListPrebuiltsOptionalParameter listPrebuiltsOptionalParameter) Gets information about all the prebuilt entities in a version of the application.
ModelsListRegexEntityInfosDefinitionStages.WithAppId	listRegexEntityInfos() Gets information about the regular expression entity models in a version of the application.
List<RegexEntityExtractor>	listRegexEntityInfos(UUID appId, String versionId, ListRegexEntityInfosOptionalParameter listRegexEntityInfosOptionalParameter) Gets information about the regular expression entity models in a version of the application.
Observable<List<RegexEntityExtractor>>	listRegexEntityInfosAsync(UUID appId, String versionId, ListRegexEntityInfosOptionalParameter listRegexEntityInfosOptionalParameter) Gets information about the regular expression entity models in a version of the application.
List<EntityRole>	listRegexEntityRoles(UUID appId, String versionId, UUID entityId) Get all roles for a regular expression entity in a version of the application.
Observable<List<EntityRole>>	listRegexEntityRolesAsync(UUID appId, String versionId, UUID entityId) Get all roles for a regular expression entity in a version of the application.
ModelsPatchClosedListDefinitionStages.WithAppId	patchClosedList() Adds a batch of sublists to an existing list entity in a version of the application.
OperationStatus	patchClosedList(UUID appId, String versionId, UUID clEntityId, PatchClosedListOptionalParameter patchClosedListOptionalParameter) Adds a batch of sublists to an existing list entity in a version of the application.
Observable<OperationStatus>	patchClosedListAsync(UUID appId, String versionId, UUID clEntityId, PatchClosedListOptionalParameter patchClosedListOptionalParameter) Adds a batch of sublists to an existing list entity in a version of the application.
OperationStatus	replaceEntityFeatures(UUID appId, String versionId, UUID entityId, List<ModelFeatureInformation> featureRelationsUpdateObject) Updates the information of the features used by the entity in a version of the application.
Observable<OperationStatus>	replaceEntityFeaturesAsync(UUID appId, String versionId, UUID entityId, List<ModelFeatureInformation> featureRelationsUpdateObject) Updates the information of the features used by the entity in a version of the application.
OperationStatus	replaceIntentFeatures(UUID appId, String versionId, UUID intentId, List<ModelFeatureInformation> featureRelationsUpdateObject) Updates the information of the features used by the intent in a version of the application.
Observable<OperationStatus>	replaceIntentFeaturesAsync(UUID appId, String versionId, UUID intentId, List<ModelFeatureInformation> featureRelationsUpdateObject) Updates the information of the features used by the intent in a version of the application.
OperationStatus	updateClosedList(UUID appId, String versionId, UUID clEntityId, ClosedListModelUpdateObject closedListModelUpdateObject) Updates the list entity in a version of the application.
Observable<OperationStatus>	updateClosedListAsync(UUID appId, String versionId, UUID clEntityId, ClosedListModelUpdateObject closedListModelUpdateObject) Updates the list entity in a version of the application.
ModelsUpdateClosedListEntityRoleDefinitionStages.WithAppId	updateClosedListEntityRole() Update a role for a given list entity in a version of the application.
OperationStatus	updateClosedListEntityRole(UUID appId, String versionId, UUID entityId, UUID roleId, UpdateClosedListEntityRoleOptionalParameter updateClosedListEntityRoleOptionalParameter) Update a role for a given list entity in a version of the application.
Observable<OperationStatus>	updateClosedListEntityRoleAsync(UUID appId, String versionId, UUID entityId, UUID roleId, UpdateClosedListEntityRoleOptionalParameter updateClosedListEntityRoleOptionalParameter) Update a role for a given list entity in a version of the application.
OperationStatus	updateCompositeEntity(UUID appId, String versionId, UUID cEntityId, CompositeEntityModel compositeModelUpdateObject) Updates a composite entity in a version of the application.
Observable<OperationStatus>	updateCompositeEntityAsync(UUID appId, String versionId, UUID cEntityId, CompositeEntityModel compositeModelUpdateObject) Updates a composite entity in a version of the application.
ModelsUpdateCompositeEntityRoleDefinitionStages.WithAppId	updateCompositeEntityRole() Update a role for a given composite entity in a version of the application.
OperationStatus	updateCompositeEntityRole(UUID appId, String versionId, UUID cEntityId, UUID roleId, UpdateCompositeEntityRoleOptionalParameter updateCompositeEntityRoleOptionalParameter) Update a role for a given composite entity in a version of the application.
Observable<OperationStatus>	updateCompositeEntityRoleAsync(UUID appId, String versionId, UUID cEntityId, UUID roleId, UpdateCompositeEntityRoleOptionalParameter updateCompositeEntityRoleOptionalParameter) Update a role for a given composite entity in a version of the application.
ModelsUpdateCustomPrebuiltEntityRoleDefinitionStages.WithAppId	updateCustomPrebuiltEntityRole() Update a role for a given prebuilt entity in a version of the application.
OperationStatus	updateCustomPrebuiltEntityRole(UUID appId, String versionId, UUID entityId, UUID roleId, UpdateCustomPrebuiltEntityRoleOptionalParameter updateCustomPrebuiltEntityRoleOptionalParameter) Update a role for a given prebuilt entity in a version of the application.
Observable<OperationStatus>	updateCustomPrebuiltEntityRoleAsync(UUID appId, String versionId, UUID entityId, UUID roleId, UpdateCustomPrebuiltEntityRoleOptionalParameter updateCustomPrebuiltEntityRoleOptionalParameter) Update a role for a given prebuilt entity in a version of the application.
OperationStatus	updateEntityChild(UUID appId, String versionId, UUID entityId, EntityModelUpdateObject entityModelUpdateObject) Updates the name of an entity extractor or the name and instanceOf model of a child entity extractor.
Observable<OperationStatus>	updateEntityChildAsync(UUID appId, String versionId, UUID entityId, EntityModelUpdateObject entityModelUpdateObject) Updates the name of an entity extractor or the name and instanceOf model of a child entity extractor.
ModelsUpdateEntityRoleDefinitionStages.WithAppId	updateEntityRole() Update a role for a given entity in a version of the application.
OperationStatus	updateEntityRole(UUID appId, String versionId, UUID entityId, UUID roleId, UpdateEntityRoleOptionalParameter updateEntityRoleOptionalParameter) Update a role for a given entity in a version of the application.
Observable<OperationStatus>	updateEntityRoleAsync(UUID appId, String versionId, UUID entityId, UUID roleId, UpdateEntityRoleOptionalParameter updateEntityRoleOptionalParameter) Update a role for a given entity in a version of the application.
ModelsUpdateExplicitListItemDefinitionStages.WithAppId	updateExplicitListItem() Updates an explicit (exception) list item for a Pattern.Any entity in a version of the application.
OperationStatus	updateExplicitListItem(UUID appId, String versionId, UUID entityId, long itemId, UpdateExplicitListItemOptionalParameter updateExplicitListItemOptionalParameter) Updates an explicit (exception) list item for a Pattern.Any entity in a version of the application.
Observable<OperationStatus>	updateExplicitListItemAsync(UUID appId, String versionId, UUID entityId, long itemId, UpdateExplicitListItemOptionalParameter updateExplicitListItemOptionalParameter) Updates an explicit (exception) list item for a Pattern.Any entity in a version of the application.
ModelsUpdateHierarchicalEntityDefinitionStages.WithAppId	updateHierarchicalEntity() Updates the name of a hierarchical entity model in a version of the application.
OperationStatus	updateHierarchicalEntity(UUID appId, String versionId, UUID hEntityId, UpdateHierarchicalEntityOptionalParameter updateHierarchicalEntityOptionalParameter) Updates the name of a hierarchical entity model in a version of the application.
Observable<OperationStatus>	updateHierarchicalEntityAsync(UUID appId, String versionId, UUID hEntityId, UpdateHierarchicalEntityOptionalParameter updateHierarchicalEntityOptionalParameter) Updates the name of a hierarchical entity model in a version of the application.
ModelsUpdateHierarchicalEntityChildDefinitionStages.WithAppId	updateHierarchicalEntityChild() Renames a single child in an existing hierarchical entity model in a version of the application.
OperationStatus	updateHierarchicalEntityChild(UUID appId, String versionId, UUID hEntityId, UUID hChildId, UpdateHierarchicalEntityChildOptionalParameter updateHierarchicalEntityChildOptionalParameter) Renames a single child in an existing hierarchical entity model in a version of the application.
Observable<OperationStatus>	updateHierarchicalEntityChildAsync(UUID appId, String versionId, UUID hEntityId, UUID hChildId, UpdateHierarchicalEntityChildOptionalParameter updateHierarchicalEntityChildOptionalParameter) Renames a single child in an existing hierarchical entity model in a version of the application.
ModelsUpdateHierarchicalEntityRoleDefinitionStages.WithAppId	updateHierarchicalEntityRole() Update a role for a given hierarchical entity in a version of the application.
OperationStatus	updateHierarchicalEntityRole(UUID appId, String versionId, UUID hEntityId, UUID roleId, UpdateHierarchicalEntityRoleOptionalParameter updateHierarchicalEntityRoleOptionalParameter) Update a role for a given hierarchical entity in a version of the application.
Observable<OperationStatus>	updateHierarchicalEntityRoleAsync(UUID appId, String versionId, UUID hEntityId, UUID roleId, UpdateHierarchicalEntityRoleOptionalParameter updateHierarchicalEntityRoleOptionalParameter) Update a role for a given hierarchical entity in a version of the application.
ModelsUpdateIntentDefinitionStages.WithAppId	updateIntent() Updates the name of an intent in a version of the application.
OperationStatus	updateIntent(UUID appId, String versionId, UUID intentId, UpdateIntentOptionalParameter updateIntentOptionalParameter) Updates the name of an intent in a version of the application.
Observable<OperationStatus>	updateIntentAsync(UUID appId, String versionId, UUID intentId, UpdateIntentOptionalParameter updateIntentOptionalParameter) Updates the name of an intent in a version of the application.
OperationStatus	updatePatternAnyEntityModel(UUID appId, String versionId, UUID entityId, PatternAnyModelUpdateObject patternAnyUpdateObject) Updates the name and explicit (exception) list of a Pattern.Any entity model in a version of the application.
Observable<OperationStatus>	updatePatternAnyEntityModelAsync(UUID appId, String versionId, UUID entityId, PatternAnyModelUpdateObject patternAnyUpdateObject) Updates the name and explicit (exception) list of a Pattern.Any entity model in a version of the application.
ModelsUpdatePatternAnyEntityRoleDefinitionStages.WithAppId	updatePatternAnyEntityRole() Update a role for a given Pattern.any entity in a version of the application.
OperationStatus	updatePatternAnyEntityRole(UUID appId, String versionId, UUID entityId, UUID roleId, UpdatePatternAnyEntityRoleOptionalParameter updatePatternAnyEntityRoleOptionalParameter) Update a role for a given Pattern.any entity in a version of the application.
Observable<OperationStatus>	updatePatternAnyEntityRoleAsync(UUID appId, String versionId, UUID entityId, UUID roleId, UpdatePatternAnyEntityRoleOptionalParameter updatePatternAnyEntityRoleOptionalParameter) Update a role for a given Pattern.any entity in a version of the application.
ModelsUpdatePrebuiltEntityRoleDefinitionStages.WithAppId	updatePrebuiltEntityRole() Update a role for a given prebuilt entity in a version of the application.
OperationStatus	updatePrebuiltEntityRole(UUID appId, String versionId, UUID entityId, UUID roleId, UpdatePrebuiltEntityRoleOptionalParameter updatePrebuiltEntityRoleOptionalParameter) Update a role for a given prebuilt entity in a version of the application.
Observable<OperationStatus>	updatePrebuiltEntityRoleAsync(UUID appId, String versionId, UUID entityId, UUID roleId, UpdatePrebuiltEntityRoleOptionalParameter updatePrebuiltEntityRoleOptionalParameter) Update a role for a given prebuilt entity in a version of the application.
OperationStatus	updateRegexEntityModel(UUID appId, String versionId, UUID regexEntityId, RegexModelUpdateObject regexEntityUpdateObject) Updates the regular expression entity in a version of the application.
Observable<OperationStatus>	updateRegexEntityModelAsync(UUID appId, String versionId, UUID regexEntityId, RegexModelUpdateObject regexEntityUpdateObject) Updates the regular expression entity in a version of the application.
ModelsUpdateRegexEntityRoleDefinitionStages.WithAppId	updateRegexEntityRole() Update a role for a given regular expression entity in a version of the application.
OperationStatus	updateRegexEntityRole(UUID appId, String versionId, UUID entityId, UUID roleId, UpdateRegexEntityRoleOptionalParameter updateRegexEntityRoleOptionalParameter) Update a role for a given regular expression entity in a version of the application.
Observable<OperationStatus>	updateRegexEntityRoleAsync(UUID appId, String versionId, UUID entityId, UUID roleId, UpdateRegexEntityRoleOptionalParameter updateRegexEntityRoleOptionalParameter) Update a role for a given regular expression entity in a version of the application.
OperationStatus	updateSubList(UUID appId, String versionId, UUID clEntityId, long subListId, WordListBaseUpdateObject wordListBaseUpdateObject) Updates one of the list entity's sublists in a version of the application.
Observable<OperationStatus>	updateSubListAsync(UUID appId, String versionId, UUID clEntityId, long subListId, WordListBaseUpdateObject wordListBaseUpdateObject) Updates one of the list entity's sublists in a version of the application.

Method Details

addClosedList

public UUID addClosedList(UUID appId, String versionId, ClosedListModelCreateObject closedListModelCreateObject)

Adds a list entity model to a version of the application.

Parameters:

appId - The application ID.

versionId - The version ID.

closedListModelCreateObject - A model containing the name and words for the new list entity extractor.

Returns:

the UUID object if successful.

Throws:

IllegalArgumentException - thrown if parameters fail the validation

ErrorResponseException - thrown if the request is rejected by server

RuntimeException - all other wrapped checked exceptions if the request fails to be sent

addClosedListAsync

public Observable addClosedListAsync(UUID appId, String versionId, ClosedListModelCreateObject closedListModelCreateObject)

Adds a list entity model to a version of the application.

Parameters:

appId - The application ID.

versionId - The version ID.

closedListModelCreateObject - A model containing the name and words for the new list entity extractor.

Returns:

the observable to the UUID object

Throws:

IllegalArgumentException - thrown if parameters fail the validation

addCompositeEntityChild

public ModelsAddCompositeEntityChildDefinitionStages.WithAppId addCompositeEntityChild()

Creates a single child in an existing composite entity model in a version of the application.

Returns:

the first stage of the addCompositeEntityChild call

addCompositeEntityChild

public UUID addCompositeEntityChild(UUID appId, String versionId, UUID cEntityId, AddCompositeEntityChildOptionalParameter addCompositeEntityChildOptionalParameter)

Creates a single child in an existing composite entity model in a version of the application.

Parameters:

appId - The application ID.

versionId - The version ID.

cEntityId - The composite entity extractor ID.

addCompositeEntityChildOptionalParameter - the object representing the optional parameters to be set before calling this API

Returns:

the UUID object if successful.

Throws:

IllegalArgumentException - thrown if parameters fail the validation

ErrorResponseException - thrown if the request is rejected by server

RuntimeException - all other wrapped checked exceptions if the request fails to be sent

addCompositeEntityChildAsync

public Observable addCompositeEntityChildAsync(UUID appId, String versionId, UUID cEntityId, AddCompositeEntityChildOptionalParameter addCompositeEntityChildOptionalParameter)

Creates a single child in an existing composite entity model in a version of the application.

Parameters:

appId - The application ID.

versionId - The version ID.

cEntityId - The composite entity extractor ID.

addCompositeEntityChildOptionalParameter - the object representing the optional parameters to be set before calling this API

Returns:

the observable to the UUID object

Throws:

IllegalArgumentException - thrown if parameters fail the validation

addCustomPrebuiltDomain

public ModelsAddCustomPrebuiltDomainDefinitionStages.WithAppId addCustomPrebuiltDomain()

Adds a customizable prebuilt domain along with all of its intent and entity models in a version of the application.

Returns:

the first stage of the addCustomPrebuiltDomain call

addCustomPrebuiltDomain

public List addCustomPrebuiltDomain(UUID appId, String versionId, AddCustomPrebuiltDomainModelsOptionalParameter addCustomPrebuiltDomainOptionalParameter)

Adds a customizable prebuilt domain along with all of its intent and entity models in a version of the application.

Parameters:

appId - The application ID.

versionId - The version ID.

addCustomPrebuiltDomainOptionalParameter - the object representing the optional parameters to be set before calling this API

Returns:

the List<UUID> object if successful.

Throws:

IllegalArgumentException - thrown if parameters fail the validation

ErrorResponseException - thrown if the request is rejected by server

RuntimeException - all other wrapped checked exceptions if the request fails to be sent

addCustomPrebuiltDomainAsync

public Observable> addCustomPrebuiltDomainAsync(UUID appId, String versionId, AddCustomPrebuiltDomainModelsOptionalParameter addCustomPrebuiltDomainOptionalParameter)

Adds a customizable prebuilt domain along with all of its intent and entity models in a version of the application.

Parameters:

appId - The application ID.

versionId - The version ID.

addCustomPrebuiltDomainOptionalParameter - the object representing the optional parameters to be set before calling this API

Returns:

the observable to the List<UUID> object

Throws:

IllegalArgumentException - thrown if parameters fail the validation

addCustomPrebuiltEntity

public UUID addCustomPrebuiltEntity(UUID appId, String versionId, PrebuiltDomainModelCreateObject prebuiltDomainModelCreateObject)

Adds a prebuilt entity model to a version of the application.

Parameters:

appId - The application ID.

versionId - The version ID.

prebuiltDomainModelCreateObject - A model object containing the name of the prebuilt entity and the name of the domain to which this model belongs.

Returns:

the UUID object if successful.

Throws:

IllegalArgumentException - thrown if parameters fail the validation

ErrorResponseException - thrown if the request is rejected by server

RuntimeException - all other wrapped checked exceptions if the request fails to be sent

addCustomPrebuiltEntityAsync

public Observable addCustomPrebuiltEntityAsync(UUID appId, String versionId, PrebuiltDomainModelCreateObject prebuiltDomainModelCreateObject)

Adds a prebuilt entity model to a version of the application.

Parameters:

appId - The application ID.

versionId - The version ID.

prebuiltDomainModelCreateObject - A model object containing the name of the prebuilt entity and the name of the domain to which this model belongs.

Returns:

the observable to the UUID object

Throws:

IllegalArgumentException - thrown if parameters fail the validation

addCustomPrebuiltIntent

public UUID addCustomPrebuiltIntent(UUID appId, String versionId, PrebuiltDomainModelCreateObject prebuiltDomainModelCreateObject)

Adds a customizable prebuilt intent model to a version of the application.

Parameters:

appId - The application ID.

versionId - The version ID.

prebuiltDomainModelCreateObject - A model object containing the name of the customizable prebuilt intent and the name of the domain to which this model belongs.

Returns:

the UUID object if successful.

Throws:

IllegalArgumentException - thrown if parameters fail the validation

ErrorResponseException - thrown if the request is rejected by server

RuntimeException - all other wrapped checked exceptions if the request fails to be sent

addCustomPrebuiltIntentAsync

public Observable addCustomPrebuiltIntentAsync(UUID appId, String versionId, PrebuiltDomainModelCreateObject prebuiltDomainModelCreateObject)

Adds a customizable prebuilt intent model to a version of the application.

Parameters:

appId - The application ID.

versionId - The version ID.

prebuiltDomainModelCreateObject - A model object containing the name of the customizable prebuilt intent and the name of the domain to which this model belongs.

Returns:

the observable to the UUID object

Throws:

IllegalArgumentException - thrown if parameters fail the validation

addEntity

public UUID addEntity(UUID appId, String versionId, EntityModelCreateObject entityModelCreateObject)

Adds an entity extractor to a version of the application.

Parameters:

appId - The application ID.

versionId - The version ID.

entityModelCreateObject - A model object containing the name of the new entity extractor and its children.

Returns:

the UUID object if successful.

Throws:

IllegalArgumentException - thrown if parameters fail the validation

ErrorResponseException - thrown if the request is rejected by server

RuntimeException - all other wrapped checked exceptions if the request fails to be sent

addEntityAsync

public Observable addEntityAsync(UUID appId, String versionId, EntityModelCreateObject entityModelCreateObject)

Adds an entity extractor to a version of the application.

Parameters:

appId - The application ID.

versionId - The version ID.

entityModelCreateObject - A model object containing the name of the new entity extractor and its children.

Returns:

the observable to the UUID object

Throws:

IllegalArgumentException - thrown if parameters fail the validation

addEntityChild

public UUID addEntityChild(UUID appId, String versionId, UUID entityId, ChildEntityModelCreateObject childEntityModelCreateObject)

Creates a single child in an existing entity model hierarchy in a version of the application.

Parameters:

appId - The application ID.

versionId - The version ID.

entityId - The entity extractor ID.

childEntityModelCreateObject - A model object containing the name of the new child model and its children.

Returns:

the UUID object if successful.

Throws:

IllegalArgumentException - thrown if parameters fail the validation

ErrorResponseException - thrown if the request is rejected by server

RuntimeException - all other wrapped checked exceptions if the request fails to be sent

addEntityChildAsync

public Observable addEntityChildAsync(UUID appId, String versionId, UUID entityId, ChildEntityModelCreateObject childEntityModelCreateObject)

Creates a single child in an existing entity model hierarchy in a version of the application.

Parameters:

appId - The application ID.

versionId - The version ID.

entityId - The entity extractor ID.

childEntityModelCreateObject - A model object containing the name of the new child model and its children.

Returns:

the observable to the UUID object

Throws:

IllegalArgumentException - thrown if parameters fail the validation

addExplicitListItem

public ModelsAddExplicitListItemDefinitionStages.WithAppId addExplicitListItem()

Add a new exception to the explicit list for the Pattern.Any entity in a version of the application.

Returns:

the first stage of the addExplicitListItem call

addExplicitListItem

public int addExplicitListItem(UUID appId, String versionId, UUID entityId, AddExplicitListItemOptionalParameter addExplicitListItemOptionalParameter)

Add a new exception to the explicit list for the Pattern.Any entity in a version of the application.

Parameters:

appId - The application ID.

versionId - The version ID.

entityId - The Pattern.Any entity extractor ID.

addExplicitListItemOptionalParameter - the object representing the optional parameters to be set before calling this API

Returns:

the int object if successful.

Throws:

IllegalArgumentException - thrown if parameters fail the validation

ErrorResponseException - thrown if the request is rejected by server

RuntimeException - all other wrapped checked exceptions if the request fails to be sent

addExplicitListItemAsync

public Observable addExplicitListItemAsync(UUID appId, String versionId, UUID entityId, AddExplicitListItemOptionalParameter addExplicitListItemOptionalParameter)

Add a new exception to the explicit list for the Pattern.Any entity in a version of the application.

Parameters:

appId - The application ID.

versionId - The version ID.

entityId - The Pattern.Any entity extractor ID.

addExplicitListItemOptionalParameter - the object representing the optional parameters to be set before calling this API

Returns:

the observable to the int object

Throws:

IllegalArgumentException - thrown if parameters fail the validation

addIntent

public ModelsAddIntentDefinitionStages.WithAppId addIntent()

Adds an intent to a version of the application.

Returns:

the first stage of the addIntent call

addIntent

public UUID addIntent(UUID appId, String versionId, AddIntentOptionalParameter addIntentOptionalParameter)

Adds an intent to a version of the application.

Parameters:

appId - The application ID.

versionId - The version ID.

addIntentOptionalParameter - the object representing the optional parameters to be set before calling this API

Returns:

the UUID object if successful.

Throws:

IllegalArgumentException - thrown if parameters fail the validation

ErrorResponseException - thrown if the request is rejected by server

RuntimeException - all other wrapped checked exceptions if the request fails to be sent

addIntentAsync

public Observable addIntentAsync(UUID appId, String versionId, AddIntentOptionalParameter addIntentOptionalParameter)

Adds an intent to a version of the application.

Parameters:

appId - The application ID.

versionId - The version ID.

addIntentOptionalParameter - the object representing the optional parameters to be set before calling this API

Returns:

the observable to the UUID object

Throws:

IllegalArgumentException - thrown if parameters fail the validation

addPrebuilt

public List addPrebuilt(UUID appId, String versionId, List prebuiltExtractorNames)

Adds a list of prebuilt entities to a version of the application.

Parameters:

appId - The application ID.

versionId - The version ID.

prebuiltExtractorNames - An array of prebuilt entity extractor names.

Returns:

the List<PrebuiltEntityExtractor> object if successful.

Throws:

IllegalArgumentException - thrown if parameters fail the validation

ErrorResponseException - thrown if the request is rejected by server

RuntimeException - all other wrapped checked exceptions if the request fails to be sent

addPrebuiltAsync

public Observable> addPrebuiltAsync(UUID appId, String versionId, List prebuiltExtractorNames)

Adds a list of prebuilt entities to a version of the application.

Parameters:

appId - The application ID.

versionId - The version ID.

prebuiltExtractorNames - An array of prebuilt entity extractor names.

Returns:

the observable to the List<PrebuiltEntityExtractor> object

Throws:

IllegalArgumentException - thrown if parameters fail the validation

addSubList

public long addSubList(UUID appId, String versionId, UUID clEntityId, WordListObject wordListCreateObject)

Adds a sublist to an existing list entity in a version of the application.

Parameters:

appId - The application ID.

versionId - The version ID.

clEntityId - The list entity extractor ID.

wordListCreateObject - Words list.

Returns:

the long object if successful.

Throws:

IllegalArgumentException - thrown if parameters fail the validation

ErrorResponseException - thrown if the request is rejected by server

RuntimeException - all other wrapped checked exceptions if the request fails to be sent

addSubListAsync

public Observable addSubListAsync(UUID appId, String versionId, UUID clEntityId, WordListObject wordListCreateObject)

Adds a sublist to an existing list entity in a version of the application.

Parameters:

appId - The application ID.

versionId - The version ID.

clEntityId - The list entity extractor ID.

wordListCreateObject - Words list.

Returns:

the observable to the long object

Throws:

IllegalArgumentException - thrown if parameters fail the validation

createClosedListEntityRole

public ModelsCreateClosedListEntityRoleDefinitionStages.WithAppId createClosedListEntityRole()

Create a role for a list entity in a version of the application.

Returns:

the first stage of the createClosedListEntityRole call

createClosedListEntityRole

public UUID createClosedListEntityRole(UUID appId, String versionId, UUID entityId, CreateClosedListEntityRoleOptionalParameter createClosedListEntityRoleOptionalParameter)

Create a role for a list entity in a version of the application.

Parameters:

appId - The application ID.

versionId - The version ID.

entityId - The entity model ID.

createClosedListEntityRoleOptionalParameter - the object representing the optional parameters to be set before calling this API

Returns:

the UUID object if successful.

Throws:

IllegalArgumentException - thrown if parameters fail the validation

ErrorResponseException - thrown if the request is rejected by server

RuntimeException - all other wrapped checked exceptions if the request fails to be sent

createClosedListEntityRoleAsync

public Observable createClosedListEntityRoleAsync(UUID appId, String versionId, UUID entityId, CreateClosedListEntityRoleOptionalParameter createClosedListEntityRoleOptionalParameter)

Create a role for a list entity in a version of the application.

Parameters:

appId - The application ID.

versionId - The version ID.

entityId - The entity model ID.

createClosedListEntityRoleOptionalParameter - the object representing the optional parameters to be set before calling this API

Returns:

the observable to the UUID object

Throws:

IllegalArgumentException - thrown if parameters fail the validation

createCompositeEntityRole

public ModelsCreateCompositeEntityRoleDefinitionStages.WithAppId createCompositeEntityRole()

Create a role for a composite entity in a version of the application.

Returns:

the first stage of the createCompositeEntityRole call

createCompositeEntityRole

public UUID createCompositeEntityRole(UUID appId, String versionId, UUID cEntityId, CreateCompositeEntityRoleOptionalParameter createCompositeEntityRoleOptionalParameter)

Create a role for a composite entity in a version of the application.

Parameters:

appId - The application ID.

versionId - The version ID.

cEntityId - The composite entity extractor ID.

createCompositeEntityRoleOptionalParameter - the object representing the optional parameters to be set before calling this API

Returns:

the UUID object if successful.

Throws:

IllegalArgumentException - thrown if parameters fail the validation

ErrorResponseException - thrown if the request is rejected by server

RuntimeException - all other wrapped checked exceptions if the request fails to be sent

createCompositeEntityRoleAsync

public Observable createCompositeEntityRoleAsync(UUID appId, String versionId, UUID cEntityId, CreateCompositeEntityRoleOptionalParameter createCompositeEntityRoleOptionalParameter)

Create a role for a composite entity in a version of the application.

Parameters:

appId - The application ID.

versionId - The version ID.

cEntityId - The composite entity extractor ID.

createCompositeEntityRoleOptionalParameter - the object representing the optional parameters to be set before calling this API

Returns:

the observable to the UUID object

Throws:

IllegalArgumentException - thrown if parameters fail the validation

createCustomPrebuiltEntityRole

public ModelsCreateCustomPrebuiltEntityRoleDefinitionStages.WithAppId createCustomPrebuiltEntityRole()

Create a role for a prebuilt entity in a version of the application.

Returns:

the first stage of the createCustomPrebuiltEntityRole call

createCustomPrebuiltEntityRole

public UUID createCustomPrebuiltEntityRole(UUID appId, String versionId, UUID entityId, CreateCustomPrebuiltEntityRoleOptionalParameter createCustomPrebuiltEntityRoleOptionalParameter)

Create a role for a prebuilt entity in a version of the application.

Parameters:

appId - The application ID.

versionId - The version ID.

entityId - The entity model ID.

createCustomPrebuiltEntityRoleOptionalParameter - the object representing the optional parameters to be set before calling this API

Returns:

the UUID object if successful.

Throws:

IllegalArgumentException - thrown if parameters fail the validation

ErrorResponseException - thrown if the request is rejected by server

RuntimeException - all other wrapped checked exceptions if the request fails to be sent

createCustomPrebuiltEntityRoleAsync

public Observable createCustomPrebuiltEntityRoleAsync(UUID appId, String versionId, UUID entityId, CreateCustomPrebuiltEntityRoleOptionalParameter createCustomPrebuiltEntityRoleOptionalParameter)

Create a role for a prebuilt entity in a version of the application.

Parameters:

appId - The application ID.

versionId - The version ID.

entityId - The entity model ID.

createCustomPrebuiltEntityRoleOptionalParameter - the object representing the optional parameters to be set before calling this API

Returns:

the observable to the UUID object

Throws:

IllegalArgumentException - thrown if parameters fail the validation

createEntityRole

public ModelsCreateEntityRoleDefinitionStages.WithAppId createEntityRole()

Create an entity role in a version of the application.

Returns:

the first stage of the createEntityRole call

createEntityRole

public UUID createEntityRole(UUID appId, String versionId, UUID entityId, CreateEntityRoleOptionalParameter createEntityRoleOptionalParameter)

Create an entity role in a version of the application.

Parameters:

appId - The application ID.

versionId - The version ID.

entityId - The entity model ID.

createEntityRoleOptionalParameter - the object representing the optional parameters to be set before calling this API

Returns:

the UUID object if successful.

Throws:

IllegalArgumentException - thrown if parameters fail the validation

ErrorResponseException - thrown if the request is rejected by server

RuntimeException - all other wrapped checked exceptions if the request fails to be sent

createEntityRoleAsync

public Observable createEntityRoleAsync(UUID appId, String versionId, UUID entityId, CreateEntityRoleOptionalParameter createEntityRoleOptionalParameter)

Create an entity role in a version of the application.

Parameters:

appId - The application ID.

versionId - The version ID.

entityId - The entity model ID.

createEntityRoleOptionalParameter - the object representing the optional parameters to be set before calling this API

Returns:

the observable to the UUID object

Throws:

IllegalArgumentException - thrown if parameters fail the validation

createHierarchicalEntityRole

public ModelsCreateHierarchicalEntityRoleDefinitionStages.WithAppId createHierarchicalEntityRole()

Create a role for an hierarchical entity in a version of the application.

Returns:

the first stage of the createHierarchicalEntityRole call

createHierarchicalEntityRole

public UUID createHierarchicalEntityRole(UUID appId, String versionId, UUID hEntityId, CreateHierarchicalEntityRoleOptionalParameter createHierarchicalEntityRoleOptionalParameter)

Create a role for an hierarchical entity in a version of the application.

Parameters:

appId - The application ID.

versionId - The version ID.

hEntityId - The hierarchical entity extractor ID.

createHierarchicalEntityRoleOptionalParameter - the object representing the optional parameters to be set before calling this API

Returns:

the UUID object if successful.

Throws:

IllegalArgumentException - thrown if parameters fail the validation

ErrorResponseException - thrown if the request is rejected by server

RuntimeException - all other wrapped checked exceptions if the request fails to be sent

createHierarchicalEntityRoleAsync

public Observable createHierarchicalEntityRoleAsync(UUID appId, String versionId, UUID hEntityId, CreateHierarchicalEntityRoleOptionalParameter createHierarchicalEntityRoleOptionalParameter)

Create a role for an hierarchical entity in a version of the application.

Parameters:

appId - The application ID.

versionId - The version ID.

hEntityId - The hierarchical entity extractor ID.

createHierarchicalEntityRoleOptionalParameter - the object representing the optional parameters to be set before calling this API

Returns:

the observable to the UUID object

Throws:

IllegalArgumentException - thrown if parameters fail the validation

createPatternAnyEntityModel

public UUID createPatternAnyEntityModel(UUID appId, String versionId, PatternAnyModelCreateObject extractorCreateObject)

Adds a pattern.any entity extractor to a version of the application.

Parameters:

appId - The application ID.

versionId - The version ID.

extractorCreateObject - A model object containing the name and explicit list for the new Pattern.Any entity extractor.

Returns:

the UUID object if successful.

Throws:

IllegalArgumentException - thrown if parameters fail the validation

ErrorResponseException - thrown if the request is rejected by server

RuntimeException - all other wrapped checked exceptions if the request fails to be sent

createPatternAnyEntityModelAsync

public Observable createPatternAnyEntityModelAsync(UUID appId, String versionId, PatternAnyModelCreateObject extractorCreateObject)

Adds a pattern.any entity extractor to a version of the application.

Parameters:

appId - The application ID.

versionId - The version ID.

extractorCreateObject - A model object containing the name and explicit list for the new Pattern.Any entity extractor.

Returns:

the observable to the UUID object

Throws:

IllegalArgumentException - thrown if parameters fail the validation

createPatternAnyEntityRole

public ModelsCreatePatternAnyEntityRoleDefinitionStages.WithAppId createPatternAnyEntityRole()

Create a role for an Pattern.any entity in a version of the application.

Returns:

the first stage of the createPatternAnyEntityRole call

createPatternAnyEntityRole

public UUID createPatternAnyEntityRole(UUID appId, String versionId, UUID entityId, CreatePatternAnyEntityRoleOptionalParameter createPatternAnyEntityRoleOptionalParameter)

Create a role for an Pattern.any entity in a version of the application.

Parameters:

appId - The application ID.

versionId - The version ID.

entityId - The entity model ID.

createPatternAnyEntityRoleOptionalParameter - the object representing the optional parameters to be set before calling this API

Returns:

the UUID object if successful.

Throws:

IllegalArgumentException - thrown if parameters fail the validation

ErrorResponseException - thrown if the request is rejected by server

RuntimeException - all other wrapped checked exceptions if the request fails to be sent

createPatternAnyEntityRoleAsync

public Observable createPatternAnyEntityRoleAsync(UUID appId, String versionId, UUID entityId, CreatePatternAnyEntityRoleOptionalParameter createPatternAnyEntityRoleOptionalParameter)

Create a role for an Pattern.any entity in a version of the application.

Parameters:

appId - The application ID.

versionId - The version ID.

entityId - The entity model ID.

createPatternAnyEntityRoleOptionalParameter - the object representing the optional parameters to be set before calling this API

Returns:

the observable to the UUID object

Throws:

IllegalArgumentException - thrown if parameters fail the validation

createPrebuiltEntityRole

public ModelsCreatePrebuiltEntityRoleDefinitionStages.WithAppId createPrebuiltEntityRole()

Create a role for a prebuilt entity in a version of the application.

Returns:

the first stage of the createPrebuiltEntityRole call

createPrebuiltEntityRole

public UUID createPrebuiltEntityRole(UUID appId, String versionId, UUID entityId, CreatePrebuiltEntityRoleOptionalParameter createPrebuiltEntityRoleOptionalParameter)

Create a role for a prebuilt entity in a version of the application.

Parameters:

appId - The application ID.

versionId - The version ID.

entityId - The entity model ID.

createPrebuiltEntityRoleOptionalParameter - the object representing the optional parameters to be set before calling this API

Returns:

the UUID object if successful.

Throws:

IllegalArgumentException - thrown if parameters fail the validation

ErrorResponseException - thrown if the request is rejected by server

RuntimeException - all other wrapped checked exceptions if the request fails to be sent

createPrebuiltEntityRoleAsync

public Observable createPrebuiltEntityRoleAsync(UUID appId, String versionId, UUID entityId, CreatePrebuiltEntityRoleOptionalParameter createPrebuiltEntityRoleOptionalParameter)

Create a role for a prebuilt entity in a version of the application.

Parameters:

appId - The application ID.

versionId - The version ID.

entityId - The entity model ID.

createPrebuiltEntityRoleOptionalParameter - the object representing the optional parameters to be set before calling this API

Returns:

the observable to the UUID object

Throws:

IllegalArgumentException - thrown if parameters fail the validation

createRegexEntityModel

public UUID createRegexEntityModel(UUID appId, String versionId, RegexModelCreateObject regexEntityExtractorCreateObj)

Adds a regular expression entity model to a version of the application.

Parameters:

appId - The application ID.

versionId - The version ID.

regexEntityExtractorCreateObj - A model object containing the name and regex pattern for the new regular expression entity extractor.

Returns:

the UUID object if successful.

Throws:

IllegalArgumentException - thrown if parameters fail the validation

ErrorResponseException - thrown if the request is rejected by server

RuntimeException - all other wrapped checked exceptions if the request fails to be sent

createRegexEntityModelAsync

public Observable createRegexEntityModelAsync(UUID appId, String versionId, RegexModelCreateObject regexEntityExtractorCreateObj)

Adds a regular expression entity model to a version of the application.

Parameters:

appId - The application ID.

versionId - The version ID.

regexEntityExtractorCreateObj - A model object containing the name and regex pattern for the new regular expression entity extractor.

Returns:

the observable to the UUID object

Throws:

IllegalArgumentException - thrown if parameters fail the validation

createRegexEntityRole

public ModelsCreateRegexEntityRoleDefinitionStages.WithAppId createRegexEntityRole()

Create a role for an regular expression entity in a version of the application.

Returns:

the first stage of the createRegexEntityRole call

createRegexEntityRole

public UUID createRegexEntityRole(UUID appId, String versionId, UUID entityId, CreateRegexEntityRoleOptionalParameter createRegexEntityRoleOptionalParameter)

Create a role for an regular expression entity in a version of the application.

Parameters:

appId - The application ID.

versionId - The version ID.

entityId - The entity model ID.

createRegexEntityRoleOptionalParameter - the object representing the optional parameters to be set before calling this API

Returns:

the UUID object if successful.

Throws:

IllegalArgumentException - thrown if parameters fail the validation

ErrorResponseException - thrown if the request is rejected by server

RuntimeException - all other wrapped checked exceptions if the request fails to be sent

createRegexEntityRoleAsync

public Observable createRegexEntityRoleAsync(UUID appId, String versionId, UUID entityId, CreateRegexEntityRoleOptionalParameter createRegexEntityRoleOptionalParameter)

Create a role for an regular expression entity in a version of the application.

Parameters:

appId - The application ID.

versionId - The version ID.

entityId - The entity model ID.

createRegexEntityRoleOptionalParameter - the object representing the optional parameters to be set before calling this API

Returns:

the observable to the UUID object

Throws:

IllegalArgumentException - thrown if parameters fail the validation

deleteClosedList

public OperationStatus deleteClosedList(UUID appId, String versionId, UUID clEntityId)

Deletes a list entity model from a version of the application.

Parameters:

appId - The application ID.

versionId - The version ID.

clEntityId - The list entity model ID.

Returns:

the OperationStatus object if successful.

Throws:

IllegalArgumentException - thrown if parameters fail the validation

ErrorResponseException - thrown if the request is rejected by server

RuntimeException - all other wrapped checked exceptions if the request fails to be sent

deleteClosedListAsync

public Observable deleteClosedListAsync(UUID appId, String versionId, UUID clEntityId)

Deletes a list entity model from a version of the application.

Parameters:

appId - The application ID.

versionId - The version ID.

clEntityId - The list entity model ID.

Returns:

the observable to the OperationStatus object

Throws:

IllegalArgumentException - thrown if parameters fail the validation

deleteClosedListEntityRole

public OperationStatus deleteClosedListEntityRole(UUID appId, String versionId, UUID entityId, UUID roleId)

Delete a role for a given list entity in a version of the application.

Parameters:

appId - The application ID.

versionId - The version ID.

entityId - The entity ID.

roleId - The entity role Id.

Returns:

the OperationStatus object if successful.

Throws:

IllegalArgumentException - thrown if parameters fail the validation

ErrorResponseException - thrown if the request is rejected by server

RuntimeException - all other wrapped checked exceptions if the request fails to be sent

deleteClosedListEntityRoleAsync

public Observable deleteClosedListEntityRoleAsync(UUID appId, String versionId, UUID entityId, UUID roleId)

Delete a role for a given list entity in a version of the application.

Parameters:

appId - The application ID.

versionId - The version ID.

entityId - The entity ID.

roleId - The entity role Id.

Returns:

the observable to the OperationStatus object

Throws:

IllegalArgumentException - thrown if parameters fail the validation

deleteCompositeEntity

public OperationStatus deleteCompositeEntity(UUID appId, String versionId, UUID cEntityId)

Deletes a composite entity from a version of the application.

Parameters:

appId - The application ID.

versionId - The version ID.

cEntityId - The composite entity extractor ID.

Returns:

the OperationStatus object if successful.

Throws:

IllegalArgumentException - thrown if parameters fail the validation

ErrorResponseException - thrown if the request is rejected by server

RuntimeException - all other wrapped checked exceptions if the request fails to be sent

deleteCompositeEntityAsync

public Observable deleteCompositeEntityAsync(UUID appId, String versionId, UUID cEntityId)

Deletes a composite entity from a version of the application.

Parameters:

appId - The application ID.

versionId - The version ID.

cEntityId - The composite entity extractor ID.

Returns:

the observable to the OperationStatus object

Throws:

IllegalArgumentException - thrown if parameters fail the validation

deleteCompositeEntityChild

public OperationStatus deleteCompositeEntityChild(UUID appId, String versionId, UUID cEntityId, UUID cChildId)

Deletes a composite entity extractor child from a version of the application.

Parameters:

appId - The application ID.

versionId - The version ID.

cEntityId - The composite entity extractor ID.

cChildId - The hierarchical entity extractor child ID.

Returns:

the OperationStatus object if successful.

Throws:

IllegalArgumentException - thrown if parameters fail the validation

ErrorResponseException - thrown if the request is rejected by server

RuntimeException - all other wrapped checked exceptions if the request fails to be sent

deleteCompositeEntityChildAsync

public Observable deleteCompositeEntityChildAsync(UUID appId, String versionId, UUID cEntityId, UUID cChildId)

Deletes a composite entity extractor child from a version of the application.

Parameters:

appId - The application ID.

versionId - The version ID.

cEntityId - The composite entity extractor ID.

cChildId - The hierarchical entity extractor child ID.

Returns:

the observable to the OperationStatus object

Throws:

IllegalArgumentException - thrown if parameters fail the validation

deleteCompositeEntityRole

public OperationStatus deleteCompositeEntityRole(UUID appId, String versionId, UUID cEntityId, UUID roleId)

Delete a role for a given composite entity in a version of the application.

Parameters:

appId - The application ID.

versionId - The version ID.

cEntityId - The composite entity extractor ID.

roleId - The entity role Id.

Returns:

the OperationStatus object if successful.

Throws:

IllegalArgumentException - thrown if parameters fail the validation

ErrorResponseException - thrown if the request is rejected by server

RuntimeException - all other wrapped checked exceptions if the request fails to be sent

deleteCompositeEntityRoleAsync

public Observable deleteCompositeEntityRoleAsync(UUID appId, String versionId, UUID cEntityId, UUID roleId)

Delete a role for a given composite entity in a version of the application.

Parameters:

appId - The application ID.

versionId - The version ID.

cEntityId - The composite entity extractor ID.

roleId - The entity role Id.

Returns:

the observable to the OperationStatus object

Throws:

IllegalArgumentException - thrown if parameters fail the validation

deleteCustomEntityRole

public OperationStatus deleteCustomEntityRole(UUID appId, String versionId, UUID entityId, UUID roleId)

Delete a role for a given prebuilt entity in a version of the application.

Parameters:

appId - The application ID.

versionId - The version ID.

entityId - The entity ID.

roleId - The entity role Id.

Returns:

the OperationStatus object if successful.

Throws:

IllegalArgumentException - thrown if parameters fail the validation

ErrorResponseException - thrown if the request is rejected by server

RuntimeException - all other wrapped checked exceptions if the request fails to be sent

deleteCustomEntityRoleAsync

public Observable deleteCustomEntityRoleAsync(UUID appId, String versionId, UUID entityId, UUID roleId)

Delete a role for a given prebuilt entity in a version of the application.

Parameters:

appId - The application ID.

versionId - The version ID.

entityId - The entity ID.

roleId - The entity role Id.

Returns:

the observable to the OperationStatus object

Throws:

IllegalArgumentException - thrown if parameters fail the validation

deleteCustomPrebuiltDomain

public OperationStatus deleteCustomPrebuiltDomain(UUID appId, String versionId, String domainName)

Deletes a prebuilt domain's models in a version of the application.

Parameters:

appId - The application ID.

versionId - The version ID.

domainName - Domain name.

Returns:

the OperationStatus object if successful.

Throws:

IllegalArgumentException - thrown if parameters fail the validation

ErrorResponseException - thrown if the request is rejected by server

RuntimeException - all other wrapped checked exceptions if the request fails to be sent

deleteCustomPrebuiltDomainAsync

public Observable deleteCustomPrebuiltDomainAsync(UUID appId, String versionId, String domainName)

Deletes a prebuilt domain's models in a version of the application.

Parameters:

appId - The application ID.

versionId - The version ID.

domainName - Domain name.

Returns:

the observable to the OperationStatus object

Throws:

IllegalArgumentException - thrown if parameters fail the validation

deleteEntity

public OperationStatus deleteEntity(UUID appId, String versionId, UUID entityId)

Deletes an entity or a child from a version of the application.

Parameters:

appId - The application ID.

versionId - The version ID.

entityId - The entity extractor or the child entity extractor ID.

Returns:

the OperationStatus object if successful.

Throws:

IllegalArgumentException - thrown if parameters fail the validation

ErrorResponseException - thrown if the request is rejected by server

RuntimeException - all other wrapped checked exceptions if the request fails to be sent

deleteEntityAsync

public Observable deleteEntityAsync(UUID appId, String versionId, UUID entityId)

Deletes an entity or a child from a version of the application.

Parameters:

appId - The application ID.

versionId - The version ID.

entityId - The entity extractor or the child entity extractor ID.

Returns:

the observable to the OperationStatus object

Throws:

IllegalArgumentException - thrown if parameters fail the validation

deleteEntityFeature

public OperationStatus deleteEntityFeature(UUID appId, String versionId, UUID entityId, ModelFeatureInformation featureRelationDeleteObject)

Deletes a relation from the feature relations used by the entity in a version of the application.

Parameters:

appId - The application ID.

versionId - The version ID.

entityId - The entity extractor ID.

featureRelationDeleteObject - A feature information object containing the feature relation to delete.

Returns:

the OperationStatus object if successful.

Throws:

IllegalArgumentException - thrown if parameters fail the validation

ErrorResponseException - thrown if the request is rejected by server

RuntimeException - all other wrapped checked exceptions if the request fails to be sent

deleteEntityFeatureAsync

public Observable deleteEntityFeatureAsync(UUID appId, String versionId, UUID entityId, ModelFeatureInformation featureRelationDeleteObject)

Deletes a relation from the feature relations used by the entity in a version of the application.

Parameters:

appId - The application ID.

versionId - The version ID.

entityId - The entity extractor ID.

featureRelationDeleteObject - A feature information object containing the feature relation to delete.

Returns:

the observable to the OperationStatus object

Throws:

IllegalArgumentException - thrown if parameters fail the validation

deleteEntityRole

public OperationStatus deleteEntityRole(UUID appId, String versionId, UUID entityId, UUID roleId)

Delete an entity role in a version of the application.

Parameters:

appId - The application ID.

versionId - The version ID.

entityId - The entity ID.

roleId - The entity role Id.

Returns:

the OperationStatus object if successful.

Throws:

IllegalArgumentException - thrown if parameters fail the validation

ErrorResponseException - thrown if the request is rejected by server

RuntimeException - all other wrapped checked exceptions if the request fails to be sent

deleteEntityRoleAsync

public Observable deleteEntityRoleAsync(UUID appId, String versionId, UUID entityId, UUID roleId)

Delete an entity role in a version of the application.

Parameters:

appId - The application ID.

versionId - The version ID.

entityId - The entity ID.

roleId - The entity role Id.

Returns:

the observable to the OperationStatus object

Throws:

IllegalArgumentException - thrown if parameters fail the validation

deleteExplicitListItem

public OperationStatus deleteExplicitListItem(UUID appId, String versionId, UUID entityId, long itemId)

Delete an item from the explicit (exception) list for a Pattern.any entity in a version of the application.

Parameters:

appId - The application ID.

versionId - The version ID.

entityId - The pattern.any entity id.

itemId - The explicit list item which will be deleted.

Returns:

the OperationStatus object if successful.

Throws:

IllegalArgumentException - thrown if parameters fail the validation

ErrorResponseException - thrown if the request is rejected by server

RuntimeException - all other wrapped checked exceptions if the request fails to be sent

deleteExplicitListItemAsync

public Observable deleteExplicitListItemAsync(UUID appId, String versionId, UUID entityId, long itemId)

Delete an item from the explicit (exception) list for a Pattern.any entity in a version of the application.

Parameters:

appId - The application ID.

versionId - The version ID.

entityId - The pattern.any entity id.

itemId - The explicit list item which will be deleted.

Returns:

the observable to the OperationStatus object

Throws:

IllegalArgumentException - thrown if parameters fail the validation

deleteHierarchicalEntity

public OperationStatus deleteHierarchicalEntity(UUID appId, String versionId, UUID hEntityId)

Deletes a hierarchical entity from a version of the application.

Parameters:

appId - The application ID.

versionId - The version ID.

hEntityId - The hierarchical entity extractor ID.

Returns:

the OperationStatus object if successful.

Throws:

IllegalArgumentException - thrown if parameters fail the validation

ErrorResponseException - thrown if the request is rejected by server

RuntimeException - all other wrapped checked exceptions if the request fails to be sent

deleteHierarchicalEntityAsync

public Observable deleteHierarchicalEntityAsync(UUID appId, String versionId, UUID hEntityId)

Deletes a hierarchical entity from a version of the application.

Parameters:

appId - The application ID.

versionId - The version ID.

hEntityId - The hierarchical entity extractor ID.

Returns:

the observable to the OperationStatus object

Throws:

IllegalArgumentException - thrown if parameters fail the validation

deleteHierarchicalEntityChild

public OperationStatus deleteHierarchicalEntityChild(UUID appId, String versionId, UUID hEntityId, UUID hChildId)

Deletes a hierarchical entity extractor child in a version of the application.

Parameters:

appId - The application ID.

versionId - The version ID.

hEntityId - The hierarchical entity extractor ID.

hChildId - The hierarchical entity extractor child ID.

Returns:

the OperationStatus object if successful.

Throws:

IllegalArgumentException - thrown if parameters fail the validation

ErrorResponseException - thrown if the request is rejected by server

RuntimeException - all other wrapped checked exceptions if the request fails to be sent

deleteHierarchicalEntityChildAsync

public Observable deleteHierarchicalEntityChildAsync(UUID appId, String versionId, UUID hEntityId, UUID hChildId)

Deletes a hierarchical entity extractor child in a version of the application.

Parameters:

appId - The application ID.

versionId - The version ID.

hEntityId - The hierarchical entity extractor ID.

hChildId - The hierarchical entity extractor child ID.

Returns:

the observable to the OperationStatus object

Throws:

IllegalArgumentException - thrown if parameters fail the validation

deleteHierarchicalEntityRole

public OperationStatus deleteHierarchicalEntityRole(UUID appId, String versionId, UUID hEntityId, UUID roleId)

Delete a role for a given hierarchical role in a version of the application.

Parameters:

appId - The application ID.

versionId - The version ID.

hEntityId - The hierarchical entity extractor ID.

roleId - The entity role Id.

Returns:

the OperationStatus object if successful.

Throws:

IllegalArgumentException - thrown if parameters fail the validation

ErrorResponseException - thrown if the request is rejected by server

RuntimeException - all other wrapped checked exceptions if the request fails to be sent

deleteHierarchicalEntityRoleAsync

public Observable deleteHierarchicalEntityRoleAsync(UUID appId, String versionId, UUID hEntityId, UUID roleId)

Delete a role for a given hierarchical role in a version of the application.

Parameters:

appId - The application ID.

versionId - The version ID.

hEntityId - The hierarchical entity extractor ID.

roleId - The entity role Id.

Returns:

the observable to the OperationStatus object

Throws:

IllegalArgumentException - thrown if parameters fail the validation

deleteIntent

public ModelsDeleteIntentDefinitionStages.WithAppId deleteIntent()

Deletes an intent from a version of the application.

Returns:

the first stage of the deleteIntent call

deleteIntent

public OperationStatus deleteIntent(UUID appId, String versionId, UUID intentId, DeleteIntentOptionalParameter deleteIntentOptionalParameter)

Deletes an intent from a version of the application.

Parameters:

appId - The application ID.

versionId - The version ID.

intentId - The intent classifier ID.

deleteIntentOptionalParameter - the object representing the optional parameters to be set before calling this API

Returns:

the OperationStatus object if successful.

Throws:

IllegalArgumentException - thrown if parameters fail the validation

ErrorResponseException - thrown if the request is rejected by server

RuntimeException - all other wrapped checked exceptions if the request fails to be sent

deleteIntentAsync

public Observable deleteIntentAsync(UUID appId, String versionId, UUID intentId, DeleteIntentOptionalParameter deleteIntentOptionalParameter)

Deletes an intent from a version of the application.

Parameters:

appId - The application ID.

versionId - The version ID.

intentId - The intent classifier ID.

deleteIntentOptionalParameter - the object representing the optional parameters to be set before calling this API

Returns:

the observable to the OperationStatus object

Throws:

IllegalArgumentException - thrown if parameters fail the validation

deleteIntentFeature

public OperationStatus deleteIntentFeature(UUID appId, String versionId, UUID intentId, ModelFeatureInformation featureRelationDeleteObject)

Deletes a relation from the feature relations used by the intent in a version of the application.

Parameters:

appId - The application ID.

versionId - The version ID.

intentId - The intent classifier ID.

featureRelationDeleteObject - A feature information object containing the feature relation to delete.

Returns:

the OperationStatus object if successful.

Throws:

IllegalArgumentException - thrown if parameters fail the validation

ErrorResponseException - thrown if the request is rejected by server

RuntimeException - all other wrapped checked exceptions if the request fails to be sent

deleteIntentFeatureAsync

public Observable deleteIntentFeatureAsync(UUID appId, String versionId, UUID intentId, ModelFeatureInformation featureRelationDeleteObject)

Deletes a relation from the feature relations used by the intent in a version of the application.

Parameters:

appId - The application ID.

versionId - The version ID.

intentId - The intent classifier ID.

featureRelationDeleteObject - A feature information object containing the feature relation to delete.

Returns:

the observable to the OperationStatus object

Throws:

IllegalArgumentException - thrown if parameters fail the validation

deletePatternAnyEntityModel

public OperationStatus deletePatternAnyEntityModel(UUID appId, String versionId, UUID entityId)

Deletes a Pattern.Any entity extractor from a version of the application.

Parameters:

appId - The application ID.

versionId - The version ID.

entityId - The Pattern.Any entity extractor ID.

Returns:

the OperationStatus object if successful.

Throws:

IllegalArgumentException - thrown if parameters fail the validation

ErrorResponseException - thrown if the request is rejected by server

RuntimeException - all other wrapped checked exceptions if the request fails to be sent

deletePatternAnyEntityModelAsync

public Observable deletePatternAnyEntityModelAsync(UUID appId, String versionId, UUID entityId)

Deletes a Pattern.Any entity extractor from a version of the application.

Parameters:

appId - The application ID.

versionId - The version ID.

entityId - The Pattern.Any entity extractor ID.

Returns:

the observable to the OperationStatus object

Throws:

IllegalArgumentException - thrown if parameters fail the validation

deletePatternAnyEntityRole

public OperationStatus deletePatternAnyEntityRole(UUID appId, String versionId, UUID entityId, UUID roleId)

Delete a role for a given Pattern.any entity in a version of the application.

Parameters:

appId - The application ID.

versionId - The version ID.

entityId - The entity ID.

roleId - The entity role Id.

Returns:

the OperationStatus object if successful.

Throws:

IllegalArgumentException - thrown if parameters fail the validation

ErrorResponseException - thrown if the request is rejected by server

RuntimeException - all other wrapped checked exceptions if the request fails to be sent

deletePatternAnyEntityRoleAsync

public Observable deletePatternAnyEntityRoleAsync(UUID appId, String versionId, UUID entityId, UUID roleId)

Delete a role for a given Pattern.any entity in a version of the application.

Parameters:

appId - The application ID.

versionId - The version ID.

entityId - The entity ID.

roleId - The entity role Id.

Returns:

the observable to the OperationStatus object

Throws:

IllegalArgumentException - thrown if parameters fail the validation

deletePrebuilt

public OperationStatus deletePrebuilt(UUID appId, String versionId, UUID prebuiltId)

Deletes a prebuilt entity extractor from a version of the application.

Parameters:

appId - The application ID.

versionId - The version ID.

prebuiltId - The prebuilt entity extractor ID.

Returns:

the OperationStatus object if successful.

Throws:

IllegalArgumentException - thrown if parameters fail the validation

ErrorResponseException - thrown if the request is rejected by server

RuntimeException - all other wrapped checked exceptions if the request fails to be sent

deletePrebuiltAsync

public Observable deletePrebuiltAsync(UUID appId, String versionId, UUID prebuiltId)

Deletes a prebuilt entity extractor from a version of the application.

Parameters:

appId - The application ID.

versionId - The version ID.

prebuiltId - The prebuilt entity extractor ID.

Returns:

the observable to the OperationStatus object

Throws:

IllegalArgumentException - thrown if parameters fail the validation

deletePrebuiltEntityRole

public OperationStatus deletePrebuiltEntityRole(UUID appId, String versionId, UUID entityId, UUID roleId)

Delete a role in a prebuilt entity in a version of the application.

Parameters:

appId - The application ID.

versionId - The version ID.

entityId - The entity ID.

roleId - The entity role Id.

Returns:

the OperationStatus object if successful.

Throws:

IllegalArgumentException - thrown if parameters fail the validation

ErrorResponseException - thrown if the request is rejected by server

RuntimeException - all other wrapped checked exceptions if the request fails to be sent

deletePrebuiltEntityRoleAsync

public Observable deletePrebuiltEntityRoleAsync(UUID appId, String versionId, UUID entityId, UUID roleId)

Delete a role in a prebuilt entity in a version of the application.

Parameters:

appId - The application ID.

versionId - The version ID.

entityId - The entity ID.

roleId - The entity role Id.

Returns:

the observable to the OperationStatus object

Throws:

IllegalArgumentException - thrown if parameters fail the validation

deleteRegexEntityModel

public OperationStatus deleteRegexEntityModel(UUID appId, String versionId, UUID regexEntityId)

Deletes a regular expression entity from a version of the application.

Parameters:

appId - The application ID.

versionId - The version ID.

regexEntityId - The regular expression entity extractor ID.

Returns:

the OperationStatus object if successful.

Throws:

IllegalArgumentException - thrown if parameters fail the validation

ErrorResponseException - thrown if the request is rejected by server

RuntimeException - all other wrapped checked exceptions if the request fails to be sent

deleteRegexEntityModelAsync

public Observable deleteRegexEntityModelAsync(UUID appId, String versionId, UUID regexEntityId)

Deletes a regular expression entity from a version of the application.

Parameters:

appId - The application ID.

versionId - The version ID.

regexEntityId - The regular expression entity extractor ID.

Returns:

the observable to the OperationStatus object

Throws:

IllegalArgumentException - thrown if parameters fail the validation

deleteRegexEntityRole

public OperationStatus deleteRegexEntityRole(UUID appId, String versionId, UUID entityId, UUID roleId)

Delete a role for a given regular expression in a version of the application.

Parameters:

appId - The application ID.

versionId - The version ID.

entityId - The entity ID.

roleId - The entity role Id.

Returns:

the OperationStatus object if successful.

Throws:

IllegalArgumentException - thrown if parameters fail the validation

ErrorResponseException - thrown if the request is rejected by server

RuntimeException - all other wrapped checked exceptions if the request fails to be sent

deleteRegexEntityRoleAsync

public Observable deleteRegexEntityRoleAsync(UUID appId, String versionId, UUID entityId, UUID roleId)

Delete a role for a given regular expression in a version of the application.

Parameters:

appId - The application ID.

versionId - The version ID.

entityId - The entity ID.

roleId - The entity role Id.

Returns:

the observable to the OperationStatus object

Throws:

IllegalArgumentException - thrown if parameters fail the validation

deleteSubList

public OperationStatus deleteSubList(UUID appId, String versionId, UUID clEntityId, long subListId)

Deletes a sublist of a specific list entity model from a version of the application.

Parameters:

appId - The application ID.

versionId - The version ID.

clEntityId - The list entity extractor ID.

subListId - The sublist ID.

Returns:

the OperationStatus object if successful.

Throws:

IllegalArgumentException - thrown if parameters fail the validation

ErrorResponseException - thrown if the request is rejected by server

RuntimeException - all other wrapped checked exceptions if the request fails to be sent

deleteSubListAsync

public Observable deleteSubListAsync(UUID appId, String versionId, UUID clEntityId, long subListId)

Deletes a sublist of a specific list entity model from a version of the application.

Parameters:

appId - The application ID.

versionId - The version ID.

clEntityId - The list entity extractor ID.

subListId - The sublist ID.

Returns:

the observable to the OperationStatus object

Throws:

IllegalArgumentException - thrown if parameters fail the validation

examplesMethod

public ModelsExamplesMethodDefinitionStages.WithAppId examplesMethod()

Gets the example utterances for the given intent or entity model in a version of the application.

Returns:

the first stage of the examplesMethod call

examplesMethod

public List examplesMethod(UUID appId, String versionId, String modelId, ExamplesMethodOptionalParameter examplesMethodOptionalParameter)

Gets the example utterances for the given intent or entity model in a version of the application.

Parameters:

appId - The application ID.

versionId - The version ID.

modelId - The ID (GUID) of the model.

examplesMethodOptionalParameter - the object representing the optional parameters to be set before calling this API

Returns:

the List<LabelTextObject> object if successful.

Throws:

IllegalArgumentException - thrown if parameters fail the validation

ErrorResponseException - thrown if the request is rejected by server

RuntimeException - all other wrapped checked exceptions if the request fails to be sent

examplesMethodAsync

public Observable> examplesMethodAsync(UUID appId, String versionId, String modelId, ExamplesMethodOptionalParameter examplesMethodOptionalParameter)

Gets the example utterances for the given intent or entity model in a version of the application.

Parameters:

appId - The application ID.

versionId - The version ID.

modelId - The ID (GUID) of the model.

examplesMethodOptionalParameter - the object representing the optional parameters to be set before calling this API

Returns:

the observable to the List<LabelTextObject> object

Throws:

IllegalArgumentException - thrown if parameters fail the validation

getClosedList

public ClosedListEntityExtractor getClosedList(UUID appId, String versionId, UUID clEntityId)

Gets information about a list entity in a version of the application.

Parameters:

appId - The application ID.

versionId - The version ID.

clEntityId - The list model ID.

Returns:

the ClosedListEntityExtractor object if successful.

Throws:

IllegalArgumentException - thrown if parameters fail the validation

ErrorResponseException - thrown if the request is rejected by server

RuntimeException - all other wrapped checked exceptions if the request fails to be sent

getClosedListAsync

public Observable getClosedListAsync(UUID appId, String versionId, UUID clEntityId)

Gets information about a list entity in a version of the application.

Parameters:

appId - The application ID.

versionId - The version ID.

clEntityId - The list model ID.

Returns:

the observable to the ClosedListEntityExtractor object

Throws:

IllegalArgumentException - thrown if parameters fail the validation

getClosedListEntityRole

public EntityRole getClosedListEntityRole(UUID appId, String versionId, UUID entityId, UUID roleId)

Get one role for a given list entity in a version of the application.

Parameters:

appId - The application ID.

versionId - The version ID.

entityId - entity ID.

roleId - entity role ID.

Returns:

the EntityRole object if successful.

Throws:

IllegalArgumentException - thrown if parameters fail the validation

ErrorResponseException - thrown if the request is rejected by server

RuntimeException - all other wrapped checked exceptions if the request fails to be sent

getClosedListEntityRoleAsync

public Observable getClosedListEntityRoleAsync(UUID appId, String versionId, UUID entityId, UUID roleId)

Get one role for a given list entity in a version of the application.

Parameters:

appId - The application ID.

versionId - The version ID.

entityId - entity ID.

roleId - entity role ID.

Returns:

the observable to the EntityRole object

Throws:

IllegalArgumentException - thrown if parameters fail the validation

getCompositeEntity

public CompositeEntityExtractor getCompositeEntity(UUID appId, String versionId, UUID cEntityId)

Gets information about a composite entity in a version of the application.

Parameters:

appId - The application ID.

versionId - The version ID.

cEntityId - The composite entity extractor ID.

Returns:

the CompositeEntityExtractor object if successful.

Throws:

IllegalArgumentException - thrown if parameters fail the validation

ErrorResponseException - thrown if the request is rejected by server

RuntimeException - all other wrapped checked exceptions if the request fails to be sent

getCompositeEntityAsync

public Observable getCompositeEntityAsync(UUID appId, String versionId, UUID cEntityId)

Gets information about a composite entity in a version of the application.

Parameters:

appId - The application ID.

versionId - The version ID.

cEntityId - The composite entity extractor ID.

Returns:

the observable to the CompositeEntityExtractor object

Throws:

IllegalArgumentException - thrown if parameters fail the validation

getCompositeEntityRole

public EntityRole getCompositeEntityRole(UUID appId, String versionId, UUID cEntityId, UUID roleId)

Get one role for a given composite entity in a version of the application.

Parameters:

appId - The application ID.

versionId - The version ID.

cEntityId - The composite entity extractor ID.

roleId - entity role ID.

Returns:

the EntityRole object if successful.

Throws:

IllegalArgumentException - thrown if parameters fail the validation

ErrorResponseException - thrown if the request is rejected by server

RuntimeException - all other wrapped checked exceptions if the request fails to be sent

getCompositeEntityRoleAsync

public Observable getCompositeEntityRoleAsync(UUID appId, String versionId, UUID cEntityId, UUID roleId)

Get one role for a given composite entity in a version of the application.

Parameters:

appId - The application ID.

versionId - The version ID.

cEntityId - The composite entity extractor ID.

roleId - entity role ID.

Returns:

the observable to the EntityRole object

Throws:

IllegalArgumentException - thrown if parameters fail the validation

getCustomEntityRole

public EntityRole getCustomEntityRole(UUID appId, String versionId, UUID entityId, UUID roleId)

Get one role for a given prebuilt entity in a version of the application.

Parameters:

appId - The application ID.

versionId - The version ID.

entityId - entity ID.

roleId - entity role ID.

Returns:

the EntityRole object if successful.

Throws:

IllegalArgumentException - thrown if parameters fail the validation

ErrorResponseException - thrown if the request is rejected by server

RuntimeException - all other wrapped checked exceptions if the request fails to be sent

getCustomEntityRoleAsync

public Observable getCustomEntityRoleAsync(UUID appId, String versionId, UUID entityId, UUID roleId)

Get one role for a given prebuilt entity in a version of the application.

Parameters:

appId - The application ID.

versionId - The version ID.

entityId - entity ID.

roleId - entity role ID.

Returns:

the observable to the EntityRole object

Throws:

IllegalArgumentException - thrown if parameters fail the validation

getEntity

public NDepthEntityExtractor getEntity(UUID appId, String versionId, UUID entityId)

Gets information about an entity model in a version of the application.

Parameters:

appId - The application ID.

versionId - The version ID.

entityId - The entity extractor ID.

Returns:

the NDepthEntityExtractor object if successful.

Throws:

IllegalArgumentException - thrown if parameters fail the validation

ErrorResponseException - thrown if the request is rejected by server

RuntimeException - all other wrapped checked exceptions if the request fails to be sent

getEntityAsync

public Observable getEntityAsync(UUID appId, String versionId, UUID entityId)

Gets information about an entity model in a version of the application.

Parameters:

appId - The application ID.

versionId - The version ID.

entityId - The entity extractor ID.

Returns:

the observable to the NDepthEntityExtractor object

Throws:

IllegalArgumentException - thrown if parameters fail the validation

getEntityFeatures

public List getEntityFeatures(UUID appId, String versionId, UUID entityId)

Gets the information of the features used by the entity in a version of the application.

Parameters:

appId - The application ID.

versionId - The version ID.

entityId - The entity extractor ID.

Returns:

the List<ModelFeatureInformation> object if successful.

Throws:

IllegalArgumentException - thrown if parameters fail the validation

ErrorResponseException - thrown if the request is rejected by server

RuntimeException - all other wrapped checked exceptions if the request fails to be sent

getEntityFeaturesAsync

public Observable> getEntityFeaturesAsync(UUID appId, String versionId, UUID entityId)

Gets the information of the features used by the entity in a version of the application.

Parameters:

appId - The application ID.

versionId - The version ID.

entityId - The entity extractor ID.

Returns:

the observable to the List<ModelFeatureInformation> object

Throws:

IllegalArgumentException - thrown if parameters fail the validation

getEntityRole

public EntityRole getEntityRole(UUID appId, String versionId, UUID entityId, UUID roleId)

Get one role for a given entity in a version of the application.

Parameters:

appId - The application ID.

versionId - The version ID.

entityId - entity ID.

roleId - entity role ID.

Returns:

the EntityRole object if successful.

Throws:

IllegalArgumentException - thrown if parameters fail the validation

ErrorResponseException - thrown if the request is rejected by server

RuntimeException - all other wrapped checked exceptions if the request fails to be sent

getEntityRoleAsync

public Observable getEntityRoleAsync(UUID appId, String versionId, UUID entityId, UUID roleId)

Get one role for a given entity in a version of the application.

Parameters:

appId - The application ID.

versionId - The version ID.

entityId - entity ID.

roleId - entity role ID.

Returns:

the observable to the EntityRole object

Throws:

IllegalArgumentException - thrown if parameters fail the validation

getExplicitList

public List getExplicitList(UUID appId, String versionId, UUID entityId)

Get the explicit (exception) list of the pattern.any entity in a version of the application.

Parameters:

appId - The application ID.

versionId - The version ID.

entityId - The Pattern.Any entity id.

Returns:

the List<ExplicitListItem> object if successful.

Throws:

IllegalArgumentException - thrown if parameters fail the validation

ErrorResponseException - thrown if the request is rejected by server

RuntimeException - all other wrapped checked exceptions if the request fails to be sent

getExplicitListAsync

public Observable> getExplicitListAsync(UUID appId, String versionId, UUID entityId)

Get the explicit (exception) list of the pattern.any entity in a version of the application.

Parameters:

appId - The application ID.

versionId - The version ID.

entityId - The Pattern.Any entity id.

Returns:

the observable to the List<ExplicitListItem> object

Throws:

IllegalArgumentException - thrown if parameters fail the validation

getExplicitListItem

public ExplicitListItem getExplicitListItem(UUID appId, String versionId, UUID entityId, long itemId)

Get the explicit (exception) list of the pattern.any entity in a version of the application.

Parameters:

appId - The application ID.

versionId - The version ID.

entityId - The Pattern.Any entity Id.

itemId - The explicit list item Id.

Returns:

the ExplicitListItem object if successful.

Throws:

IllegalArgumentException - thrown if parameters fail the validation

ErrorResponseException - thrown if the request is rejected by server

RuntimeException - all other wrapped checked exceptions if the request fails to be sent

getExplicitListItemAsync

public Observable getExplicitListItemAsync(UUID appId, String versionId, UUID entityId, long itemId)

Get the explicit (exception) list of the pattern.any entity in a version of the application.

Parameters:

appId - The application ID.

versionId - The version ID.

entityId - The Pattern.Any entity Id.

itemId - The explicit list item Id.

Returns:

the observable to the ExplicitListItem object

Throws:

IllegalArgumentException - thrown if parameters fail the validation

getHierarchicalEntity

public HierarchicalEntityExtractor getHierarchicalEntity(UUID appId, String versionId, UUID hEntityId)

Gets information about a hierarchical entity in a version of the application.

Parameters:

appId - The application ID.

versionId - The version ID.

hEntityId - The hierarchical entity extractor ID.

Returns:

the HierarchicalEntityExtractor object if successful.

Throws:

IllegalArgumentException - thrown if parameters fail the validation

ErrorResponseException - thrown if the request is rejected by server

RuntimeException - all other wrapped checked exceptions if the request fails to be sent

getHierarchicalEntityAsync

public Observable getHierarchicalEntityAsync(UUID appId, String versionId, UUID hEntityId)

Gets information about a hierarchical entity in a version of the application.

Parameters:

appId - The application ID.

versionId - The version ID.

hEntityId - The hierarchical entity extractor ID.

Returns:

the observable to the HierarchicalEntityExtractor object

Throws:

IllegalArgumentException - thrown if parameters fail the validation

getHierarchicalEntityChild

public HierarchicalChildEntity getHierarchicalEntityChild(UUID appId, String versionId, UUID hEntityId, UUID hChildId)

Gets information about the child's model contained in an hierarchical entity child model in a version of the application.

Parameters:

appId - The application ID.

versionId - The version ID.

hEntityId - The hierarchical entity extractor ID.

hChildId - The hierarchical entity extractor child ID.

Returns:

the HierarchicalChildEntity object if successful.

Throws:

IllegalArgumentException - thrown if parameters fail the validation

ErrorResponseException - thrown if the request is rejected by server

RuntimeException - all other wrapped checked exceptions if the request fails to be sent

getHierarchicalEntityChildAsync

public Observable getHierarchicalEntityChildAsync(UUID appId, String versionId, UUID hEntityId, UUID hChildId)

Gets information about the child's model contained in an hierarchical entity child model in a version of the application.

Parameters:

appId - The application ID.

versionId - The version ID.

hEntityId - The hierarchical entity extractor ID.

hChildId - The hierarchical entity extractor child ID.

Returns:

the observable to the HierarchicalChildEntity object

Throws:

IllegalArgumentException - thrown if parameters fail the validation

getHierarchicalEntityRole

public EntityRole getHierarchicalEntityRole(UUID appId, String versionId, UUID hEntityId, UUID roleId)

Get one role for a given hierarchical entity in a version of the application.

Parameters:

appId - The application ID.

versionId - The version ID.

hEntityId - The hierarchical entity extractor ID.

roleId - entity role ID.

Returns:

the EntityRole object if successful.

Throws:

IllegalArgumentException - thrown if parameters fail the validation

ErrorResponseException - thrown if the request is rejected by server

RuntimeException - all other wrapped checked exceptions if the request fails to be sent

getHierarchicalEntityRoleAsync

public Observable getHierarchicalEntityRoleAsync(UUID appId, String versionId, UUID hEntityId, UUID roleId)

Get one role for a given hierarchical entity in a version of the application.

Parameters:

appId - The application ID.

versionId - The version ID.

hEntityId - The hierarchical entity extractor ID.

roleId - entity role ID.

Returns:

the observable to the EntityRole object

Throws:

IllegalArgumentException - thrown if parameters fail the validation

getIntent

public IntentClassifier getIntent(UUID appId, String versionId, UUID intentId)

Gets information about the intent model in a version of the application.

Parameters:

appId - The application ID.

versionId - The version ID.

intentId - The intent classifier ID.

Returns:

the IntentClassifier object if successful.

Throws:

IllegalArgumentException - thrown if parameters fail the validation

ErrorResponseException - thrown if the request is rejected by server

RuntimeException - all other wrapped checked exceptions if the request fails to be sent

getIntentAsync

public Observable getIntentAsync(UUID appId, String versionId, UUID intentId)

Gets information about the intent model in a version of the application.

Parameters:

appId - The application ID.

versionId - The version ID.

intentId - The intent classifier ID.

Returns:

the observable to the IntentClassifier object

Throws:

IllegalArgumentException - thrown if parameters fail the validation

getIntentFeatures

public List getIntentFeatures(UUID appId, String versionId, UUID intentId)

Gets the information of the features used by the intent in a version of the application.

Parameters:

appId - The application ID.

versionId - The version ID.

intentId - The intent classifier ID.

Returns:

the List<ModelFeatureInformation> object if successful.

Throws:

IllegalArgumentException - thrown if parameters fail the validation

ErrorResponseException - thrown if the request is rejected by server

RuntimeException - all other wrapped checked exceptions if the request fails to be sent

getIntentFeaturesAsync

public Observable> getIntentFeaturesAsync(UUID appId, String versionId, UUID intentId)

Gets the information of the features used by the intent in a version of the application.

Parameters:

appId - The application ID.

versionId - The version ID.

intentId - The intent classifier ID.

Returns:

the observable to the List<ModelFeatureInformation> object

Throws:

IllegalArgumentException - thrown if parameters fail the validation

getPatternAnyEntityInfo

public PatternAnyEntityExtractor getPatternAnyEntityInfo(UUID appId, String versionId, UUID entityId)

Gets information about the Pattern.Any model in a version of the application.

Parameters:

appId - The application ID.

versionId - The version ID.

entityId - The entity extractor ID.

Returns:

the PatternAnyEntityExtractor object if successful.

Throws:

IllegalArgumentException - thrown if parameters fail the validation

ErrorResponseException - thrown if the request is rejected by server

RuntimeException - all other wrapped checked exceptions if the request fails to be sent

getPatternAnyEntityInfoAsync

public Observable getPatternAnyEntityInfoAsync(UUID appId, String versionId, UUID entityId)

Gets information about the Pattern.Any model in a version of the application.

Parameters:

appId - The application ID.

versionId - The version ID.

entityId - The entity extractor ID.

Returns:

the observable to the PatternAnyEntityExtractor object

Throws:

IllegalArgumentException - thrown if parameters fail the validation

getPatternAnyEntityRole

public EntityRole getPatternAnyEntityRole(UUID appId, String versionId, UUID entityId, UUID roleId)

Get one role for a given Pattern.any entity in a version of the application.

Parameters:

appId - The application ID.

versionId - The version ID.

entityId - entity ID.

roleId - entity role ID.

Returns:

the EntityRole object if successful.

Throws:

IllegalArgumentException - thrown if parameters fail the validation

ErrorResponseException - thrown if the request is rejected by server

RuntimeException - all other wrapped checked exceptions if the request fails to be sent

getPatternAnyEntityRoleAsync

public Observable getPatternAnyEntityRoleAsync(UUID appId, String versionId, UUID entityId, UUID roleId)

Get one role for a given Pattern.any entity in a version of the application.

Parameters:

appId - The application ID.

versionId - The version ID.

entityId - entity ID.

roleId - entity role ID.

Returns:

the observable to the EntityRole object

Throws:

IllegalArgumentException - thrown if parameters fail the validation

getPrebuilt

public PrebuiltEntityExtractor getPrebuilt(UUID appId, String versionId, UUID prebuiltId)

Gets information about a prebuilt entity model in a version of the application.

Parameters:

appId - The application ID.

versionId - The version ID.

prebuiltId - The prebuilt entity extractor ID.

Returns:

the PrebuiltEntityExtractor object if successful.

Throws:

IllegalArgumentException - thrown if parameters fail the validation

ErrorResponseException - thrown if the request is rejected by server

RuntimeException - all other wrapped checked exceptions if the request fails to be sent

getPrebuiltAsync

public Observable getPrebuiltAsync(UUID appId, String versionId, UUID prebuiltId)

Gets information about a prebuilt entity model in a version of the application.

Parameters:

appId - The application ID.

versionId - The version ID.

prebuiltId - The prebuilt entity extractor ID.

Returns:

the observable to the PrebuiltEntityExtractor object

Throws:

IllegalArgumentException - thrown if parameters fail the validation

getPrebuiltEntityRole

public EntityRole getPrebuiltEntityRole(UUID appId, String versionId, UUID entityId, UUID roleId)

Get one role for a given prebuilt entity in a version of the application.

Parameters:

appId - The application ID.

versionId - The version ID.

entityId - entity ID.

roleId - entity role ID.

Returns:

the EntityRole object if successful.

Throws:

IllegalArgumentException - thrown if parameters fail the validation

ErrorResponseException - thrown if the request is rejected by server

RuntimeException - all other wrapped checked exceptions if the request fails to be sent

getPrebuiltEntityRoleAsync

public Observable getPrebuiltEntityRoleAsync(UUID appId, String versionId, UUID entityId, UUID roleId)

Get one role for a given prebuilt entity in a version of the application.

Parameters:

appId - The application ID.

versionId - The version ID.

entityId - entity ID.

roleId - entity role ID.

Returns:

the observable to the EntityRole object

Throws:

IllegalArgumentException - thrown if parameters fail the validation

getRegexEntityEntityInfo

public RegexEntityExtractor getRegexEntityEntityInfo(UUID appId, String versionId, UUID regexEntityId)

Gets information about a regular expression entity in a version of the application.

Parameters:

appId - The application ID.

versionId - The version ID.

regexEntityId - The regular expression entity model ID.

Returns:

the RegexEntityExtractor object if successful.

Throws:

IllegalArgumentException - thrown if parameters fail the validation

ErrorResponseException - thrown if the request is rejected by server

RuntimeException - all other wrapped checked exceptions if the request fails to be sent

getRegexEntityEntityInfoAsync

public Observable getRegexEntityEntityInfoAsync(UUID appId, String versionId, UUID regexEntityId)

Gets information about a regular expression entity in a version of the application.

Parameters:

appId - The application ID.

versionId - The version ID.

regexEntityId - The regular expression entity model ID.

Returns:

the observable to the RegexEntityExtractor object

Throws:

IllegalArgumentException - thrown if parameters fail the validation

getRegexEntityRole

public EntityRole getRegexEntityRole(UUID appId, String versionId, UUID entityId, UUID roleId)

Get one role for a given regular expression entity in a version of the application.

Parameters:

appId - The application ID.

versionId - The version ID.

entityId - entity ID.

roleId - entity role ID.

Returns:

the EntityRole object if successful.

Throws:

IllegalArgumentException - thrown if parameters fail the validation

ErrorResponseException - thrown if the request is rejected by server

RuntimeException - all other wrapped checked exceptions if the request fails to be sent

getRegexEntityRoleAsync

public Observable getRegexEntityRoleAsync(UUID appId, String versionId, UUID entityId, UUID roleId)

Get one role for a given regular expression entity in a version of the application.

Parameters:

appId - The application ID.

versionId - The version ID.

entityId - entity ID.

roleId - entity role ID.

Returns:

the observable to the EntityRole object

Throws:

IllegalArgumentException - thrown if parameters fail the validation

listClosedListEntityRoles

public List listClosedListEntityRoles(UUID appId, String versionId, UUID entityId)

Get all roles for a list entity in a version of the application.

Parameters:

appId - The application ID.

versionId - The version ID.

entityId - entity Id.

Returns:

the List<EntityRole> object if successful.

Throws:

IllegalArgumentException - thrown if parameters fail the validation

ErrorResponseException - thrown if the request is rejected by server

RuntimeException - all other wrapped checked exceptions if the request fails to be sent

listClosedListEntityRolesAsync

public Observable> listClosedListEntityRolesAsync(UUID appId, String versionId, UUID entityId)

Get all roles for a list entity in a version of the application.

Parameters:

appId - The application ID.

versionId - The version ID.

entityId - entity Id.

Returns:

the observable to the List<EntityRole> object

Throws:

IllegalArgumentException - thrown if parameters fail the validation

listClosedLists

public ModelsListClosedListsDefinitionStages.WithAppId listClosedLists()

Gets information about all the list entity models in a version of the application.

Returns:

the first stage of the listClosedLists call

listClosedLists

public List listClosedLists(UUID appId, String versionId, ListClosedListsOptionalParameter listClosedListsOptionalParameter)

Gets information about all the list entity models in a version of the application.

Parameters:

appId - The application ID.

versionId - The version ID.

listClosedListsOptionalParameter - the object representing the optional parameters to be set before calling this API

Returns:

the List<ClosedListEntityExtractor> object if successful.

Throws:

IllegalArgumentException - thrown if parameters fail the validation

ErrorResponseException - thrown if the request is rejected by server

RuntimeException - all other wrapped checked exceptions if the request fails to be sent

listClosedListsAsync

public Observable> listClosedListsAsync(UUID appId, String versionId, ListClosedListsOptionalParameter listClosedListsOptionalParameter)

Gets information about all the list entity models in a version of the application.

Parameters:

appId - The application ID.

versionId - The version ID.

listClosedListsOptionalParameter - the object representing the optional parameters to be set before calling this API

Returns:

the observable to the List<ClosedListEntityExtractor> object

Throws:

IllegalArgumentException - thrown if parameters fail the validation

listCompositeEntities

public ModelsListCompositeEntitiesDefinitionStages.WithAppId listCompositeEntities()

Gets information about all the composite entity models in a version of the application.

Returns:

the first stage of the listCompositeEntities call

listCompositeEntities

public List listCompositeEntities(UUID appId, String versionId, ListCompositeEntitiesOptionalParameter listCompositeEntitiesOptionalParameter)

Gets information about all the composite entity models in a version of the application.

Parameters:

appId - The application ID.

versionId - The version ID.

listCompositeEntitiesOptionalParameter - the object representing the optional parameters to be set before calling this API

Returns:

the List<CompositeEntityExtractor> object if successful.

Throws:

IllegalArgumentException - thrown if parameters fail the validation

ErrorResponseException - thrown if the request is rejected by server

RuntimeException - all other wrapped checked exceptions if the request fails to be sent

listCompositeEntitiesAsync

public Observable> listCompositeEntitiesAsync(UUID appId, String versionId, ListCompositeEntitiesOptionalParameter listCompositeEntitiesOptionalParameter)

Gets information about all the composite entity models in a version of the application.

Parameters:

appId - The application ID.

versionId - The version ID.

listCompositeEntitiesOptionalParameter - the object representing the optional parameters to be set before calling this API

Returns:

the observable to the List<CompositeEntityExtractor> object

Throws:

IllegalArgumentException - thrown if parameters fail the validation

listCompositeEntityRoles

public List listCompositeEntityRoles(UUID appId, String versionId, UUID cEntityId)

Get all roles for a composite entity in a version of the application.

Parameters:

appId - The application ID.

versionId - The version ID.

cEntityId - The composite entity extractor ID.

Returns:

the List<EntityRole> object if successful.

Throws:

IllegalArgumentException - thrown if parameters fail the validation

ErrorResponseException - thrown if the request is rejected by server

RuntimeException - all other wrapped checked exceptions if the request fails to be sent

listCompositeEntityRolesAsync

public Observable> listCompositeEntityRolesAsync(UUID appId, String versionId, UUID cEntityId)

Get all roles for a composite entity in a version of the application.

Parameters:

appId - The application ID.

versionId - The version ID.

cEntityId - The composite entity extractor ID.

Returns:

the observable to the List<EntityRole> object

Throws:

IllegalArgumentException - thrown if parameters fail the validation

listCustomPrebuiltEntities

public List listCustomPrebuiltEntities(UUID appId, String versionId)

Gets all prebuilt entities used in a version of the application.

Parameters:

appId - The application ID.

versionId - The version ID.

Returns:

the List<EntityExtractor> object if successful.

Throws:

IllegalArgumentException - thrown if parameters fail the validation

ErrorResponseException - thrown if the request is rejected by server

RuntimeException - all other wrapped checked exceptions if the request fails to be sent

listCustomPrebuiltEntitiesAsync

public Observable> listCustomPrebuiltEntitiesAsync(UUID appId, String versionId)

Gets all prebuilt entities used in a version of the application.

Parameters:

appId - The application ID.

versionId - The version ID.

Returns:

the observable to the List<EntityExtractor> object

Throws:

IllegalArgumentException - thrown if parameters fail the validation

listCustomPrebuiltEntityRoles

public List listCustomPrebuiltEntityRoles(UUID appId, String versionId, UUID entityId)

Get all roles for a prebuilt entity in a version of the application.

Parameters:

appId - The application ID.

versionId - The version ID.

entityId - entity Id.

Returns:

the List<EntityRole> object if successful.

Throws:

IllegalArgumentException - thrown if parameters fail the validation

ErrorResponseException - thrown if the request is rejected by server

RuntimeException - all other wrapped checked exceptions if the request fails to be sent

listCustomPrebuiltEntityRolesAsync

public Observable> listCustomPrebuiltEntityRolesAsync(UUID appId, String versionId, UUID entityId)

Get all roles for a prebuilt entity in a version of the application.

Parameters:

appId - The application ID.

versionId - The version ID.

entityId - entity Id.

Returns:

the observable to the List<EntityRole> object

Throws:

IllegalArgumentException - thrown if parameters fail the validation

listCustomPrebuiltIntents

public List listCustomPrebuiltIntents(UUID appId, String versionId)

Gets information about customizable prebuilt intents added to a version of the application.

Parameters:

appId - The application ID.

versionId - The version ID.

Returns:

the List<IntentClassifier> object if successful.

Throws:

IllegalArgumentException - thrown if parameters fail the validation

ErrorResponseException - thrown if the request is rejected by server

RuntimeException - all other wrapped checked exceptions if the request fails to be sent

listCustomPrebuiltIntentsAsync

public Observable> listCustomPrebuiltIntentsAsync(UUID appId, String versionId)

Gets information about customizable prebuilt intents added to a version of the application.

Parameters:

appId - The application ID.

versionId - The version ID.

Returns:

the observable to the List<IntentClassifier> object

Throws:

IllegalArgumentException - thrown if parameters fail the validation

listCustomPrebuiltModels

public List listCustomPrebuiltModels(UUID appId, String versionId)

Gets all prebuilt intent and entity model information used in a version of this application.

Parameters:

appId - The application ID.

versionId - The version ID.

Returns:

the List<CustomPrebuiltModel> object if successful.

Throws:

IllegalArgumentException - thrown if parameters fail the validation

ErrorResponseException - thrown if the request is rejected by server

RuntimeException - all other wrapped checked exceptions if the request fails to be sent

listCustomPrebuiltModelsAsync

public Observable> listCustomPrebuiltModelsAsync(UUID appId, String versionId)

Gets all prebuilt intent and entity model information used in a version of this application.

Parameters:

appId - The application ID.

versionId - The version ID.

Returns:

the observable to the List<CustomPrebuiltModel> object

Throws:

IllegalArgumentException - thrown if parameters fail the validation

listEntities

public ModelsListEntitiesDefinitionStages.WithAppId listEntities()

Gets information about all the simple entity models in a version of the application.

Returns:

the first stage of the listEntities call

listEntities

public List listEntities(UUID appId, String versionId, ListEntitiesOptionalParameter listEntitiesOptionalParameter)

Gets information about all the simple entity models in a version of the application.

Parameters:

appId - The application ID.

versionId - The version ID.

listEntitiesOptionalParameter - the object representing the optional parameters to be set before calling this API

Returns:

the List<NDepthEntityExtractor> object if successful.

Throws:

IllegalArgumentException - thrown if parameters fail the validation

ErrorResponseException - thrown if the request is rejected by server

RuntimeException - all other wrapped checked exceptions if the request fails to be sent

listEntitiesAsync

public Observable> listEntitiesAsync(UUID appId, String versionId, ListEntitiesOptionalParameter listEntitiesOptionalParameter)

Gets information about all the simple entity models in a version of the application.

Parameters:

appId - The application ID.

versionId - The version ID.

listEntitiesOptionalParameter - the object representing the optional parameters to be set before calling this API

Returns:

the observable to the List<NDepthEntityExtractor> object

Throws:

IllegalArgumentException - thrown if parameters fail the validation

listEntityRoles

public List listEntityRoles(UUID appId, String versionId, UUID entityId)

Get all roles for an entity in a version of the application.

Parameters:

appId - The application ID.

versionId - The version ID.

entityId - entity Id.

Returns:

the List<EntityRole> object if successful.

Throws:

IllegalArgumentException - thrown if parameters fail the validation

ErrorResponseException - thrown if the request is rejected by server

RuntimeException - all other wrapped checked exceptions if the request fails to be sent

listEntityRolesAsync

public Observable> listEntityRolesAsync(UUID appId, String versionId, UUID entityId)

Get all roles for an entity in a version of the application.

Parameters:

appId - The application ID.

versionId - The version ID.

entityId - entity Id.

Returns:

the observable to the List<EntityRole> object

Throws:

IllegalArgumentException - thrown if parameters fail the validation

listEntitySuggestions

public ModelsListEntitySuggestionsDefinitionStages.WithAppId listEntitySuggestions()

Get suggested example utterances that would improve the accuracy of the entity model in a version of the application.

Returns:

the first stage of the listEntitySuggestions call

listEntitySuggestions

public List listEntitySuggestions(UUID appId, String versionId, UUID entityId, ListEntitySuggestionsOptionalParameter listEntitySuggestionsOptionalParameter)

Get suggested example utterances that would improve the accuracy of the entity model in a version of the application.

Parameters:

appId - The application ID.

versionId - The version ID.

entityId - The target entity extractor model to enhance.

listEntitySuggestionsOptionalParameter - the object representing the optional parameters to be set before calling this API

Returns:

the List<EntitiesSuggestionExample> object if successful.

Throws:

IllegalArgumentException - thrown if parameters fail the validation

ErrorResponseException - thrown if the request is rejected by server

RuntimeException - all other wrapped checked exceptions if the request fails to be sent

listEntitySuggestionsAsync

public Observable> listEntitySuggestionsAsync(UUID appId, String versionId, UUID entityId, ListEntitySuggestionsOptionalParameter listEntitySuggestionsOptionalParameter)

Get suggested example utterances that would improve the accuracy of the entity model in a version of the application.

Parameters:

appId - The application ID.

versionId - The version ID.

entityId - The target entity extractor model to enhance.

listEntitySuggestionsOptionalParameter - the object representing the optional parameters to be set before calling this API

Returns:

the observable to the List<EntitiesSuggestionExample> object

Throws:

IllegalArgumentException - thrown if parameters fail the validation

listHierarchicalEntities

public ModelsListHierarchicalEntitiesDefinitionStages.WithAppId listHierarchicalEntities()

Gets information about all the hierarchical entity models in a version of the application.

Returns:

the first stage of the listHierarchicalEntities call

listHierarchicalEntities

public List listHierarchicalEntities(UUID appId, String versionId, ListHierarchicalEntitiesOptionalParameter listHierarchicalEntitiesOptionalParameter)

Gets information about all the hierarchical entity models in a version of the application.

Parameters:

appId - The application ID.

versionId - The version ID.

listHierarchicalEntitiesOptionalParameter - the object representing the optional parameters to be set before calling this API

Returns:

the List<HierarchicalEntityExtractor> object if successful.

Throws:

IllegalArgumentException - thrown if parameters fail the validation

ErrorResponseException - thrown if the request is rejected by server

RuntimeException - all other wrapped checked exceptions if the request fails to be sent

listHierarchicalEntitiesAsync

public Observable> listHierarchicalEntitiesAsync(UUID appId, String versionId, ListHierarchicalEntitiesOptionalParameter listHierarchicalEntitiesOptionalParameter)

Gets information about all the hierarchical entity models in a version of the application.

Parameters:

appId - The application ID.

versionId - The version ID.

listHierarchicalEntitiesOptionalParameter - the object representing the optional parameters to be set before calling this API

Returns:

the observable to the List<HierarchicalEntityExtractor> object

Throws:

IllegalArgumentException - thrown if parameters fail the validation

listHierarchicalEntityRoles

public List listHierarchicalEntityRoles(UUID appId, String versionId, UUID hEntityId)

Get all roles for a hierarchical entity in a version of the application.

Parameters:

appId - The application ID.

versionId - The version ID.

hEntityId - The hierarchical entity extractor ID.

Returns:

the List<EntityRole> object if successful.

Throws:

IllegalArgumentException - thrown if parameters fail the validation

ErrorResponseException - thrown if the request is rejected by server

RuntimeException - all other wrapped checked exceptions if the request fails to be sent

listHierarchicalEntityRolesAsync

public Observable> listHierarchicalEntityRolesAsync(UUID appId, String versionId, UUID hEntityId)

Get all roles for a hierarchical entity in a version of the application.

Parameters:

appId - The application ID.

versionId - The version ID.

hEntityId - The hierarchical entity extractor ID.

Returns:

the observable to the List<EntityRole> object

Throws:

IllegalArgumentException - thrown if parameters fail the validation

listIntents

public ModelsListIntentsDefinitionStages.WithAppId listIntents()

Gets information about the intent models in a version of the application.

Returns:

the first stage of the listIntents call

listIntents

public List listIntents(UUID appId, String versionId, ListIntentsOptionalParameter listIntentsOptionalParameter)

Gets information about the intent models in a version of the application.

Parameters:

appId - The application ID.

versionId - The version ID.

listIntentsOptionalParameter - the object representing the optional parameters to be set before calling this API

Returns:

the List<IntentClassifier> object if successful.

Throws:

IllegalArgumentException - thrown if parameters fail the validation

ErrorResponseException - thrown if the request is rejected by server

RuntimeException - all other wrapped checked exceptions if the request fails to be sent

listIntentsAsync

public Observable> listIntentsAsync(UUID appId, String versionId, ListIntentsOptionalParameter listIntentsOptionalParameter)

Gets information about the intent models in a version of the application.

Parameters:

appId - The application ID.

versionId - The version ID.

listIntentsOptionalParameter - the object representing the optional parameters to be set before calling this API

Returns:

the observable to the List<IntentClassifier> object

Throws:

IllegalArgumentException - thrown if parameters fail the validation

listIntentSuggestions

public ModelsListIntentSuggestionsDefinitionStages.WithAppId listIntentSuggestions()

Suggests example utterances that would improve the accuracy of the intent model in a version of the application.

Returns:

the first stage of the listIntentSuggestions call

listIntentSuggestions

public List listIntentSuggestions(UUID appId, String versionId, UUID intentId, ListIntentSuggestionsOptionalParameter listIntentSuggestionsOptionalParameter)

Suggests example utterances that would improve the accuracy of the intent model in a version of the application.

Parameters:

appId - The application ID.

versionId - The version ID.

intentId - The intent classifier ID.

listIntentSuggestionsOptionalParameter - the object representing the optional parameters to be set before calling this API

Returns:

the List<IntentsSuggestionExample> object if successful.

Throws:

IllegalArgumentException - thrown if parameters fail the validation

ErrorResponseException - thrown if the request is rejected by server

RuntimeException - all other wrapped checked exceptions if the request fails to be sent

listIntentSuggestionsAsync

public Observable> listIntentSuggestionsAsync(UUID appId, String versionId, UUID intentId, ListIntentSuggestionsOptionalParameter listIntentSuggestionsOptionalParameter)

Suggests example utterances that would improve the accuracy of the intent model in a version of the application.

Parameters:

appId - The application ID.

versionId - The version ID.

intentId - The intent classifier ID.

listIntentSuggestionsOptionalParameter - the object representing the optional parameters to be set before calling this API

Returns:

the observable to the List<IntentsSuggestionExample> object

Throws:

IllegalArgumentException - thrown if parameters fail the validation

listModels

public ModelsListModelsDefinitionStages.WithAppId listModels()

Gets information about all the intent and entity models in a version of the application.

Returns:

the first stage of the listModels call

listModels

public List listModels(UUID appId, String versionId, ListModelsOptionalParameter listModelsOptionalParameter)

Gets information about all the intent and entity models in a version of the application.

Parameters:

appId - The application ID.

versionId - The version ID.

listModelsOptionalParameter - the object representing the optional parameters to be set before calling this API

Returns:

the List<ModelInfoResponse> object if successful.

Throws:

IllegalArgumentException - thrown if parameters fail the validation

ErrorResponseException - thrown if the request is rejected by server

RuntimeException - all other wrapped checked exceptions if the request fails to be sent

listModelsAsync

public Observable> listModelsAsync(UUID appId, String versionId, ListModelsOptionalParameter listModelsOptionalParameter)

Gets information about all the intent and entity models in a version of the application.

Parameters:

appId - The application ID.

versionId - The version ID.

listModelsOptionalParameter - the object representing the optional parameters to be set before calling this API

Returns:

the observable to the List<ModelInfoResponse> object

Throws:

IllegalArgumentException - thrown if parameters fail the validation

listPatternAnyEntityInfos

public ModelsListPatternAnyEntityInfosDefinitionStages.WithAppId listPatternAnyEntityInfos()

Get information about the Pattern.Any entity models in a version of the application.

Returns:

the first stage of the listPatternAnyEntityInfos call

listPatternAnyEntityInfos

public List listPatternAnyEntityInfos(UUID appId, String versionId, ListPatternAnyEntityInfosOptionalParameter listPatternAnyEntityInfosOptionalParameter)

Get information about the Pattern.Any entity models in a version of the application.

Parameters:

appId - The application ID.

versionId - The version ID.

listPatternAnyEntityInfosOptionalParameter - the object representing the optional parameters to be set before calling this API

Returns:

the List<PatternAnyEntityExtractor> object if successful.

Throws:

IllegalArgumentException - thrown if parameters fail the validation

ErrorResponseException - thrown if the request is rejected by server

RuntimeException - all other wrapped checked exceptions if the request fails to be sent

listPatternAnyEntityInfosAsync

public Observable> listPatternAnyEntityInfosAsync(UUID appId, String versionId, ListPatternAnyEntityInfosOptionalParameter listPatternAnyEntityInfosOptionalParameter)

Get information about the Pattern.Any entity models in a version of the application.

Parameters:

appId - The application ID.

versionId - The version ID.

listPatternAnyEntityInfosOptionalParameter - the object representing the optional parameters to be set before calling this API

Returns:

the observable to the List<PatternAnyEntityExtractor> object

Throws:

IllegalArgumentException - thrown if parameters fail the validation

listPatternAnyEntityRoles

public List listPatternAnyEntityRoles(UUID appId, String versionId, UUID entityId)

Get all roles for a Pattern.any entity in a version of the application.

Parameters:

appId - The application ID.

versionId - The version ID.

entityId - entity Id.

Returns:

the List<EntityRole> object if successful.

Throws:

IllegalArgumentException - thrown if parameters fail the validation

ErrorResponseException - thrown if the request is rejected by server

RuntimeException - all other wrapped checked exceptions if the request fails to be sent

listPatternAnyEntityRolesAsync

public Observable> listPatternAnyEntityRolesAsync(UUID appId, String versionId, UUID entityId)

Get all roles for a Pattern.any entity in a version of the application.

Parameters:

appId - The application ID.

versionId - The version ID.

entityId - entity Id.

Returns:

the observable to the List<EntityRole> object

Throws:

IllegalArgumentException - thrown if parameters fail the validation

listPrebuiltEntities

public List listPrebuiltEntities(UUID appId, String versionId)

Gets all the available prebuilt entities in a version of the application.

Parameters:

appId - The application ID.

versionId - The version ID.

Returns:

the List<AvailablePrebuiltEntityModel> object if successful.

Throws:

IllegalArgumentException - thrown if parameters fail the validation

ErrorResponseException - thrown if the request is rejected by server

RuntimeException - all other wrapped checked exceptions if the request fails to be sent

listPrebuiltEntitiesAsync

public Observable> listPrebuiltEntitiesAsync(UUID appId, String versionId)

Gets all the available prebuilt entities in a version of the application.

Parameters:

appId - The application ID.

versionId - The version ID.

Returns:

the observable to the List<AvailablePrebuiltEntityModel> object

Throws:

IllegalArgumentException - thrown if parameters fail the validation

listPrebuiltEntityRoles

public List listPrebuiltEntityRoles(UUID appId, String versionId, UUID entityId)

Get a prebuilt entity's roles in a version of the application.

Parameters:

appId - The application ID.

versionId - The version ID.

entityId - entity Id.

Returns:

the List<EntityRole> object if successful.

Throws:

IllegalArgumentException - thrown if parameters fail the validation

ErrorResponseException - thrown if the request is rejected by server

RuntimeException - all other wrapped checked exceptions if the request fails to be sent

listPrebuiltEntityRolesAsync

public Observable> listPrebuiltEntityRolesAsync(UUID appId, String versionId, UUID entityId)

Get a prebuilt entity's roles in a version of the application.

Parameters:

appId - The application ID.

versionId - The version ID.

entityId - entity Id.

Returns:

the observable to the List<EntityRole> object

Throws:

IllegalArgumentException - thrown if parameters fail the validation

listPrebuilts

public ModelsListPrebuiltsDefinitionStages.WithAppId listPrebuilts()

Gets information about all the prebuilt entities in a version of the application.

Returns:

the first stage of the listPrebuilts call

listPrebuilts

public List listPrebuilts(UUID appId, String versionId, ListPrebuiltsOptionalParameter listPrebuiltsOptionalParameter)

Gets information about all the prebuilt entities in a version of the application.

Parameters:

appId - The application ID.

versionId - The version ID.

listPrebuiltsOptionalParameter - the object representing the optional parameters to be set before calling this API

Returns:

the List<PrebuiltEntityExtractor> object if successful.

Throws:

IllegalArgumentException - thrown if parameters fail the validation

ErrorResponseException - thrown if the request is rejected by server

RuntimeException - all other wrapped checked exceptions if the request fails to be sent

listPrebuiltsAsync

public Observable> listPrebuiltsAsync(UUID appId, String versionId, ListPrebuiltsOptionalParameter listPrebuiltsOptionalParameter)

Gets information about all the prebuilt entities in a version of the application.

Parameters:

appId - The application ID.

versionId - The version ID.

listPrebuiltsOptionalParameter - the object representing the optional parameters to be set before calling this API

Returns:

the observable to the List<PrebuiltEntityExtractor> object

Throws:

IllegalArgumentException - thrown if parameters fail the validation

listRegexEntityInfos

public ModelsListRegexEntityInfosDefinitionStages.WithAppId listRegexEntityInfos()

Gets information about the regular expression entity models in a version of the application.

Returns:

the first stage of the listRegexEntityInfos call

listRegexEntityInfos

public List listRegexEntityInfos(UUID appId, String versionId, ListRegexEntityInfosOptionalParameter listRegexEntityInfosOptionalParameter)

Gets information about the regular expression entity models in a version of the application.

Parameters:

appId - The application ID.

versionId - The version ID.

listRegexEntityInfosOptionalParameter - the object representing the optional parameters to be set before calling this API

Returns:

the List<RegexEntityExtractor> object if successful.

Throws:

IllegalArgumentException - thrown if parameters fail the validation

ErrorResponseException - thrown if the request is rejected by server

RuntimeException - all other wrapped checked exceptions if the request fails to be sent

listRegexEntityInfosAsync

public Observable> listRegexEntityInfosAsync(UUID appId, String versionId, ListRegexEntityInfosOptionalParameter listRegexEntityInfosOptionalParameter)

Gets information about the regular expression entity models in a version of the application.

Parameters:

appId - The application ID.

versionId - The version ID.

listRegexEntityInfosOptionalParameter - the object representing the optional parameters to be set before calling this API

Returns:

the observable to the List<RegexEntityExtractor> object

Throws:

IllegalArgumentException - thrown if parameters fail the validation

listRegexEntityRoles

public List listRegexEntityRoles(UUID appId, String versionId, UUID entityId)

Get all roles for a regular expression entity in a version of the application.

Parameters:

appId - The application ID.

versionId - The version ID.

entityId - entity Id.

Returns:

the List<EntityRole> object if successful.

Throws:

IllegalArgumentException - thrown if parameters fail the validation

ErrorResponseException - thrown if the request is rejected by server

RuntimeException - all other wrapped checked exceptions if the request fails to be sent

listRegexEntityRolesAsync

public Observable> listRegexEntityRolesAsync(UUID appId, String versionId, UUID entityId)

Get all roles for a regular expression entity in a version of the application.

Parameters:

appId - The application ID.

versionId - The version ID.

entityId - entity Id.

Returns:

the observable to the List<EntityRole> object

Throws:

IllegalArgumentException - thrown if parameters fail the validation

patchClosedList

public ModelsPatchClosedListDefinitionStages.WithAppId patchClosedList()

Adds a batch of sublists to an existing list entity in a version of the application.

Returns:

the first stage of the patchClosedList call

patchClosedList

public OperationStatus patchClosedList(UUID appId, String versionId, UUID clEntityId, PatchClosedListOptionalParameter patchClosedListOptionalParameter)

Adds a batch of sublists to an existing list entity in a version of the application.

Parameters:

appId - The application ID.

versionId - The version ID.

clEntityId - The list entity model ID.

patchClosedListOptionalParameter - the object representing the optional parameters to be set before calling this API

Returns:

the OperationStatus object if successful.

Throws:

IllegalArgumentException - thrown if parameters fail the validation

ErrorResponseException - thrown if the request is rejected by server

RuntimeException - all other wrapped checked exceptions if the request fails to be sent

patchClosedListAsync

public Observable patchClosedListAsync(UUID appId, String versionId, UUID clEntityId, PatchClosedListOptionalParameter patchClosedListOptionalParameter)

Adds a batch of sublists to an existing list entity in a version of the application.

Parameters:

appId - The application ID.

versionId - The version ID.

clEntityId - The list entity model ID.

patchClosedListOptionalParameter - the object representing the optional parameters to be set before calling this API

Returns:

the observable to the OperationStatus object

Throws:

IllegalArgumentException - thrown if parameters fail the validation

replaceEntityFeatures

public OperationStatus replaceEntityFeatures(UUID appId, String versionId, UUID entityId, List featureRelationsUpdateObject)

Updates the information of the features used by the entity in a version of the application.

Parameters:

appId - The application ID.

versionId - The version ID.

entityId - The entity extractor ID.

featureRelationsUpdateObject - A list of feature information objects containing the new feature relations.

Returns:

the OperationStatus object if successful.

Throws:

IllegalArgumentException - thrown if parameters fail the validation

ErrorResponseException - thrown if the request is rejected by server

RuntimeException - all other wrapped checked exceptions if the request fails to be sent

replaceEntityFeaturesAsync

public Observable replaceEntityFeaturesAsync(UUID appId, String versionId, UUID entityId, List featureRelationsUpdateObject)

Updates the information of the features used by the entity in a version of the application.

Parameters:

appId - The application ID.

versionId - The version ID.

entityId - The entity extractor ID.

featureRelationsUpdateObject - A list of feature information objects containing the new feature relations.

Returns:

the observable to the OperationStatus object

Throws:

IllegalArgumentException - thrown if parameters fail the validation

replaceIntentFeatures

public OperationStatus replaceIntentFeatures(UUID appId, String versionId, UUID intentId, List featureRelationsUpdateObject)

Updates the information of the features used by the intent in a version of the application.

Parameters:

appId - The application ID.

versionId - The version ID.

intentId - The intent classifier ID.

featureRelationsUpdateObject - A list of feature information objects containing the new feature relations.

Returns:

the OperationStatus object if successful.

Throws:

IllegalArgumentException - thrown if parameters fail the validation

ErrorResponseException - thrown if the request is rejected by server

RuntimeException - all other wrapped checked exceptions if the request fails to be sent

replaceIntentFeaturesAsync

public Observable replaceIntentFeaturesAsync(UUID appId, String versionId, UUID intentId, List featureRelationsUpdateObject)

Updates the information of the features used by the intent in a version of the application.

Parameters:

appId - The application ID.

versionId - The version ID.

intentId - The intent classifier ID.

featureRelationsUpdateObject - A list of feature information objects containing the new feature relations.

Returns:

the observable to the OperationStatus object

Throws:

IllegalArgumentException - thrown if parameters fail the validation

updateClosedList

public OperationStatus updateClosedList(UUID appId, String versionId, UUID clEntityId, ClosedListModelUpdateObject closedListModelUpdateObject)

Updates the list entity in a version of the application.

Parameters:

appId - The application ID.

versionId - The version ID.

clEntityId - The list model ID.

closedListModelUpdateObject - The new list entity name and words list.

Returns:

the OperationStatus object if successful.

Throws:

IllegalArgumentException - thrown if parameters fail the validation

ErrorResponseException - thrown if the request is rejected by server

RuntimeException - all other wrapped checked exceptions if the request fails to be sent

updateClosedListAsync

public Observable updateClosedListAsync(UUID appId, String versionId, UUID clEntityId, ClosedListModelUpdateObject closedListModelUpdateObject)

Updates the list entity in a version of the application.

Parameters:

appId - The application ID.

versionId - The version ID.

clEntityId - The list model ID.

closedListModelUpdateObject - The new list entity name and words list.

Returns:

the observable to the OperationStatus object

Throws:

IllegalArgumentException - thrown if parameters fail the validation

updateClosedListEntityRole

public ModelsUpdateClosedListEntityRoleDefinitionStages.WithAppId updateClosedListEntityRole()

Update a role for a given list entity in a version of the application.

Returns:

the first stage of the updateClosedListEntityRole call

updateClosedListEntityRole

public OperationStatus updateClosedListEntityRole(UUID appId, String versionId, UUID entityId, UUID roleId, UpdateClosedListEntityRoleOptionalParameter updateClosedListEntityRoleOptionalParameter)

Update a role for a given list entity in a version of the application.

Parameters:

appId - The application ID.

versionId - The version ID.

entityId - The entity ID.

roleId - The entity role ID.

updateClosedListEntityRoleOptionalParameter - the object representing the optional parameters to be set before calling this API

Returns:

the OperationStatus object if successful.

Throws:

IllegalArgumentException - thrown if parameters fail the validation

ErrorResponseException - thrown if the request is rejected by server

RuntimeException - all other wrapped checked exceptions if the request fails to be sent

updateClosedListEntityRoleAsync

public Observable updateClosedListEntityRoleAsync(UUID appId, String versionId, UUID entityId, UUID roleId, UpdateClosedListEntityRoleOptionalParameter updateClosedListEntityRoleOptionalParameter)

Update a role for a given list entity in a version of the application.

Parameters:

appId - The application ID.

versionId - The version ID.

entityId - The entity ID.

roleId - The entity role ID.

updateClosedListEntityRoleOptionalParameter - the object representing the optional parameters to be set before calling this API

Returns:

the observable to the OperationStatus object

Throws:

IllegalArgumentException - thrown if parameters fail the validation

updateCompositeEntity

public OperationStatus updateCompositeEntity(UUID appId, String versionId, UUID cEntityId, CompositeEntityModel compositeModelUpdateObject)

Updates a composite entity in a version of the application.

Parameters:

appId - The application ID.

versionId - The version ID.

cEntityId - The composite entity extractor ID.

compositeModelUpdateObject - A model object containing the new entity extractor name and children.

Returns:

the OperationStatus object if successful.

Throws:

IllegalArgumentException - thrown if parameters fail the validation

ErrorResponseException - thrown if the request is rejected by server

RuntimeException - all other wrapped checked exceptions if the request fails to be sent

updateCompositeEntityAsync

public Observable updateCompositeEntityAsync(UUID appId, String versionId, UUID cEntityId, CompositeEntityModel compositeModelUpdateObject)

Updates a composite entity in a version of the application.

Parameters:

appId - The application ID.

versionId - The version ID.

cEntityId - The composite entity extractor ID.

compositeModelUpdateObject - A model object containing the new entity extractor name and children.

Returns:

the observable to the OperationStatus object

Throws:

IllegalArgumentException - thrown if parameters fail the validation

updateCompositeEntityRole

public ModelsUpdateCompositeEntityRoleDefinitionStages.WithAppId updateCompositeEntityRole()

Update a role for a given composite entity in a version of the application.

Returns:

the first stage of the updateCompositeEntityRole call

updateCompositeEntityRole

public OperationStatus updateCompositeEntityRole(UUID appId, String versionId, UUID cEntityId, UUID roleId, UpdateCompositeEntityRoleOptionalParameter updateCompositeEntityRoleOptionalParameter)

Update a role for a given composite entity in a version of the application.

Parameters:

appId - The application ID.

versionId - The version ID.

cEntityId - The composite entity extractor ID.

roleId - The entity role ID.

updateCompositeEntityRoleOptionalParameter - the object representing the optional parameters to be set before calling this API

Returns:

the OperationStatus object if successful.

Throws:

IllegalArgumentException - thrown if parameters fail the validation

ErrorResponseException - thrown if the request is rejected by server

RuntimeException - all other wrapped checked exceptions if the request fails to be sent

updateCompositeEntityRoleAsync

public Observable updateCompositeEntityRoleAsync(UUID appId, String versionId, UUID cEntityId, UUID roleId, UpdateCompositeEntityRoleOptionalParameter updateCompositeEntityRoleOptionalParameter)

Update a role for a given composite entity in a version of the application.

Parameters:

appId - The application ID.

versionId - The version ID.

cEntityId - The composite entity extractor ID.

roleId - The entity role ID.

updateCompositeEntityRoleOptionalParameter - the object representing the optional parameters to be set before calling this API

Returns:

the observable to the OperationStatus object

Throws:

IllegalArgumentException - thrown if parameters fail the validation

updateCustomPrebuiltEntityRole

public ModelsUpdateCustomPrebuiltEntityRoleDefinitionStages.WithAppId updateCustomPrebuiltEntityRole()

Update a role for a given prebuilt entity in a version of the application.

Returns:

the first stage of the updateCustomPrebuiltEntityRole call

updateCustomPrebuiltEntityRole

public OperationStatus updateCustomPrebuiltEntityRole(UUID appId, String versionId, UUID entityId, UUID roleId, UpdateCustomPrebuiltEntityRoleOptionalParameter updateCustomPrebuiltEntityRoleOptionalParameter)

Update a role for a given prebuilt entity in a version of the application.

Parameters:

appId - The application ID.

versionId - The version ID.

entityId - The entity ID.

roleId - The entity role ID.

updateCustomPrebuiltEntityRoleOptionalParameter - the object representing the optional parameters to be set before calling this API

Returns:

the OperationStatus object if successful.

Throws:

IllegalArgumentException - thrown if parameters fail the validation

ErrorResponseException - thrown if the request is rejected by server

RuntimeException - all other wrapped checked exceptions if the request fails to be sent

updateCustomPrebuiltEntityRoleAsync

public Observable updateCustomPrebuiltEntityRoleAsync(UUID appId, String versionId, UUID entityId, UUID roleId, UpdateCustomPrebuiltEntityRoleOptionalParameter updateCustomPrebuiltEntityRoleOptionalParameter)

Update a role for a given prebuilt entity in a version of the application.

Parameters:

appId - The application ID.

versionId - The version ID.

entityId - The entity ID.

roleId - The entity role ID.

updateCustomPrebuiltEntityRoleOptionalParameter - the object representing the optional parameters to be set before calling this API

Returns:

the observable to the OperationStatus object

Throws:

IllegalArgumentException - thrown if parameters fail the validation

updateEntityChild

public OperationStatus updateEntityChild(UUID appId, String versionId, UUID entityId, EntityModelUpdateObject entityModelUpdateObject)

Updates the name of an entity extractor or the name and instanceOf model of a child entity extractor.

Parameters:

appId - The application ID.

versionId - The version ID.

entityId - The entity extractor or the child entity extractor ID.

entityModelUpdateObject - A model object containing the name new entity extractor or the name and instance of model of a child entity extractor.

Returns:

the OperationStatus object if successful.

Throws:

IllegalArgumentException - thrown if parameters fail the validation

ErrorResponseException - thrown if the request is rejected by server

RuntimeException - all other wrapped checked exceptions if the request fails to be sent

updateEntityChildAsync

public Observable updateEntityChildAsync(UUID appId, String versionId, UUID entityId, EntityModelUpdateObject entityModelUpdateObject)

Updates the name of an entity extractor or the name and instanceOf model of a child entity extractor.

Parameters:

appId - The application ID.

versionId - The version ID.

entityId - The entity extractor or the child entity extractor ID.

entityModelUpdateObject - A model object containing the name new entity extractor or the name and instance of model of a child entity extractor.

Returns:

the observable to the OperationStatus object

Throws:

IllegalArgumentException - thrown if parameters fail the validation

updateEntityRole

public ModelsUpdateEntityRoleDefinitionStages.WithAppId updateEntityRole()

Update a role for a given entity in a version of the application.

Returns:

the first stage of the updateEntityRole call

updateEntityRole

public OperationStatus updateEntityRole(UUID appId, String versionId, UUID entityId, UUID roleId, UpdateEntityRoleOptionalParameter updateEntityRoleOptionalParameter)

Update a role for a given entity in a version of the application.

Parameters:

appId - The application ID.

versionId - The version ID.

entityId - The entity ID.

roleId - The entity role ID.

updateEntityRoleOptionalParameter - the object representing the optional parameters to be set before calling this API

Returns:

the OperationStatus object if successful.

Throws:

IllegalArgumentException - thrown if parameters fail the validation

ErrorResponseException - thrown if the request is rejected by server

RuntimeException - all other wrapped checked exceptions if the request fails to be sent

updateEntityRoleAsync

public Observable updateEntityRoleAsync(UUID appId, String versionId, UUID entityId, UUID roleId, UpdateEntityRoleOptionalParameter updateEntityRoleOptionalParameter)

Update a role for a given entity in a version of the application.

Parameters:

appId - The application ID.

versionId - The version ID.

entityId - The entity ID.

roleId - The entity role ID.

updateEntityRoleOptionalParameter - the object representing the optional parameters to be set before calling this API

Returns:

the observable to the OperationStatus object

Throws:

IllegalArgumentException - thrown if parameters fail the validation

updateExplicitListItem

public ModelsUpdateExplicitListItemDefinitionStages.WithAppId updateExplicitListItem()

Updates an explicit (exception) list item for a Pattern.Any entity in a version of the application.

Returns:

the first stage of the updateExplicitListItem call

updateExplicitListItem

public OperationStatus updateExplicitListItem(UUID appId, String versionId, UUID entityId, long itemId, UpdateExplicitListItemOptionalParameter updateExplicitListItemOptionalParameter)

Updates an explicit (exception) list item for a Pattern.Any entity in a version of the application.

Parameters:

appId - The application ID.

versionId - The version ID.

entityId - The Pattern.Any entity extractor ID.

itemId - The explicit list item ID.

updateExplicitListItemOptionalParameter - the object representing the optional parameters to be set before calling this API

Returns:

the OperationStatus object if successful.

Throws:

IllegalArgumentException - thrown if parameters fail the validation

ErrorResponseException - thrown if the request is rejected by server

RuntimeException - all other wrapped checked exceptions if the request fails to be sent

updateExplicitListItemAsync

public Observable updateExplicitListItemAsync(UUID appId, String versionId, UUID entityId, long itemId, UpdateExplicitListItemOptionalParameter updateExplicitListItemOptionalParameter)

Updates an explicit (exception) list item for a Pattern.Any entity in a version of the application.

Parameters:

appId - The application ID.

versionId - The version ID.

entityId - The Pattern.Any entity extractor ID.

itemId - The explicit list item ID.

updateExplicitListItemOptionalParameter - the object representing the optional parameters to be set before calling this API

Returns:

the observable to the OperationStatus object

Throws:

IllegalArgumentException - thrown if parameters fail the validation

updateHierarchicalEntity

public ModelsUpdateHierarchicalEntityDefinitionStages.WithAppId updateHierarchicalEntity()

Updates the name of a hierarchical entity model in a version of the application.

Returns:

the first stage of the updateHierarchicalEntity call

updateHierarchicalEntity

public OperationStatus updateHierarchicalEntity(UUID appId, String versionId, UUID hEntityId, UpdateHierarchicalEntityOptionalParameter updateHierarchicalEntityOptionalParameter)

Updates the name of a hierarchical entity model in a version of the application.

Parameters:

appId - The application ID.

versionId - The version ID.

hEntityId - The hierarchical entity extractor ID.

updateHierarchicalEntityOptionalParameter - the object representing the optional parameters to be set before calling this API

Returns:

the OperationStatus object if successful.

Throws:

IllegalArgumentException - thrown if parameters fail the validation

ErrorResponseException - thrown if the request is rejected by server

RuntimeException - all other wrapped checked exceptions if the request fails to be sent

updateHierarchicalEntityAsync

public Observable updateHierarchicalEntityAsync(UUID appId, String versionId, UUID hEntityId, UpdateHierarchicalEntityOptionalParameter updateHierarchicalEntityOptionalParameter)

Updates the name of a hierarchical entity model in a version of the application.

Parameters:

appId - The application ID.

versionId - The version ID.

hEntityId - The hierarchical entity extractor ID.

updateHierarchicalEntityOptionalParameter - the object representing the optional parameters to be set before calling this API

Returns:

the observable to the OperationStatus object

Throws:

IllegalArgumentException - thrown if parameters fail the validation

updateHierarchicalEntityChild

public ModelsUpdateHierarchicalEntityChildDefinitionStages.WithAppId updateHierarchicalEntityChild()

Renames a single child in an existing hierarchical entity model in a version of the application.

Returns:

the first stage of the updateHierarchicalEntityChild call

updateHierarchicalEntityChild

public OperationStatus updateHierarchicalEntityChild(UUID appId, String versionId, UUID hEntityId, UUID hChildId, UpdateHierarchicalEntityChildOptionalParameter updateHierarchicalEntityChildOptionalParameter)

Renames a single child in an existing hierarchical entity model in a version of the application.

Parameters:

appId - The application ID.

versionId - The version ID.

hEntityId - The hierarchical entity extractor ID.

hChildId - The hierarchical entity extractor child ID.

updateHierarchicalEntityChildOptionalParameter - the object representing the optional parameters to be set before calling this API

Returns:

the OperationStatus object if successful.

Throws:

IllegalArgumentException - thrown if parameters fail the validation

ErrorResponseException - thrown if the request is rejected by server

RuntimeException - all other wrapped checked exceptions if the request fails to be sent

updateHierarchicalEntityChildAsync

public Observable updateHierarchicalEntityChildAsync(UUID appId, String versionId, UUID hEntityId, UUID hChildId, UpdateHierarchicalEntityChildOptionalParameter updateHierarchicalEntityChildOptionalParameter)

Renames a single child in an existing hierarchical entity model in a version of the application.

Parameters:

appId - The application ID.

versionId - The version ID.

hEntityId - The hierarchical entity extractor ID.

hChildId - The hierarchical entity extractor child ID.

updateHierarchicalEntityChildOptionalParameter - the object representing the optional parameters to be set before calling this API

Returns:

the observable to the OperationStatus object

Throws:

IllegalArgumentException - thrown if parameters fail the validation

updateHierarchicalEntityRole

public ModelsUpdateHierarchicalEntityRoleDefinitionStages.WithAppId updateHierarchicalEntityRole()

Update a role for a given hierarchical entity in a version of the application.

Returns:

the first stage of the updateHierarchicalEntityRole call

updateHierarchicalEntityRole

public OperationStatus updateHierarchicalEntityRole(UUID appId, String versionId, UUID hEntityId, UUID roleId, UpdateHierarchicalEntityRoleOptionalParameter updateHierarchicalEntityRoleOptionalParameter)

Update a role for a given hierarchical entity in a version of the application.

Parameters:

appId - The application ID.

versionId - The version ID.

hEntityId - The hierarchical entity extractor ID.

roleId - The entity role ID.

updateHierarchicalEntityRoleOptionalParameter - the object representing the optional parameters to be set before calling this API

Returns:

the OperationStatus object if successful.

Throws:

IllegalArgumentException - thrown if parameters fail the validation

ErrorResponseException - thrown if the request is rejected by server

RuntimeException - all other wrapped checked exceptions if the request fails to be sent

updateHierarchicalEntityRoleAsync

public Observable updateHierarchicalEntityRoleAsync(UUID appId, String versionId, UUID hEntityId, UUID roleId, UpdateHierarchicalEntityRoleOptionalParameter updateHierarchicalEntityRoleOptionalParameter)

Update a role for a given hierarchical entity in a version of the application.

Parameters:

appId - The application ID.

versionId - The version ID.

hEntityId - The hierarchical entity extractor ID.

roleId - The entity role ID.

updateHierarchicalEntityRoleOptionalParameter - the object representing the optional parameters to be set before calling this API

Returns:

the observable to the OperationStatus object

Throws:

IllegalArgumentException - thrown if parameters fail the validation

updateIntent

public ModelsUpdateIntentDefinitionStages.WithAppId updateIntent()

Updates the name of an intent in a version of the application.

Returns:

the first stage of the updateIntent call

updateIntent

public OperationStatus updateIntent(UUID appId, String versionId, UUID intentId, UpdateIntentOptionalParameter updateIntentOptionalParameter)

Updates the name of an intent in a version of the application.

Parameters:

appId - The application ID.

versionId - The version ID.

intentId - The intent classifier ID.

updateIntentOptionalParameter - the object representing the optional parameters to be set before calling this API

Returns:

the OperationStatus object if successful.

Throws:

IllegalArgumentException - thrown if parameters fail the validation

ErrorResponseException - thrown if the request is rejected by server

RuntimeException - all other wrapped checked exceptions if the request fails to be sent

updateIntentAsync

public Observable updateIntentAsync(UUID appId, String versionId, UUID intentId, UpdateIntentOptionalParameter updateIntentOptionalParameter)

Updates the name of an intent in a version of the application.

Parameters:

appId - The application ID.

versionId - The version ID.

intentId - The intent classifier ID.

updateIntentOptionalParameter - the object representing the optional parameters to be set before calling this API

Returns:

the observable to the OperationStatus object

Throws:

IllegalArgumentException - thrown if parameters fail the validation

updatePatternAnyEntityModel

public OperationStatus updatePatternAnyEntityModel(UUID appId, String versionId, UUID entityId, PatternAnyModelUpdateObject patternAnyUpdateObject)

Updates the name and explicit (exception) list of a Pattern.Any entity model in a version of the application.

Parameters:

appId - The application ID.

versionId - The version ID.

entityId - The Pattern.Any entity extractor ID.

patternAnyUpdateObject - An object containing the explicit list of the Pattern.Any entity.

Returns:

the OperationStatus object if successful.

Throws:

IllegalArgumentException - thrown if parameters fail the validation

ErrorResponseException - thrown if the request is rejected by server

RuntimeException - all other wrapped checked exceptions if the request fails to be sent

updatePatternAnyEntityModelAsync

public Observable updatePatternAnyEntityModelAsync(UUID appId, String versionId, UUID entityId, PatternAnyModelUpdateObject patternAnyUpdateObject)

Updates the name and explicit (exception) list of a Pattern.Any entity model in a version of the application.

Parameters:

appId - The application ID.

versionId - The version ID.

entityId - The Pattern.Any entity extractor ID.

patternAnyUpdateObject - An object containing the explicit list of the Pattern.Any entity.

Returns:

the observable to the OperationStatus object

Throws:

IllegalArgumentException - thrown if parameters fail the validation

updatePatternAnyEntityRole

public ModelsUpdatePatternAnyEntityRoleDefinitionStages.WithAppId updatePatternAnyEntityRole()

Update a role for a given Pattern.any entity in a version of the application.

Returns:

the first stage of the updatePatternAnyEntityRole call

updatePatternAnyEntityRole

public OperationStatus updatePatternAnyEntityRole(UUID appId, String versionId, UUID entityId, UUID roleId, UpdatePatternAnyEntityRoleOptionalParameter updatePatternAnyEntityRoleOptionalParameter)

Update a role for a given Pattern.any entity in a version of the application.

Parameters:

appId - The application ID.

versionId - The version ID.

entityId - The entity ID.

roleId - The entity role ID.

updatePatternAnyEntityRoleOptionalParameter - the object representing the optional parameters to be set before calling this API

Returns:

the OperationStatus object if successful.

Throws:

IllegalArgumentException - thrown if parameters fail the validation

ErrorResponseException - thrown if the request is rejected by server

RuntimeException - all other wrapped checked exceptions if the request fails to be sent

updatePatternAnyEntityRoleAsync

public Observable updatePatternAnyEntityRoleAsync(UUID appId, String versionId, UUID entityId, UUID roleId, UpdatePatternAnyEntityRoleOptionalParameter updatePatternAnyEntityRoleOptionalParameter)

Update a role for a given Pattern.any entity in a version of the application.

Parameters:

appId - The application ID.

versionId - The version ID.

entityId - The entity ID.

roleId - The entity role ID.

updatePatternAnyEntityRoleOptionalParameter - the object representing the optional parameters to be set before calling this API

Returns:

the observable to the OperationStatus object

Throws:

IllegalArgumentException - thrown if parameters fail the validation

updatePrebuiltEntityRole

public ModelsUpdatePrebuiltEntityRoleDefinitionStages.WithAppId updatePrebuiltEntityRole()

Update a role for a given prebuilt entity in a version of the application.

Returns:

the first stage of the updatePrebuiltEntityRole call

updatePrebuiltEntityRole

public OperationStatus updatePrebuiltEntityRole(UUID appId, String versionId, UUID entityId, UUID roleId, UpdatePrebuiltEntityRoleOptionalParameter updatePrebuiltEntityRoleOptionalParameter)

Update a role for a given prebuilt entity in a version of the application.

Parameters:

appId - The application ID.

versionId - The version ID.

entityId - The entity ID.

roleId - The entity role ID.

updatePrebuiltEntityRoleOptionalParameter - the object representing the optional parameters to be set before calling this API

Returns:

the OperationStatus object if successful.

Throws:

IllegalArgumentException - thrown if parameters fail the validation

ErrorResponseException - thrown if the request is rejected by server

RuntimeException - all other wrapped checked exceptions if the request fails to be sent

updatePrebuiltEntityRoleAsync

public Observable updatePrebuiltEntityRoleAsync(UUID appId, String versionId, UUID entityId, UUID roleId, UpdatePrebuiltEntityRoleOptionalParameter updatePrebuiltEntityRoleOptionalParameter)

Update a role for a given prebuilt entity in a version of the application.

Parameters:

appId - The application ID.

versionId - The version ID.

entityId - The entity ID.

roleId - The entity role ID.

updatePrebuiltEntityRoleOptionalParameter - the object representing the optional parameters to be set before calling this API

Returns:

the observable to the OperationStatus object

Throws:

IllegalArgumentException - thrown if parameters fail the validation

updateRegexEntityModel

public OperationStatus updateRegexEntityModel(UUID appId, String versionId, UUID regexEntityId, RegexModelUpdateObject regexEntityUpdateObject)

Updates the regular expression entity in a version of the application.

Parameters:

appId - The application ID.

versionId - The version ID.

regexEntityId - The regular expression entity extractor ID.

regexEntityUpdateObject - An object containing the new entity name and regex pattern.

Returns:

the OperationStatus object if successful.

Throws:

IllegalArgumentException - thrown if parameters fail the validation

ErrorResponseException - thrown if the request is rejected by server

RuntimeException - all other wrapped checked exceptions if the request fails to be sent

updateRegexEntityModelAsync

public Observable updateRegexEntityModelAsync(UUID appId, String versionId, UUID regexEntityId, RegexModelUpdateObject regexEntityUpdateObject)

Updates the regular expression entity in a version of the application.

Parameters:

appId - The application ID.

versionId - The version ID.

regexEntityId - The regular expression entity extractor ID.

regexEntityUpdateObject - An object containing the new entity name and regex pattern.

Returns:

the observable to the OperationStatus object

Throws:

IllegalArgumentException - thrown if parameters fail the validation

updateRegexEntityRole

public ModelsUpdateRegexEntityRoleDefinitionStages.WithAppId updateRegexEntityRole()

Update a role for a given regular expression entity in a version of the application.

Returns:

the first stage of the updateRegexEntityRole call

updateRegexEntityRole

public OperationStatus updateRegexEntityRole(UUID appId, String versionId, UUID entityId, UUID roleId, UpdateRegexEntityRoleOptionalParameter updateRegexEntityRoleOptionalParameter)

Update a role for a given regular expression entity in a version of the application.

Parameters:

appId - The application ID.

versionId - The version ID.

entityId - The entity ID.

roleId - The entity role ID.

updateRegexEntityRoleOptionalParameter - the object representing the optional parameters to be set before calling this API

Returns:

the OperationStatus object if successful.

Throws:

IllegalArgumentException - thrown if parameters fail the validation

ErrorResponseException - thrown if the request is rejected by server

RuntimeException - all other wrapped checked exceptions if the request fails to be sent

updateRegexEntityRoleAsync

public Observable updateRegexEntityRoleAsync(UUID appId, String versionId, UUID entityId, UUID roleId, UpdateRegexEntityRoleOptionalParameter updateRegexEntityRoleOptionalParameter)

Update a role for a given regular expression entity in a version of the application.

Parameters:

appId - The application ID.

versionId - The version ID.

entityId - The entity ID.

roleId - The entity role ID.

updateRegexEntityRoleOptionalParameter - the object representing the optional parameters to be set before calling this API

Returns:

the observable to the OperationStatus object

Throws:

IllegalArgumentException - thrown if parameters fail the validation

updateSubList

public OperationStatus updateSubList(UUID appId, String versionId, UUID clEntityId, long subListId, WordListBaseUpdateObject wordListBaseUpdateObject)

Updates one of the list entity's sublists in a version of the application.

Parameters:

appId - The application ID.

versionId - The version ID.

clEntityId - The list entity extractor ID.

subListId - The sublist ID.

wordListBaseUpdateObject - A sublist update object containing the new canonical form and the list of words.

Returns:

the OperationStatus object if successful.

Throws:

IllegalArgumentException - thrown if parameters fail the validation

ErrorResponseException - thrown if the request is rejected by server

RuntimeException - all other wrapped checked exceptions if the request fails to be sent

updateSubListAsync

public Observable updateSubListAsync(UUID appId, String versionId, UUID clEntityId, long subListId, WordListBaseUpdateObject wordListBaseUpdateObject)

Updates one of the list entity's sublists in a version of the application.

Parameters:

appId - The application ID.

versionId - The version ID.

clEntityId - The list entity extractor ID.

subListId - The sublist ID.

wordListBaseUpdateObject - A sublist update object containing the new canonical form and the list of words.

Returns:

the observable to the OperationStatus object

Throws:

IllegalArgumentException - thrown if parameters fail the validation