Modify Cognitive Search Swagger #3386

jeji1101 · 2018-07-10T22:24:09Z

This checklist is used to make sure that common issues in a pull request are addressed. This will expedite the process of getting your pull request merged and avoid extra work on your part to fix issues discovered during the review process.

PR information

The title of the PR is clear and informative.
There are a small number of commits, each of which have an informative message. This means that previously merged commits do not appear in the history of the PR. For information on cleaning up the commits in your pull request, see this page.
Except for special cases involving multiple contributors, the PR is started from a fork of the main repository, not a branch.
If applicable, the PR references the bug/issue that it fixes.
Swagger files are correctly named (e.g. the api-version in the path should match the api-version in the spec).

Quality of Swagger

I have read the contribution guidelines.
My spec meets the review criteria:
- The spec conforms to the Swagger 2.0 specification.
- The spec follows the guidelines described in the Swagger checklist document.
- Validation tools were run on swagger spec(s) and have all been fixed in this PR.

AutorestCI · 2018-07-10T22:24:34Z

Automation for azure-sdk-for-python

Nothing to generate for azure-sdk-for-python

AutorestCI · 2018-07-10T22:25:13Z

Automation for azure-sdk-for-go

Nothing to generate for azure-sdk-for-go

AutorestCI · 2018-07-10T22:25:13Z

Automation for azure-sdk-for-ruby

Nothing to generate for azure-sdk-for-ruby

AutorestCI · 2018-07-10T22:26:04Z

Automation for azure-sdk-for-node

Nothing to generate for azure-sdk-for-node

AutorestCI · 2018-07-10T22:26:43Z

Automation for azure-sdk-for-java

Nothing to generate for azure-sdk-for-java

vl8163264128 · 2018-07-10T23:49:43Z

...arch/data-plane/Microsoft.Azure.Search.Service/preview/2017-11-11-preview/searchservice.json

 			"url": "https://docs.microsoft.com/azure/search/cognitive-search-tutorial-blob"
 	    },
-		"description": "A list of Cognitive Search skills."
+		"description": "A list of cognitive skills."


is this the right description?
only indexers have datasource, skillset and index names

Synced up with Victor offline on this.

vl8163264128 · 2018-07-10T23:50:54Z

...arch/data-plane/Microsoft.Azure.Search.Service/preview/2017-11-11-preview/searchservice.json

 			"context": {
 				"type": "string",
-				"description": "The context of the skill."
+				"description": "Represents the level at which operations take place, such as the document root or document path (for example, document/sentiment or document/content)."


document root or document content (for example, /document or /document/content)

vl8163264128 · 2018-07-10T23:53:04Z

...arch/data-plane/Microsoft.Azure.Search.Service/preview/2017-11-11-preview/searchservice.json

 			"name": {
 				"type": "string",
-				"description": "The name of the output."
+				"description": "The name path of the output."


The name of the output defined by the skill.

vl8163264128 · 2018-07-10T23:53:49Z

...arch/data-plane/Microsoft.Azure.Search.Service/preview/2017-11-11-preview/searchservice.json

-		"targetName"],
-		"description": "output field mapping for a skill."
+		"required": [
+		    "name", "targetName"


I believe targetName is optional and defaults to name

vl8163264128 · 2018-07-10T23:59:08Z

...arch/data-plane/Microsoft.Azure.Search.Service/preview/2017-11-11-preview/searchservice.json

+		"externalDocs": {
+			"url": "https://docs.microsoft.com/rest/api/searchservice/naming-rules"
+	    },
+		"description": "Output field mapping for a skill."


Name of the skill output.

Synced up with Victor offline on this. I will need to add the OutputFieldMappings field into the indexer.

vl8163264128 · 2018-07-10T23:59:57Z

...arch/data-plane/Microsoft.Azure.Search.Service/preview/2017-11-11-preview/searchservice.json

 			"url": "https://docs.microsoft.com/azure/search/cognitive-search-skill-ocr"
 	    },
-		"description": "The skill extracts text from image files."
+		"description": "A skill extracts text from image files."


A skill that extracts text from image files.

vl8163264128 · 2018-07-11T00:00:32Z

...arch/data-plane/Microsoft.Azure.Search.Service/preview/2017-11-11-preview/searchservice.json

 			"url": "https://docs.microsoft.com/azure/search/cognitive-search-skill-image-analysis"
 	    },
-		"description": "The skill analyzes image files. It extracts a rich set of visual features based on the image content."
+		"description": "A skill analyzes image files. It extracts a rich set of visual features based on the image content."


A skill that analyzes image files.

vl8163264128 · 2018-07-11T00:02:36Z

...arch/data-plane/Microsoft.Azure.Search.Service/preview/2017-11-11-preview/searchservice.json

 			"url": "https://docs.microsoft.com/azure/search/cognitive-search-skill-language-detection"
 	    },
-		"description": "The skill detects the language of input text and reports a single language code for every document submitted on the request. The language code is paired with a score indicating the strength of the analysis."
+		"description": "A skill detects the language of input text and reports a single language code for every document submitted on the request. The language code is paired with a score indicating the confidence of the analysis."


"that"

Why is it "every document submitted on the request"? Doesn't this skill take a single string as input?

I copied it from this link: https://docs.microsoft.com/azure/search/cognitive-search-skill-language-detection. I think we can send a batch request for language detection.

jhendrixMSFT

Looks like there's some feedback to be addressed.

jhendrixMSFT · 2018-07-16T16:47:16Z

