Search in sources :

Example 16 with Value

use of com.ibm.watson.developer_cloud.assistant.v1.model.Value in project java-sdk by watson-developer-cloud.

the class Assistant method getValue.

/**
 * Get entity value.
 *
 * Get information about an entity value. This operation is limited to 6000 requests per 5 minutes. For more
 * information, see **Rate limiting**.
 *
 * @param getValueOptions the {@link GetValueOptions} containing the options for the call
 * @return a {@link ServiceCall} with a response type of {@link ValueExport}
 */
public ServiceCall<ValueExport> getValue(GetValueOptions getValueOptions) {
    Validator.notNull(getValueOptions, "getValueOptions cannot be null");
    String[] pathSegments = { "v1/workspaces", "entities", "values" };
    String[] pathParameters = { getValueOptions.workspaceId(), getValueOptions.entity(), getValueOptions.value() };
    RequestBuilder builder = RequestBuilder.get(RequestBuilder.constructHttpUrl(getEndPoint(), pathSegments, pathParameters));
    builder.query(VERSION, versionDate);
    if (getValueOptions.export() != null) {
        builder.query("export", String.valueOf(getValueOptions.export()));
    }
    if (getValueOptions.includeAudit() != null) {
        builder.query("include_audit", String.valueOf(getValueOptions.includeAudit()));
    }
    return createServiceCall(builder.build(), ResponseConverterUtils.getObject(ValueExport.class));
}
Also used : RequestBuilder(com.ibm.watson.developer_cloud.http.RequestBuilder) ValueExport(com.ibm.watson.developer_cloud.assistant.v1.model.ValueExport)

Example 17 with Value

use of com.ibm.watson.developer_cloud.assistant.v1.model.Value in project java-sdk by watson-developer-cloud.

the class Assistant method listSynonyms.

/**
 * List entity value synonyms.
 *
 * List the synonyms for an entity value. This operation is limited to 2500 requests per 30 minutes. For more
 * information, see **Rate limiting**.
 *
 * @param listSynonymsOptions the {@link ListSynonymsOptions} containing the options for the call
 * @return a {@link ServiceCall} with a response type of {@link SynonymCollection}
 */
public ServiceCall<SynonymCollection> listSynonyms(ListSynonymsOptions listSynonymsOptions) {
    Validator.notNull(listSynonymsOptions, "listSynonymsOptions cannot be null");
    String[] pathSegments = { "v1/workspaces", "entities", "values", "synonyms" };
    String[] pathParameters = { listSynonymsOptions.workspaceId(), listSynonymsOptions.entity(), listSynonymsOptions.value() };
    RequestBuilder builder = RequestBuilder.get(RequestBuilder.constructHttpUrl(getEndPoint(), pathSegments, pathParameters));
    builder.query(VERSION, versionDate);
    if (listSynonymsOptions.pageLimit() != null) {
        builder.query("page_limit", String.valueOf(listSynonymsOptions.pageLimit()));
    }
    if (listSynonymsOptions.includeCount() != null) {
        builder.query("include_count", String.valueOf(listSynonymsOptions.includeCount()));
    }
    if (listSynonymsOptions.sort() != null) {
        builder.query("sort", listSynonymsOptions.sort());
    }
    if (listSynonymsOptions.cursor() != null) {
        builder.query("cursor", listSynonymsOptions.cursor());
    }
    if (listSynonymsOptions.includeAudit() != null) {
        builder.query("include_audit", String.valueOf(listSynonymsOptions.includeAudit()));
    }
    return createServiceCall(builder.build(), ResponseConverterUtils.getObject(SynonymCollection.class));
}
Also used : RequestBuilder(com.ibm.watson.developer_cloud.http.RequestBuilder) SynonymCollection(com.ibm.watson.developer_cloud.assistant.v1.model.SynonymCollection)

Example 18 with Value

use of com.ibm.watson.developer_cloud.assistant.v1.model.Value in project java-sdk by watson-developer-cloud.

the class Assistant method updateValue.

/**
 * Update entity value.
 *
 * Update an existing entity value with new or modified data. You must provide component objects defining the content
 * of the updated entity value. This operation is limited to 1000 requests per 30 minutes. For more information, see
 * **Rate limiting**.
 *
 * @param updateValueOptions the {@link UpdateValueOptions} containing the options for the call
 * @return a {@link ServiceCall} with a response type of {@link Value}
 */
