Skip to content

Commit 3703e81

Browse files
ShivangiRejaShivangiReja
authored
[Search] Update readme and samples to use the same format of search resource data as official docs (Azure#33347)
* [Search] Update readme and samples to use same format of resource data as official docs
1 parent 954a09d commit 3703e81

28 files changed

+1958
-1073
lines changed

‎sdk/search/Azure.Search.Documents/README.md‎

Lines changed: 13 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -346,8 +346,8 @@ SearchIndex index = new SearchIndex("hotels")
346346
Fields = new FieldBuilder().Build(typeof(Hotel)),
347347
Suggesters =
348348
{
349-
// Suggest query terms from the hotelName field.
350-
new SearchSuggester("sg", "hotelName")
349+
// Suggest query terms from the HotelName field.
350+
new SearchSuggester("sg", "HotelName")
351351
}
352352
};
353353

@@ -364,26 +364,26 @@ SearchIndex index = new SearchIndex("hotels")
364364
{
365365
Fields =
366366
{
367-
new SimpleField("hotelId", SearchFieldDataType.String) { IsKey = true, IsFilterable = true, IsSortable = true },
368-
new SearchableField("hotelName") { IsFilterable = true, IsSortable = true },
369-
new SearchableField("description") { AnalyzerName = LexicalAnalyzerName.EnLucene },
370-
new SearchableField("tags", collection: true) { IsFilterable = true, IsFacetable = true },
371-
new ComplexField("address")
367+
new SimpleField("HotelId", SearchFieldDataType.String) { IsKey = true, IsFilterable = true, IsSortable = true },
368+
new SearchableField("HotelName") { IsFilterable = true, IsSortable = true },
369+
new SearchableField("Description") { AnalyzerName = LexicalAnalyzerName.EnLucene },
370+
new SearchableField("Tags", collection: true) { IsFilterable = true, IsFacetable = true },
371+
new ComplexField("Address")
372372
{
373373
Fields =
374374
{
375-
new SearchableField("streetAddress"),
376-
new SearchableField("city") { IsFilterable = true, IsSortable = true, IsFacetable = true },
377-
new SearchableField("stateProvince") { IsFilterable = true, IsSortable = true, IsFacetable = true },
378-
new SearchableField("country") { IsFilterable = true, IsSortable = true, IsFacetable = true },
379-
new SearchableField("postalCode") { IsFilterable = true, IsSortable = true, IsFacetable = true }
375+
new SearchableField("StreetAddress"),
376+
new SearchableField("City") { IsFilterable = true, IsSortable = true, IsFacetable = true },
377+
new SearchableField("StateProvince") { IsFilterable = true, IsSortable = true, IsFacetable = true },
378+
new SearchableField("Country") { IsFilterable = true, IsSortable = true, IsFacetable = true },
379+
new SearchableField("PostalCode") { IsFilterable = true, IsSortable = true, IsFacetable = true }
380380
}
381381
}
382382
},
383383
Suggesters =
384384
{
385385
// Suggest query terms from the hotelName field.
386-
new SearchSuggester("sg", "hotelName")
386+
new SearchSuggester("sg", "HotelName")
387387
}
388388
};
389389

‎sdk/search/Azure.Search.Documents/samples/Sample02_Service.md‎