@vl8163264128 ping

vl8163264128 · 2018-07-18T18:03:30Z

#sign-off

brjohnstmsft · 2018-07-31T04:05:51Z

...arch/data-plane/Microsoft.Azure.Search.Service/preview/2017-11-11-preview/searchservice.json

+        },
+		"skillsetName": {
+          "type": "string",
+          "description": "The name of the cognitive skillset executing with this indexer."


@jeji1101 It would be helpful to mention here that you can leave this null if you want an indexer without an associated skillset.

brjohnstmsft · 2018-07-31T04:07:37Z

...arch/data-plane/Microsoft.Azure.Search.Service/preview/2017-11-11-preview/searchservice.json

+          "items": {
+            "$ref": "#/definitions/FieldMapping"
+          },
+          "description": "Output field mappings are applied after enrichment and immediately before indexing.",


@jeji1101 We don't really define the term "enrichment" here, so maybe it would help to have more context. How about:

"Applicable only to indexers with an associated skillset. Output field mappings are applied after documents are enriched by the skillset, immediately before indexing."

brjohnstmsft · 2018-07-31T04:10:02Z

...arch/data-plane/Microsoft.Azure.Search.Service/preview/2017-11-11-preview/searchservice.json

 					"$ref": "#/definitions/InputFieldMappingEntry"
 				},
-				"description": "The inputs of the skill."
+				"description": "Inputs of the skills could be a column in the source data set, or the output of an upstream skill."


@jeji1101 Terminology consistency: Please call it "data source" instead of "source data set".

brjohnstmsft · 2018-07-31T04:22:43Z

...arch/data-plane/Microsoft.Azure.Search.Service/preview/2017-11-11-preview/searchservice.json

 			"targetName": {
 				"type": "string",
-				"description": "The target name of the output."
+				"description": "The target name of the output. It is optional and default to name."


@jeji1101 default to name -> defaults to name

brjohnstmsft · 2018-07-31T04:32:12Z

...arch/data-plane/Microsoft.Azure.Search.Service/preview/2017-11-11-preview/searchservice.json

+		"required": [
+		    "name"
+		],
+		"externalDocs": {


@jeji1101 This seems like the wrong doc link.

brjohnstmsft · 2018-07-31T04:54:12Z

...arch/data-plane/Microsoft.Azure.Search.Service/preview/2017-11-11-preview/searchservice.json

 			"url": "https://docs.microsoft.com/azure/search/cognitive-search-skill-sentiment"
 	    },
-		"description": "Text analytics sentiment analysis."
+		"description": "Text analytics positive-negative sentiment analysis, scored as a floating point value in a range of zero to 1."


@jeji1101 "zero to one" or "0 to 1"

hsinyij added 4 commits June 25, 2018 13:06

Address CR comments

a872883

Address CR comment

c1e7836

Address PR comments in C#

54822a5

Fix syntax error

94225a1

azuresdkci assigned jhendrixMSFT Jul 10, 2018

azuresdkci requested a review from jhendrixMSFT July 10, 2018 22:25

Merge branch 'master' into jeji/addresscomments

bfb2ca8

jeji1101 changed the title ~~Jeji/addresscomments~~ Modify Cognitive Search Swagger Jul 10, 2018

vl8163264128 reviewed Jul 10, 2018

View reviewed changes

vl8163264128 reviewed Jul 11, 2018

View reviewed changes

jhendrixMSFT requested changes Jul 11, 2018

View reviewed changes

Address CR comments

8bd321b

jhendrixMSFT approved these changes Jul 18, 2018

View reviewed changes

jhendrixMSFT merged commit c4c8e6d into Azure:master Jul 18, 2018

jeji1101 mentioned this pull request Jul 19, 2018

[DO NOT MERGE] Add Cognitive Skillset Operations Azure/azure-sdk-for-net#4566

Closed

9 tasks

jeji1101 mentioned this pull request Jul 30, 2018

[Azure Search] Add Cognitive Skillset Operations Azure/azure-sdk-for-net#4609

Merged

9 tasks

brjohnstmsft reviewed Jul 31, 2018

View reviewed changes

Modify Cognitive Search Swagger #3386

Modify Cognitive Search Swagger #3386

Uh oh!

Conversation

jeji1101 commented Jul 10, 2018 • edited by azuresdkci Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

PR information

Quality of Swagger

Uh oh!

AutorestCI commented Jul 10, 2018 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Automation for azure-sdk-for-python

Uh oh!

AutorestCI commented Jul 10, 2018 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Automation for azure-sdk-for-go

Uh oh!

AutorestCI commented Jul 10, 2018 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Automation for azure-sdk-for-ruby

Uh oh!

AutorestCI commented Jul 10, 2018 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Automation for azure-sdk-for-node

Uh oh!

AutorestCI commented Jul 10, 2018 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Automation for azure-sdk-for-java

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!

jhendrixMSFT left a comment

Choose a reason for hiding this comment

Uh oh!

jhendrixMSFT commented Jul 16, 2018

Uh oh!

vl8163264128 commented Jul 18, 2018

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!

jeji1101 commented Jul 10, 2018 •

edited by azuresdkci

Loading

AutorestCI commented Jul 10, 2018 •

edited

Loading

AutorestCI commented Jul 10, 2018 •

edited

Loading

AutorestCI commented Jul 10, 2018 •

edited

Loading

AutorestCI commented Jul 10, 2018 •

edited

Loading

AutorestCI commented Jul 10, 2018 •

edited

Loading