public ServiceCall<Value> updateValue(UpdateValueOptions updateValueOptions) {
    Validator.notNull(updateValueOptions, "updateValueOptions cannot be null");
    String[] pathSegments = { "v1/workspaces", "entities", "values" };
    String[] pathParameters = { updateValueOptions.workspaceId(), updateValueOptions.entity(), updateValueOptions.value() };
    RequestBuilder builder = RequestBuilder.post(RequestBuilder.constructHttpUrl(getEndPoint(), pathSegments, pathParameters));
    builder.query(VERSION, versionDate);
    final JsonObject contentJson = new JsonObject();
    if (updateValueOptions.newSynonyms() != null) {
        contentJson.add("synonyms", GsonSingleton.getGson().toJsonTree(updateValueOptions.newSynonyms()));
    }
    if (updateValueOptions.valueType() != null) {
        contentJson.addProperty("type", updateValueOptions.valueType());
    }
    if (updateValueOptions.newMetadata() != null) {
        contentJson.add("metadata", GsonSingleton.getGson().toJsonTree(updateValueOptions.newMetadata()));
    }
    if (updateValueOptions.newPatterns() != null) {
        contentJson.add("patterns", GsonSingleton.getGson().toJsonTree(updateValueOptions.newPatterns()));
    }
    if (updateValueOptions.newValue() != null) {
        contentJson.addProperty("value", updateValueOptions.newValue());
    }
    builder.bodyJson(contentJson);
    return createServiceCall(builder.build(), ResponseConverterUtils.getObject(Value.class));
}
Also used : RequestBuilder(com.ibm.watson.developer_cloud.http.RequestBuilder) Value(com.ibm.watson.developer_cloud.assistant.v1.model.Value) JsonObject(com.google.gson.JsonObject)

Example 19 with Value

use of com.ibm.watson.developer_cloud.assistant.v1.model.Value in project java-sdk by watson-developer-cloud.

the class Assistant method getSynonym.

/**
 * Get entity value synonym.
 *
 * Get information about a synonym of an entity value. This operation is limited to 6000 requests per 5 minutes. For
 * more information, see **Rate limiting**.
 *
 * @param getSynonymOptions the {@link GetSynonymOptions} containing the options for the call
 * @return a {@link ServiceCall} with a response type of {@link Synonym}
 */
public ServiceCall<Synonym> getSynonym(GetSynonymOptions getSynonymOptions) {
    Validator.notNull(getSynonymOptions, "getSynonymOptions cannot be null");
    String[] pathSegments = { "v1/workspaces", "entities", "values", "synonyms" };
    String[] pathParameters = { getSynonymOptions.workspaceId(), getSynonymOptions.entity(), getSynonymOptions.value(), getSynonymOptions.synonym() };
    RequestBuilder builder = RequestBuilder.get(RequestBuilder.constructHttpUrl(getEndPoint(), pathSegments, pathParameters));
    builder.query(VERSION, versionDate);
    if (getSynonymOptions.includeAudit() != null) {
        builder.query("include_audit", String.valueOf(getSynonymOptions.includeAudit()));
    }
    return createServiceCall(builder.build(), ResponseConverterUtils.getObject(Synonym.class));
}
Also used : RequestBuilder(com.ibm.watson.developer_cloud.http.RequestBuilder) Synonym(com.ibm.watson.developer_cloud.assistant.v1.model.Synonym)

Example 20 with Value

use of com.ibm.watson.developer_cloud.assistant.v1.model.Value in project java-sdk by watson-developer-cloud.

the class AssistantServiceIT method testCreateWorkspace.

/**
 * Test createWorkspace.
 */