Lines changed: 20 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -88,20 +88,20 @@ SearchIndex index = new SearchIndex(indexName)
8888
{
8989
Fields =
9090
{
91-
new SimpleField("hotelId", SearchFieldDataType.String) { IsKey = true, IsFilterable = true, IsSortable = true },
92-
new SearchableField("hotelName") { IsFilterable = true, IsSortable = true },
93-
new SearchableField("description") { AnalyzerName = LexicalAnalyzerName.EnLucene },
94-
new SearchableField("descriptionFr") { AnalyzerName = LexicalAnalyzerName.FrLucene },
95-
new SearchableField("tags", collection: true) { IsFilterable = true, IsFacetable = true },
96-
new ComplexField("address")
91+
new SimpleField("HotelId", SearchFieldDataType.String) { IsKey = true, IsFilterable = true, IsSortable = true },
92+
new SearchableField("HotelName") { IsFilterable = true, IsSortable = true },
93+
new SearchableField("Description") { AnalyzerName = LexicalAnalyzerName.EnLucene },
94+
new SearchableField("DescriptionFr") { AnalyzerName = LexicalAnalyzerName.FrLucene },
95+
new SearchableField("Tags", collection: true) { IsFilterable = true, IsFacetable = true },
96+
new ComplexField("Address")
9797
{
9898
Fields =
9999
{
100-
new SearchableField("streetAddress"),
101-
new SearchableField("city") { IsFilterable = true, IsSortable = true, IsFacetable = true },
102-
new SearchableField("stateProvince") { IsFilterable = true, IsSortable = true, IsFacetable = true },
103-
new SearchableField("country") { SynonymMapNames = new[] { synonymMapName }, IsFilterable = true, IsSortable = true, IsFacetable = true },
104-
new SearchableField("postalCode") { IsFilterable = true, IsSortable = true, IsFacetable = true }
100+
new SearchableField("StreetAddress"),
101+
new SearchableField("City") { IsFilterable = true, IsSortable = true, IsFacetable = true },
102+
new SearchableField("StateProvince") { IsFilterable = true, IsSortable = true, IsFacetable = true },
103+
new SearchableField("Country") { SynonymMapNames = new[] { synonymMapName }, IsFilterable = true, IsSortable = true, IsFacetable = true },
104+
new SearchableField("PostalCode") { IsFilterable = true, IsSortable = true, IsFacetable = true }
105105
}
106106
}
107107
}
@@ -167,7 +167,7 @@ about all available skills.
167167
TextTranslationSkill translationSkill = new TextTranslationSkill(
168168
inputs: new[]
169169
{
170-
new InputFieldMappingEntry("text") { Source = "/document/description" }
170+
new InputFieldMappingEntry("text") { Source = "/document/Description" }
171171
},
172172
outputs: new[]
173173
{
@@ -185,9 +185,9 @@ TextTranslationSkill translationSkill = new TextTranslationSkill(
185185
ConditionalSkill conditionalSkill = new ConditionalSkill(
186186
inputs: new[]
187187
{
188-
new InputFieldMappingEntry("condition") { Source = "= $(/document/descriptionFr) == null" },
188+
new InputFieldMappingEntry("condition") { Source = "= $(/document/DescriptionFr) == null" },
189189
new InputFieldMappingEntry("whenTrue") { Source = "/document/descriptionFrTranslated" },
190-
new InputFieldMappingEntry("whenFalse") { Source = "/document/descriptionFr" }
190+
new InputFieldMappingEntry("whenFalse") { Source = "/document/DescriptionFr" }
191191
},
192192
outputs: new[]
193193
{
@@ -230,15 +230,15 @@ SearchIndexer indexer = new SearchIndexer(
230230
// We only want to index fields defined in our index, excluding descriptionFr if defined.
231231
FieldMappings =
232232
{
233-
new FieldMapping("hotelId"),
234-
new FieldMapping("hotelName"),
235-
new FieldMapping("description"),
236-
new FieldMapping("tags"),
237-
new FieldMapping("address")
233+
new FieldMapping("HotelId"),
234+
new FieldMapping("HotelName"),
235+
new FieldMapping("Description"),
236+
new FieldMapping("Tags"),
237+
new FieldMapping("Address")
238238
},
239239
OutputFieldMappings =
240240
{
241-
new FieldMapping("/document/descriptionFrFinal") { TargetFieldName = "descriptionFr" }
241+
new FieldMapping("/document/descriptionFrFinal") { TargetFieldName = "DescriptionFr" }
242242
},
243243
Parameters = new IndexingParameters
244244
{

‎sdk/search/Azure.Search.Documents/samples/Sample06_EncryptedIndex.md‎

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -83,11 +83,11 @@ SearchIndexer indexer = new SearchIndexer(
8383
// Map the fields in our documents we want to index.
8484
FieldMappings =
8585
{
86-
new FieldMapping("hotelId"),
87-
new FieldMapping("hotelName"),
88-
new FieldMapping("description"),
89-
new FieldMapping("tags"),
90-
new FieldMapping("address")
86+
new FieldMapping("HotelId"),
87+
new FieldMapping("HotelName"),
88+
new FieldMapping("Description"),
89+
new FieldMapping("Tags"),
90+
new FieldMapping("Address")
9191
},
9292
Parameters = new IndexingParameters
9393
{

‎sdk/search/Azure.Search.Documents/src/Indexes/Models/SearchIndex.cs‎

Lines changed: 13 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -82,8 +82,8 @@ public SearchIndex(string name, IEnumerable<SearchField> fields)
8282
/// Fields = new FieldBuilder().Build(typeof(Hotel)),
8383
/// Suggesters =
8484
/// {
85-
/// // Suggest query terms from the hotelName field.
86-
/// new SearchSuggester(&quot;sg&quot;, &quot;hotelName&quot;)
85+
/// // Suggest query terms from the HotelName field.
86+
/// new SearchSuggester(&quot;sg&quot;, &quot;HotelName&quot;)
8787
/// }
8888
/// };
8989
/// </code>
@@ -94,26 +94,26 @@ public SearchIndex(string name, IEnumerable<SearchField> fields)
9494
/// {
9595
/// Fields =
9696
/// {
97-
/// new SimpleField(&quot;hotelId&quot;, SearchFieldDataType.String) { IsKey = true, IsFilterable = true, IsSortable = true },
98-
/// new SearchableField(&quot;hotelName&quot;) { IsFilterable = true, IsSortable = true },
99-
/// new SearchableField(&quot;description&quot;) { AnalyzerName = LexicalAnalyzerName.EnLucene },
100-
/// new SearchableField(&quot;tags&quot;, collection: true) { IsFilterable = true, IsFacetable = true },
101-
/// new ComplexField(&quot;address&quot;)
97+
/// new SimpleField(&quot;HotelId&quot;, SearchFieldDataType.String) { IsKey = true, IsFilterable = true, IsSortable = true },
98+
/// new SearchableField(&quot;HotelName&quot;) { IsFilterable = true, IsSortable = true },
99+
/// new SearchableField(&quot;Description&quot;) { AnalyzerName = LexicalAnalyzerName.EnLucene },
100+
/// new SearchableField(&quot;Tags&quot;, collection: true) { IsFilterable = true, IsFacetable = true },
101+
/// new ComplexField(&quot;Address&quot;)
102102
/// {
103103
/// Fields =
104104
/// {
105-
/// new SearchableField(&quot;streetAddress&quot;),
106-
/// new SearchableField(&quot;city&quot;) { IsFilterable = true, IsSortable = true, IsFacetable = true },
107-
/// new SearchableField(&quot;stateProvince&quot;) { IsFilterable = true, IsSortable = true, IsFacetable = true },
108-
/// new SearchableField(&quot;country&quot;) { IsFilterable = true, IsSortable = true, IsFacetable = true },
109-
/// new SearchableField(&quot;postalCode&quot;) { IsFilterable = true, IsSortable = true, IsFacetable = true }
105+
/// new SearchableField(&quot;StreetAddress&quot;),
106+
/// new SearchableField(&quot;City&quot;) { IsFilterable = true, IsSortable = true, IsFacetable = true },
107+
/// new SearchableField(&quot;StateProvince&quot;) { IsFilterable = true, IsSortable = true, IsFacetable = true },
108+
/// new SearchableField(&quot;Country&quot;) { IsFilterable = true, IsSortable = true, IsFacetable = true },
109+
/// new SearchableField(&quot;PostalCode&quot;) { IsFilterable = true, IsSortable = true, IsFacetable = true }
110110
/// }
111111
/// }
112112
/// },
113113
/// Suggesters =
114114
/// {
115115
/// // Suggest query terms from the hotelName field.
116-
/// new SearchSuggester(&quot;sg&quot;, &quot;hotelName&quot;)
116+
/// new SearchSuggester(&quot;sg&quot;, &quot;HotelName&quot;)
117117
/// }
118118
/// };
119119
/// </code>

0 commit comments

Comments
 (0)