You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: articles/search/search-dotnet-sdk-migration-version-10.md
+9-13Lines changed: 9 additions & 13 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -30,7 +30,7 @@ Version 10 adds several features and bug fixes, bringing it to the same function
30
30
Version 10 of the Azure Search .NET SDK targets the latest generally available version of the Azure Search REST API (`2019-05-06`) with these updates:
31
31
32
32
* Introduction of two new skills - [Conditional skill](cognitive-search-skill-conditional.md) and [Text Translation skill](cognitive-search-skill-text-translation.md).
33
-
*[Shaper skill](cognitive-search-skill-shaper.md) inputs have been restructured to accommodate consolidation from nested contexts. For more information, see this [example json definition](https://docs.microsoft.com/azure/search/cognitive-search-skill-shaper#scenario-3-input-consolidation-from-nested-contexts).
33
+
*[Shaper skill](cognitive-search-skill-shaper.md) inputs have been restructured to accommodate consolidation from nested contexts. For more information, see this [example JSON definition](https://docs.microsoft.com/azure/search/cognitive-search-skill-shaper#scenario-3-input-consolidation-from-nested-contexts).
34
34
* Addition of 2 new [field mapping functions](search-indexer-field-mappings.md):
@@ -63,7 +63,7 @@ There are several breaking changes in version 10 that may require code changes i
63
63
64
64
The definition of the [Custom Web API skill](cognitive-search-custom-skill-web-api.md) was incorrectly specified in version 9 and older.
65
65
66
-
The model for `WebApiSkill` specified `HttpHeaders` as an object property that _contains_ a dictionary. Creating a skillset with a `WebApiSkill` constructed in this manner would result in an exception because the REST API would consider the request badly formed. This has been corrected, by making `HttpHeaders`**a top-level dictionary property** on `WebApiSkill` model itself - which is considered a valid request from the REST API.
66
+
The model for `WebApiSkill` specified `HttpHeaders` as an object property that _contains_ a dictionary. Creating a skillset with a `WebApiSkill` constructed in this manner would result in an exception because the REST API would consider the request badly formed. This has been corrected, by making `HttpHeaders`**a top-level dictionary property** on the `WebApiSkill` model itself - which is considered a valid request from the REST API.
67
67
68
68
For example, if you previously attempted to instantiate a `WebApiSkill` as follows:
69
69
@@ -106,20 +106,20 @@ var webApiSkill = new WebApiSkill(
106
106
107
107
Shaper skill can now allow input consolidation from nested contexts. To enable this change, we modified `InputFieldMappingEntry` so that it can be instantiated by specifying just a `Source` property, or both the `SourceContext` and `Inputs` properties.
108
108
109
-
You will most likely not need to make any code changes - however note that only either of those 2 combinations are allowed. This means:
109
+
You will most likely not need to make any code changes; however note that only one of these two combinations is allowed. This means:
110
110
111
111
- Creating an `InputFieldMappingEntry` where only `Source` is initialized is valid.
112
-
- Creating an `InputFieldMappingEntry` where exactly both`SourceContext` and `Inputs` are initialized is valid.
112
+
- Creating an `InputFieldMappingEntry` where only`SourceContext` and `Inputs` are initialized is valid.
113
113
- All other combinations involving those three properties are invalid.
114
114
115
-
If you decide to start making use of this new capability, make sure all your clients are updated to use version 10 first, before rolling out that change. Otherwise, there is a possibility that an update by a client (using an older version of the SDK) to the shaper skill may result in validation errors.
115
+
If you decide to start making use of this new capability, make sure all your clients are updated to use version 10 first, before rolling out that change. Otherwise, there is a possibility that an update by a client (using an older version of the SDK) to the Shaper skill may result in validation errors.
116
116
117
117
> [!NOTE]
118
-
> Even though the underlying `InputFieldMappingEntry` model has been modified to allow consolidation from nested contexts, it's use is only valid withing the definition of a shaper skill, at the moment. Using this capability in other skills, while valid at compile time, will result in a validation error at runtime.
118
+
> Even though the underlying `InputFieldMappingEntry` model has been modified to allow consolidation from nested contexts, it's use is only valid within the definition of a Shaper skill. Using this capability in other skills, while valid at compile time, will result in a validation error at runtime.
119
119
120
120
## Skills can be identified by a name
121
121
122
-
Each skill within a skillset now has a new property `Name`, which can be initialized in your code to help identify the skill, in case you'd like to pinpoint errors/warnings during the indexer execution. This is optional - when unspecified (which is the default, if no explicit code change was made), it is assigned a default name using the 1-based index of the skill in the skillset. For example, in the following skillset definition (most initializations skipped for brevity):
122
+
Each skill within a skillset now has a new property `Name`, which can be initialized in your code to help identify the skill. This is optional - when unspecified (which is the default, if no explicit code change was made), it is assigned a default name using the 1-based index of the skill in the skillset, prefixed with the '#' character. For example, in the following skillset definition (most initializations skipped for brevity):
123
123
124
124
```csharp
125
125
varskillset=newSkillset()
@@ -136,11 +136,7 @@ var skillset = new Skillset()
## Additional details for errors and warnings as part of indexer execution status
146
142
@@ -155,7 +151,7 @@ If you choose to identify skills by a custom name, make sure to update all insta
155
151
156
152
## Next steps
157
153
158
-
- Changes to the shaper skill have the most potential impact on new or existing code. As a next step, be sure to revisit this example illustrating the input structure: [Shaper skill JSON definition example](cognitive-search-skill-shaper.md)
154
+
- Changes to the Shaper skill have the most potential impact on new or existing code. As a next step, be sure to revisit this example illustrating the input structure: [Shaper skill JSON definition example](cognitive-search-skill-shaper.md)
-WewelcomeyourfeedbackontheSDK. Ifyouencounterproblems, feelfreetoaskusfor help on [Stack Overflow](https://stackoverflow.com/questions/tagged/azure-search). If you find a bug, you can file an issue in the [Azure .NET SDK GitHub repository](https://github.com/Azure/azure-sdk-for-net/issues). Make sure to prefix your issue title with "[Azure Search]".
0 commit comments