Skip to content

Commit 02275b1

Browse files
authored
readme & sample updates (#12095)
1 parent fddce40 commit 02275b1

9 files changed

+262
-138
lines changed

sdk/search/azure-search-documents/README.md

+218-116
Large diffs are not rendered by default.

sdk/search/azure-search-documents/azure/search/documents/indexes/_internal/_utils.py

+4-2
Original file line numberDiff line numberDiff line change
@@ -423,11 +423,12 @@ def pack_search_field(search_field):
423423
)
424424
fields = [pack_search_field(x) for x in search_field.fields] \
425425
if search_field.fields else None
426+
retrievable = not search_field.hidden if search_field.hidden is not None else None
426427
return _SearchField(
427428
name=search_field.name,
428429
type=search_field.type,
429430
key=search_field.key,
430-
retrievable=not search_field.hidden,
431+
retrievable=retrievable,
431432
searchable=search_field.searchable,
432433
filterable=search_field.filterable,
433434
sortable=search_field.sortable,
@@ -446,11 +447,12 @@ def unpack_search_field(search_field):
446447
return None
447448
fields = [unpack_search_field(x) for x in search_field.fields] \
448449
if search_field.fields else None
450+
hidden = not search_field.retrievable if search_field.retrievable is not None else None
449451
return _SearchField(
450452
name=search_field.name,
451453
type=search_field.type,
452454
key=search_field.key,
453-
hidden=not search_field.retrievable,
455+
hidden=hidden,
454456
searchable=search_field.searchable,
455457
filterable=search_field.filterable,
456458
sortable=search_field.sortable,

sdk/search/azure-search-documents/samples/async_samples/sample_data_source_operations_async.py

+1-1
Original file line numberDiff line numberDiff line change
@@ -64,7 +64,7 @@ async def get_data_source_connection():
6464
async def delete_data_source_connection():
6565
# [START delete_data_source_connection_async]
6666
async with client:
67-
client.delete_datasource("async-sample-data-source-connection")
67+
client.delete_data_source_connection("async-sample-data-source-connection")
6868
print("Data Source Connection 'async-sample-data-source-connection' successfully deleted")
6969
# [END delete_data_source_connection_async]
7070

sdk/search/azure-search-documents/samples/async_samples/sample_index_crud_operations_async.py

+1-1
Original file line numberDiff line numberDiff line change
@@ -96,7 +96,7 @@ async def update_index():
9696
scoring_profiles=scoring_profiles,
9797
cors_options=cors_options)
9898

99-
result = await client.create_or_update_index(index_name=index.name, index=index)
99+
result = await client.create_or_update_index(index=index)
100100
# [END update_index_async]
101101

102102
async def delete_index():

sdk/search/azure-search-documents/samples/async_samples/sample_indexers_operations_async.py

+19-9
Original file line numberDiff line numberDiff line change
@@ -27,7 +27,12 @@
2727

2828
from azure.core.credentials import AzureKeyCredential
2929
from azure.search.documents.indexes.models import (
30-
SearchIndexerDataContainer, SearchIndex, SearchIndexer, SimpleField, SearchFieldDataType
30+
SearchIndexerDataContainer,
31+
SearchIndexerDataSourceConnection,
32+
SearchIndex,
33+
SearchIndexer,
34+
SimpleField,
35+
SearchFieldDataType
3136
)
3237
from azure.search.documents.indexes.aio import SearchIndexerClient, SearchIndexClient
3338

@@ -41,23 +46,28 @@ async def create_indexer():
4146
SimpleField(name="baseRate", type=SearchFieldDataType.Double)
4247
]
4348
index = SearchIndex(name=index_name, fields=fields)
44-
ind_client = SearchIndexClient(service_endpoint, AzureKeyCredential(key))
49+
ind_client = SearchIndexerClient(service_endpoint, AzureKeyCredential(key))
4550
async with ind_client:
4651
await ind_client.create_index(index)
4752

4853
# [START create_indexer_async]
4954
# create a datasource
5055
container = SearchIndexerDataContainer(name='searchcontainer')
56+
data_source_connection = SearchIndexerDataSourceConnection(
57+
name="indexer-datasource",
58+
type="azureblob",
59+
connection_string=connection_string,
60+
container=container
61+
)
5162
async with ind_client:
52-
data_source = await ind_client.create_datasource(
53-
name="async-indexer-datasource",
54-
type="azureblob",
55-
connection_string=connection_string,
56-
container=container
57-
)
63+
data_source = await ind_client.create_data_source_connection(data_source_connection)
5864