@Test
public void testCreateWorkspace() {
    // gotta be unique
    String workspaceName = "API Test " + UUID.randomUUID().toString();
    String workspaceDescription = "Description of " + workspaceName;
    String workspaceLanguage = "en";
    // metadata
    Map<String, Object> workspaceMetadata = new HashMap<String, Object>();
    String metadataValue = "value for " + workspaceName;
    workspaceMetadata.put("key", metadataValue);
    // intents
    List<CreateIntent> workspaceIntents = new ArrayList<CreateIntent>();
    // gotta be unique
    String intentName = "Hello" + UUID.randomUUID().toString();
    String intentDescription = "Description of " + intentName;
    String intentExample = "Example of " + intentName;
    List<CreateExample> intentExamples = new ArrayList<CreateExample>();
    intentExamples.add(new CreateExample.Builder().text(intentExample).build());
    workspaceIntents.add(new CreateIntent.Builder().intent(intentName).description(intentDescription).examples(intentExamples).build());
    // entities
    List<CreateEntity> workspaceEntities = new ArrayList<CreateEntity>();
    // gotta be unique
    String entityName = "Hello" + UUID.randomUUID().toString();
    String entityDescription = "Description of " + entityName;
    String entitySource = "Source for " + entityName;
    String entityValue = "Value of " + entityName;
    String entityValueSynonym = "Synonym for Value of " + entityName;
    List<CreateValue> entityValues = new ArrayList<CreateValue>();
    entityValues.add(new CreateValue.Builder().value(entityValue).addSynonym(entityValueSynonym).build());
    workspaceEntities.add(new CreateEntity.Builder().entity(entityName).description(entityDescription).values(entityValues).build());
    // counterexamples
    List<CreateCounterexample> workspaceCounterExamples = new ArrayList<CreateCounterexample>();
    String counterExampleText = "Counterexample for " + workspaceName;
    workspaceCounterExamples.add(new CreateCounterexample.Builder().text(counterExampleText).build());
    CreateWorkspaceOptions createOptions = new CreateWorkspaceOptions.Builder().name(workspaceName).description(workspaceDescription).language(workspaceLanguage).metadata(workspaceMetadata).intents(workspaceIntents).entities(workspaceEntities).counterexamples(workspaceCounterExamples).build();
    String workspaceId = null;
    try {
        Workspace response = service.createWorkspace(createOptions).execute();
        assertNotNull(response);
        assertNotNull(response.getWorkspaceId());
        workspaceId = response.getWorkspaceId();
        assertNotNull(response.getName());
        assertEquals(response.getName(), workspaceName);
        assertNotNull(response.getDescription());
        assertEquals(response.getDescription(), workspaceDescription);
        assertNotNull(response.getLanguage());
        assertEquals(response.getLanguage(), workspaceLanguage);
        // metadata
        assertNotNull(response.getMetadata());
        assertNotNull(response.getMetadata().get("key"));
        assertEquals(response.getMetadata().get("key"), metadataValue);
        GetWorkspaceOptions getOptions = new GetWorkspaceOptions.Builder(workspaceId).export(true).build();
        WorkspaceExport exResponse = service.getWorkspace(getOptions).execute();
        assertNotNull(exResponse);
        // intents
        assertNotNull(exResponse.getIntents());
        assertTrue(exResponse.getIntents().size() == 1);
        assertNotNull(exResponse.getIntents().get(0).getIntentName());
        assertEquals(exResponse.getIntents().get(0).getIntentName(), intentName);
        assertNotNull(exResponse.getIntents().get(0).getDescription());
        assertEquals(exResponse.getIntents().get(0).getDescription(), intentDescription);
        assertNotNull(exResponse.getIntents().get(0).getExamples());
        assertTrue(exResponse.getIntents().get(0).getExamples().size() == 1);
        assertNotNull(exResponse.getIntents().get(0).getExamples().get(0));
        assertNotNull(exResponse.getIntents().get(0).getExamples().get(0).getExampleText());
        assertEquals(exResponse.getIntents().get(0).getExamples().get(0).getExampleText(), intentExample);
        // entities
        assertNotNull(exResponse.getEntities());
        assertTrue(exResponse.getEntities().size() == 1);
        assertNotNull(exResponse.getEntities().get(0).getEntityName());
        assertEquals(exResponse.getEntities().get(0).getEntityName(), entityName);
        assertNotNull(exResponse.getEntities().get(0).getDescription());
        assertEquals(exResponse.getEntities().get(0).getDescription(), entityDescription);
        assertNotNull(exResponse.getEntities().get(0).getValues());
        assertTrue(exResponse.getEntities().get(0).getValues().size() == 1);
        assertNotNull(exResponse.getEntities().get(0).getValues().get(0).getValueText());
        assertEquals(exResponse.getEntities().get(0).getValues().get(0).getValueText(), entityValue);
        assertNotNull(exResponse.getEntities().get(0).getValues().get(0).getSynonyms());
        assertTrue(exResponse.getEntities().get(0).getValues().get(0).getSynonyms().size() == 1);
        assertEquals(exResponse.getEntities().get(0).getValues().get(0).getSynonyms().get(0), entityValueSynonym);
        // counterexamples
        assertNotNull(exResponse.getCounterexamples());
        assertTrue(exResponse.getCounterexamples().size() == 1);
        assertNotNull(exResponse.getCounterexamples().get(0).getText());
        assertEquals(exResponse.getCounterexamples().get(0).getText(), counterExampleText);
    } catch (Exception ex) {
        fail(ex.getMessage());
    } finally {
        // Clean up
        if (workspaceId != null) {
            DeleteWorkspaceOptions deleteOptions = new DeleteWorkspaceOptions.Builder(workspaceId).build();
            service.deleteWorkspace(deleteOptions).execute();
        }
    }
}
Also used : CreateEntity(com.ibm.watson.developer_cloud.assistant.v1.model.CreateEntity) DeleteWorkspaceOptions(com.ibm.watson.developer_cloud.assistant.v1.model.DeleteWorkspaceOptions) CreateValue(com.ibm.watson.developer_cloud.assistant.v1.model.CreateValue) HashMap(java.util.HashMap) CreateExample(com.ibm.watson.developer_cloud.assistant.v1.model.CreateExample) ArrayList(java.util.ArrayList) WorkspaceExport(com.ibm.watson.developer_cloud.assistant.v1.model.WorkspaceExport) CreateWorkspaceOptions(com.ibm.watson.developer_cloud.assistant.v1.model.CreateWorkspaceOptions) GetWorkspaceOptions(com.ibm.watson.developer_cloud.assistant.v1.model.GetWorkspaceOptions) CreateIntent(com.ibm.watson.developer_cloud.assistant.v1.model.CreateIntent) UnauthorizedException(com.ibm.watson.developer_cloud.service.exception.UnauthorizedException) NotFoundException(com.ibm.watson.developer_cloud.service.exception.NotFoundException) CreateCounterexample(com.ibm.watson.developer_cloud.assistant.v1.model.CreateCounterexample) Workspace(com.ibm.watson.developer_cloud.assistant.v1.model.Workspace) Test(org.junit.Test)

