UX study updates by samvaity · Pull Request #12586 · Azure/azure-sdk-for-java

samvaity · 2020-06-29T04:32:08Z

No description provided.

kristapratico · 2020-06-29T15:45:14Z

sdk/formrecognizer/azure-ai-formrecognizer/README.md

 Form content is returned in a collection of `FormPage` objects.
- - Recognizing common fields from US receipts, using a pre-trained receipt model on the Form Recognizer service.
+ - [Recognizing common fields from US receipts](#recognize-receipts), using a pre-trained receipt model on the Form Recognizer service.
 These fields and meta-data are returned in a collection of `USReceipt` objects.


Suggested change

These fields and meta-data are returned in a collection of `USReceipt` objects.

These fields and meta-data are returned in a collection of `RecognizedForm` objects.

kristapratico · 2020-06-29T15:46:51Z

sdk/formrecognizer/azure-ai-formrecognizer/README.md

+<!-- embedme ./src/samples/java/com/azure/ai/formrecognizer/ReadmeSamples.java#L195-L215 -->
 ```java
-String trainingFilesUrl = "{training_set_SAS_URL}";
+String trainingFilesUrl = "{<SAS-URL-of-your-form-folder-in-blob-storage>}";


"SAS-URL-of-your-form-folder-" makes me think I need to include the folder name in the url. I think "SAS-URL-of-your-container-in-blob-storage" might make more sense.

kristapratico · 2020-06-29T15:48:45Z

...e-ai-formrecognizer/src/main/java/com/azure/ai/formrecognizer/FormRecognizerAsyncClient.java

     *
-     * @return A {@link PollerFlux} that polls the recognize custom form operation until it has completed, has failed,
-     * or has been cancelled. The completed operation returns a List of {@link FormPage}.
+     * @return A {@link PollerFlux} that polls the recognize layout operation until it has completed, has failed, or has


should we say content operation here?

kristapratico · 2020-06-29T15:49:19Z

...e-ai-formrecognizer/src/main/java/com/azure/ai/formrecognizer/FormRecognizerAsyncClient.java

+     * @param receiptUrl The URL of the receipt to analyze.
     *
     * @return A {@link PollerFlux} that polls the recognize receipt operation until it has completed, has failed,
     * or has been cancelled. The completed operation returns a List of {@link RecognizedReceipt}.


Suggested change

* or has been cancelled. The completed operation returns a List of {@link RecognizedReceipt}.

* or has been cancelled. The completed operation returns a List of {@link RecognizedForm}.

This also happens in other parts of the document

I still have the receipt design changes in a PR so this will be taken care there - #12380

maririos · 2020-06-29T16:07:38Z

sdk/formrecognizer/azure-ai-formrecognizer/README.md

-* Train a model with labels: [TrainModelWithLabels][train_labeled_model] ([async][train_labeled_model_async])
-* Manage custom models: [ManageCustomModels][manage_custom_models] ([async][manage_custom_models_async])
-* Copy a model between Form Recognizer resources: [CopyModel][copy_model] ([async][copy_model_async])
+* Recognize receipts: [RecognizeReceipts][recognize_receipts] ([RecognizeReceiptsAsync][recognize_receipts_async])


It still looks like the same line. What about making it a table? so sync and async links in different columns?
Or do a subsection or sync and another for async?

maririos · 2020-06-29T16:09:00Z

...e-ai-formrecognizer/src/main/java/com/azure/ai/formrecognizer/FormRecognizerAsyncClient.java

@@ -133,9 +133,9 @@ public final class FormRecognizerAsyncClient {
     * @param length The exact length of the data. Size of the file must be less than 50 MB.


do you validate the size in the client?
Also, is this constrain from the service?

We do not validate the size on the client and yes it is a constraint from the service.

I would prefer deleting this from here then, in case the service decides to change the limitations

maririos · 2020-06-29T16:11:01Z

...e-ai-formrecognizer/src/main/java/com/azure/ai/formrecognizer/FormRecognizerAsyncClient.java

+     * .tiff type file stream. Content-type is auto-detected and could be {@code null}.
     *
-     * @return A {@link PollerFlux} that polls the recognize receipt operation until it has completed, has failed,
+     * @return A {@link PollerFlux} that polls the recognize custom form operation until it has completed, has failed,


should it say recognized?

maririos · 2020-06-29T16:13:18Z

...e-ai-formrecognizer/src/main/java/com/azure/ai/formrecognizer/FormRecognizerAsyncClient.java

     *
-     * @return A {@link PollerFlux} that polls the recognize receipt operation until it has completed, has failed,
-     * or has been cancelled. The completed operation returns a List of {@link FormPage}.
+     * @return A {@link PollerFlux} polls the recognize layout operation until it has completed, has failed, or has


any reason we use layout instead of recognized content operation? similar to what Krista said above

maririos · 2020-06-29T16:19:43Z

...er/azure-ai-formrecognizer/src/main/java/com/azure/ai/formrecognizer/models/FormContent.java


    /*
-     * Text content of the extracted field.
+     * Text content of the extracted line.


consider changing to extracted element. it could be a whole line or a single word and eventually it could be the selection in a checkbox element

maririos · 2020-06-29T16:21:46Z

...er/azure-ai-formrecognizer/src/main/java/com/azure/ai/formrecognizer/models/FormContent.java


    /**
-     * The text of the extracted item.
+     * The text content of the extracted line.


maririos · 2020-06-29T16:27:12Z

...rmrecognizer/src/main/java/com/azure/ai/formrecognizer/training/FormTrainingAsyncClient.java

     * Other type of content is ignored.
     * <p>The service does not support cancellation of the long running operation and returns with an
     * error message indicating absence of cancellation support.</p>
+     * See <a href="https://docs.microsoft.com/en-us/azure/cognitive-services/form-recognizer/build-training-data-set#upload-your-training-data">here</a>


remove the en-us from the link so that it is set to the user locale

same with other links

maririos · 2020-06-29T16:36:36Z

...rmrecognizer/src/main/java/com/azure/ai/formrecognizer/training/FormTrainingAsyncClient.java


    /**
-     * Get account information.
+     * Get account information for all custom models on the form recognizer account with an Http response.


because it also returns information about the resource itself (like the capacity) I will suggest

Suggested change

* Get account information for all custom models on the form recognizer account with an Http response.

* Get account information of the form recognizer account with an Http response.

maririos · 2020-06-29T16:36:58Z

...rmrecognizer/src/main/java/com/azure/ai/formrecognizer/training/FormTrainingAsyncClient.java

     *
-     * @return A {@link Mono} containing containing status code and HTTP headers
-     * @throws NullPointerException If {@code modelId} is {@code null}.
+     * @return A {@link Response} containing containing status code and HTTP headers


Suggested change

* @return A {@link Response} containing containing status code and HTTP headers

* @return A {@link Response} containing status code and HTTP headers

...er/src/samples/java/com/azure/ai/formrecognizer/FormRecognizerClientJavaDocCodeSnippets.java

...e-ai-formrecognizer/src/main/java/com/azure/ai/formrecognizer/FormRecognizerAsyncClient.java

...c/samples/java/com/azure/ai/formrecognizer/FormRecognizerAsyncClientJavaDocCodeSnippets.java

kristapratico

🚢

…zure/ai/formrecognizer/FormRecognizerAsyncClient.java Co-authored-by: Krista Pratico <krpratic@microsoft.com>

…m/azure/ai/formrecognizer/FormRecognizerAsyncClientJavaDocCodeSnippets.java Co-authored-by: Krista Pratico <krpratic@microsoft.com>

samvaity · 2020-06-30T20:28:28Z

/azp run java - formrecognizer - ci

azure-pipelines · 2020-06-30T22:11:34Z

Azure Pipelines successfully started running 1 pipeline(s).

javadoc updates

acc2760

samvaity requested review from mssfang and sima-zhu as code owners June 29, 2020 04:32

samvaity requested review from kristapratico and maririos June 29, 2020 04:32

samvaity self-assigned this Jun 29, 2020

samvaity requested a review from jeremymeng June 29, 2020 04:32

samvaity linked an issue Jun 29, 2020 that may be closed by this pull request

Address Feedback from JS/Java User Studies #11888

Closed

18 tasks

checkstyle update

afcee34

kristapratico reviewed Jun 29, 2020

View reviewed changes

maririos reviewed Jun 29, 2020

View reviewed changes

...er/src/samples/java/com/azure/ai/formrecognizer/FormRecognizerClientJavaDocCodeSnippets.java Show resolved Hide resolved

samvaity added 2 commits June 29, 2020 15:39

review comments

3e1c620

update readme

6ef4a90

samvaity requested review from kristapratico and maririos June 29, 2020 22:58

kristapratico reviewed Jun 29, 2020

View reviewed changes

...e-ai-formrecognizer/src/main/java/com/azure/ai/formrecognizer/FormRecognizerAsyncClient.java Outdated Show resolved Hide resolved

kristapratico reviewed Jun 29, 2020

View reviewed changes

...c/samples/java/com/azure/ai/formrecognizer/FormRecognizerAsyncClientJavaDocCodeSnippets.java Outdated Show resolved Hide resolved

kristapratico approved these changes Jun 29, 2020

View reviewed changes

samvaity and others added 2 commits June 29, 2020 18:19

Update sdk/formrecognizer/azure-ai-formrecognizer/src/main/java/com/a…

f4cfbae

…zure/ai/formrecognizer/FormRecognizerAsyncClient.java Co-authored-by: Krista Pratico <krpratic@microsoft.com>

Update sdk/formrecognizer/azure-ai-formrecognizer/src/samples/java/co…

6f52d6e

…m/azure/ai/formrecognizer/FormRecognizerAsyncClientJavaDocCodeSnippets.java Co-authored-by: Krista Pratico <krpratic@microsoft.com>

maririos approved these changes Jul 1, 2020

View reviewed changes

samvaity merged commit 49ec0e2 into Azure:master Jul 1, 2020

samvaity deleted the ux-study branch September 17, 2020 20:18

	These fields and meta-data are returned in a collection of `USReceipt` objects.
	These fields and meta-data are returned in a collection of `RecognizedForm` objects.

	* or has been cancelled. The completed operation returns a List of {@link RecognizedReceipt}.
	* or has been cancelled. The completed operation returns a List of {@link RecognizedForm}.

		@@ -133,9 +133,9 @@ public final class FormRecognizerAsyncClient {
		* @param length The exact length of the data. Size of the file must be less than 50 MB.

	* Get account information for all custom models on the form recognizer account with an Http response.
	* Get account information of the form recognizer account with an Http response.

	* @return A {@link Response} containing containing status code and HTTP headers
	* @return A {@link Response} containing status code and HTTP headers

Comments

Conversation

samvaity commented Jun 29, 2020

Uh oh!

kristapratico Jun 29, 2020 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

kristapratico left a comment

Choose a reason for hiding this comment

Uh oh!

samvaity commented Jun 30, 2020 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

azure-pipelines bot commented Jun 30, 2020

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

kristapratico Jun 29, 2020 •

edited

Loading

samvaity commented Jun 30, 2020 •

edited

Loading