5965
# create an indexer
60-
indexer = SearchIndexer(name="async-sample-indexer", data_source_name="async-indexer-datasource", target_index_name="hotels")
66+
indexer = SearchIndexer(
67+
name="async-sample-indexer",
68+
data_source_name="async-indexer-datasource",
69+
target_index_name="indexer-hotels"
70+
)
6171
async with indexers_client:
6272
result = await indexers_client.create_indexer(indexer)
6373
print("Create new Indexer - async-sample-indexer")

sdk/search/azure-search-documents/samples/async_samples/sample_synonym_map_operations_async.py

+2-2
Original file line numberDiff line numberDiff line change
@@ -44,15 +44,15 @@ async def create_synonym_map():
4444
async def get_synonym_maps():
4545
# [START get_synonym_maps_async]
4646
result = await client.get_synonym_maps()
47-
names = [x["name"] for x in result]
47+
names = [x.name for x in result]
4848
print("Found {} Synonym Maps in the service: {}".format(len(result), ", ".join(names)))
4949
# [END get_synonym_maps_async]
5050

5151
async def get_synonym_map():
5252
# [START get_synonym_map_async]
5353
result = await client.get_synonym_map("test-syn-map")
5454
print("Retrived Synonym Map 'test-syn-map' with synonyms")
55-
for syn in result["synonyms"]:
55+
for syn in result.synonyms:
5656
print(" {}".format(syn))
5757
# [END get_synonym_map_async]
5858

sdk/search/azure-search-documents/samples/sample_index_crud_operations.py

+2-2
Original file line numberDiff line numberDiff line change
@@ -87,13 +87,13 @@ def update_index():
8787
)
8888
scoring_profiles = []
8989
scoring_profiles.append(scoring_profile)
90-
index = Index(
90+
index = SearchIndex(
9191
name=name,
9292
fields=fields,
9393
scoring_profiles=scoring_profiles,
9494
cors_options=cors_options)
9595

96-
result = client.create_or_update_index(index_name=index.name, index=index)
96+
result = client.create_or_update_index(index=index)
9797
# [END update_index]
9898

9999
def delete_index():

sdk/search/azure-search-documents/samples/sample_indexers_operations.py

+13-3
Original file line numberDiff line numberDiff line change
@@ -26,7 +26,12 @@
2626

2727
from azure.core.credentials import AzureKeyCredential
2828
from azure.search.documents.indexes.models import (
29-
SearchIndexerDataContainer, SearchIndex, SearchIndexer, SimpleField, SearchFieldDataType
29+
SearchIndexerDataContainer,
30+
SearchIndexerDataSourceConnection,
31+
SearchIndex,
32+
SearchIndexer,
33+
SimpleField,
34+
SearchFieldDataType
3035
)
3136
from azure.search.documents.indexes import SearchIndexClient, SearchIndexerClient
3237

@@ -46,15 +51,20 @@ def create_indexer():
4651
# [START create_indexer]
4752
# create a datasource
4853
container = SearchIndexerDataContainer(name='searchcontainer')
49-
data_source = indexers_client.create_datasource(
54+
data_source_connection = SearchIndexerDataSourceConnection(
5055
name="indexer-datasource",
5156
type="azureblob",
5257
connection_string=connection_string,
5358
container=container
5459
)
60+
data_source = indexers_client.create_data_source_connection(data_source_connection)
5561

5662
# create an indexer
57-
indexer = SearchIndexer(name="sample-indexer", data_source_name="indexer-datasource", target_index_name="hotels")
63+
indexer = SearchIndexer(
64+
name="sample-indexer",
65+
data_source_name="indexer-datasource",
66+
target_index_name="indexer-hotels"
67+
)
5868
result = indexers_client.create_indexer(indexer)
5969
print("Create new Indexer - sample-indexer")
6070
# [END create_indexer]

sdk/search/azure-search-documents/samples/sample_synonym_map_operations.py

+2-2
Original file line numberDiff line numberDiff line change
@@ -43,15 +43,15 @@ def create_synonym_map():
4343
def get_synonym_maps():
4444
# [START get_synonym_maps]
4545
result = client.get_synonym_maps()
46-
names = [x["name"] for x in result]
46+
names = [x.name for x in result]
4747
print("Found {} Synonym Maps in the service: {}".format(len(result), ", ".join(names)))
4848
# [END get_synonym_maps]
4949

5050
def get_synonym_map():
5151
# [START get_synonym_map]
5252
result = client.get_synonym_map("test-syn-map")
5353
print("Retrived Synonym Map 'test-syn-map' with synonyms")
54-
for syn in result["synonyms"]:
54+
for syn in result.synonyms:
5555
print(" {}".format(syn))
5656
# [END get_synonym_map]
5757

0 commit comments

Comments
 (0)