Aggregations

Test (org.junit.Test)24 NotFoundException (com.ibm.watson.developer_cloud.service.exception.NotFoundException)17 CreateEntityOptions (com.ibm.watson.developer_cloud.assistant.v1.model.CreateEntityOptions)14 CreateValueOptions (com.ibm.watson.developer_cloud.assistant.v1.model.CreateValueOptions)10 JsonObject (com.google.gson.JsonObject)9 RequestBuilder (com.ibm.watson.developer_cloud.http.RequestBuilder)9 HashMap (java.util.HashMap)9 WatsonServiceUnitTest (com.ibm.watson.developer_cloud.WatsonServiceUnitTest)7 Synonym (com.ibm.watson.developer_cloud.assistant.v1.model.Synonym)7 CreateValue (com.ibm.watson.developer_cloud.assistant.v1.model.CreateValue)6 DeleteValueOptions (com.ibm.watson.developer_cloud.assistant.v1.model.DeleteValueOptions)5 Value (com.ibm.watson.developer_cloud.assistant.v1.model.Value)5 Value (com.ibm.watson.developer_cloud.conversation.v1.model.Value)5 CreateSynonymOptions (com.ibm.watson.developer_cloud.assistant.v1.model.CreateSynonymOptions)4 DeleteEntityOptions (com.ibm.watson.developer_cloud.assistant.v1.model.DeleteEntityOptions)4 DeleteSynonymOptions (com.ibm.watson.developer_cloud.assistant.v1.model.DeleteSynonymOptions)4 ValueExport (com.ibm.watson.developer_cloud.assistant.v1.model.ValueExport)4 CreateCounterexample (com.ibm.watson.developer_cloud.assistant.v1.model.CreateCounterexample)3 CreateEntity (com.ibm.watson.developer_cloud.assistant.v1.model.CreateEntity)3 CreateIntent (com.ibm.watson.developer_cloud.assistant.v1.model.CreateIntent)3