diff --git a/specification/search/data-plane/Microsoft.Azure.Search.Service/stable/2019-05-06/examples/SearchServiceCreateOrUpdateSkillset.json b/specification/search/data-plane/Microsoft.Azure.Search.Service/stable/2019-05-06/examples/SearchServiceCreateOrUpdateSkillset.json index 03c281462208..85e95eb1e9cf 100644 --- a/specification/search/data-plane/Microsoft.Azure.Search.Service/stable/2019-05-06/examples/SearchServiceCreateOrUpdateSkillset.json +++ b/specification/search/data-plane/Microsoft.Azure.Search.Service/stable/2019-05-06/examples/SearchServiceCreateOrUpdateSkillset.json @@ -84,6 +84,31 @@ "targetName": "keyPhrases" } ] + }, + { + "@odata.type": "#Microsoft.Skills.Custom.WebApiSkill", + "name": "MyCustomWebApiSkill", + "uri": "https://contoso.example.org", + "httpMethod": "POST", + "timeout": "PT30S", + "batchSize": 1, + "inputs": [ + { + "name": "text", + "source": "/document/pages/*" + }, + { + "name": "languageCode", + "source": "/document/languageCode" + } + ], + "outputs": [ + { + "name": "customresult", + "targetName": "result" + } + ], + "httpHeaders": {} } ] } @@ -96,6 +121,7 @@ "skills": [ { "@odata.type": "#Microsoft.Skills.Text.EntityRecognitionSkill", + "name": "#1", "description": null, "context": null, "inputs": [ @@ -118,6 +144,7 @@ }, { "@odata.type": "#Microsoft.Skills.Text.LanguageDetectionSkill", + "name": "#2", "description": null, "context": null, "inputs": [ @@ -135,6 +162,7 @@ }, { "@odata.type": "#Microsoft.Skills.Text.SplitSkill", + "name": "#3", "description": null, "context": null, "inputs": [ @@ -159,6 +187,7 @@ }, { "@odata.type": "#Microsoft.Skills.Text.KeyPhraseExtractionSkill", + "name": "#4", "description": null, "context": "/document/pages/*", "inputs": [ @@ -179,6 +208,34 @@ ], "defaultLanguageCode": null, "maxKeyPhraseCount": null + }, + { + "@odata.type": "#Microsoft.Skills.Custom.WebApiSkill", + "name": "MyCustomWebApiSkill", + "description": null, + "context": "/document", + "uri": "https://contoso.example.org", + "httpMethod": "POST", + "timeout": "PT30S", + "batchSize": 1, + "degreeOfParallelism": null, + "inputs": [ + { + "name": "text", + "source": "/document/pages/*" + }, + { + "name": "languageCode", + "source": "/document/languageCode" + } + ], + "outputs": [ + { + "name": "customresult", + "targetName": "result" + } + ], + "httpHeaders": {} } ] } @@ -190,6 +247,7 @@ "skills": [ { "@odata.type": "#Microsoft.Skills.Text.EntityRecognitionSkill", + "name": "#1", "description": null, "context": null, "inputs": [ @@ -212,6 +270,7 @@ }, { "@odata.type": "#Microsoft.Skills.Text.LanguageDetectionSkill", + "name": "#2", "description": null, "context": null, "inputs": [ @@ -229,6 +288,7 @@ }, { "@odata.type": "#Microsoft.Skills.Text.SplitSkill", + "name": "#3", "description": null, "context": null, "inputs": [ @@ -253,6 +313,7 @@ }, { "@odata.type": "#Microsoft.Skills.Text.KeyPhraseExtractionSkill", + "name": "#4", "description": null, "context": "/document/pages/*", "inputs": [ @@ -273,6 +334,34 @@ ], "defaultLanguageCode": null, "maxKeyPhraseCount": null + }, + { + "@odata.type": "#Microsoft.Skills.Custom.WebApiSkill", + "name": "MyCustomWebApiSkill", + "description": null, + "context": "/document", + "uri": "https://contoso.example.org", + "httpMethod": "POST", + "timeout": "PT30S", + "batchSize": 1, + "degreeOfParallelism": null, + "inputs": [ + { + "name": "text", + "source": "/document/pages/*" + }, + { + "name": "languageCode", + "source": "/document/languageCode" + } + ], + "outputs": [ + { + "name": "customresult", + "targetName": "result" + } + ], + "httpHeaders": {} } ] } diff --git a/specification/search/data-plane/Microsoft.Azure.Search.Service/stable/2019-05-06/examples/SearchServiceCreateSkillset.json b/specification/search/data-plane/Microsoft.Azure.Search.Service/stable/2019-05-06/examples/SearchServiceCreateSkillset.json index a459519e32b9..e604929d9636 100644 --- a/specification/search/data-plane/Microsoft.Azure.Search.Service/stable/2019-05-06/examples/SearchServiceCreateSkillset.json +++ b/specification/search/data-plane/Microsoft.Azure.Search.Service/stable/2019-05-06/examples/SearchServiceCreateSkillset.json @@ -84,6 +84,31 @@ "targetName": "keyPhrases" } ] + }, + { + "@odata.type": "#Microsoft.Skills.Custom.WebApiSkill", + "name": "MyCustomWebApiSkill", + "uri": "https://contoso.example.org", + "httpMethod": "POST", + "timeout": "PT30S", + "batchSize": 1, + "inputs": [ + { + "name": "text", + "source": "/document/pages/*" + }, + { + "name": "languageCode", + "source": "/document/languageCode" + } + ], + "outputs": [ + { + "name": "customresult", + "targetName": "result" + } + ], + "httpHeaders": {} } ] } @@ -96,6 +121,7 @@ "skills": [ { "@odata.type": "#Microsoft.Skills.Text.EntityRecognitionSkill", + "name": "#1", "description": null, "context": null, "inputs": [ @@ -118,6 +144,7 @@ }, { "@odata.type": "#Microsoft.Skills.Text.LanguageDetectionSkill", + "name": "#2", "description": null, "context": null, "inputs": [ @@ -135,6 +162,7 @@ }, { "@odata.type": "#Microsoft.Skills.Text.SplitSkill", + "name": "#3", "description": null, "context": null, "inputs": [ @@ -159,6 +187,7 @@ }, { "@odata.type": "#Microsoft.Skills.Text.KeyPhraseExtractionSkill", + "name": "#4", "description": null, "context": "/document/pages/*", "inputs": [ @@ -179,6 +208,34 @@ ], "defaultLanguageCode": null, "maxKeyPhraseCount": null + }, + { + "@odata.type": "#Microsoft.Skills.Custom.WebApiSkill", + "name": "MyCustomWebApiSkill", + "description": null, + "context": "/document", + "uri": "https://contoso.example.org", + "httpMethod": "POST", + "timeout": "PT30S", + "batchSize": 1, + "degreeOfParallelism": null, + "inputs": [ + { + "name": "text", + "source": "/document/pages/*" + }, + { + "name": "languageCode", + "source": "/document/languageCode" + } + ], + "outputs": [ + { + "name": "customresult", + "targetName": "result" + } + ], + "httpHeaders": {} } ] } diff --git a/specification/search/data-plane/Microsoft.Azure.Search.Service/stable/2019-05-06/examples/SearchServiceGetIndexerStatus.json b/specification/search/data-plane/Microsoft.Azure.Search.Service/stable/2019-05-06/examples/SearchServiceGetIndexerStatus.json index 83e9dce778af..b4363864d2a3 100644 --- a/specification/search/data-plane/Microsoft.Azure.Search.Service/stable/2019-05-06/examples/SearchServiceGetIndexerStatus.json +++ b/specification/search/data-plane/Microsoft.Azure.Search.Service/stable/2019-05-06/examples/SearchServiceGetIndexerStatus.json @@ -43,17 +43,38 @@ { "key": "", "errorMessage": "Document key cannot be missing or empty.", - "statusCode": 400 + "statusCode": 400, + "name": null, + "details": null, + "documentationLink": null + }, + { + "key": "document id 1", + "errorMessage": "Could not read the value of column 'foo' at index '0'.", + "statusCode": 400, + "name": "DocumentExtraction.AzureBlob.MyDataSource", + "details": "The file could not be parsed.", + "documentationLink": "https://go.microsoft.com/fwlink/?linkid=2049388" } ], "warnings": [ { "key": "document id", - "message": "A warning doesn't stop indexing, and is intended to inform you of certain interesting situations, like when a blob indexer truncates the amount of text extracted from a blob." + "message": "A warning doesn't stop indexing, and is intended to inform you of certain interesting situations, like when a blob indexer truncates the amount of text extracted from a blob.", + "name": null, + "details": null, + "documentationLink": null + }, + { + "key": "document id 2", + "message": "Document was truncated to 50000 characters.", + "name": "Enrichment.LanguageDetectionSkill.#4", + "details": "The skill did something that didn't break anything, nonetheless something we didn't expect happened, so it might be worth double checking.", + "documentationLink": "https://go.microsoft.com/fwlink/?linkid=2099692" } ], "itemsProcessed": 1, - "itemsFailed": 1, + "itemsFailed": 2, "initialTrackingState": null, "finalTrackingState": null } diff --git a/specification/search/data-plane/Microsoft.Azure.Search.Service/stable/2019-05-06/examples/SearchServiceGetSkillset.json b/specification/search/data-plane/Microsoft.Azure.Search.Service/stable/2019-05-06/examples/SearchServiceGetSkillset.json index e552e1a0b9a3..f384a69c7ece 100644 --- a/specification/search/data-plane/Microsoft.Azure.Search.Service/stable/2019-05-06/examples/SearchServiceGetSkillset.json +++ b/specification/search/data-plane/Microsoft.Azure.Search.Service/stable/2019-05-06/examples/SearchServiceGetSkillset.json @@ -13,6 +13,7 @@ "skills": [ { "@odata.type": "#Microsoft.Skills.Text.EntityRecognitionSkill", + "name": "#1", "description": null, "context": null, "inputs": [ @@ -35,6 +36,7 @@ }, { "@odata.type": "#Microsoft.Skills.Text.LanguageDetectionSkill", + "name": "#2", "description": null, "context": null, "inputs": [ @@ -52,6 +54,7 @@ }, { "@odata.type": "#Microsoft.Skills.Text.SplitSkill", + "name": "#3", "description": null, "context": null, "inputs": [ @@ -76,6 +79,7 @@ }, { "@odata.type": "#Microsoft.Skills.Text.KeyPhraseExtractionSkill", + "name": "#4", "description": null, "context": "/document/pages/*", "inputs": [ @@ -96,6 +100,34 @@ ], "defaultLanguageCode": null, "maxKeyPhraseCount": null + }, + { + "@odata.type": "#Microsoft.Skills.Custom.WebApiSkill", + "name": "MyCustomWebApiSkill", + "description": null, + "context": "/document", + "uri": "https://contoso.example.org", + "httpMethod": "POST", + "timeout": "PT30S", + "batchSize": 1, + "degreeOfParallelism": null, + "inputs": [ + { + "name": "text", + "source": "/document/pages/*" + }, + { + "name": "languageCode", + "source": "/document/languageCode" + } + ], + "outputs": [ + { + "name": "customresult", + "targetName": "result" + } + ], + "httpHeaders": {} } ] } diff --git a/specification/search/data-plane/Microsoft.Azure.Search.Service/stable/2019-05-06/examples/SearchServiceListSkillsets.json b/specification/search/data-plane/Microsoft.Azure.Search.Service/stable/2019-05-06/examples/SearchServiceListSkillsets.json index 03705fc89a51..c0ae4f91a9ee 100644 --- a/specification/search/data-plane/Microsoft.Azure.Search.Service/stable/2019-05-06/examples/SearchServiceListSkillsets.json +++ b/specification/search/data-plane/Microsoft.Azure.Search.Service/stable/2019-05-06/examples/SearchServiceListSkillsets.json @@ -14,6 +14,7 @@ "skills": [ { "@odata.type": "#Microsoft.Skills.Text.EntityRecognitionSkill", + "name": "#1", "description": null, "context": null, "inputs": [ @@ -36,6 +37,7 @@ }, { "@odata.type": "#Microsoft.Skills.Text.LanguageDetectionSkill", + "name": "#2", "description": null, "context": null, "inputs": [ @@ -53,6 +55,7 @@ }, { "@odata.type": "#Microsoft.Skills.Text.SplitSkill", + "name": "#3", "description": null, "context": null, "inputs": [ @@ -77,6 +80,7 @@ }, { "@odata.type": "#Microsoft.Skills.Text.KeyPhraseExtractionSkill", + "name": "#4", "description": null, "context": "/document/pages/*", "inputs": [ @@ -97,6 +101,34 @@ ], "defaultLanguageCode": null, "maxKeyPhraseCount": null + }, + { + "@odata.type": "#Microsoft.Skills.Custom.WebApiSkill", + "name": "MyCustomWebApiSkill", + "description": null, + "context": "/document", + "uri": "https://contoso.example.org", + "httpMethod": "POST", + "timeout": "PT30S", + "batchSize": 1, + "degreeOfParallelism": null, + "inputs": [ + { + "name": "text", + "source": "/document/pages/*" + }, + { + "name": "languageCode", + "source": "/document/languageCode" + } + ], + "outputs": [ + { + "name": "customresult", + "targetName": "result" + } + ], + "httpHeaders": {} } ] } diff --git a/specification/search/data-plane/Microsoft.Azure.Search.Service/stable/2019-05-06/searchservice.json b/specification/search/data-plane/Microsoft.Azure.Search.Service/stable/2019-05-06/searchservice.json index 1cdd1dda3546..37a5f4f87bbc 100644 --- a/specification/search/data-plane/Microsoft.Azure.Search.Service/stable/2019-05-06/searchservice.json +++ b/specification/search/data-plane/Microsoft.Azure.Search.Service/stable/2019-05-06/searchservice.json @@ -3768,6 +3768,21 @@ "x-nullable": false, "readOnly": true, "description": "The status code indicating why the indexing operation failed. Possible values include: 400 for a malformed input document, 404 for document not found, 409 for a version conflict, 422 when the index is temporarily unavailable, or 503 for when the service is too busy." + }, + "name": { + "type": "string", + "readOnly": true, + "description": "The name of the source at which the error originated. For example, this could refer to a particular skill in the attached skillset. This may not be always available." + }, + "details": { + "type": "string", + "readOnly": true, + "description": "Additional, verbose details about the error to assist in debugging the indexer. This may not be always available." + }, + "documentationLink": { + "type": "string", + "readOnly": true, + "description": "A link to a troubleshooting guide for these classes of errors. This may not be always available." } }, "description": "Represents an item- or document-level indexing error." @@ -3783,6 +3798,21 @@ "type": "string", "readOnly": true, "description": "The message describing the warning that occurred while processing the item." + }, + "name": { + "type": "string", + "readOnly": true, + "description": "The name of the source at which the warning originated. For example, this could refer to a particular skill in the attached skillset. This may not be always available." + }, + "details": { + "type": "string", + "readOnly": true, + "description": "Additional, verbose details about the warning to assist in debugging the indexer. This may not be always available." + }, + "documentationLink": { + "type": "string", + "readOnly": true, + "description": "A link to a troubleshooting guide for these classes of warnings. This may not be always available." } }, "description": "Represents an item-level warning." @@ -4546,6 +4576,10 @@ "@odata.type": { "type": "string" }, + "name": { + "type": "string", + "description": "The name of the skill which uniquely identifies it within the skillset. A skill with no name defined will be given a default name of its 1-based index in the skills array, prefixed with the character '#'." + }, "description": { "type": "string", "description": "The description of the skill which describes the inputs, outputs, and usage of the skill." @@ -4947,6 +4981,12 @@ "format": "int32", "x-nullable": true, "description": "The desired batch size which indicates number of documents." + }, + "degreeOfParallelism": { + "type": "integer", + "format": "int32", + "x-nullable": true, + "description": "If set, the number of parallel calls that can be made to the Web API." } }, "required": [