diff --git a/discovery/src/main/java/com/ibm/watson/discovery/v2/Discovery.java b/discovery/src/main/java/com/ibm/watson/discovery/v2/Discovery.java index 4c57da1171..e341cfe8e2 100644 --- a/discovery/src/main/java/com/ibm/watson/discovery/v2/Discovery.java +++ b/discovery/src/main/java/com/ibm/watson/discovery/v2/Discovery.java @@ -461,6 +461,9 @@ public ServiceCall createCollection( if (createCollectionOptions.language() != null) { contentJson.addProperty("language", createCollectionOptions.language()); } + if (createCollectionOptions.ocrEnabled() != null) { + contentJson.addProperty("ocr_enabled", createCollectionOptions.ocrEnabled()); + } if (createCollectionOptions.enrichments() != null) { contentJson.add( "enrichments", @@ -555,6 +558,9 @@ public ServiceCall updateCollection( if (updateCollectionOptions.description() != null) { contentJson.addProperty("description", updateCollectionOptions.description()); } + if (updateCollectionOptions.ocrEnabled() != null) { + contentJson.addProperty("ocr_enabled", updateCollectionOptions.ocrEnabled()); + } if (updateCollectionOptions.enrichments() != null) { contentJson.add( "enrichments", diff --git a/discovery/src/main/java/com/ibm/watson/discovery/v2/model/AddDocumentOptions.java b/discovery/src/main/java/com/ibm/watson/discovery/v2/model/AddDocumentOptions.java index 54e3033155..dc9d9ddf12 100644 --- a/discovery/src/main/java/com/ibm/watson/discovery/v2/model/AddDocumentOptions.java +++ b/discovery/src/main/java/com/ibm/watson/discovery/v2/model/AddDocumentOptions.java @@ -198,8 +198,8 @@ public Builder newBuilder() { /** * Gets the projectId. * - *

The ID of the project. This information can be found from the *Integrate and Deploy* page in - * Discovery. + *

The Universally Unique Identifier (UUID) of the project. This information can be found from + * the *Integrate and Deploy* page in Discovery. * * @return the projectId */ @@ -210,7 +210,7 @@ public String projectId() { /** * Gets the collectionId. * - *

The ID of the collection. + *

The Universally Unique Identifier (UUID) of the collection. * * @return the collectionId */ diff --git a/discovery/src/main/java/com/ibm/watson/discovery/v2/model/AnalyzeDocumentOptions.java b/discovery/src/main/java/com/ibm/watson/discovery/v2/model/AnalyzeDocumentOptions.java index 2bc85ff450..1b7c1034b1 100644 --- a/discovery/src/main/java/com/ibm/watson/discovery/v2/model/AnalyzeDocumentOptions.java +++ b/discovery/src/main/java/com/ibm/watson/discovery/v2/model/AnalyzeDocumentOptions.java @@ -183,8 +183,8 @@ public Builder newBuilder() { /** * Gets the projectId. * - *

The ID of the project. This information can be found from the *Integrate and Deploy* page in - * Discovery. + *

The Universally Unique Identifier (UUID) of the project. This information can be found from + * the *Integrate and Deploy* page in Discovery. * * @return the projectId */ @@ -195,7 +195,7 @@ public String projectId() { /** * Gets the collectionId. * - *

The ID of the collection. + *

The Universally Unique Identifier (UUID) of the collection. * * @return the collectionId */ diff --git a/discovery/src/main/java/com/ibm/watson/discovery/v2/model/Collection.java b/discovery/src/main/java/com/ibm/watson/discovery/v2/model/Collection.java index 14e8baeec3..f882dcff71 100644 --- a/discovery/src/main/java/com/ibm/watson/discovery/v2/model/Collection.java +++ b/discovery/src/main/java/com/ibm/watson/discovery/v2/model/Collection.java @@ -1,5 +1,5 @@ /* - * (C) Copyright IBM Corp. 2019, 2023. + * (C) Copyright IBM Corp. 2019, 2024. * * Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with * the License. You may obtain a copy of the License at @@ -28,7 +28,7 @@ protected Collection() {} /** * Gets the collectionId. * - *

The unique identifier of the collection. + *

The Universally Unique Identifier (UUID) of the collection. * * @return the collectionId */ diff --git a/discovery/src/main/java/com/ibm/watson/discovery/v2/model/CollectionDetails.java b/discovery/src/main/java/com/ibm/watson/discovery/v2/model/CollectionDetails.java index 32369a1b83..ecb4e67c7c 100644 --- a/discovery/src/main/java/com/ibm/watson/discovery/v2/model/CollectionDetails.java +++ b/discovery/src/main/java/com/ibm/watson/discovery/v2/model/CollectionDetails.java @@ -28,6 +28,10 @@ public class CollectionDetails extends GenericModel { protected String description; protected Date created; protected String language; + + @SerializedName("ocr_enabled") + protected Boolean ocrEnabled; + protected List enrichments; @SerializedName("smart_document_understanding") @@ -38,6 +42,7 @@ public static class Builder { private String name; private String description; private String language; + private Boolean ocrEnabled; private List enrichments; /** @@ -49,6 +54,7 @@ private Builder(CollectionDetails collectionDetails) { this.name = collectionDetails.name; this.description = collectionDetails.description; this.language = collectionDetails.language; + this.ocrEnabled = collectionDetails.ocrEnabled; this.enrichments = collectionDetails.enrichments; } @@ -121,6 +127,17 @@ public Builder language(String language) { return this; } + /** + * Set the ocrEnabled. + * + * @param ocrEnabled the ocrEnabled + * @return the CollectionDetails builder + */ + public Builder ocrEnabled(Boolean ocrEnabled) { + this.ocrEnabled = ocrEnabled; + return this; + } + /** * Set the enrichments. Existing enrichments will be replaced. * @@ -140,6 +157,7 @@ protected CollectionDetails(Builder builder) { name = builder.name; description = builder.description; language = builder.language; + ocrEnabled = builder.ocrEnabled; enrichments = builder.enrichments; } @@ -155,7 +173,7 @@ public Builder newBuilder() { /** * Gets the collectionId. * - *

The unique identifier of the collection. + *

The Universally Unique Identifier (UUID) of the collection. * * @return the collectionId */ @@ -208,6 +226,18 @@ public String language() { return language; } + /** + * Gets the ocrEnabled. + * + *

If set to `true`, optical character recognition (OCR) is enabled. For more information, see + * [Optical character recognition](/docs/discovery-data?topic=discovery-data-collections#ocr). + * + * @return the ocrEnabled + */ + public Boolean ocrEnabled() { + return ocrEnabled; + } + /** * Gets the enrichments. * diff --git a/discovery/src/main/java/com/ibm/watson/discovery/v2/model/CreateCollectionOptions.java b/discovery/src/main/java/com/ibm/watson/discovery/v2/model/CreateCollectionOptions.java index 75dab15c55..2639f8ce8d 100644 --- a/discovery/src/main/java/com/ibm/watson/discovery/v2/model/CreateCollectionOptions.java +++ b/discovery/src/main/java/com/ibm/watson/discovery/v2/model/CreateCollectionOptions.java @@ -23,6 +23,7 @@ public class CreateCollectionOptions extends GenericModel { protected String name; protected String description; protected String language; + protected Boolean ocrEnabled; protected List enrichments; /** Builder. */ @@ -31,6 +32,7 @@ public static class Builder { private String name; private String description; private String language; + private Boolean ocrEnabled; private List enrichments; /** @@ -43,6 +45,7 @@ private Builder(CreateCollectionOptions createCollectionOptions) { this.name = createCollectionOptions.name; this.description = createCollectionOptions.description; this.language = createCollectionOptions.language; + this.ocrEnabled = createCollectionOptions.ocrEnabled; this.enrichments = createCollectionOptions.enrichments; } @@ -128,6 +131,17 @@ public Builder language(String language) { return this; } + /** + * Set the ocrEnabled. + * + * @param ocrEnabled the ocrEnabled + * @return the CreateCollectionOptions builder + */ + public Builder ocrEnabled(Boolean ocrEnabled) { + this.ocrEnabled = ocrEnabled; + return this; + } + /** * Set the enrichments. Existing enrichments will be replaced. * @@ -149,6 +163,7 @@ public Builder collectionDetails(CollectionDetails collectionDetails) { this.name = collectionDetails.name(); this.description = collectionDetails.description(); this.language = collectionDetails.language(); + this.ocrEnabled = collectionDetails.ocrEnabled(); this.enrichments = collectionDetails.enrichments(); return this; } @@ -163,6 +178,7 @@ protected CreateCollectionOptions(Builder builder) { name = builder.name; description = builder.description; language = builder.language; + ocrEnabled = builder.ocrEnabled; enrichments = builder.enrichments; } @@ -178,8 +194,8 @@ public Builder newBuilder() { /** * Gets the projectId. * - *

The ID of the project. This information can be found from the *Integrate and Deploy* page in - * Discovery. + *

The Universally Unique Identifier (UUID) of the project. This information can be found from + * the *Integrate and Deploy* page in Discovery. * * @return the projectId */ @@ -221,6 +237,18 @@ public String language() { return language; } + /** + * Gets the ocrEnabled. + * + *

If set to `true`, optical character recognition (OCR) is enabled. For more information, see + * [Optical character recognition](/docs/discovery-data?topic=discovery-data-collections#ocr). + * + * @return the ocrEnabled + */ + public Boolean ocrEnabled() { + return ocrEnabled; + } + /** * Gets the enrichments. * diff --git a/discovery/src/main/java/com/ibm/watson/discovery/v2/model/CreateDocumentClassifierModelOptions.java b/discovery/src/main/java/com/ibm/watson/discovery/v2/model/CreateDocumentClassifierModelOptions.java index 6b52e96e83..b587cb5378 100644 --- a/discovery/src/main/java/com/ibm/watson/discovery/v2/model/CreateDocumentClassifierModelOptions.java +++ b/discovery/src/main/java/com/ibm/watson/discovery/v2/model/CreateDocumentClassifierModelOptions.java @@ -247,8 +247,8 @@ public Builder newBuilder() { /** * Gets the projectId. * - *

The ID of the project. This information can be found from the *Integrate and Deploy* page in - * Discovery. + *

The Universally Unique Identifier (UUID) of the project. This information can be found from + * the *Integrate and Deploy* page in Discovery. * * @return the projectId */ @@ -259,7 +259,7 @@ public String projectId() { /** * Gets the classifierId. * - *

The ID of the classifier. + *

The Universally Unique Identifier (UUID) of the classifier. * * @return the classifierId */ diff --git a/discovery/src/main/java/com/ibm/watson/discovery/v2/model/CreateDocumentClassifierOptions.java b/discovery/src/main/java/com/ibm/watson/discovery/v2/model/CreateDocumentClassifierOptions.java index bfb752f14d..772c69d76e 100644 --- a/discovery/src/main/java/com/ibm/watson/discovery/v2/model/CreateDocumentClassifierOptions.java +++ b/discovery/src/main/java/com/ibm/watson/discovery/v2/model/CreateDocumentClassifierOptions.java @@ -1,5 +1,5 @@ /* - * (C) Copyright IBM Corp. 2022, 2023. + * (C) Copyright IBM Corp. 2022, 2024. * * Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with * the License. You may obtain a copy of the License at @@ -165,8 +165,8 @@ public Builder newBuilder() { /** * Gets the projectId. * - *

The ID of the project. This information can be found from the *Integrate and Deploy* page in - * Discovery. + *

The Universally Unique Identifier (UUID) of the project. This information can be found from + * the *Integrate and Deploy* page in Discovery. * * @return the projectId */ diff --git a/discovery/src/main/java/com/ibm/watson/discovery/v2/model/CreateEnrichmentOptions.java b/discovery/src/main/java/com/ibm/watson/discovery/v2/model/CreateEnrichmentOptions.java index afef4fb769..c22a9d2df3 100644 --- a/discovery/src/main/java/com/ibm/watson/discovery/v2/model/CreateEnrichmentOptions.java +++ b/discovery/src/main/java/com/ibm/watson/discovery/v2/model/CreateEnrichmentOptions.java @@ -133,8 +133,8 @@ public Builder newBuilder() { /** * Gets the projectId. * - *

The ID of the project. This information can be found from the *Integrate and Deploy* page in - * Discovery. + *

The Universally Unique Identifier (UUID) of the project. This information can be found from + * the *Integrate and Deploy* page in Discovery. * * @return the projectId */ diff --git a/discovery/src/main/java/com/ibm/watson/discovery/v2/model/CreateExpansionsOptions.java b/discovery/src/main/java/com/ibm/watson/discovery/v2/model/CreateExpansionsOptions.java index f11a60cd34..2bcf88bd0d 100644 --- a/discovery/src/main/java/com/ibm/watson/discovery/v2/model/CreateExpansionsOptions.java +++ b/discovery/src/main/java/com/ibm/watson/discovery/v2/model/CreateExpansionsOptions.java @@ -149,8 +149,8 @@ public Builder newBuilder() { /** * Gets the projectId. * - *

The ID of the project. This information can be found from the *Integrate and Deploy* page in - * Discovery. + *

The Universally Unique Identifier (UUID) of the project. This information can be found from + * the *Integrate and Deploy* page in Discovery. * * @return the projectId */ @@ -161,7 +161,7 @@ public String projectId() { /** * Gets the collectionId. * - *

The ID of the collection. + *

The Universally Unique Identifier (UUID) of the collection. * * @return the collectionId */ diff --git a/discovery/src/main/java/com/ibm/watson/discovery/v2/model/CreateProjectOptions.java b/discovery/src/main/java/com/ibm/watson/discovery/v2/model/CreateProjectOptions.java index 3745946086..e3d18f6e3d 100644 --- a/discovery/src/main/java/com/ibm/watson/discovery/v2/model/CreateProjectOptions.java +++ b/discovery/src/main/java/com/ibm/watson/discovery/v2/model/CreateProjectOptions.java @@ -1,5 +1,5 @@ /* - * (C) Copyright IBM Corp. 2020, 2023. + * (C) Copyright IBM Corp. 2020, 2024. * * Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with * the License. You may obtain a copy of the License at @@ -25,8 +25,13 @@ public class CreateProjectOptions extends GenericModel { * *

The `content_mining` and `content_intelligence` types are available with Premium plan * managed deployments and installed deployments only. + * + *

The Intelligent Document Processing (IDP) project type is available from IBM Cloud-managed + * instances only. */ public interface Type { + /** intelligent_document_processing. */ + String INTELLIGENT_DOCUMENT_PROCESSING = "intelligent_document_processing"; /** document_retrieval. */ String DOCUMENT_RETRIEVAL = "document_retrieval"; /** conversational_search. */ @@ -158,6 +163,9 @@ public String name() { *

The `content_mining` and `content_intelligence` types are available with Premium plan * managed deployments and installed deployments only. * + *

The Intelligent Document Processing (IDP) project type is available from IBM Cloud-managed + * instances only. + * * @return the type */ public String type() { diff --git a/discovery/src/main/java/com/ibm/watson/discovery/v2/model/CreateStopwordListOptions.java b/discovery/src/main/java/com/ibm/watson/discovery/v2/model/CreateStopwordListOptions.java index 1e4302bc3d..08c3fa467c 100644 --- a/discovery/src/main/java/com/ibm/watson/discovery/v2/model/CreateStopwordListOptions.java +++ b/discovery/src/main/java/com/ibm/watson/discovery/v2/model/CreateStopwordListOptions.java @@ -146,8 +146,8 @@ public Builder newBuilder() { /** * Gets the projectId. * - *

The ID of the project. This information can be found from the *Integrate and Deploy* page in - * Discovery. + *

The Universally Unique Identifier (UUID) of the project. This information can be found from + * the *Integrate and Deploy* page in Discovery. * * @return the projectId */ @@ -158,7 +158,7 @@ public String projectId() { /** * Gets the collectionId. * - *

The ID of the collection. + *

The Universally Unique Identifier (UUID) of the collection. * * @return the collectionId */ diff --git a/discovery/src/main/java/com/ibm/watson/discovery/v2/model/CreateTrainingQueryOptions.java b/discovery/src/main/java/com/ibm/watson/discovery/v2/model/CreateTrainingQueryOptions.java index a4f287bb35..1d090d9247 100644 --- a/discovery/src/main/java/com/ibm/watson/discovery/v2/model/CreateTrainingQueryOptions.java +++ b/discovery/src/main/java/com/ibm/watson/discovery/v2/model/CreateTrainingQueryOptions.java @@ -166,8 +166,8 @@ public Builder newBuilder() { /** * Gets the projectId. * - *

The ID of the project. This information can be found from the *Integrate and Deploy* page in - * Discovery. + *

The Universally Unique Identifier (UUID) of the project. This information can be found from + * the *Integrate and Deploy* page in Discovery. * * @return the projectId */ diff --git a/discovery/src/main/java/com/ibm/watson/discovery/v2/model/DeleteCollectionOptions.java b/discovery/src/main/java/com/ibm/watson/discovery/v2/model/DeleteCollectionOptions.java index a107533818..4314ad8a7a 100644 --- a/discovery/src/main/java/com/ibm/watson/discovery/v2/model/DeleteCollectionOptions.java +++ b/discovery/src/main/java/com/ibm/watson/discovery/v2/model/DeleteCollectionOptions.java @@ -1,5 +1,5 @@ /* - * (C) Copyright IBM Corp. 2020, 2023. + * (C) Copyright IBM Corp. 2020, 2024. * * Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with * the License. You may obtain a copy of the License at @@ -103,8 +103,8 @@ public Builder newBuilder() { /** * Gets the projectId. * - *

The ID of the project. This information can be found from the *Integrate and Deploy* page in - * Discovery. + *

The Universally Unique Identifier (UUID) of the project. This information can be found from + * the *Integrate and Deploy* page in Discovery. * * @return the projectId */ @@ -115,7 +115,7 @@ public String projectId() { /** * Gets the collectionId. * - *

The ID of the collection. + *

The Universally Unique Identifier (UUID) of the collection. * * @return the collectionId */ diff --git a/discovery/src/main/java/com/ibm/watson/discovery/v2/model/DeleteDocumentClassifierModelOptions.java b/discovery/src/main/java/com/ibm/watson/discovery/v2/model/DeleteDocumentClassifierModelOptions.java index ff405f1244..94248906d0 100644 --- a/discovery/src/main/java/com/ibm/watson/discovery/v2/model/DeleteDocumentClassifierModelOptions.java +++ b/discovery/src/main/java/com/ibm/watson/discovery/v2/model/DeleteDocumentClassifierModelOptions.java @@ -1,5 +1,5 @@ /* - * (C) Copyright IBM Corp. 2022, 2023. + * (C) Copyright IBM Corp. 2022, 2024. * * Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with * the License. You may obtain a copy of the License at @@ -121,8 +121,8 @@ public Builder newBuilder() { /** * Gets the projectId. * - *

The ID of the project. This information can be found from the *Integrate and Deploy* page in - * Discovery. + *

The Universally Unique Identifier (UUID) of the project. This information can be found from + * the *Integrate and Deploy* page in Discovery. * * @return the projectId */ @@ -133,7 +133,7 @@ public String projectId() { /** * Gets the classifierId. * - *

The ID of the classifier. + *

The Universally Unique Identifier (UUID) of the classifier. * * @return the classifierId */ @@ -144,7 +144,7 @@ public String classifierId() { /** * Gets the modelId. * - *

The ID of the classifier model. + *

The Universally Unique Identifier (UUID) of the classifier model. * * @return the modelId */ diff --git a/discovery/src/main/java/com/ibm/watson/discovery/v2/model/DeleteDocumentClassifierOptions.java b/discovery/src/main/java/com/ibm/watson/discovery/v2/model/DeleteDocumentClassifierOptions.java index 2654a62467..5054ec8185 100644 --- a/discovery/src/main/java/com/ibm/watson/discovery/v2/model/DeleteDocumentClassifierOptions.java +++ b/discovery/src/main/java/com/ibm/watson/discovery/v2/model/DeleteDocumentClassifierOptions.java @@ -1,5 +1,5 @@ /* - * (C) Copyright IBM Corp. 2022, 2023. + * (C) Copyright IBM Corp. 2022, 2024. * * Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with * the License. You may obtain a copy of the License at @@ -103,8 +103,8 @@ public Builder newBuilder() { /** * Gets the projectId. * - *

The ID of the project. This information can be found from the *Integrate and Deploy* page in - * Discovery. + *

The Universally Unique Identifier (UUID) of the project. This information can be found from + * the *Integrate and Deploy* page in Discovery. * * @return the projectId */ @@ -115,7 +115,7 @@ public String projectId() { /** * Gets the classifierId. * - *

The ID of the classifier. + *

The Universally Unique Identifier (UUID) of the classifier. * * @return the classifierId */ diff --git a/discovery/src/main/java/com/ibm/watson/discovery/v2/model/DeleteDocumentOptions.java b/discovery/src/main/java/com/ibm/watson/discovery/v2/model/DeleteDocumentOptions.java index 044f348e88..c09bcda6b6 100644 --- a/discovery/src/main/java/com/ibm/watson/discovery/v2/model/DeleteDocumentOptions.java +++ b/discovery/src/main/java/com/ibm/watson/discovery/v2/model/DeleteDocumentOptions.java @@ -1,5 +1,5 @@ /* - * (C) Copyright IBM Corp. 2019, 2023. + * (C) Copyright IBM Corp. 2019, 2024. * * Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with * the License. You may obtain a copy of the License at @@ -137,8 +137,8 @@ public Builder newBuilder() { /** * Gets the projectId. * - *

The ID of the project. This information can be found from the *Integrate and Deploy* page in - * Discovery. + *

The Universally Unique Identifier (UUID) of the project. This information can be found from + * the *Integrate and Deploy* page in Discovery. * * @return the projectId */ @@ -149,7 +149,7 @@ public String projectId() { /** * Gets the collectionId. * - *

The ID of the collection. + *

The Universally Unique Identifier (UUID) of the collection. * * @return the collectionId */ diff --git a/discovery/src/main/java/com/ibm/watson/discovery/v2/model/DeleteEnrichmentOptions.java b/discovery/src/main/java/com/ibm/watson/discovery/v2/model/DeleteEnrichmentOptions.java index 268815141b..e444d62241 100644 --- a/discovery/src/main/java/com/ibm/watson/discovery/v2/model/DeleteEnrichmentOptions.java +++ b/discovery/src/main/java/com/ibm/watson/discovery/v2/model/DeleteEnrichmentOptions.java @@ -1,5 +1,5 @@ /* - * (C) Copyright IBM Corp. 2020, 2023. + * (C) Copyright IBM Corp. 2020, 2024. * * Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with * the License. You may obtain a copy of the License at @@ -103,8 +103,8 @@ public Builder newBuilder() { /** * Gets the projectId. * - *

The ID of the project. This information can be found from the *Integrate and Deploy* page in - * Discovery. + *

The Universally Unique Identifier (UUID) of the project. This information can be found from + * the *Integrate and Deploy* page in Discovery. * * @return the projectId */ @@ -115,7 +115,7 @@ public String projectId() { /** * Gets the enrichmentId. * - *

The ID of the enrichment. + *

The Universally Unique Identifier (UUID) of the enrichment. * * @return the enrichmentId */ diff --git a/discovery/src/main/java/com/ibm/watson/discovery/v2/model/DeleteExpansionsOptions.java b/discovery/src/main/java/com/ibm/watson/discovery/v2/model/DeleteExpansionsOptions.java index 9e29583f45..be0c9ff50e 100644 --- a/discovery/src/main/java/com/ibm/watson/discovery/v2/model/DeleteExpansionsOptions.java +++ b/discovery/src/main/java/com/ibm/watson/discovery/v2/model/DeleteExpansionsOptions.java @@ -1,5 +1,5 @@ /* - * (C) Copyright IBM Corp. 2022, 2023. + * (C) Copyright IBM Corp. 2022, 2024. * * Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with * the License. You may obtain a copy of the License at @@ -103,8 +103,8 @@ public Builder newBuilder() { /** * Gets the projectId. * - *

The ID of the project. This information can be found from the *Integrate and Deploy* page in - * Discovery. + *

The Universally Unique Identifier (UUID) of the project. This information can be found from + * the *Integrate and Deploy* page in Discovery. * * @return the projectId */ @@ -115,7 +115,7 @@ public String projectId() { /** * Gets the collectionId. * - *

The ID of the collection. + *

The Universally Unique Identifier (UUID) of the collection. * * @return the collectionId */ diff --git a/discovery/src/main/java/com/ibm/watson/discovery/v2/model/DeleteProjectOptions.java b/discovery/src/main/java/com/ibm/watson/discovery/v2/model/DeleteProjectOptions.java index e4742e4913..fb8559bb00 100644 --- a/discovery/src/main/java/com/ibm/watson/discovery/v2/model/DeleteProjectOptions.java +++ b/discovery/src/main/java/com/ibm/watson/discovery/v2/model/DeleteProjectOptions.java @@ -1,5 +1,5 @@ /* - * (C) Copyright IBM Corp. 2020, 2023. + * (C) Copyright IBM Corp. 2020, 2024. * * Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with * the License. You may obtain a copy of the License at @@ -84,8 +84,8 @@ public Builder newBuilder() { /** * Gets the projectId. * - *

The ID of the project. This information can be found from the *Integrate and Deploy* page in - * Discovery. + *

The Universally Unique Identifier (UUID) of the project. This information can be found from + * the *Integrate and Deploy* page in Discovery. * * @return the projectId */ diff --git a/discovery/src/main/java/com/ibm/watson/discovery/v2/model/DeleteStopwordListOptions.java b/discovery/src/main/java/com/ibm/watson/discovery/v2/model/DeleteStopwordListOptions.java index 8bc20aef0b..e23d5cf3b9 100644 --- a/discovery/src/main/java/com/ibm/watson/discovery/v2/model/DeleteStopwordListOptions.java +++ b/discovery/src/main/java/com/ibm/watson/discovery/v2/model/DeleteStopwordListOptions.java @@ -1,5 +1,5 @@ /* - * (C) Copyright IBM Corp. 2022, 2023. + * (C) Copyright IBM Corp. 2022, 2024. * * Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with * the License. You may obtain a copy of the License at @@ -103,8 +103,8 @@ public Builder newBuilder() { /** * Gets the projectId. * - *

The ID of the project. This information can be found from the *Integrate and Deploy* page in - * Discovery. + *

The Universally Unique Identifier (UUID) of the project. This information can be found from + * the *Integrate and Deploy* page in Discovery. * * @return the projectId */ @@ -115,7 +115,7 @@ public String projectId() { /** * Gets the collectionId. * - *

The ID of the collection. + *

The Universally Unique Identifier (UUID) of the collection. * * @return the collectionId */ diff --git a/discovery/src/main/java/com/ibm/watson/discovery/v2/model/DeleteTrainingQueriesOptions.java b/discovery/src/main/java/com/ibm/watson/discovery/v2/model/DeleteTrainingQueriesOptions.java index b433df6e77..72602016fb 100644 --- a/discovery/src/main/java/com/ibm/watson/discovery/v2/model/DeleteTrainingQueriesOptions.java +++ b/discovery/src/main/java/com/ibm/watson/discovery/v2/model/DeleteTrainingQueriesOptions.java @@ -1,5 +1,5 @@ /* - * (C) Copyright IBM Corp. 2019, 2023. + * (C) Copyright IBM Corp. 2019, 2024. * * Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with * the License. You may obtain a copy of the License at @@ -84,8 +84,8 @@ public Builder newBuilder() { /** * Gets the projectId. * - *

The ID of the project. This information can be found from the *Integrate and Deploy* page in - * Discovery. + *

The Universally Unique Identifier (UUID) of the project. This information can be found from + * the *Integrate and Deploy* page in Discovery. * * @return the projectId */ diff --git a/discovery/src/main/java/com/ibm/watson/discovery/v2/model/DeleteTrainingQueryOptions.java b/discovery/src/main/java/com/ibm/watson/discovery/v2/model/DeleteTrainingQueryOptions.java index 481e9178b2..6e8c45ec59 100644 --- a/discovery/src/main/java/com/ibm/watson/discovery/v2/model/DeleteTrainingQueryOptions.java +++ b/discovery/src/main/java/com/ibm/watson/discovery/v2/model/DeleteTrainingQueryOptions.java @@ -1,5 +1,5 @@ /* - * (C) Copyright IBM Corp. 2021, 2023. + * (C) Copyright IBM Corp. 2021, 2024. * * Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with * the License. You may obtain a copy of the License at @@ -102,8 +102,8 @@ public Builder newBuilder() { /** * Gets the projectId. * - *

The ID of the project. This information can be found from the *Integrate and Deploy* page in - * Discovery. + *

The Universally Unique Identifier (UUID) of the project. This information can be found from + * the *Integrate and Deploy* page in Discovery. * * @return the projectId */ diff --git a/discovery/src/main/java/com/ibm/watson/discovery/v2/model/DocumentClassifier.java b/discovery/src/main/java/com/ibm/watson/discovery/v2/model/DocumentClassifier.java index 416bf501a7..7b807f6996 100644 --- a/discovery/src/main/java/com/ibm/watson/discovery/v2/model/DocumentClassifier.java +++ b/discovery/src/main/java/com/ibm/watson/discovery/v2/model/DocumentClassifier.java @@ -1,5 +1,5 @@ /* - * (C) Copyright IBM Corp. 2022, 2023. + * (C) Copyright IBM Corp. 2022, 2024. * * Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with * the License. You may obtain a copy of the License at @@ -49,7 +49,7 @@ protected DocumentClassifier() {} /** * Gets the classifierId. * - *

A unique identifier of the document classifier. + *

The Universally Unique Identifier (UUID) of the document classifier. * * @return the classifierId */ diff --git a/discovery/src/main/java/com/ibm/watson/discovery/v2/model/DocumentClassifierEnrichment.java b/discovery/src/main/java/com/ibm/watson/discovery/v2/model/DocumentClassifierEnrichment.java index 2f6fab78d3..94a7cfd17f 100644 --- a/discovery/src/main/java/com/ibm/watson/discovery/v2/model/DocumentClassifierEnrichment.java +++ b/discovery/src/main/java/com/ibm/watson/discovery/v2/model/DocumentClassifierEnrichment.java @@ -126,7 +126,7 @@ public Builder newBuilder() { /** * Gets the enrichmentId. * - *

A unique identifier of the enrichment. + *

The Universally Unique Identifier (UUID) of the enrichment. * * @return the enrichmentId */ diff --git a/discovery/src/main/java/com/ibm/watson/discovery/v2/model/DocumentClassifierModel.java b/discovery/src/main/java/com/ibm/watson/discovery/v2/model/DocumentClassifierModel.java index ccbef44617..cc3ba0cd40 100644 --- a/discovery/src/main/java/com/ibm/watson/discovery/v2/model/DocumentClassifierModel.java +++ b/discovery/src/main/java/com/ibm/watson/discovery/v2/model/DocumentClassifierModel.java @@ -1,5 +1,5 @@ /* - * (C) Copyright IBM Corp. 2022, 2023. + * (C) Copyright IBM Corp. 2022, 2024. * * Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with * the License. You may obtain a copy of the License at @@ -57,7 +57,7 @@ protected DocumentClassifierModel() {} /** * Gets the modelId. * - *

A unique identifier of the document classifier model. + *

The Universally Unique Identifier (UUID) of the document classifier model. * * @return the modelId */ @@ -158,7 +158,8 @@ public ClassifierModelEvaluation getEvaluation() { /** * Gets the enrichmentId. * - *

A unique identifier of the enrichment that is generated by this document classifier model. + *

The Universally Unique Identifier (UUID) of the enrichment that is generated by this + * document classifier model. * * @return the enrichmentId */ diff --git a/discovery/src/main/java/com/ibm/watson/discovery/v2/model/Enrichment.java b/discovery/src/main/java/com/ibm/watson/discovery/v2/model/Enrichment.java index bb29b3da3c..74ecf80c38 100644 --- a/discovery/src/main/java/com/ibm/watson/discovery/v2/model/Enrichment.java +++ b/discovery/src/main/java/com/ibm/watson/discovery/v2/model/Enrichment.java @@ -57,7 +57,7 @@ protected Enrichment() {} /** * Gets the enrichmentId. * - *

The unique identifier of this enrichment. + *

The Universally Unique Identifier (UUID) of this enrichment. * * @return the enrichmentId */ diff --git a/discovery/src/main/java/com/ibm/watson/discovery/v2/model/EnrichmentOptions.java b/discovery/src/main/java/com/ibm/watson/discovery/v2/model/EnrichmentOptions.java index abd9e9c3ec..baea3a8148 100644 --- a/discovery/src/main/java/com/ibm/watson/discovery/v2/model/EnrichmentOptions.java +++ b/discovery/src/main/java/com/ibm/watson/discovery/v2/model/EnrichmentOptions.java @@ -343,8 +343,8 @@ public String resultField() { /** * Gets the classifierId. * - *

A unique identifier of the document classifier. Required when **type** is `classifier`. Not - * valid when creating any other type of enrichment. + *

The Universally Unique Identifier (UUID) of the document classifier. Required when **type** + * is `classifier`. Not valid when creating any other type of enrichment. * * @return the classifierId */ @@ -355,8 +355,8 @@ public String classifierId() { /** * Gets the modelId. * - *

A unique identifier of the document classifier model. Required when **type** is - * `classifier`. Not valid when creating any other type of enrichment. + *

The Universally Unique Identifier (UUID) of the document classifier model. Required when + * **type** is `classifier`. Not valid when creating any other type of enrichment. * * @return the modelId */ diff --git a/discovery/src/main/java/com/ibm/watson/discovery/v2/model/GetAutocompletionOptions.java b/discovery/src/main/java/com/ibm/watson/discovery/v2/model/GetAutocompletionOptions.java index cb0bc335d0..6136d04d01 100644 --- a/discovery/src/main/java/com/ibm/watson/discovery/v2/model/GetAutocompletionOptions.java +++ b/discovery/src/main/java/com/ibm/watson/discovery/v2/model/GetAutocompletionOptions.java @@ -164,8 +164,8 @@ public Builder newBuilder() { /** * Gets the projectId. * - *

The ID of the project. This information can be found from the *Integrate and Deploy* page in - * Discovery. + *

The Universally Unique Identifier (UUID) of the project. This information can be found from + * the *Integrate and Deploy* page in Discovery. * * @return the projectId */ diff --git a/discovery/src/main/java/com/ibm/watson/discovery/v2/model/GetCollectionOptions.java b/discovery/src/main/java/com/ibm/watson/discovery/v2/model/GetCollectionOptions.java index fa1fa328bd..332998d3b6 100644 --- a/discovery/src/main/java/com/ibm/watson/discovery/v2/model/GetCollectionOptions.java +++ b/discovery/src/main/java/com/ibm/watson/discovery/v2/model/GetCollectionOptions.java @@ -1,5 +1,5 @@ /* - * (C) Copyright IBM Corp. 2020, 2023. + * (C) Copyright IBM Corp. 2020, 2024. * * Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with * the License. You may obtain a copy of the License at @@ -103,8 +103,8 @@ public Builder newBuilder() { /** * Gets the projectId. * - *

The ID of the project. This information can be found from the *Integrate and Deploy* page in - * Discovery. + *

The Universally Unique Identifier (UUID) of the project. This information can be found from + * the *Integrate and Deploy* page in Discovery. * * @return the projectId */ @@ -115,7 +115,7 @@ public String projectId() { /** * Gets the collectionId. * - *

The ID of the collection. + *

The Universally Unique Identifier (UUID) of the collection. * * @return the collectionId */ diff --git a/discovery/src/main/java/com/ibm/watson/discovery/v2/model/GetComponentSettingsOptions.java b/discovery/src/main/java/com/ibm/watson/discovery/v2/model/GetComponentSettingsOptions.java index 29f9f72bb9..c41f0c3cef 100644 --- a/discovery/src/main/java/com/ibm/watson/discovery/v2/model/GetComponentSettingsOptions.java +++ b/discovery/src/main/java/com/ibm/watson/discovery/v2/model/GetComponentSettingsOptions.java @@ -1,5 +1,5 @@ /* - * (C) Copyright IBM Corp. 2019, 2023. + * (C) Copyright IBM Corp. 2019, 2024. * * Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with * the License. You may obtain a copy of the License at @@ -84,8 +84,8 @@ public Builder newBuilder() { /** * Gets the projectId. * - *

The ID of the project. This information can be found from the *Integrate and Deploy* page in - * Discovery. + *

The Universally Unique Identifier (UUID) of the project. This information can be found from + * the *Integrate and Deploy* page in Discovery. * * @return the projectId */ diff --git a/discovery/src/main/java/com/ibm/watson/discovery/v2/model/GetDocumentClassifierModelOptions.java b/discovery/src/main/java/com/ibm/watson/discovery/v2/model/GetDocumentClassifierModelOptions.java index 7b500a3b3c..262a818cae 100644 --- a/discovery/src/main/java/com/ibm/watson/discovery/v2/model/GetDocumentClassifierModelOptions.java +++ b/discovery/src/main/java/com/ibm/watson/discovery/v2/model/GetDocumentClassifierModelOptions.java @@ -1,5 +1,5 @@ /* - * (C) Copyright IBM Corp. 2022, 2023. + * (C) Copyright IBM Corp. 2022, 2024. * * Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with * the License. You may obtain a copy of the License at @@ -121,8 +121,8 @@ public Builder newBuilder() { /** * Gets the projectId. * - *

The ID of the project. This information can be found from the *Integrate and Deploy* page in - * Discovery. + *

The Universally Unique Identifier (UUID) of the project. This information can be found from + * the *Integrate and Deploy* page in Discovery. * * @return the projectId */ @@ -133,7 +133,7 @@ public String projectId() { /** * Gets the classifierId. * - *

The ID of the classifier. + *

The Universally Unique Identifier (UUID) of the classifier. * * @return the classifierId */ @@ -144,7 +144,7 @@ public String classifierId() { /** * Gets the modelId. * - *

The ID of the classifier model. + *

The Universally Unique Identifier (UUID) of the classifier model. * * @return the modelId */ diff --git a/discovery/src/main/java/com/ibm/watson/discovery/v2/model/GetDocumentClassifierOptions.java b/discovery/src/main/java/com/ibm/watson/discovery/v2/model/GetDocumentClassifierOptions.java index f4d2fd916e..a0cbf320d2 100644 --- a/discovery/src/main/java/com/ibm/watson/discovery/v2/model/GetDocumentClassifierOptions.java +++ b/discovery/src/main/java/com/ibm/watson/discovery/v2/model/GetDocumentClassifierOptions.java @@ -1,5 +1,5 @@ /* - * (C) Copyright IBM Corp. 2022, 2023. + * (C) Copyright IBM Corp. 2022, 2024. * * Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with * the License. You may obtain a copy of the License at @@ -103,8 +103,8 @@ public Builder newBuilder() { /** * Gets the projectId. * - *

The ID of the project. This information can be found from the *Integrate and Deploy* page in - * Discovery. + *

The Universally Unique Identifier (UUID) of the project. This information can be found from + * the *Integrate and Deploy* page in Discovery. * * @return the projectId */ @@ -115,7 +115,7 @@ public String projectId() { /** * Gets the classifierId. * - *

The ID of the classifier. + *

The Universally Unique Identifier (UUID) of the classifier. * * @return the classifierId */ diff --git a/discovery/src/main/java/com/ibm/watson/discovery/v2/model/GetDocumentOptions.java b/discovery/src/main/java/com/ibm/watson/discovery/v2/model/GetDocumentOptions.java index 82f8546fa3..fcc44584f7 100644 --- a/discovery/src/main/java/com/ibm/watson/discovery/v2/model/GetDocumentOptions.java +++ b/discovery/src/main/java/com/ibm/watson/discovery/v2/model/GetDocumentOptions.java @@ -1,5 +1,5 @@ /* - * (C) Copyright IBM Corp. 2022, 2023. + * (C) Copyright IBM Corp. 2022, 2024. * * Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with * the License. You may obtain a copy of the License at @@ -122,8 +122,8 @@ public Builder newBuilder() { /** * Gets the projectId. * - *

The ID of the project. This information can be found from the *Integrate and Deploy* page in - * Discovery. + *

The Universally Unique Identifier (UUID) of the project. This information can be found from + * the *Integrate and Deploy* page in Discovery. * * @return the projectId */ @@ -134,7 +134,7 @@ public String projectId() { /** * Gets the collectionId. * - *

The ID of the collection. + *

The Universally Unique Identifier (UUID) of the collection. * * @return the collectionId */ diff --git a/discovery/src/main/java/com/ibm/watson/discovery/v2/model/GetEnrichmentOptions.java b/discovery/src/main/java/com/ibm/watson/discovery/v2/model/GetEnrichmentOptions.java index e5e0f36a91..7082e8a30f 100644 --- a/discovery/src/main/java/com/ibm/watson/discovery/v2/model/GetEnrichmentOptions.java +++ b/discovery/src/main/java/com/ibm/watson/discovery/v2/model/GetEnrichmentOptions.java @@ -1,5 +1,5 @@ /* - * (C) Copyright IBM Corp. 2020, 2023. + * (C) Copyright IBM Corp. 2020, 2024. * * Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with * the License. You may obtain a copy of the License at @@ -103,8 +103,8 @@ public Builder newBuilder() { /** * Gets the projectId. * - *

The ID of the project. This information can be found from the *Integrate and Deploy* page in - * Discovery. + *

The Universally Unique Identifier (UUID) of the project. This information can be found from + * the *Integrate and Deploy* page in Discovery. * * @return the projectId */ @@ -115,7 +115,7 @@ public String projectId() { /** * Gets the enrichmentId. * - *

The ID of the enrichment. + *

The Universally Unique Identifier (UUID) of the enrichment. * * @return the enrichmentId */ diff --git a/discovery/src/main/java/com/ibm/watson/discovery/v2/model/GetProjectOptions.java b/discovery/src/main/java/com/ibm/watson/discovery/v2/model/GetProjectOptions.java index 5f8ea41357..5ba084acca 100644 --- a/discovery/src/main/java/com/ibm/watson/discovery/v2/model/GetProjectOptions.java +++ b/discovery/src/main/java/com/ibm/watson/discovery/v2/model/GetProjectOptions.java @@ -1,5 +1,5 @@ /* - * (C) Copyright IBM Corp. 2020, 2023. + * (C) Copyright IBM Corp. 2020, 2024. * * Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with * the License. You may obtain a copy of the License at @@ -84,8 +84,8 @@ public Builder newBuilder() { /** * Gets the projectId. * - *

The ID of the project. This information can be found from the *Integrate and Deploy* page in - * Discovery. + *

The Universally Unique Identifier (UUID) of the project. This information can be found from + * the *Integrate and Deploy* page in Discovery. * * @return the projectId */ diff --git a/discovery/src/main/java/com/ibm/watson/discovery/v2/model/GetStopwordListOptions.java b/discovery/src/main/java/com/ibm/watson/discovery/v2/model/GetStopwordListOptions.java index 8cd9a34849..689fdca7a6 100644 --- a/discovery/src/main/java/com/ibm/watson/discovery/v2/model/GetStopwordListOptions.java +++ b/discovery/src/main/java/com/ibm/watson/discovery/v2/model/GetStopwordListOptions.java @@ -1,5 +1,5 @@ /* - * (C) Copyright IBM Corp. 2022, 2023. + * (C) Copyright IBM Corp. 2022, 2024. * * Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with * the License. You may obtain a copy of the License at @@ -103,8 +103,8 @@ public Builder newBuilder() { /** * Gets the projectId. * - *

The ID of the project. This information can be found from the *Integrate and Deploy* page in - * Discovery. + *

The Universally Unique Identifier (UUID) of the project. This information can be found from + * the *Integrate and Deploy* page in Discovery. * * @return the projectId */ @@ -115,7 +115,7 @@ public String projectId() { /** * Gets the collectionId. * - *

The ID of the collection. + *

The Universally Unique Identifier (UUID) of the collection. * * @return the collectionId */ diff --git a/discovery/src/main/java/com/ibm/watson/discovery/v2/model/GetTrainingQueryOptions.java b/discovery/src/main/java/com/ibm/watson/discovery/v2/model/GetTrainingQueryOptions.java index c22be101f4..a1c6c76a3f 100644 --- a/discovery/src/main/java/com/ibm/watson/discovery/v2/model/GetTrainingQueryOptions.java +++ b/discovery/src/main/java/com/ibm/watson/discovery/v2/model/GetTrainingQueryOptions.java @@ -1,5 +1,5 @@ /* - * (C) Copyright IBM Corp. 2019, 2023. + * (C) Copyright IBM Corp. 2019, 2024. * * Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with * the License. You may obtain a copy of the License at @@ -102,8 +102,8 @@ public Builder newBuilder() { /** * Gets the projectId. * - *

The ID of the project. This information can be found from the *Integrate and Deploy* page in - * Discovery. + *

The Universally Unique Identifier (UUID) of the project. This information can be found from + * the *Integrate and Deploy* page in Discovery. * * @return the projectId */ diff --git a/discovery/src/main/java/com/ibm/watson/discovery/v2/model/ListCollectionsOptions.java b/discovery/src/main/java/com/ibm/watson/discovery/v2/model/ListCollectionsOptions.java index c795eca96c..78be90e1df 100644 --- a/discovery/src/main/java/com/ibm/watson/discovery/v2/model/ListCollectionsOptions.java +++ b/discovery/src/main/java/com/ibm/watson/discovery/v2/model/ListCollectionsOptions.java @@ -1,5 +1,5 @@ /* - * (C) Copyright IBM Corp. 2019, 2023. + * (C) Copyright IBM Corp. 2019, 2024. * * Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with * the License. You may obtain a copy of the License at @@ -84,8 +84,8 @@ public Builder newBuilder() { /** * Gets the projectId. * - *

The ID of the project. This information can be found from the *Integrate and Deploy* page in - * Discovery. + *

The Universally Unique Identifier (UUID) of the project. This information can be found from + * the *Integrate and Deploy* page in Discovery. * * @return the projectId */ diff --git a/discovery/src/main/java/com/ibm/watson/discovery/v2/model/ListDocumentClassifierModelsOptions.java b/discovery/src/main/java/com/ibm/watson/discovery/v2/model/ListDocumentClassifierModelsOptions.java index 044307e117..6a8a2eede8 100644 --- a/discovery/src/main/java/com/ibm/watson/discovery/v2/model/ListDocumentClassifierModelsOptions.java +++ b/discovery/src/main/java/com/ibm/watson/discovery/v2/model/ListDocumentClassifierModelsOptions.java @@ -1,5 +1,5 @@ /* - * (C) Copyright IBM Corp. 2022, 2023. + * (C) Copyright IBM Corp. 2022, 2024. * * Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with * the License. You may obtain a copy of the License at @@ -103,8 +103,8 @@ public Builder newBuilder() { /** * Gets the projectId. * - *

The ID of the project. This information can be found from the *Integrate and Deploy* page in - * Discovery. + *

The Universally Unique Identifier (UUID) of the project. This information can be found from + * the *Integrate and Deploy* page in Discovery. * * @return the projectId */ @@ -115,7 +115,7 @@ public String projectId() { /** * Gets the classifierId. * - *

The ID of the classifier. + *

The Universally Unique Identifier (UUID) of the classifier. * * @return the classifierId */ diff --git a/discovery/src/main/java/com/ibm/watson/discovery/v2/model/ListDocumentClassifiersOptions.java b/discovery/src/main/java/com/ibm/watson/discovery/v2/model/ListDocumentClassifiersOptions.java index aa3aa8439d..f63c0680fd 100644 --- a/discovery/src/main/java/com/ibm/watson/discovery/v2/model/ListDocumentClassifiersOptions.java +++ b/discovery/src/main/java/com/ibm/watson/discovery/v2/model/ListDocumentClassifiersOptions.java @@ -1,5 +1,5 @@ /* - * (C) Copyright IBM Corp. 2022, 2023. + * (C) Copyright IBM Corp. 2022, 2024. * * Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with * the License. You may obtain a copy of the License at @@ -84,8 +84,8 @@ public Builder newBuilder() { /** * Gets the projectId. * - *

The ID of the project. This information can be found from the *Integrate and Deploy* page in - * Discovery. + *

The Universally Unique Identifier (UUID) of the project. This information can be found from + * the *Integrate and Deploy* page in Discovery. * * @return the projectId */ diff --git a/discovery/src/main/java/com/ibm/watson/discovery/v2/model/ListDocumentsOptions.java b/discovery/src/main/java/com/ibm/watson/discovery/v2/model/ListDocumentsOptions.java index 8812f0d775..3d4fc99d93 100644 --- a/discovery/src/main/java/com/ibm/watson/discovery/v2/model/ListDocumentsOptions.java +++ b/discovery/src/main/java/com/ibm/watson/discovery/v2/model/ListDocumentsOptions.java @@ -1,5 +1,5 @@ /* - * (C) Copyright IBM Corp. 2022, 2023. + * (C) Copyright IBM Corp. 2022, 2024. * * Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with * the License. You may obtain a copy of the License at @@ -193,8 +193,8 @@ public Builder newBuilder() { /** * Gets the projectId. * - *

The ID of the project. This information can be found from the *Integrate and Deploy* page in - * Discovery. + *

The Universally Unique Identifier (UUID) of the project. This information can be found from + * the *Integrate and Deploy* page in Discovery. * * @return the projectId */ @@ -205,7 +205,7 @@ public String projectId() { /** * Gets the collectionId. * - *

The ID of the collection. + *

The Universally Unique Identifier (UUID) of the collection. * * @return the collectionId */ diff --git a/discovery/src/main/java/com/ibm/watson/discovery/v2/model/ListEnrichmentsOptions.java b/discovery/src/main/java/com/ibm/watson/discovery/v2/model/ListEnrichmentsOptions.java index af02273a6b..d012519e50 100644 --- a/discovery/src/main/java/com/ibm/watson/discovery/v2/model/ListEnrichmentsOptions.java +++ b/discovery/src/main/java/com/ibm/watson/discovery/v2/model/ListEnrichmentsOptions.java @@ -1,5 +1,5 @@ /* - * (C) Copyright IBM Corp. 2020, 2023. + * (C) Copyright IBM Corp. 2020, 2024. * * Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with * the License. You may obtain a copy of the License at @@ -84,8 +84,8 @@ public Builder newBuilder() { /** * Gets the projectId. * - *

The ID of the project. This information can be found from the *Integrate and Deploy* page in - * Discovery. + *

The Universally Unique Identifier (UUID) of the project. This information can be found from + * the *Integrate and Deploy* page in Discovery. * * @return the projectId */ diff --git a/discovery/src/main/java/com/ibm/watson/discovery/v2/model/ListExpansionsOptions.java b/discovery/src/main/java/com/ibm/watson/discovery/v2/model/ListExpansionsOptions.java index cf23ea4ac7..287760564a 100644 --- a/discovery/src/main/java/com/ibm/watson/discovery/v2/model/ListExpansionsOptions.java +++ b/discovery/src/main/java/com/ibm/watson/discovery/v2/model/ListExpansionsOptions.java @@ -1,5 +1,5 @@ /* - * (C) Copyright IBM Corp. 2022, 2023. + * (C) Copyright IBM Corp. 2022, 2024. * * Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with * the License. You may obtain a copy of the License at @@ -103,8 +103,8 @@ public Builder newBuilder() { /** * Gets the projectId. * - *

The ID of the project. This information can be found from the *Integrate and Deploy* page in - * Discovery. + *

The Universally Unique Identifier (UUID) of the project. This information can be found from + * the *Integrate and Deploy* page in Discovery. * * @return the projectId */ @@ -115,7 +115,7 @@ public String projectId() { /** * Gets the collectionId. * - *

The ID of the collection. + *

The Universally Unique Identifier (UUID) of the collection. * * @return the collectionId */ diff --git a/discovery/src/main/java/com/ibm/watson/discovery/v2/model/ListFieldsOptions.java b/discovery/src/main/java/com/ibm/watson/discovery/v2/model/ListFieldsOptions.java index 66ddd804da..e373e8f29c 100644 --- a/discovery/src/main/java/com/ibm/watson/discovery/v2/model/ListFieldsOptions.java +++ b/discovery/src/main/java/com/ibm/watson/discovery/v2/model/ListFieldsOptions.java @@ -116,8 +116,8 @@ public Builder newBuilder() { /** * Gets the projectId. * - *

The ID of the project. This information can be found from the *Integrate and Deploy* page in - * Discovery. + *

The Universally Unique Identifier (UUID) of the project. This information can be found from + * the *Integrate and Deploy* page in Discovery. * * @return the projectId */ diff --git a/discovery/src/main/java/com/ibm/watson/discovery/v2/model/ListTrainingQueriesOptions.java b/discovery/src/main/java/com/ibm/watson/discovery/v2/model/ListTrainingQueriesOptions.java index 85696804c2..8bce0a07a0 100644 --- a/discovery/src/main/java/com/ibm/watson/discovery/v2/model/ListTrainingQueriesOptions.java +++ b/discovery/src/main/java/com/ibm/watson/discovery/v2/model/ListTrainingQueriesOptions.java @@ -1,5 +1,5 @@ /* - * (C) Copyright IBM Corp. 2019, 2023. + * (C) Copyright IBM Corp. 2019, 2024. * * Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with * the License. You may obtain a copy of the License at @@ -84,8 +84,8 @@ public Builder newBuilder() { /** * Gets the projectId. * - *

The ID of the project. This information can be found from the *Integrate and Deploy* page in - * Discovery. + *

The Universally Unique Identifier (UUID) of the project. This information can be found from + * the *Integrate and Deploy* page in Discovery. * * @return the projectId */ diff --git a/discovery/src/main/java/com/ibm/watson/discovery/v2/model/ProjectDetails.java b/discovery/src/main/java/com/ibm/watson/discovery/v2/model/ProjectDetails.java index d01aa92fa7..24800540a4 100644 --- a/discovery/src/main/java/com/ibm/watson/discovery/v2/model/ProjectDetails.java +++ b/discovery/src/main/java/com/ibm/watson/discovery/v2/model/ProjectDetails.java @@ -1,5 +1,5 @@ /* - * (C) Copyright IBM Corp. 2020, 2023. + * (C) Copyright IBM Corp. 2020, 2024. * * Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with * the License. You may obtain a copy of the License at @@ -26,8 +26,13 @@ public class ProjectDetails extends GenericModel { * *

The `content_mining` and `content_intelligence` types are available with Premium plan * managed deployments and installed deployments only. + * + *

The Intelligent Document Processing (IDP) project type is available from IBM Cloud-managed + * instances only. */ public interface Type { + /** intelligent_document_processing. */ + String INTELLIGENT_DOCUMENT_PROCESSING = "intelligent_document_processing"; /** document_retrieval. */ String DOCUMENT_RETRIEVAL = "document_retrieval"; /** conversational_search. */ @@ -60,7 +65,7 @@ protected ProjectDetails() {} /** * Gets the projectId. * - *

The unique identifier of this project. + *

The Universally Unique Identifier (UUID) of this project. * * @return the projectId */ @@ -90,6 +95,9 @@ public String getName() { *

The `content_mining` and `content_intelligence` types are available with Premium plan * managed deployments and installed deployments only. * + *

The Intelligent Document Processing (IDP) project type is available from IBM Cloud-managed + * instances only. + * * @return the type */ public String getType() { diff --git a/discovery/src/main/java/com/ibm/watson/discovery/v2/model/ProjectListDetails.java b/discovery/src/main/java/com/ibm/watson/discovery/v2/model/ProjectListDetails.java index 6b86430423..d93651447a 100644 --- a/discovery/src/main/java/com/ibm/watson/discovery/v2/model/ProjectListDetails.java +++ b/discovery/src/main/java/com/ibm/watson/discovery/v2/model/ProjectListDetails.java @@ -1,5 +1,5 @@ /* - * (C) Copyright IBM Corp. 2020, 2023. + * (C) Copyright IBM Corp. 2020, 2024. * * Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with * the License. You may obtain a copy of the License at @@ -26,8 +26,13 @@ public class ProjectListDetails extends GenericModel { * *

The `content_mining` and `content_intelligence` types are available with Premium plan * managed deployments and installed deployments only. + * + *

The Intelligent Document Processing (IDP) project type is available from IBM Cloud-managed + * instances only. */ public interface Type { + /** intelligent_document_processing. */ + String INTELLIGENT_DOCUMENT_PROCESSING = "intelligent_document_processing"; /** document_retrieval. */ String DOCUMENT_RETRIEVAL = "document_retrieval"; /** conversational_search. */ @@ -57,7 +62,7 @@ protected ProjectListDetails() {} /** * Gets the projectId. * - *

The unique identifier of this project. + *

The Universally Unique Identifier (UUID) of this project. * * @return the projectId */ @@ -87,6 +92,9 @@ public String getName() { *

The `content_mining` and `content_intelligence` types are available with Premium plan * managed deployments and installed deployments only. * + *

The Intelligent Document Processing (IDP) project type is available from IBM Cloud-managed + * instances only. + * * @return the type */ public String getType() { diff --git a/discovery/src/main/java/com/ibm/watson/discovery/v2/model/QueryAggregationQueryTimesliceAggregation.java b/discovery/src/main/java/com/ibm/watson/discovery/v2/model/QueryAggregationQueryTimesliceAggregation.java index d001da825b..b2a62375ce 100644 --- a/discovery/src/main/java/com/ibm/watson/discovery/v2/model/QueryAggregationQueryTimesliceAggregation.java +++ b/discovery/src/main/java/com/ibm/watson/discovery/v2/model/QueryAggregationQueryTimesliceAggregation.java @@ -1,5 +1,5 @@ /* - * (C) Copyright IBM Corp. 2023. + * (C) Copyright IBM Corp. 2023, 2024. * * Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with * the License. You may obtain a copy of the License at diff --git a/discovery/src/main/java/com/ibm/watson/discovery/v2/model/QueryNoticesOptions.java b/discovery/src/main/java/com/ibm/watson/discovery/v2/model/QueryNoticesOptions.java index 9d3bf11ee5..d50937249f 100644 --- a/discovery/src/main/java/com/ibm/watson/discovery/v2/model/QueryNoticesOptions.java +++ b/discovery/src/main/java/com/ibm/watson/discovery/v2/model/QueryNoticesOptions.java @@ -159,8 +159,8 @@ public Builder newBuilder() { /** * Gets the projectId. * - *

The ID of the project. This information can be found from the *Integrate and Deploy* page in - * Discovery. + *

The Universally Unique Identifier (UUID) of the project. This information can be found from + * the *Integrate and Deploy* page in Discovery. * * @return the projectId */ diff --git a/discovery/src/main/java/com/ibm/watson/discovery/v2/model/QueryOptions.java b/discovery/src/main/java/com/ibm/watson/discovery/v2/model/QueryOptions.java index ffc81b1a00..4f6a614cd4 100644 --- a/discovery/src/main/java/com/ibm/watson/discovery/v2/model/QueryOptions.java +++ b/discovery/src/main/java/com/ibm/watson/discovery/v2/model/QueryOptions.java @@ -341,8 +341,8 @@ public Builder newBuilder() { /** * Gets the projectId. * - *

The ID of the project. This information can be found from the *Integrate and Deploy* page in - * Discovery. + *

The Universally Unique Identifier (UUID) of the project. This information can be found from + * the *Integrate and Deploy* page in Discovery. * * @return the projectId */ diff --git a/discovery/src/main/java/com/ibm/watson/discovery/v2/model/UpdateCollectionOptions.java b/discovery/src/main/java/com/ibm/watson/discovery/v2/model/UpdateCollectionOptions.java index 3b39280c5f..d1c0cc8f29 100644 --- a/discovery/src/main/java/com/ibm/watson/discovery/v2/model/UpdateCollectionOptions.java +++ b/discovery/src/main/java/com/ibm/watson/discovery/v2/model/UpdateCollectionOptions.java @@ -23,6 +23,7 @@ public class UpdateCollectionOptions extends GenericModel { protected String collectionId; protected String name; protected String description; + protected Boolean ocrEnabled; protected List enrichments; /** Builder. */ @@ -31,6 +32,7 @@ public static class Builder { private String collectionId; private String name; private String description; + private Boolean ocrEnabled; private List enrichments; /** @@ -43,6 +45,7 @@ private Builder(UpdateCollectionOptions updateCollectionOptions) { this.collectionId = updateCollectionOptions.collectionId; this.name = updateCollectionOptions.name; this.description = updateCollectionOptions.description; + this.ocrEnabled = updateCollectionOptions.ocrEnabled; this.enrichments = updateCollectionOptions.enrichments; } @@ -128,6 +131,17 @@ public Builder description(String description) { return this; } + /** + * Set the ocrEnabled. + * + * @param ocrEnabled the ocrEnabled + * @return the UpdateCollectionOptions builder + */ + public Builder ocrEnabled(Boolean ocrEnabled) { + this.ocrEnabled = ocrEnabled; + return this; + } + /** * Set the enrichments. Existing enrichments will be replaced. * @@ -150,6 +164,7 @@ protected UpdateCollectionOptions(Builder builder) { collectionId = builder.collectionId; name = builder.name; description = builder.description; + ocrEnabled = builder.ocrEnabled; enrichments = builder.enrichments; } @@ -165,8 +180,8 @@ public Builder newBuilder() { /** * Gets the projectId. * - *

The ID of the project. This information can be found from the *Integrate and Deploy* page in - * Discovery. + *

The Universally Unique Identifier (UUID) of the project. This information can be found from + * the *Integrate and Deploy* page in Discovery. * * @return the projectId */ @@ -177,7 +192,7 @@ public String projectId() { /** * Gets the collectionId. * - *

The ID of the collection. + *

The Universally Unique Identifier (UUID) of the collection. * * @return the collectionId */ @@ -207,6 +222,18 @@ public String description() { return description; } + /** + * Gets the ocrEnabled. + * + *

If set to `true`, optical character recognition (OCR) is enabled. For more information, see + * [Optical character recognition](/docs/discovery-data?topic=discovery-data-collections#ocr). + * + * @return the ocrEnabled + */ + public Boolean ocrEnabled() { + return ocrEnabled; + } + /** * Gets the enrichments. * diff --git a/discovery/src/main/java/com/ibm/watson/discovery/v2/model/UpdateDocumentClassifierModelOptions.java b/discovery/src/main/java/com/ibm/watson/discovery/v2/model/UpdateDocumentClassifierModelOptions.java index 525073642d..af86087545 100644 --- a/discovery/src/main/java/com/ibm/watson/discovery/v2/model/UpdateDocumentClassifierModelOptions.java +++ b/discovery/src/main/java/com/ibm/watson/discovery/v2/model/UpdateDocumentClassifierModelOptions.java @@ -1,5 +1,5 @@ /* - * (C) Copyright IBM Corp. 2022, 2023. + * (C) Copyright IBM Corp. 2022, 2024. * * Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with * the License. You may obtain a copy of the License at @@ -151,8 +151,8 @@ public Builder newBuilder() { /** * Gets the projectId. * - *

The ID of the project. This information can be found from the *Integrate and Deploy* page in - * Discovery. + *

The Universally Unique Identifier (UUID) of the project. This information can be found from + * the *Integrate and Deploy* page in Discovery. * * @return the projectId */ @@ -163,7 +163,7 @@ public String projectId() { /** * Gets the classifierId. * - *

The ID of the classifier. + *

The Universally Unique Identifier (UUID) of the classifier. * * @return the classifierId */ @@ -174,7 +174,7 @@ public String classifierId() { /** * Gets the modelId. * - *

The ID of the classifier model. + *

The Universally Unique Identifier (UUID) of the classifier model. * * @return the modelId */ diff --git a/discovery/src/main/java/com/ibm/watson/discovery/v2/model/UpdateDocumentClassifierOptions.java b/discovery/src/main/java/com/ibm/watson/discovery/v2/model/UpdateDocumentClassifierOptions.java index c4df0c2030..f23fdbe8dd 100644 --- a/discovery/src/main/java/com/ibm/watson/discovery/v2/model/UpdateDocumentClassifierOptions.java +++ b/discovery/src/main/java/com/ibm/watson/discovery/v2/model/UpdateDocumentClassifierOptions.java @@ -1,5 +1,5 @@ /* - * (C) Copyright IBM Corp. 2022, 2023. + * (C) Copyright IBM Corp. 2022, 2024. * * Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with * the License. You may obtain a copy of the License at @@ -179,8 +179,8 @@ public Builder newBuilder() { /** * Gets the projectId. * - *

The ID of the project. This information can be found from the *Integrate and Deploy* page in - * Discovery. + *

The Universally Unique Identifier (UUID) of the project. This information can be found from + * the *Integrate and Deploy* page in Discovery. * * @return the projectId */ @@ -191,7 +191,7 @@ public String projectId() { /** * Gets the classifierId. * - *

The ID of the classifier. + *

The Universally Unique Identifier (UUID) of the classifier. * * @return the classifierId */ diff --git a/discovery/src/main/java/com/ibm/watson/discovery/v2/model/UpdateDocumentOptions.java b/discovery/src/main/java/com/ibm/watson/discovery/v2/model/UpdateDocumentOptions.java index d68bce22f7..9c58dd4b12 100644 --- a/discovery/src/main/java/com/ibm/watson/discovery/v2/model/UpdateDocumentOptions.java +++ b/discovery/src/main/java/com/ibm/watson/discovery/v2/model/UpdateDocumentOptions.java @@ -217,8 +217,8 @@ public Builder newBuilder() { /** * Gets the projectId. * - *

The ID of the project. This information can be found from the *Integrate and Deploy* page in - * Discovery. + *

The Universally Unique Identifier (UUID) of the project. This information can be found from + * the *Integrate and Deploy* page in Discovery. * * @return the projectId */ @@ -229,7 +229,7 @@ public String projectId() { /** * Gets the collectionId. * - *

The ID of the collection. + *

The Universally Unique Identifier (UUID) of the collection. * * @return the collectionId */ diff --git a/discovery/src/main/java/com/ibm/watson/discovery/v2/model/UpdateEnrichmentOptions.java b/discovery/src/main/java/com/ibm/watson/discovery/v2/model/UpdateEnrichmentOptions.java index a1b2e34647..530e75d2b1 100644 --- a/discovery/src/main/java/com/ibm/watson/discovery/v2/model/UpdateEnrichmentOptions.java +++ b/discovery/src/main/java/com/ibm/watson/discovery/v2/model/UpdateEnrichmentOptions.java @@ -1,5 +1,5 @@ /* - * (C) Copyright IBM Corp. 2020, 2023. + * (C) Copyright IBM Corp. 2020, 2024. * * Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with * the License. You may obtain a copy of the License at @@ -136,8 +136,8 @@ public Builder newBuilder() { /** * Gets the projectId. * - *

The ID of the project. This information can be found from the *Integrate and Deploy* page in - * Discovery. + *

The Universally Unique Identifier (UUID) of the project. This information can be found from + * the *Integrate and Deploy* page in Discovery. * * @return the projectId */ @@ -148,7 +148,7 @@ public String projectId() { /** * Gets the enrichmentId. * - *

The ID of the enrichment. + *

The Universally Unique Identifier (UUID) of the enrichment. * * @return the enrichmentId */ diff --git a/discovery/src/main/java/com/ibm/watson/discovery/v2/model/UpdateProjectOptions.java b/discovery/src/main/java/com/ibm/watson/discovery/v2/model/UpdateProjectOptions.java index e0e06421ab..cb43c1e63c 100644 --- a/discovery/src/main/java/com/ibm/watson/discovery/v2/model/UpdateProjectOptions.java +++ b/discovery/src/main/java/com/ibm/watson/discovery/v2/model/UpdateProjectOptions.java @@ -1,5 +1,5 @@ /* - * (C) Copyright IBM Corp. 2020, 2023. + * (C) Copyright IBM Corp. 2020, 2024. * * Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with * the License. You may obtain a copy of the License at @@ -99,8 +99,8 @@ public Builder newBuilder() { /** * Gets the projectId. * - *

The ID of the project. This information can be found from the *Integrate and Deploy* page in - * Discovery. + *

The Universally Unique Identifier (UUID) of the project. This information can be found from + * the *Integrate and Deploy* page in Discovery. * * @return the projectId */ diff --git a/discovery/src/main/java/com/ibm/watson/discovery/v2/model/UpdateTrainingQueryOptions.java b/discovery/src/main/java/com/ibm/watson/discovery/v2/model/UpdateTrainingQueryOptions.java index fee05dbbfb..dadc0a4cc3 100644 --- a/discovery/src/main/java/com/ibm/watson/discovery/v2/model/UpdateTrainingQueryOptions.java +++ b/discovery/src/main/java/com/ibm/watson/discovery/v2/model/UpdateTrainingQueryOptions.java @@ -188,8 +188,8 @@ public Builder newBuilder() { /** * Gets the projectId. * - *

The ID of the project. This information can be found from the *Integrate and Deploy* page in - * Discovery. + *

The Universally Unique Identifier (UUID) of the project. This information can be found from + * the *Integrate and Deploy* page in Discovery. * * @return the projectId */ diff --git a/discovery/src/test/java/com/ibm/watson/discovery/v2/DiscoveryTest.java b/discovery/src/test/java/com/ibm/watson/discovery/v2/DiscoveryTest.java index 16e6d15a1e..9169adb714 100644 --- a/discovery/src/test/java/com/ibm/watson/discovery/v2/DiscoveryTest.java +++ b/discovery/src/test/java/com/ibm/watson/discovery/v2/DiscoveryTest.java @@ -154,7 +154,7 @@ public void testGetVersion() throws Throwable { public void testListProjectsWOptions() throws Throwable { // Register a mock response String mockResponseBody = - "{\"projects\": [{\"project_id\": \"projectId\", \"name\": \"name\", \"type\": \"document_retrieval\", \"relevancy_training_status\": {\"data_updated\": \"dataUpdated\", \"total_examples\": 13, \"sufficient_label_diversity\": true, \"processing\": true, \"minimum_examples_added\": true, \"successfully_trained\": \"successfullyTrained\", \"available\": false, \"notices\": 7, \"minimum_queries_added\": false}, \"collection_count\": 15}]}"; + "{\"projects\": [{\"project_id\": \"projectId\", \"name\": \"name\", \"type\": \"intelligent_document_processing\", \"relevancy_training_status\": {\"data_updated\": \"dataUpdated\", \"total_examples\": 13, \"sufficient_label_diversity\": true, \"processing\": true, \"minimum_examples_added\": true, \"successfully_trained\": \"successfullyTrained\", \"available\": false, \"notices\": 7, \"minimum_queries_added\": false}, \"collection_count\": 15}]}"; String listProjectsPath = "/v2/projects"; server.enqueue( new MockResponse() @@ -200,7 +200,7 @@ public void testListProjectsWRetries() throws Throwable { public void testCreateProjectWOptions() throws Throwable { // Register a mock response String mockResponseBody = - "{\"project_id\": \"projectId\", \"name\": \"name\", \"type\": \"document_retrieval\", \"relevancy_training_status\": {\"data_updated\": \"dataUpdated\", \"total_examples\": 13, \"sufficient_label_diversity\": true, \"processing\": true, \"minimum_examples_added\": true, \"successfully_trained\": \"successfullyTrained\", \"available\": false, \"notices\": 7, \"minimum_queries_added\": false}, \"collection_count\": 15, \"default_query_parameters\": {\"collection_ids\": [\"collectionIds\"], \"passages\": {\"enabled\": false, \"count\": 5, \"fields\": [\"fields\"], \"characters\": 10, \"per_document\": false, \"max_per_document\": 14}, \"table_results\": {\"enabled\": false, \"count\": 5, \"per_document\": 0}, \"aggregation\": \"aggregation\", \"suggested_refinements\": {\"enabled\": false, \"count\": 5}, \"spelling_suggestions\": false, \"highlight\": false, \"count\": 5, \"sort\": \"sort\", \"return\": [\"xReturn\"]}}"; + "{\"project_id\": \"projectId\", \"name\": \"name\", \"type\": \"intelligent_document_processing\", \"relevancy_training_status\": {\"data_updated\": \"dataUpdated\", \"total_examples\": 13, \"sufficient_label_diversity\": true, \"processing\": true, \"minimum_examples_added\": true, \"successfully_trained\": \"successfullyTrained\", \"available\": false, \"notices\": 7, \"minimum_queries_added\": false}, \"collection_count\": 15, \"default_query_parameters\": {\"collection_ids\": [\"collectionIds\"], \"passages\": {\"enabled\": false, \"count\": 5, \"fields\": [\"fields\"], \"characters\": 10, \"per_document\": false, \"max_per_document\": 14}, \"table_results\": {\"enabled\": false, \"count\": 5, \"per_document\": 0}, \"aggregation\": \"aggregation\", \"suggested_refinements\": {\"enabled\": false, \"count\": 5}, \"spelling_suggestions\": false, \"highlight\": false, \"count\": 5, \"sort\": \"sort\", \"return\": [\"xReturn\"]}}"; String createProjectPath = "/v2/projects"; server.enqueue( new MockResponse() @@ -253,7 +253,7 @@ public void testCreateProjectWOptions() throws Throwable { CreateProjectOptions createProjectOptionsModel = new CreateProjectOptions.Builder() .name("testString") - .type("document_retrieval") + .type("intelligent_document_processing") .defaultQueryParameters(defaultQueryParamsModel) .build(); @@ -299,7 +299,7 @@ public void testCreateProjectNoOptions() throws Throwable { public void testGetProjectWOptions() throws Throwable { // Register a mock response String mockResponseBody = - "{\"project_id\": \"projectId\", \"name\": \"name\", \"type\": \"document_retrieval\", \"relevancy_training_status\": {\"data_updated\": \"dataUpdated\", \"total_examples\": 13, \"sufficient_label_diversity\": true, \"processing\": true, \"minimum_examples_added\": true, \"successfully_trained\": \"successfullyTrained\", \"available\": false, \"notices\": 7, \"minimum_queries_added\": false}, \"collection_count\": 15, \"default_query_parameters\": {\"collection_ids\": [\"collectionIds\"], \"passages\": {\"enabled\": false, \"count\": 5, \"fields\": [\"fields\"], \"characters\": 10, \"per_document\": false, \"max_per_document\": 14}, \"table_results\": {\"enabled\": false, \"count\": 5, \"per_document\": 0}, \"aggregation\": \"aggregation\", \"suggested_refinements\": {\"enabled\": false, \"count\": 5}, \"spelling_suggestions\": false, \"highlight\": false, \"count\": 5, \"sort\": \"sort\", \"return\": [\"xReturn\"]}}"; + "{\"project_id\": \"projectId\", \"name\": \"name\", \"type\": \"intelligent_document_processing\", \"relevancy_training_status\": {\"data_updated\": \"dataUpdated\", \"total_examples\": 13, \"sufficient_label_diversity\": true, \"processing\": true, \"minimum_examples_added\": true, \"successfully_trained\": \"successfullyTrained\", \"available\": false, \"notices\": 7, \"minimum_queries_added\": false}, \"collection_count\": 15, \"default_query_parameters\": {\"collection_ids\": [\"collectionIds\"], \"passages\": {\"enabled\": false, \"count\": 5, \"fields\": [\"fields\"], \"characters\": 10, \"per_document\": false, \"max_per_document\": 14}, \"table_results\": {\"enabled\": false, \"count\": 5, \"per_document\": 0}, \"aggregation\": \"aggregation\", \"suggested_refinements\": {\"enabled\": false, \"count\": 5}, \"spelling_suggestions\": false, \"highlight\": false, \"count\": 5, \"sort\": \"sort\", \"return\": [\"xReturn\"]}}"; String getProjectPath = "/v2/projects/testString"; server.enqueue( new MockResponse() @@ -353,7 +353,7 @@ public void testGetProjectNoOptions() throws Throwable { public void testUpdateProjectWOptions() throws Throwable { // Register a mock response String mockResponseBody = - "{\"project_id\": \"projectId\", \"name\": \"name\", \"type\": \"document_retrieval\", \"relevancy_training_status\": {\"data_updated\": \"dataUpdated\", \"total_examples\": 13, \"sufficient_label_diversity\": true, \"processing\": true, \"minimum_examples_added\": true, \"successfully_trained\": \"successfullyTrained\", \"available\": false, \"notices\": 7, \"minimum_queries_added\": false}, \"collection_count\": 15, \"default_query_parameters\": {\"collection_ids\": [\"collectionIds\"], \"passages\": {\"enabled\": false, \"count\": 5, \"fields\": [\"fields\"], \"characters\": 10, \"per_document\": false, \"max_per_document\": 14}, \"table_results\": {\"enabled\": false, \"count\": 5, \"per_document\": 0}, \"aggregation\": \"aggregation\", \"suggested_refinements\": {\"enabled\": false, \"count\": 5}, \"spelling_suggestions\": false, \"highlight\": false, \"count\": 5, \"sort\": \"sort\", \"return\": [\"xReturn\"]}}"; + "{\"project_id\": \"projectId\", \"name\": \"name\", \"type\": \"intelligent_document_processing\", \"relevancy_training_status\": {\"data_updated\": \"dataUpdated\", \"total_examples\": 13, \"sufficient_label_diversity\": true, \"processing\": true, \"minimum_examples_added\": true, \"successfully_trained\": \"successfullyTrained\", \"available\": false, \"notices\": 7, \"minimum_queries_added\": false}, \"collection_count\": 15, \"default_query_parameters\": {\"collection_ids\": [\"collectionIds\"], \"passages\": {\"enabled\": false, \"count\": 5, \"fields\": [\"fields\"], \"characters\": 10, \"per_document\": false, \"max_per_document\": 14}, \"table_results\": {\"enabled\": false, \"count\": 5, \"per_document\": 0}, \"aggregation\": \"aggregation\", \"suggested_refinements\": {\"enabled\": false, \"count\": 5}, \"spelling_suggestions\": false, \"highlight\": false, \"count\": 5, \"sort\": \"sort\", \"return\": [\"xReturn\"]}}"; String updateProjectPath = "/v2/projects/testString"; server.enqueue( new MockResponse() @@ -568,7 +568,7 @@ public void testListCollectionsNoOptions() throws Throwable { public void testCreateCollectionWOptions() throws Throwable { // Register a mock response String mockResponseBody = - "{\"collection_id\": \"collectionId\", \"name\": \"name\", \"description\": \"description\", \"created\": \"2019-01-01T12:00:00.000Z\", \"language\": \"en\", \"enrichments\": [{\"enrichment_id\": \"enrichmentId\", \"fields\": [\"fields\"]}], \"smart_document_understanding\": {\"enabled\": false, \"model\": \"custom\"}}"; + "{\"collection_id\": \"collectionId\", \"name\": \"name\", \"description\": \"description\", \"created\": \"2019-01-01T12:00:00.000Z\", \"language\": \"en\", \"ocr_enabled\": false, \"enrichments\": [{\"enrichment_id\": \"enrichmentId\", \"fields\": [\"fields\"]}], \"smart_document_understanding\": {\"enabled\": false, \"model\": \"custom\"}}"; String createCollectionPath = "/v2/projects/testString/collections"; server.enqueue( new MockResponse() @@ -590,6 +590,7 @@ public void testCreateCollectionWOptions() throws Throwable { .name("testString") .description("testString") .language("en") + .ocrEnabled(false) .enrichments(java.util.Arrays.asList(collectionEnrichmentModel)) .build(); @@ -635,7 +636,7 @@ public void testCreateCollectionNoOptions() throws Throwable { public void testGetCollectionWOptions() throws Throwable { // Register a mock response String mockResponseBody = - "{\"collection_id\": \"collectionId\", \"name\": \"name\", \"description\": \"description\", \"created\": \"2019-01-01T12:00:00.000Z\", \"language\": \"en\", \"enrichments\": [{\"enrichment_id\": \"enrichmentId\", \"fields\": [\"fields\"]}], \"smart_document_understanding\": {\"enabled\": false, \"model\": \"custom\"}}"; + "{\"collection_id\": \"collectionId\", \"name\": \"name\", \"description\": \"description\", \"created\": \"2019-01-01T12:00:00.000Z\", \"language\": \"en\", \"ocr_enabled\": false, \"enrichments\": [{\"enrichment_id\": \"enrichmentId\", \"fields\": [\"fields\"]}], \"smart_document_understanding\": {\"enabled\": false, \"model\": \"custom\"}}"; String getCollectionPath = "/v2/projects/testString/collections/testString"; server.enqueue( new MockResponse() @@ -692,7 +693,7 @@ public void testGetCollectionNoOptions() throws Throwable { public void testUpdateCollectionWOptions() throws Throwable { // Register a mock response String mockResponseBody = - "{\"collection_id\": \"collectionId\", \"name\": \"name\", \"description\": \"description\", \"created\": \"2019-01-01T12:00:00.000Z\", \"language\": \"en\", \"enrichments\": [{\"enrichment_id\": \"enrichmentId\", \"fields\": [\"fields\"]}], \"smart_document_understanding\": {\"enabled\": false, \"model\": \"custom\"}}"; + "{\"collection_id\": \"collectionId\", \"name\": \"name\", \"description\": \"description\", \"created\": \"2019-01-01T12:00:00.000Z\", \"language\": \"en\", \"ocr_enabled\": false, \"enrichments\": [{\"enrichment_id\": \"enrichmentId\", \"fields\": [\"fields\"]}], \"smart_document_understanding\": {\"enabled\": false, \"model\": \"custom\"}}"; String updateCollectionPath = "/v2/projects/testString/collections/testString"; server.enqueue( new MockResponse() @@ -714,6 +715,7 @@ public void testUpdateCollectionWOptions() throws Throwable { .collectionId("testString") .name("testString") .description("testString") + .ocrEnabled(false) .enrichments(java.util.Arrays.asList(collectionEnrichmentModel)) .build(); diff --git a/discovery/src/test/java/com/ibm/watson/discovery/v2/model/CollectionDetailsTest.java b/discovery/src/test/java/com/ibm/watson/discovery/v2/model/CollectionDetailsTest.java index 65908242fd..a7b54f3e0a 100644 --- a/discovery/src/test/java/com/ibm/watson/discovery/v2/model/CollectionDetailsTest.java +++ b/discovery/src/test/java/com/ibm/watson/discovery/v2/model/CollectionDetailsTest.java @@ -1,5 +1,5 @@ /* - * (C) Copyright IBM Corp. 2020, 2023. + * (C) Copyright IBM Corp. 2020, 2024. * * Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with * the License. You may obtain a copy of the License at @@ -43,11 +43,13 @@ public void testCollectionDetails() throws Throwable { .name("testString") .description("testString") .language("en") + .ocrEnabled(false) .enrichments(java.util.Arrays.asList(collectionEnrichmentModel)) .build(); assertEquals(collectionDetailsModel.name(), "testString"); assertEquals(collectionDetailsModel.description(), "testString"); assertEquals(collectionDetailsModel.language(), "en"); + assertEquals(collectionDetailsModel.ocrEnabled(), Boolean.valueOf(false)); assertEquals( collectionDetailsModel.enrichments(), java.util.Arrays.asList(collectionEnrichmentModel)); @@ -59,6 +61,7 @@ public void testCollectionDetails() throws Throwable { assertEquals(collectionDetailsModelNew.name(), "testString"); assertEquals(collectionDetailsModelNew.description(), "testString"); assertEquals(collectionDetailsModelNew.language(), "en"); + assertEquals(collectionDetailsModelNew.ocrEnabled(), Boolean.valueOf(false)); } @Test(expectedExceptions = IllegalArgumentException.class) diff --git a/discovery/src/test/java/com/ibm/watson/discovery/v2/model/CreateCollectionOptionsTest.java b/discovery/src/test/java/com/ibm/watson/discovery/v2/model/CreateCollectionOptionsTest.java index b8b78bee39..e23dbac338 100644 --- a/discovery/src/test/java/com/ibm/watson/discovery/v2/model/CreateCollectionOptionsTest.java +++ b/discovery/src/test/java/com/ibm/watson/discovery/v2/model/CreateCollectionOptionsTest.java @@ -1,5 +1,5 @@ /* - * (C) Copyright IBM Corp. 2020, 2023. + * (C) Copyright IBM Corp. 2020, 2024. * * Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with * the License. You may obtain a copy of the License at @@ -44,12 +44,14 @@ public void testCreateCollectionOptions() throws Throwable { .name("testString") .description("testString") .language("en") + .ocrEnabled(false) .enrichments(java.util.Arrays.asList(collectionEnrichmentModel)) .build(); assertEquals(createCollectionOptionsModel.projectId(), "testString"); assertEquals(createCollectionOptionsModel.name(), "testString"); assertEquals(createCollectionOptionsModel.description(), "testString"); assertEquals(createCollectionOptionsModel.language(), "en"); + assertEquals(createCollectionOptionsModel.ocrEnabled(), Boolean.valueOf(false)); assertEquals( createCollectionOptionsModel.enrichments(), java.util.Arrays.asList(collectionEnrichmentModel)); diff --git a/discovery/src/test/java/com/ibm/watson/discovery/v2/model/CreateProjectOptionsTest.java b/discovery/src/test/java/com/ibm/watson/discovery/v2/model/CreateProjectOptionsTest.java index 5571c63216..23b9bb5151 100644 --- a/discovery/src/test/java/com/ibm/watson/discovery/v2/model/CreateProjectOptionsTest.java +++ b/discovery/src/test/java/com/ibm/watson/discovery/v2/model/CreateProjectOptionsTest.java @@ -93,11 +93,11 @@ public void testCreateProjectOptions() throws Throwable { CreateProjectOptions createProjectOptionsModel = new CreateProjectOptions.Builder() .name("testString") - .type("document_retrieval") + .type("intelligent_document_processing") .defaultQueryParameters(defaultQueryParamsModel) .build(); assertEquals(createProjectOptionsModel.name(), "testString"); - assertEquals(createProjectOptionsModel.type(), "document_retrieval"); + assertEquals(createProjectOptionsModel.type(), "intelligent_document_processing"); assertEquals(createProjectOptionsModel.defaultQueryParameters(), defaultQueryParamsModel); } diff --git a/discovery/src/test/java/com/ibm/watson/discovery/v2/model/UpdateCollectionOptionsTest.java b/discovery/src/test/java/com/ibm/watson/discovery/v2/model/UpdateCollectionOptionsTest.java index 0b1cba8ba9..d0950f752f 100644 --- a/discovery/src/test/java/com/ibm/watson/discovery/v2/model/UpdateCollectionOptionsTest.java +++ b/discovery/src/test/java/com/ibm/watson/discovery/v2/model/UpdateCollectionOptionsTest.java @@ -1,5 +1,5 @@ /* - * (C) Copyright IBM Corp. 2020, 2022. + * (C) Copyright IBM Corp. 2020, 2024. * * Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with * the License. You may obtain a copy of the License at @@ -44,12 +44,14 @@ public void testUpdateCollectionOptions() throws Throwable { .collectionId("testString") .name("testString") .description("testString") + .ocrEnabled(false) .enrichments(java.util.Arrays.asList(collectionEnrichmentModel)) .build(); assertEquals(updateCollectionOptionsModel.projectId(), "testString"); assertEquals(updateCollectionOptionsModel.collectionId(), "testString"); assertEquals(updateCollectionOptionsModel.name(), "testString"); assertEquals(updateCollectionOptionsModel.description(), "testString"); + assertEquals(updateCollectionOptionsModel.ocrEnabled(), Boolean.valueOf(false)); assertEquals( updateCollectionOptionsModel.enrichments(), java.util.Arrays.asList(collectionEnrichmentModel)); diff --git a/examples/src/main/java/com/ibm/watson/speech_to_text/v1/MicrophoneWithWebSocketsExample.java b/examples/src/main/java/com/ibm/watson/speech_to_text/v1/MicrophoneWithWebSocketsExample.java index 93567b5f4f..d0abae02a5 100644 --- a/examples/src/main/java/com/ibm/watson/speech_to_text/v1/MicrophoneWithWebSocketsExample.java +++ b/examples/src/main/java/com/ibm/watson/speech_to_text/v1/MicrophoneWithWebSocketsExample.java @@ -1,5 +1,5 @@ /* - * (C) Copyright IBM Corp. 2019, 2021. + * (C) Copyright IBM Corp. 2019, 2024. * * Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with * the License. You may obtain a copy of the License at @@ -56,7 +56,6 @@ public static void main(final String[] args) throws Exception { RecognizeWithWebsocketsOptions options = new RecognizeWithWebsocketsOptions.Builder() .audio(audio) - .interimResults(true) .timestamps(true) .wordConfidence(true) // .inactivityTimeout(5) // use this to stop listening when the speaker pauses, i.e. for diff --git a/examples/src/main/java/com/ibm/watson/speech_to_text/v1/RecognizeUsingWebSocketsExample.java b/examples/src/main/java/com/ibm/watson/speech_to_text/v1/RecognizeUsingWebSocketsExample.java index 74925f6f25..1c1ad4301e 100644 --- a/examples/src/main/java/com/ibm/watson/speech_to_text/v1/RecognizeUsingWebSocketsExample.java +++ b/examples/src/main/java/com/ibm/watson/speech_to_text/v1/RecognizeUsingWebSocketsExample.java @@ -1,5 +1,5 @@ /* - * (C) Copyright IBM Corp. 2019, 2021. + * (C) Copyright IBM Corp. 2019, 2024. * * Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with * the License. You may obtain a copy of the License at @@ -38,7 +38,6 @@ public static void main(String[] args) throws FileNotFoundException, Interrupted RecognizeWithWebsocketsOptions options = new RecognizeWithWebsocketsOptions.Builder() .audio(audio) - .interimResults(true) .contentType(HttpMediaType.AUDIO_WAV) .build(); diff --git a/examples/src/main/java/com/ibm/watson/speech_to_text/v1/RecognizeUsingWebSocketsWithSpeakerLabelsExample.java b/examples/src/main/java/com/ibm/watson/speech_to_text/v1/RecognizeUsingWebSocketsWithSpeakerLabelsExample.java index e4281aa593..1106552313 100644 --- a/examples/src/main/java/com/ibm/watson/speech_to_text/v1/RecognizeUsingWebSocketsWithSpeakerLabelsExample.java +++ b/examples/src/main/java/com/ibm/watson/speech_to_text/v1/RecognizeUsingWebSocketsWithSpeakerLabelsExample.java @@ -1,5 +1,5 @@ /* - * (C) Copyright IBM Corp. 2019, 2021. + * (C) Copyright IBM Corp. 2019, 2024. * * Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with * the License. You may obtain a copy of the License at @@ -226,7 +226,6 @@ public static void main(String[] args) throws FileNotFoundException, Interrupted RecognizeWithWebsocketsOptions options = new RecognizeWithWebsocketsOptions.Builder() .audio(audio) - .interimResults(true) .speakerLabels(true) .model(RecognizeOptions.Model.EN_US_NARROWBANDMODEL) .contentType(HttpMediaType.AUDIO_WAV) diff --git a/language-translator/src/test/java/com/ibm/watson/language_translator/v3/LanguageTranslatorIT.java b/language-translator/src/test/java/com/ibm/watson/language_translator/v3/LanguageTranslatorIT.java index b4bb9ff089..8b8d32a1a0 100644 --- a/language-translator/src/test/java/com/ibm/watson/language_translator/v3/LanguageTranslatorIT.java +++ b/language-translator/src/test/java/com/ibm/watson/language_translator/v3/LanguageTranslatorIT.java @@ -1,5 +1,5 @@ /* - * (C) Copyright IBM Corp. 2019, 2023. + * (C) Copyright IBM Corp. 2019, 2024. * * Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with * the License. You may obtain a copy of the License at diff --git a/speech-to-text/README.md b/speech-to-text/README.md index f14a56715c..04fc09c33b 100755 --- a/speech-to-text/README.md +++ b/speech-to-text/README.md @@ -50,7 +50,6 @@ InputStream audio = new FileInputStream("src/test/resources/sample1.wav"); RecognizeOptions options = new RecognizeOptions.Builder() .audio(audio) .contentType(HttpMediaType.AUDIO_WAV) - .interimResults(true) .build(); service.recognizeUsingWebSocket(options, new BaseRecognizeCallback() { diff --git a/speech-to-text/src/main/java/com/ibm/watson/speech_to_text/v1/SpeechToText.java b/speech-to-text/src/main/java/com/ibm/watson/speech_to_text/v1/SpeechToText.java index 55aa1febf0..433fbcd695 100644 --- a/speech-to-text/src/main/java/com/ibm/watson/speech_to_text/v1/SpeechToText.java +++ b/speech-to-text/src/main/java/com/ibm/watson/speech_to_text/v1/SpeechToText.java @@ -113,8 +113,8 @@ * *

Effective **31 July 2023**, all previous-generation models will be removed from the service * and the documentation. Most previous-generation models were deprecated on 15 March 2022. You must - * migrate to the equivalent next-generation model by 31 July 2023. For more information, see - * [Migrating to next-generation + * migrate to the equivalent large speech model or next-generation model by 31 July 2023. For more + * information, see [Migrating to large speech * models](https://cloud.ibm.com/docs/speech-to-text?topic=speech-to-text-models-migrate).{: * deprecated} * @@ -190,8 +190,7 @@ public SpeechToText(String serviceName, Authenticator authenticator) { * Sends audio and returns transcription results for recognition requests over a WebSocket * connection. Requests and responses are enabled over a single TCP connection that abstracts much * of the complexity of the request to offer efficient implementation, low latency, high - * throughput, and an asynchronous response. By default, only final results are returned for any - * request; to enable interim results, set the interimResults parameter to true. + * throughput, and an asynchronous response. * *

The service imposes a data size limit of 100 MB per utterance (per recognition request). You * can send multiple utterances over a single WebSocket connection. The service automatically @@ -372,31 +371,37 @@ public ServiceCall getModel(GetModelOptions getModelOptions) { *

**See also:** [Supported audio * formats](https://cloud.ibm.com/docs/speech-to-text?topic=speech-to-text-audio-formats). * - *

### Next-generation models + *

### Large speech models and Next-generation models * - *

The service supports next-generation `Multimedia` (16 kHz) and `Telephony` (8 kHz) models - * for many languages. Next-generation models have higher throughput than the service's previous - * generation of `Broadband` and `Narrowband` models. When you use next-generation models, the - * service can return transcriptions more quickly and also provide noticeably better transcription - * accuracy. + *

The service supports large speech models and next-generation `Multimedia` (16 kHz) and + * `Telephony` (8 kHz) models for many languages. Large speech models and next-generation models + * have higher throughput than the service's previous generation of `Broadband` and `Narrowband` + * models. When you use large speech models and next-generation models, the service can return + * transcriptions more quickly and also provide noticeably better transcription accuracy. * - *

You specify a next-generation model by using the `model` query parameter, as you do a - * previous-generation model. Most next-generation models support the `low_latency` parameter, and - * all next-generation models support the `character_insertion_bias` parameter. These parameters - * are not available with previous-generation models. + *

You specify a large speech model or next-generation model by using the `model` query + * parameter, as you do a previous-generation model. Only the next-generation models support the + * `low_latency` parameter, and all large speech models and next-generation models support the + * `character_insertion_bias` parameter. These parameters are not available with + * previous-generation models. * - *

Next-generation models do not support all of the speech recognition parameters that are - * available for use with previous-generation models. Next-generation models do not support the - * following parameters: * `acoustic_customization_id` * `keywords` and `keywords_threshold` * - * `processing_metrics` and `processing_metrics_interval` * `word_alternatives_threshold` + *

Large speech models and next-generation models do not support all of the speech recognition + * parameters that are available for use with previous-generation models. Next-generation models + * do not support the following parameters: * `acoustic_customization_id` * `keywords` and + * `keywords_threshold` * `processing_metrics` and `processing_metrics_interval` * + * `word_alternatives_threshold` * *

**Important:** Effective **31 July 2023**, all previous-generation models will be removed * from the service and the documentation. Most previous-generation models were deprecated on 15 - * March 2022. You must migrate to the equivalent next-generation model by 31 July 2023. For more - * information, see [Migrating to next-generation + * March 2022. You must migrate to the equivalent large speech model or next-generation model by + * 31 July 2023. For more information, see [Migrating to large speech * models](https://cloud.ibm.com/docs/speech-to-text?topic=speech-to-text-models-migrate). * - *

**See also:** * [Next-generation languages and + *

**See also:** * [Large speech languages and + * models](https://cloud.ibm.com/docs/speech-to-text?topic=speech-to-text-models-large-speech-languages) + * * [Supported features for large speech + * models](https://cloud.ibm.com/docs/speech-to-text?topic=speech-to-text-models-large-speech-languages#models-lsm-supported-features) + * * [Next-generation languages and * models](https://cloud.ibm.com/docs/speech-to-text?topic=speech-to-text-models-ng) * [Supported * features for next-generation * models](https://cloud.ibm.com/docs/speech-to-text?topic=speech-to-text-models-ng#models-ng-features) @@ -439,6 +444,9 @@ public ServiceCall recognize(RecognizeOptions recogniz if (recognizeOptions.model() != null) { builder.query("model", String.valueOf(recognizeOptions.model())); } + if (recognizeOptions.speechBeginEvent() != null) { + builder.query("speech_begin_event", String.valueOf(recognizeOptions.speechBeginEvent())); + } if (recognizeOptions.languageCustomizationId() != null) { builder.query( "language_customization_id", String.valueOf(recognizeOptions.languageCustomizationId())); @@ -699,31 +707,37 @@ public ServiceCall unregisterCallback(UnregisterCallbackOptions unregister *

**See also:** [Supported audio * formats](https://cloud.ibm.com/docs/speech-to-text?topic=speech-to-text-audio-formats). * - *

### Next-generation models + *

### Large speech models and Next-generation models * - *

The service supports next-generation `Multimedia` (16 kHz) and `Telephony` (8 kHz) models - * for many languages. Next-generation models have higher throughput than the service's previous - * generation of `Broadband` and `Narrowband` models. When you use next-generation models, the - * service can return transcriptions more quickly and also provide noticeably better transcription - * accuracy. + *

The service supports large speech models and next-generation `Multimedia` (16 kHz) and + * `Telephony` (8 kHz) models for many languages. Large speech models and next-generation models + * have higher throughput than the service's previous generation of `Broadband` and `Narrowband` + * models. When you use large speech models and next-generation models, the service can return + * transcriptions more quickly and also provide noticeably better transcription accuracy. * - *

You specify a next-generation model by using the `model` query parameter, as you do a - * previous-generation model. Most next-generation models support the `low_latency` parameter, and - * all next-generation models support the `character_insertion_bias` parameter. These parameters - * are not available with previous-generation models. + *

You specify a large speech model or next-generation model by using the `model` query + * parameter, as you do a previous-generation model. Only the next-generation models support the + * `low_latency` parameter, and all large speech models and next-generation models support the + * `character_insertion_bias` parameter. These parameters are not available with + * previous-generation models. * - *

Next-generation models do not support all of the speech recognition parameters that are - * available for use with previous-generation models. Next-generation models do not support the - * following parameters: * `acoustic_customization_id` * `keywords` and `keywords_threshold` * - * `processing_metrics` and `processing_metrics_interval` * `word_alternatives_threshold` + *

Large speech models and next-generation models do not support all of the speech recognition + * parameters that are available for use with previous-generation models. Next-generation models + * do not support the following parameters: * `acoustic_customization_id` * `keywords` and + * `keywords_threshold` * `processing_metrics` and `processing_metrics_interval` * + * `word_alternatives_threshold` * *

**Important:** Effective **31 July 2023**, all previous-generation models will be removed * from the service and the documentation. Most previous-generation models were deprecated on 15 - * March 2022. You must migrate to the equivalent next-generation model by 31 July 2023. For more - * information, see [Migrating to next-generation + * March 2022. You must migrate to the equivalent large speech model or next-generation model by + * 31 July 2023. For more information, see [Migrating to large speech * models](https://cloud.ibm.com/docs/speech-to-text?topic=speech-to-text-models-migrate). * - *

**See also:** * [Next-generation languages and + *

**See also:** * [Large speech languages and + * models](https://cloud.ibm.com/docs/speech-to-text?topic=speech-to-text-models-large-speech-languages) + * * [Supported features for large speech + * models](https://cloud.ibm.com/docs/speech-to-text?topic=speech-to-text-models-large-speech-languages#models-lsm-supported-features) + * * [Next-generation languages and * models](https://cloud.ibm.com/docs/speech-to-text?topic=speech-to-text-models-ng) * [Supported * features for next-generation * models](https://cloud.ibm.com/docs/speech-to-text?topic=speech-to-text-models-ng#models-ng-features). @@ -994,14 +1008,49 @@ public ServiceCall deleteJob(DeleteJobOptions deleteJobOptions) { * *

**Important:** Effective **31 July 2023**, all previous-generation models will be removed * from the service and the documentation. Most previous-generation models were deprecated on 15 - * March 2022. You must migrate to the equivalent next-generation model by 31 July 2023. For more - * information, see [Migrating to next-generation + * March 2022. You must migrate to the equivalent large speech model or next-generation model by + * 31 July 2023. For more information, see [Migrating to large speech * models](https://cloud.ibm.com/docs/speech-to-text?topic=speech-to-text-models-migrate). * *

**See also:** * [Create a custom language * model](https://cloud.ibm.com/docs/speech-to-text?topic=speech-to-text-languageCreate#createModel-language) * * [Language support for - * customization](https://cloud.ibm.com/docs/speech-to-text?topic=speech-to-text-custom-support). + * customization](https://cloud.ibm.com/docs/speech-to-text?topic=speech-to-text-custom-support) + * + *

### Large speech models and Next-generation models + * + *

The service supports large speech models and next-generation `Multimedia` (16 kHz) and + * `Telephony` (8 kHz) models for many languages. Large speech models and next-generation models + * have higher throughput than the service's previous generation of `Broadband` and `Narrowband` + * models. When you use large speech models and next-generation models, the service can return + * transcriptions more quickly and also provide noticeably better transcription accuracy. + * + *

You specify a large speech model or next-generation model by using the `model` query + * parameter, as you do a previous-generation model. Only the next-generation models support the + * `low_latency` parameter, and all large speech models and next-generation models support the + * `character_insertion_bias` parameter. These parameters are not available with + * previous-generation models. + * + *

Large speech models and next-generation models do not support all of the speech recognition + * parameters that are available for use with previous-generation models. Next-generation models + * do not support the following parameters: * `acoustic_customization_id` * `keywords` and + * `keywords_threshold` * `processing_metrics` and `processing_metrics_interval` * + * `word_alternatives_threshold` + * + *

**Important:** Effective **31 July 2023**, all previous-generation models will be removed + * from the service and the documentation. Most previous-generation models were deprecated on 15 + * March 2022. You must migrate to the equivalent large speech model or next-generation model by + * 31 July 2023. For more information, see [Migrating to large speech + * models](https://cloud.ibm.com/docs/speech-to-text?topic=speech-to-text-models-migrate). + * + *

**See also:** * [Large speech languages and + * models](https://cloud.ibm.com/docs/speech-to-text?topic=speech-to-text-models-large-speech-languages) + * * [Supported features for large speech + * models](https://cloud.ibm.com/docs/speech-to-text?topic=speech-to-text-models-large-speech-languages#models-lsm-supported-features) + * * [Next-generation languages and + * models](https://cloud.ibm.com/docs/speech-to-text?topic=speech-to-text-models-ng) * [Supported + * features for next-generation + * models](https://cloud.ibm.com/docs/speech-to-text?topic=speech-to-text-models-ng#models-ng-features). * * @param createLanguageModelOptions the {@link CreateLanguageModelOptions} containing the options * for the call @@ -1403,6 +1452,10 @@ public ServiceCall listCorpora(ListCorporaOptions listCorporaOptions) { * until the service's analysis of the corpus for the current request completes. Use the [Get a * corpus](#getcorpus) method to check the status of the analysis. * + *

_For custom models that are based on large speech models_, the service parses and extracts + * word sequences from one or multiple corpora files. The characters help the service learn and + * predict character sequences from audio. + * *

_For custom models that are based on previous-generation models_, the service auto-populates * the model's words resource with words from the corpus that are not found in its base * vocabulary. These words are referred to as out-of-vocabulary (OOV) words. After adding a @@ -1429,11 +1482,11 @@ public ServiceCall listCorpora(ListCorporaOptions listCorporaOptions) { * model](https://cloud.ibm.com/docs/speech-to-text?topic=speech-to-text-languageCreate#addCorpus) * * [Working with corpora for previous-generation * models](https://cloud.ibm.com/docs/speech-to-text?topic=speech-to-text-corporaWords#workingCorpora) - * * [Working with corpora for next-generation + * * [Working with corpora for large speech models and next-generation * models](https://cloud.ibm.com/docs/speech-to-text?topic=speech-to-text-corporaWords-ng#workingCorpora-ng) * * [Validating a words resource for previous-generation * models](https://cloud.ibm.com/docs/speech-to-text?topic=speech-to-text-corporaWords#validateModel) - * * [Validating a words resource for next-generation + * * [Validating a words resource for large speech models and next-generation * models](https://cloud.ibm.com/docs/speech-to-text?topic=speech-to-text-corporaWords-ng#validateModel-ng). * * @param addCorpusOptions the {@link AddCorpusOptions} containing the options for the call @@ -1657,11 +1710,11 @@ public ServiceCall listWords(ListWordsOptions listWordsOptions) { * model](https://cloud.ibm.com/docs/speech-to-text?topic=speech-to-text-languageCreate#addWords) * * [Working with custom words for previous-generation * models](https://cloud.ibm.com/docs/speech-to-text?topic=speech-to-text-corporaWords#workingWords) - * * [Working with custom words for next-generation + * * [Working with custom words for large speech models and next-generation * models](https://cloud.ibm.com/docs/speech-to-text?topic=speech-to-text-corporaWords-ng#workingWords-ng) * * [Validating a words resource for previous-generation * models](https://cloud.ibm.com/docs/speech-to-text?topic=speech-to-text-corporaWords#validateModel) - * * [Validating a words resource for next-generation + * * [Validating a words resource for large speech models and next-generation * models](https://cloud.ibm.com/docs/speech-to-text?topic=speech-to-text-corporaWords-ng#validateModel-ng). * * @param addWordsOptions the {@link AddWordsOptions} containing the options for the call @@ -1732,11 +1785,11 @@ public ServiceCall addWords(AddWordsOptions addWordsOptions) { * model](https://cloud.ibm.com/docs/speech-to-text?topic=speech-to-text-languageCreate#addWords) * * [Working with custom words for previous-generation * models](https://cloud.ibm.com/docs/speech-to-text?topic=speech-to-text-corporaWords#workingWords) - * * [Working with custom words for next-generation + * * [Working with custom words for large speech models and next-generation * models](https://cloud.ibm.com/docs/speech-to-text?topic=speech-to-text-corporaWords-ng#workingWords-ng) * * [Validating a words resource for previous-generation * models](https://cloud.ibm.com/docs/speech-to-text?topic=speech-to-text-corporaWords#validateModel) - * * [Validating a words resource for next-generation + * * [Validating a words resource for large speech models and next-generation * models](https://cloud.ibm.com/docs/speech-to-text?topic=speech-to-text-corporaWords-ng#validateModel-ng). * * @param addWordOptions the {@link AddWordOptions} containing the options for the call @@ -2057,12 +2110,12 @@ public ServiceCall deleteGrammar(DeleteGrammarOptions deleteGrammarOptions * but you cannot create any more until your model count is below the limit. * *

**Note:** Acoustic model customization is supported only for use with previous-generation - * models. It is not supported for next-generation models. + * models. It is not supported for large speech models and next-generation models. * *

**Important:** Effective **31 July 2023**, all previous-generation models will be removed * from the service and the documentation. Most previous-generation models were deprecated on 15 - * March 2022. You must migrate to the equivalent next-generation model by 31 July 2023. For more - * information, see [Migrating to next-generation + * March 2022. You must migrate to the equivalent large speech model or next-generation model by + * 31 July 2023. For more information, see [Migrating to large speech * models](https://cloud.ibm.com/docs/speech-to-text?topic=speech-to-text-models-migrate). * *

**See also:** [Create a custom acoustic @@ -2107,7 +2160,7 @@ public ServiceCall createAcousticModel( * credentials for the instance of the service that owns a model to list information about it. * *

**Note:** Acoustic model customization is supported only for use with previous-generation - * models. It is not supported for next-generation models. + * models. It is not supported for large speech models and next-generation models. * *

**See also:** [Listing custom acoustic * models](https://cloud.ibm.com/docs/speech-to-text?topic=speech-to-text-manageAcousticModels#listModels-acoustic). @@ -2148,7 +2201,7 @@ public ServiceCall listAcousticModels( * credentials for the instance of the service that owns a model to list information about it. * *

**Note:** Acoustic model customization is supported only for use with previous-generation - * models. It is not supported for next-generation models. + * models. It is not supported for large speech models and next-generation models. * *

**See also:** [Listing custom acoustic * models](https://cloud.ibm.com/docs/speech-to-text?topic=speech-to-text-manageAcousticModels#listModels-acoustic). @@ -2166,7 +2219,7 @@ public ServiceCall listAcousticModels() { * instance of the service that owns a model to list information about it. * *

**Note:** Acoustic model customization is supported only for use with previous-generation - * models. It is not supported for next-generation models. + * models. It is not supported for large speech models and next-generation models. * *

**See also:** [Listing custom acoustic * models](https://cloud.ibm.com/docs/speech-to-text?topic=speech-to-text-manageAcousticModels#listModels-acoustic). @@ -2205,7 +2258,7 @@ public ServiceCall getAcousticModel( * use credentials for the instance of the service that owns a model to delete it. * *

**Note:** Acoustic model customization is supported only for use with previous-generation - * models. It is not supported for next-generation models. + * models. It is not supported for large speech models and next-generation models. * *

**See also:** [Deleting a custom acoustic * model](https://cloud.ibm.com/docs/speech-to-text?topic=speech-to-text-manageAcousticModels#deleteModel-acoustic). @@ -2268,7 +2321,7 @@ public ServiceCall deleteAcousticModel( * fully trained and available. * *

**Note:** Acoustic model customization is supported only for use with previous-generation - * models. It is not supported for next-generation models. + * models. It is not supported for large speech models and next-generation models. * *

**See also:** * [Train the custom acoustic * model](https://cloud.ibm.com/docs/speech-to-text?topic=speech-to-text-acoustic#trainModel-acoustic) @@ -2342,7 +2395,7 @@ public ServiceCall trainAcousticModel( * owns a model to reset it. * *

**Note:** Acoustic model customization is supported only for use with previous-generation - * models. It is not supported for next-generation models. + * models. It is not supported for large speech models and next-generation models. * *

**See also:** [Resetting a custom acoustic * model](https://cloud.ibm.com/docs/speech-to-text?topic=speech-to-text-manageAcousticModels#resetModel-acoustic). @@ -2400,7 +2453,7 @@ public ServiceCall resetAcousticModel(ResetAcousticModelOptions resetAcous * language model. * *

**Note:** Acoustic model customization is supported only for use with previous-generation - * models. It is not supported for next-generation models. + * models. It is not supported for large speech models and next-generation models. * *

**See also:** [Upgrading a custom acoustic * model](https://cloud.ibm.com/docs/speech-to-text?topic=speech-to-text-custom-upgrade#custom-upgrade-acoustic). @@ -2450,7 +2503,7 @@ public ServiceCall upgradeAcousticModel( * audio resources. * *

**Note:** Acoustic model customization is supported only for use with previous-generation - * models. It is not supported for next-generation models. + * models. It is not supported for large speech models and next-generation models. * *

**See also:** [Listing audio resources for a custom acoustic * model](https://cloud.ibm.com/docs/speech-to-text?topic=speech-to-text-manageAudio#listAudio). @@ -2521,7 +2574,7 @@ public ServiceCall listAudio(ListAudioOptions listAudioOptions) * becomes `ok`. * *

**Note:** Acoustic model customization is supported only for use with previous-generation - * models. It is not supported for next-generation models. + * models. It is not supported for large speech models and next-generation models. * *

**See also:** [Add audio to the custom acoustic * model](https://cloud.ibm.com/docs/speech-to-text?topic=speech-to-text-acoustic#addAudio). @@ -2631,7 +2684,7 @@ public ServiceCall addAudio(AddAudioOptions addAudioOptions) { * resources. * *

**Note:** Acoustic model customization is supported only for use with previous-generation - * models. It is not supported for next-generation models. + * models. It is not supported for large speech models and next-generation models. * *

**See also:** [Listing audio resources for a custom acoustic * model](https://cloud.ibm.com/docs/speech-to-text?topic=speech-to-text-manageAudio#listAudio). @@ -2676,7 +2729,7 @@ public ServiceCall getAudio(GetAudioOptions getAudioOptions) { * audio resources. * *

**Note:** Acoustic model customization is supported only for use with previous-generation - * models. It is not supported for next-generation models. + * models. It is not supported for large speech models and next-generation models. * *

**See also:** [Deleting an audio resource from a custom acoustic * model](https://cloud.ibm.com/docs/speech-to-text?topic=speech-to-text-manageAudio#deleteAudio). diff --git a/speech-to-text/src/main/java/com/ibm/watson/speech_to_text/v1/model/Corpus.java b/speech-to-text/src/main/java/com/ibm/watson/speech_to_text/v1/model/Corpus.java index c67051d400..4f691fb23d 100644 --- a/speech-to-text/src/main/java/com/ibm/watson/speech_to_text/v1/model/Corpus.java +++ b/speech-to-text/src/main/java/com/ibm/watson/speech_to_text/v1/model/Corpus.java @@ -1,5 +1,5 @@ /* - * (C) Copyright IBM Corp. 2016, 2023. + * (C) Copyright IBM Corp. 2016, 2024. * * Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with * the License. You may obtain a copy of the License at @@ -73,8 +73,9 @@ public Long getTotalWords() { /** * Gets the outOfVocabularyWords. * - *

_For custom models that are based on previous-generation models_, the number of OOV words - * extracted from the corpus. The value is `0` while the corpus is being processed. + *

_For custom models that are based on large speech models and previous-generation models_, + * the number of OOV words extracted from the corpus. The value is `0` while the corpus is being + * processed. * *

_For custom models that are based on next-generation models_, no OOV words are extracted * from corpora, so the value is always `0`. diff --git a/speech-to-text/src/main/java/com/ibm/watson/speech_to_text/v1/model/CreateJobOptions.java b/speech-to-text/src/main/java/com/ibm/watson/speech_to_text/v1/model/CreateJobOptions.java index 6508138f67..17661b801d 100644 --- a/speech-to-text/src/main/java/com/ibm/watson/speech_to_text/v1/model/CreateJobOptions.java +++ b/speech-to-text/src/main/java/com/ibm/watson/speech_to_text/v1/model/CreateJobOptions.java @@ -51,6 +51,8 @@ public interface Model { String DE_DE_NARROWBANDMODEL = "de-DE_NarrowbandModel"; /** de-DE_Telephony. */ String DE_DE_TELEPHONY = "de-DE_Telephony"; + /** en-AU. */ + String EN_AU = "en-AU"; /** en-AU_BroadbandModel. */ String EN_AU_BROADBANDMODEL = "en-AU_BroadbandModel"; /** en-AU_Multimedia. */ @@ -59,8 +61,12 @@ public interface Model { String EN_AU_NARROWBANDMODEL = "en-AU_NarrowbandModel"; /** en-AU_Telephony. */ String EN_AU_TELEPHONY = "en-AU_Telephony"; + /** en-IN. */ + String EN_IN = "en-IN"; /** en-IN_Telephony. */ String EN_IN_TELEPHONY = "en-IN_Telephony"; + /** en-GB. */ + String EN_GB = "en-GB"; /** en-GB_BroadbandModel. */ String EN_GB_BROADBANDMODEL = "en-GB_BroadbandModel"; /** en-GB_Multimedia. */ @@ -69,6 +75,8 @@ public interface Model { String EN_GB_NARROWBANDMODEL = "en-GB_NarrowbandModel"; /** en-GB_Telephony. */ String EN_GB_TELEPHONY = "en-GB_Telephony"; + /** en-US. */ + String EN_US = "en-US"; /** en-US_BroadbandModel. */ String EN_US_BROADBANDMODEL = "en-US_BroadbandModel"; /** en-US_Multimedia. */ @@ -111,6 +119,8 @@ public interface Model { String ES_PE_BROADBANDMODEL = "es-PE_BroadbandModel"; /** es-PE_NarrowbandModel. */ String ES_PE_NARROWBANDMODEL = "es-PE_NarrowbandModel"; + /** fr-CA. */ + String FR_CA = "fr-CA"; /** fr-CA_BroadbandModel. */ String FR_CA_BROADBANDMODEL = "fr-CA_BroadbandModel"; /** fr-CA_Multimedia. */ @@ -119,6 +129,8 @@ public interface Model { String FR_CA_NARROWBANDMODEL = "fr-CA_NarrowbandModel"; /** fr-CA_Telephony. */ String FR_CA_TELEPHONY = "fr-CA_Telephony"; + /** fr-FR. */ + String FR_FR = "fr-FR"; /** fr-FR_BroadbandModel. */ String FR_FR_BROADBANDMODEL = "fr-FR_BroadbandModel"; /** fr-FR_Multimedia. */ @@ -137,6 +149,8 @@ public interface Model { String IT_IT_MULTIMEDIA = "it-IT_Multimedia"; /** it-IT_Telephony. */ String IT_IT_TELEPHONY = "it-IT_Telephony"; + /** ja-JP. */ + String JA_JP = "ja-JP"; /** ja-JP_BroadbandModel. */ String JA_JP_BROADBANDMODEL = "ja-JP_BroadbandModel"; /** ja-JP_Multimedia. */ @@ -952,9 +966,9 @@ public String baseModelVersion() { * custom language model compared to those from the base model for the current request. * *

Specify a value between 0.0 and 1.0. Unless a different customization weight was specified - * for the custom model when the model was trained, the default value is: * 0.3 for - * previous-generation models * 0.2 for most next-generation models * 0.1 for next-generation - * English and Japanese models + * for the custom model when the model was trained, the default value is: * 0.5 for large speech + * models * 0.3 for previous-generation models * 0.2 for most next-generation models * 0.1 for + * next-generation English and Japanese models * *

A customization weight that you specify overrides a weight that was specified when the * custom model was trained. The default value yields the best performance in general. Assign a @@ -1117,8 +1131,8 @@ public Boolean smartFormatting() { /** * Gets the smartFormattingVersion. * - *

Smart formatting version is for next-generation models and that is supported in US English, - * Brazilian Portuguese, French and German languages. + *

Smart formatting version for large speech models and next-generation models is supported in + * US English, Brazilian Portuguese, French, German, Spanish and French Canadian languages. * * @return the smartFormattingVersion */ @@ -1135,8 +1149,8 @@ public Long smartFormattingVersion() { * of whether you specify `false` for the parameter. * _For previous-generation models,_ the * parameter can be used with Australian English, US English, German, Japanese, Korean, and * Spanish (both broadband and narrowband models) and UK English (narrowband model) transcription - * only. * _For next-generation models,_ the parameter can be used with Czech, English - * (Australian, Indian, UK, and US), German, Japanese, Korean, and Spanish transcription only. + * only. * _For large speech models and next-generation models,_ the parameter can be used with + * all available languages. * *

See [Speaker * labels](https://cloud.ibm.com/docs/speech-to-text?topic=speech-to-text-speaker-labels). @@ -1310,8 +1324,8 @@ public Boolean splitTranscriptAtPhraseEnd() { *

The values increase on a monotonic curve. Specifying one or two decimal places of precision * (for example, `0.55`) is typically more than sufficient. * - *

The parameter is supported with all next-generation models and with most previous-generation - * models. See [Speech detector + *

The parameter is supported with all large speech models, next-generation models and with + * most previous-generation models. See [Speech detector * sensitivity](https://cloud.ibm.com/docs/speech-to-text?topic=speech-to-text-detection#detection-parameters-sensitivity) * and [Language model * support](https://cloud.ibm.com/docs/speech-to-text?topic=speech-to-text-detection#detection-support). @@ -1336,8 +1350,8 @@ public Float speechDetectorSensitivity() { *

The values increase on a monotonic curve. Specifying one or two decimal places of precision * (for example, `0.55`) is typically more than sufficient. * - *

The parameter is supported with all next-generation models and with most previous-generation - * models. See [Background audio + *

The parameter is supported with all large speech models, next-generation models and with + * most previous-generation models. See [Background audio * suppression](https://cloud.ibm.com/docs/speech-to-text?topic=speech-to-text-detection#detection-parameters-suppression) * and [Language model * support](https://cloud.ibm.com/docs/speech-to-text?topic=speech-to-text-detection#detection-support). @@ -1357,9 +1371,9 @@ public Float backgroundAudioSuppression() { * parameter causes the models to produce results even more quickly, though the results might be * less accurate when the parameter is used. * - *

The parameter is not available for previous-generation `Broadband` and `Narrowband` models. - * It is available for most next-generation models. * For a list of next-generation models that - * support low latency, see [Supported next-generation language + *

The parameter is not available for large speech models and previous-generation `Broadband` + * and `Narrowband` models. It is available for most next-generation models. * For a list of + * next-generation models that support low latency, see [Supported next-generation language * models](https://cloud.ibm.com/docs/speech-to-text?topic=speech-to-text-models-ng#models-ng-supported). * * For more information about the `low_latency` parameter, see [Low * latency](https://cloud.ibm.com/docs/speech-to-text?topic=speech-to-text-interim#low-latency). @@ -1373,9 +1387,10 @@ public Boolean lowLatency() { /** * Gets the characterInsertionBias. * - *

For next-generation models, an indication of whether the service is biased to recognize - * shorter or longer strings of characters when developing transcription hypotheses. By default, - * the service is optimized to produce the best balance of strings of different lengths. + *

For large speech models and next-generation models, an indication of whether the service is + * biased to recognize shorter or longer strings of characters when developing transcription + * hypotheses. By default, the service is optimized to produce the best balance of strings of + * different lengths. * *

The default bias is 0.0. The allowable range of values is -1.0 to 1.0. * Negative values * bias the service to favor hypotheses with shorter strings of characters. * Positive values bias diff --git a/speech-to-text/src/main/java/com/ibm/watson/speech_to_text/v1/model/CreateLanguageModelOptions.java b/speech-to-text/src/main/java/com/ibm/watson/speech_to_text/v1/model/CreateLanguageModelOptions.java index e6922f9a05..2538ef3366 100644 --- a/speech-to-text/src/main/java/com/ibm/watson/speech_to_text/v1/model/CreateLanguageModelOptions.java +++ b/speech-to-text/src/main/java/com/ibm/watson/speech_to_text/v1/model/CreateLanguageModelOptions.java @@ -1,5 +1,5 @@ /* - * (C) Copyright IBM Corp. 2018, 2023. + * (C) Copyright IBM Corp. 2018, 2024. * * Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with * the License. You may obtain a copy of the License at @@ -39,6 +39,8 @@ public interface BaseModelName { String DE_DE_NARROWBANDMODEL = "de-DE_NarrowbandModel"; /** de-DE_Telephony. */ String DE_DE_TELEPHONY = "de-DE_Telephony"; + /** en-AU. */ + String EN_AU = "en-AU"; /** en-AU_BroadbandModel. */ String EN_AU_BROADBANDMODEL = "en-AU_BroadbandModel"; /** en-AU_Multimedia. */ @@ -47,6 +49,8 @@ public interface BaseModelName { String EN_AU_NARROWBANDMODEL = "en-AU_NarrowbandModel"; /** en-AU_Telephony. */ String EN_AU_TELEPHONY = "en-AU_Telephony"; + /** en-GB. */ + String EN_GB = "en-GB"; /** en-GB_BroadbandModel. */ String EN_GB_BROADBANDMODEL = "en-GB_BroadbandModel"; /** en-GB_Multimedia. */ @@ -55,8 +59,12 @@ public interface BaseModelName { String EN_GB_NARROWBANDMODEL = "en-GB_NarrowbandModel"; /** en-GB_Telephony. */ String EN_GB_TELEPHONY = "en-GB_Telephony"; + /** en-IN. */ + String EN_IN = "en-IN"; /** en-IN_Telephony. */ String EN_IN_TELEPHONY = "en-IN_Telephony"; + /** en-US. */ + String EN_US = "en-US"; /** en-US_BroadbandModel. */ String EN_US_BROADBANDMODEL = "en-US_BroadbandModel"; /** en-US_Multimedia. */ @@ -99,6 +107,8 @@ public interface BaseModelName { String ES_PE_BROADBANDMODEL = "es-PE_BroadbandModel"; /** es-PE_NarrowbandModel. */ String ES_PE_NARROWBANDMODEL = "es-PE_NarrowbandModel"; + /** fr-CA. */ + String FR_CA = "fr-CA"; /** fr-CA_BroadbandModel. */ String FR_CA_BROADBANDMODEL = "fr-CA_BroadbandModel"; /** fr-CA_Multimedia. */ @@ -107,6 +117,8 @@ public interface BaseModelName { String FR_CA_NARROWBANDMODEL = "fr-CA_NarrowbandModel"; /** fr-CA_Telephony. */ String FR_CA_TELEPHONY = "fr-CA_Telephony"; + /** fr-FR. */ + String FR_FR = "fr-FR"; /** fr-FR_BroadbandModel. */ String FR_FR_BROADBANDMODEL = "fr-FR_BroadbandModel"; /** fr-FR_Multimedia. */ @@ -125,6 +137,8 @@ public interface BaseModelName { String IT_IT_MULTIMEDIA = "it-IT_Multimedia"; /** it-IT_Telephony. */ String IT_IT_TELEPHONY = "it-IT_Telephony"; + /** ja-JP. */ + String JA_JP = "ja-JP"; /** ja-JP_BroadbandModel. */ String JA_JP_BROADBANDMODEL = "ja-JP_BroadbandModel"; /** ja-JP_Multimedia. */ diff --git a/speech-to-text/src/main/java/com/ibm/watson/speech_to_text/v1/model/GetModelOptions.java b/speech-to-text/src/main/java/com/ibm/watson/speech_to_text/v1/model/GetModelOptions.java index 58d75de720..26ff76eb4a 100644 --- a/speech-to-text/src/main/java/com/ibm/watson/speech_to_text/v1/model/GetModelOptions.java +++ b/speech-to-text/src/main/java/com/ibm/watson/speech_to_text/v1/model/GetModelOptions.java @@ -1,5 +1,5 @@ /* - * (C) Copyright IBM Corp. 2018, 2023. + * (C) Copyright IBM Corp. 2018, 2024. * * Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with * the License. You may obtain a copy of the License at @@ -36,6 +36,8 @@ public interface ModelId { String DE_DE_NARROWBANDMODEL = "de-DE_NarrowbandModel"; /** de-DE_Telephony. */ String DE_DE_TELEPHONY = "de-DE_Telephony"; + /** en-AU. */ + String EN_AU = "en-AU"; /** en-AU_BroadbandModel. */ String EN_AU_BROADBANDMODEL = "en-AU_BroadbandModel"; /** en-AU_Multimedia. */ @@ -44,6 +46,8 @@ public interface ModelId { String EN_AU_NARROWBANDMODEL = "en-AU_NarrowbandModel"; /** en-AU_Telephony. */ String EN_AU_TELEPHONY = "en-AU_Telephony"; + /** en-GB. */ + String EN_GB = "en-GB"; /** en-GB_BroadbandModel. */ String EN_GB_BROADBANDMODEL = "en-GB_BroadbandModel"; /** en-GB_Multimedia. */ @@ -52,8 +56,12 @@ public interface ModelId { String EN_GB_NARROWBANDMODEL = "en-GB_NarrowbandModel"; /** en-GB_Telephony. */ String EN_GB_TELEPHONY = "en-GB_Telephony"; + /** en-IN. */ + String EN_IN = "en-IN"; /** en-IN_Telephony. */ String EN_IN_TELEPHONY = "en-IN_Telephony"; + /** en-US. */ + String EN_US = "en-US"; /** en-US_BroadbandModel. */ String EN_US_BROADBANDMODEL = "en-US_BroadbandModel"; /** en-US_Multimedia. */ @@ -96,6 +104,8 @@ public interface ModelId { String ES_PE_BROADBANDMODEL = "es-PE_BroadbandModel"; /** es-PE_NarrowbandModel. */ String ES_PE_NARROWBANDMODEL = "es-PE_NarrowbandModel"; + /** fr-CA. */ + String FR_CA = "fr-CA"; /** fr-CA_BroadbandModel. */ String FR_CA_BROADBANDMODEL = "fr-CA_BroadbandModel"; /** fr-CA_Multimedia. */ @@ -104,6 +114,8 @@ public interface ModelId { String FR_CA_NARROWBANDMODEL = "fr-CA_NarrowbandModel"; /** fr-CA_Telephony. */ String FR_CA_TELEPHONY = "fr-CA_Telephony"; + /** fr-FR. */ + String FR_FR = "fr-FR"; /** fr-FR_BroadbandModel. */ String FR_FR_BROADBANDMODEL = "fr-FR_BroadbandModel"; /** fr-FR_Multimedia. */ @@ -122,6 +134,8 @@ public interface ModelId { String IT_IT_MULTIMEDIA = "it-IT_Multimedia"; /** it-IT_Telephony. */ String IT_IT_TELEPHONY = "it-IT_Telephony"; + /** ja-JP. */ + String JA_JP = "ja-JP"; /** ja-JP_BroadbandModel. */ String JA_JP_BROADBANDMODEL = "ja-JP_BroadbandModel"; /** ja-JP_Multimedia. */ diff --git a/speech-to-text/src/main/java/com/ibm/watson/speech_to_text/v1/model/RecognizeOptions.java b/speech-to-text/src/main/java/com/ibm/watson/speech_to_text/v1/model/RecognizeOptions.java index 94476fbdb5..443c176c3a 100644 --- a/speech-to-text/src/main/java/com/ibm/watson/speech_to_text/v1/model/RecognizeOptions.java +++ b/speech-to-text/src/main/java/com/ibm/watson/speech_to_text/v1/model/RecognizeOptions.java @@ -51,6 +51,8 @@ public interface Model { String DE_DE_NARROWBANDMODEL = "de-DE_NarrowbandModel"; /** de-DE_Telephony. */ String DE_DE_TELEPHONY = "de-DE_Telephony"; + /** en-AU. */ + String EN_AU = "en-AU"; /** en-AU_BroadbandModel. */ String EN_AU_BROADBANDMODEL = "en-AU_BroadbandModel"; /** en-AU_Multimedia. */ @@ -59,8 +61,12 @@ public interface Model { String EN_AU_NARROWBANDMODEL = "en-AU_NarrowbandModel"; /** en-AU_Telephony. */ String EN_AU_TELEPHONY = "en-AU_Telephony"; + /** en-IN. */ + String EN_IN = "en-IN"; /** en-IN_Telephony. */ String EN_IN_TELEPHONY = "en-IN_Telephony"; + /** en-GB. */ + String EN_GB = "en-GB"; /** en-GB_BroadbandModel. */ String EN_GB_BROADBANDMODEL = "en-GB_BroadbandModel"; /** en-GB_Multimedia. */ @@ -69,6 +75,8 @@ public interface Model { String EN_GB_NARROWBANDMODEL = "en-GB_NarrowbandModel"; /** en-GB_Telephony. */ String EN_GB_TELEPHONY = "en-GB_Telephony"; + /** en-US. */ + String EN_US = "en-US"; /** en-US_BroadbandModel. */ String EN_US_BROADBANDMODEL = "en-US_BroadbandModel"; /** en-US_Multimedia. */ @@ -111,6 +119,8 @@ public interface Model { String ES_PE_BROADBANDMODEL = "es-PE_BroadbandModel"; /** es-PE_NarrowbandModel. */ String ES_PE_NARROWBANDMODEL = "es-PE_NarrowbandModel"; + /** fr-CA. */ + String FR_CA = "fr-CA"; /** fr-CA_BroadbandModel. */ String FR_CA_BROADBANDMODEL = "fr-CA_BroadbandModel"; /** fr-CA_Multimedia. */ @@ -119,6 +129,8 @@ public interface Model { String FR_CA_NARROWBANDMODEL = "fr-CA_NarrowbandModel"; /** fr-CA_Telephony. */ String FR_CA_TELEPHONY = "fr-CA_Telephony"; + /** fr-FR. */ + String FR_FR = "fr-FR"; /** fr-FR_BroadbandModel. */ String FR_FR_BROADBANDMODEL = "fr-FR_BroadbandModel"; /** fr-FR_Multimedia. */ @@ -137,6 +149,8 @@ public interface Model { String IT_IT_MULTIMEDIA = "it-IT_Multimedia"; /** it-IT_Telephony. */ String IT_IT_TELEPHONY = "it-IT_Telephony"; + /** ja-JP. */ + String JA_JP = "ja-JP"; /** ja-JP_BroadbandModel. */ String JA_JP_BROADBANDMODEL = "ja-JP_BroadbandModel"; /** ja-JP_Multimedia. */ @@ -184,6 +198,7 @@ public interface Model { protected InputStream audio; protected String contentType; protected String model; + protected Boolean speechBeginEvent; protected String languageCustomizationId; protected String acousticCustomizationId; protected String baseModelVersion; @@ -214,6 +229,7 @@ public static class Builder { private InputStream audio; private String contentType; private String model; + private Boolean speechBeginEvent; private String languageCustomizationId; private String acousticCustomizationId; private String baseModelVersion; @@ -248,6 +264,7 @@ private Builder(RecognizeOptions recognizeOptions) { this.audio = recognizeOptions.audio; this.contentType = recognizeOptions.contentType; this.model = recognizeOptions.model; + this.speechBeginEvent = recognizeOptions.speechBeginEvent; this.languageCustomizationId = recognizeOptions.languageCustomizationId; this.acousticCustomizationId = recognizeOptions.acousticCustomizationId; this.baseModelVersion = recognizeOptions.baseModelVersion; @@ -343,6 +360,17 @@ public Builder model(String model) { return this; } + /** + * Set the speechBeginEvent. + * + * @param speechBeginEvent the speechBeginEvent + * @return the RecognizeOptions builder + */ + public Builder speechBeginEvent(Boolean speechBeginEvent) { + this.speechBeginEvent = speechBeginEvent; + return this; + } + /** * Set the languageCustomizationId. * @@ -627,6 +655,7 @@ protected RecognizeOptions(Builder builder) { audio = builder.audio; contentType = builder.contentType; model = builder.model; + speechBeginEvent = builder.speechBeginEvent; languageCustomizationId = builder.languageCustomizationId; acousticCustomizationId = builder.acousticCustomizationId; baseModelVersion = builder.baseModelVersion; @@ -706,6 +735,22 @@ public String model() { return model; } + /** + * Gets the speechBeginEvent. + * + *

If `true`, the service returns a response object `SpeechActivity` which contains the time + * when a speech activity is detected in the stream. This can be used both in standard and low + * latency mode. This feature enables client applications to know that some words/speech has been + * detected and the service is in the process of decoding. This can be used in lieu of interim + * results in standard mode. See [Using speech recognition + * parameters](https://cloud.ibm.com/docs/speech-to-text?topic=speech-to-text-service-features#features-parameters). + * + * @return the speechBeginEvent + */ + public Boolean speechBeginEvent() { + return speechBeginEvent; + } + /** * Gets the languageCustomizationId. * @@ -764,9 +809,9 @@ public String baseModelVersion() { * custom language model compared to those from the base model for the current request. * *

Specify a value between 0.0 and 1.0. Unless a different customization weight was specified - * for the custom model when the model was trained, the default value is: * 0.3 for - * previous-generation models * 0.2 for most next-generation models * 0.1 for next-generation - * English and Japanese models + * for the custom model when the model was trained, the default value is: * 0.5 for large speech + * models * 0.3 for previous-generation models * 0.2 for most next-generation models * 0.1 for + * next-generation English and Japanese models * *

A customization weight that you specify overrides a weight that was specified when the * custom model was trained. The default value yields the best performance in general. Assign a @@ -929,8 +974,8 @@ public Boolean smartFormatting() { /** * Gets the smartFormattingVersion. * - *

Smart formatting version is for next-generation models and that is supported in US English, - * Brazilian Portuguese, French and German languages. + *

Smart formatting version for large speech models and next-generation models is supported in + * US English, Brazilian Portuguese, French, German, Spanish and French Canadian languages. * * @return the smartFormattingVersion */ @@ -947,8 +992,8 @@ public Long smartFormattingVersion() { * of whether you specify `false` for the parameter. * _For previous-generation models,_ the * parameter can be used with Australian English, US English, German, Japanese, Korean, and * Spanish (both broadband and narrowband models) and UK English (narrowband model) transcription - * only. * _For next-generation models,_ the parameter can be used with Czech, English - * (Australian, Indian, UK, and US), German, Japanese, Korean, and Spanish transcription only. + * only. * _For large speech models and next-generation models,_ the parameter can be used with + * all available languages. * *

See [Speaker * labels](https://cloud.ibm.com/docs/speech-to-text?topic=speech-to-text-speaker-labels). @@ -1080,8 +1125,8 @@ public Boolean splitTranscriptAtPhraseEnd() { *

The values increase on a monotonic curve. Specifying one or two decimal places of precision * (for example, `0.55`) is typically more than sufficient. * - *

The parameter is supported with all next-generation models and with most previous-generation - * models. See [Speech detector + *

The parameter is supported with all large speech models, next-generation models and with + * most previous-generation models. See [Speech detector * sensitivity](https://cloud.ibm.com/docs/speech-to-text?topic=speech-to-text-detection#detection-parameters-sensitivity) * and [Language model * support](https://cloud.ibm.com/docs/speech-to-text?topic=speech-to-text-detection#detection-support). @@ -1106,8 +1151,8 @@ public Float speechDetectorSensitivity() { *

The values increase on a monotonic curve. Specifying one or two decimal places of precision * (for example, `0.55`) is typically more than sufficient. * - *

The parameter is supported with all next-generation models and with most previous-generation - * models. See [Background audio + *

The parameter is supported with all large speech models, next-generation models and with + * most previous-generation models. See [Background audio * suppression](https://cloud.ibm.com/docs/speech-to-text?topic=speech-to-text-detection#detection-parameters-suppression) * and [Language model * support](https://cloud.ibm.com/docs/speech-to-text?topic=speech-to-text-detection#detection-support). @@ -1127,9 +1172,9 @@ public Float backgroundAudioSuppression() { * parameter causes the models to produce results even more quickly, though the results might be * less accurate when the parameter is used. * - *

The parameter is not available for previous-generation `Broadband` and `Narrowband` models. - * It is available for most next-generation models. * For a list of next-generation models that - * support low latency, see [Supported next-generation language + *

The parameter is not available for large speech models and previous-generation `Broadband` + * and `Narrowband` models. It is available for most next-generation models. * For a list of + * next-generation models that support low latency, see [Supported next-generation language * models](https://cloud.ibm.com/docs/speech-to-text?topic=speech-to-text-models-ng#models-ng-supported). * * For more information about the `low_latency` parameter, see [Low * latency](https://cloud.ibm.com/docs/speech-to-text?topic=speech-to-text-interim#low-latency). @@ -1143,9 +1188,10 @@ public Boolean lowLatency() { /** * Gets the characterInsertionBias. * - *

For next-generation models, an indication of whether the service is biased to recognize - * shorter or longer strings of characters when developing transcription hypotheses. By default, - * the service is optimized to produce the best balance of strings of different lengths. + *

For large speech models and next-generation models, an indication of whether the service is + * biased to recognize shorter or longer strings of characters when developing transcription + * hypotheses. By default, the service is optimized to produce the best balance of strings of + * different lengths. * *

The default bias is 0.0. The allowable range of values is -1.0 to 1.0. * Negative values * bias the service to favor hypotheses with shorter strings of characters. * Positive values bias diff --git a/speech-to-text/src/main/java/com/ibm/watson/speech_to_text/v1/model/RecognizeWithWebsocketsOptions.java b/speech-to-text/src/main/java/com/ibm/watson/speech_to_text/v1/model/RecognizeWithWebsocketsOptions.java index a53b88d0f0..bcc2129eae 100644 --- a/speech-to-text/src/main/java/com/ibm/watson/speech_to_text/v1/model/RecognizeWithWebsocketsOptions.java +++ b/speech-to-text/src/main/java/com/ibm/watson/speech_to_text/v1/model/RecognizeWithWebsocketsOptions.java @@ -1,5 +1,5 @@ /* - * (C) Copyright IBM Corp. 2020, 2022. + * (C) Copyright IBM Corp. 2020, 2024. * * Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with * the License. You may obtain a copy of the License at @@ -201,9 +201,7 @@ public interface Model { protected Boolean splitTranscriptAtPhraseEnd; protected Float speechDetectorSensitivity; protected Float backgroundAudioSuppression; - protected Boolean lowLatency; protected Float characterInsertionBias; - private Boolean interimResults; private Boolean processingMetrics; private Float processingMetricsInterval; @@ -234,9 +232,7 @@ public static class Builder { private Boolean splitTranscriptAtPhraseEnd; private Float speechDetectorSensitivity; private Float backgroundAudioSuppression; - private Boolean lowLatency; private Float characterInsertionBias; - private Boolean interimResults; private Boolean processingMetrics; private Float processingMetricsInterval; @@ -266,9 +262,7 @@ private Builder(RecognizeWithWebsocketsOptions recognizeWithWebsocketsOptions) { this.splitTranscriptAtPhraseEnd = recognizeWithWebsocketsOptions.splitTranscriptAtPhraseEnd; this.speechDetectorSensitivity = recognizeWithWebsocketsOptions.speechDetectorSensitivity; this.backgroundAudioSuppression = recognizeWithWebsocketsOptions.backgroundAudioSuppression; - this.lowLatency = recognizeWithWebsocketsOptions.lowLatency; this.characterInsertionBias = recognizeWithWebsocketsOptions.characterInsertionBias; - this.interimResults = recognizeWithWebsocketsOptions.interimResults; this.processingMetrics = recognizeWithWebsocketsOptions.processingMetrics; this.processingMetricsInterval = recognizeWithWebsocketsOptions.processingMetricsInterval; } @@ -584,17 +578,6 @@ public Builder backgroundAudioSuppression(Float backgroundAudioSuppression) { return this; } - /** - * Set the lowLatency. - * - * @param lowLatency the lowLatency - * @return the RecognizeOptions builder - */ - public Builder lowLatency(Boolean lowLatency) { - this.lowLatency = lowLatency; - return this; - } - /** * Set the characterInsertionBias. * @@ -618,19 +601,6 @@ public Builder audio(File audio) throws FileNotFoundException { return this; } - /** - * Set the interimResults. - * - *

NOTE: This parameter only works for the `recognizeUsingWebSocket` method. - * - * @param interimResults the interimResults - * @return the interimResults - */ - public Builder interimResults(Boolean interimResults) { - this.interimResults = interimResults; - return this; - } - /** * Set the processingMetrics. * @@ -685,9 +655,7 @@ protected RecognizeWithWebsocketsOptions(Builder builder) { splitTranscriptAtPhraseEnd = builder.splitTranscriptAtPhraseEnd; speechDetectorSensitivity = builder.speechDetectorSensitivity; backgroundAudioSuppression = builder.backgroundAudioSuppression; - lowLatency = builder.lowLatency; characterInsertionBias = builder.characterInsertionBias; - interimResults = builder.interimResults; processingMetrics = builder.processingMetrics; processingMetricsInterval = builder.processingMetricsInterval; } @@ -1123,28 +1091,6 @@ public Float backgroundAudioSuppression() { return backgroundAudioSuppression; } - /** - * Gets the lowLatency. - * - *

If `true` for next-generation `Multimedia` and `Telephony` models that support low latency, - * directs the service to produce results even more quickly than it usually does. Next-generation - * models produce transcription results faster than previous-generation models. The `low_latency` - * parameter causes the models to produce results even more quickly, though the results might be - * less accurate when the parameter is used. - * - *

The parameter is not available for previous-generation `Broadband` and `Narrowband` models. - * It is available for most next-generation models. * For a list of next-generation models that - * support low latency, see [Supported next-generation language - * models](https://cloud.ibm.com/docs/speech-to-text?topic=speech-to-text-models-ng#models-ng-supported). - * * For more information about the `low_latency` parameter, see [Low - * latency](https://cloud.ibm.com/docs/speech-to-text?topic=speech-to-text-interim#low-latency). - * - * @return the lowLatency - */ - public Boolean lowLatency() { - return lowLatency; - } - /** * Gets the characterInsertionBias. * @@ -1176,21 +1122,6 @@ public Float characterInsertionBias() { return characterInsertionBias; } - /** - * Gets the interimResults. - * - *

If `true`, the service returns interim results as a stream of `SpeechRecognitionResults` - * objects. By default, the service returns a single `SpeechRecognitionResults` object with final - * results only. - * - *

NOTE: This parameter only works for the `recognizeUsingWebSocket` method. - * - * @return the interimResults - */ - public Boolean interimResults() { - return interimResults; - } - /** * Gets the processingMetrics. * diff --git a/speech-to-text/src/main/java/com/ibm/watson/speech_to_text/v1/model/TrainLanguageModelOptions.java b/speech-to-text/src/main/java/com/ibm/watson/speech_to_text/v1/model/TrainLanguageModelOptions.java index f32bd6de8d..2ca530c64e 100644 --- a/speech-to-text/src/main/java/com/ibm/watson/speech_to_text/v1/model/TrainLanguageModelOptions.java +++ b/speech-to-text/src/main/java/com/ibm/watson/speech_to_text/v1/model/TrainLanguageModelOptions.java @@ -25,9 +25,9 @@ public class TrainLanguageModelOptions extends GenericModel { * that were added or modified by the user directly. The model is not trained on new words * extracted from corpora or grammars. * - *

_For custom models that are based on next-generation models_, the service ignores the - * parameter. The words resource contains only custom words that the user adds or modifies - * directly, so the parameter is unnecessary. + *

_For custom models that are based on large speech models and next-generation models_, the + * service ignores the `word_type_to_add` parameter. The words resource contains only custom words + * that the user adds or modifies directly, so the parameter is unnecessary. */ public interface WordTypeToAdd { /** all. */ @@ -184,9 +184,9 @@ public String customizationId() { * that were added or modified by the user directly. The model is not trained on new words * extracted from corpora or grammars. * - *

_For custom models that are based on next-generation models_, the service ignores the - * parameter. The words resource contains only custom words that the user adds or modifies - * directly, so the parameter is unnecessary. + *

_For custom models that are based on large speech models and next-generation models_, the + * service ignores the `word_type_to_add` parameter. The words resource contains only custom words + * that the user adds or modifies directly, so the parameter is unnecessary. * * @return the wordTypeToAdd */ @@ -200,8 +200,8 @@ public String wordTypeToAdd() { *

Specifies a customization weight for the custom language model. The customization weight * tells the service how much weight to give to words from the custom language model compared to * those from the base model for speech recognition. Specify a value between 0.0 and 1.0. The - * default value is: * 0.3 for previous-generation models * 0.2 for most next-generation models * - * 0.1 for next-generation English and Japanese models + * default value is: * 0.5 for large speech models * 0.3 for previous-generation models * 0.2 for + * most next-generation models * 0.1 for next-generation English and Japanese models * *

The default value yields the best performance in general. Assign a higher value if your * audio makes frequent use of OOV words from the custom model. Use caution when setting the diff --git a/speech-to-text/src/test/java/com/ibm/watson/speech_to_text/v1/SpeechToTextIT.java b/speech-to-text/src/test/java/com/ibm/watson/speech_to_text/v1/SpeechToTextIT.java index 1d612850ce..076c7c42a7 100755 --- a/speech-to-text/src/test/java/com/ibm/watson/speech_to_text/v1/SpeechToTextIT.java +++ b/speech-to-text/src/test/java/com/ibm/watson/speech_to_text/v1/SpeechToTextIT.java @@ -1,5 +1,5 @@ /* - * (C) Copyright IBM Corp. 2019, 2022. + * (C) Copyright IBM Corp. 2019, 2024. * * Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with * the License. You may obtain a copy of the License at @@ -347,7 +347,6 @@ public void testRecognizeWebSocket() throws FileNotFoundException, InterruptedEx .wordAlternativesThreshold(0.5f) .model(EN_BROADBAND16K) .contentType(HttpMediaType.AUDIO_WAV) - .interimResults(true) .processingMetrics(true) .processingMetricsInterval(0.2f) .audioMetrics(true) diff --git a/speech-to-text/src/test/java/com/ibm/watson/speech_to_text/v1/SpeechToTextTest.java b/speech-to-text/src/test/java/com/ibm/watson/speech_to_text/v1/SpeechToTextTest.java index 1c340b1772..4f6dbc7d02 100755 --- a/speech-to-text/src/test/java/com/ibm/watson/speech_to_text/v1/SpeechToTextTest.java +++ b/speech-to-text/src/test/java/com/ibm/watson/speech_to_text/v1/SpeechToTextTest.java @@ -226,6 +226,7 @@ public void testRecognizeWOptions() throws Throwable { .audio(TestUtilities.createMockStream("This is a mock file.")) .contentType("application/octet-stream") .model("en-US_BroadbandModel") + .speechBeginEvent(false) .languageCustomizationId("testString") .acousticCustomizationId("testString") .baseModelVersion("testString") @@ -270,6 +271,7 @@ public void testRecognizeWOptions() throws Throwable { Map query = TestUtilities.parseQueryString(request); assertNotNull(query); assertEquals(query.get("model"), "en-US_BroadbandModel"); + assertEquals(Boolean.valueOf(query.get("speech_begin_event")), Boolean.valueOf(false)); assertEquals(query.get("language_customization_id"), "testString"); assertEquals(query.get("acoustic_customization_id"), "testString"); assertEquals(query.get("base_model_version"), "testString"); diff --git a/speech-to-text/src/test/java/com/ibm/watson/speech_to_text/v1/model/RecognizeOptionsTest.java b/speech-to-text/src/test/java/com/ibm/watson/speech_to_text/v1/model/RecognizeOptionsTest.java index f146f693b1..fe108d4c26 100644 --- a/speech-to-text/src/test/java/com/ibm/watson/speech_to_text/v1/model/RecognizeOptionsTest.java +++ b/speech-to-text/src/test/java/com/ibm/watson/speech_to_text/v1/model/RecognizeOptionsTest.java @@ -36,6 +36,7 @@ public void testRecognizeOptions() throws Throwable { .audio(TestUtilities.createMockStream("This is a mock file.")) .contentType("application/octet-stream") .model("en-US_BroadbandModel") + .speechBeginEvent(false) .languageCustomizationId("testString") .acousticCustomizationId("testString") .baseModelVersion("testString") @@ -66,6 +67,7 @@ public void testRecognizeOptions() throws Throwable { IOUtils.toString(TestUtilities.createMockStream("This is a mock file."))); assertEquals(recognizeOptionsModel.contentType(), "application/octet-stream"); assertEquals(recognizeOptionsModel.model(), "en-US_BroadbandModel"); + assertEquals(recognizeOptionsModel.speechBeginEvent(), Boolean.valueOf(false)); assertEquals(recognizeOptionsModel.languageCustomizationId(), "testString"); assertEquals(recognizeOptionsModel.acousticCustomizationId(), "testString"); assertEquals(recognizeOptionsModel.baseModelVersion(), "testString");