Skip to content

Commit 8b885da

Browse files
[formrecognizer] sample fixes (Azure#20964)
* remove passing api_version in v3.1.x samples and uncomment list models * skip mgmt samples failing due to list models
1 parent 78a4a8a commit 8b885da

35 files changed

+64
-60
lines changed

scripts/devops_tasks/test_run_samples.py

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -125,6 +125,10 @@
125125
"sample_list_translations_with_filters.py",
126126
"sample_translation_with_custom_model.py",
127127
"sample_translation_with_custom_model_async.py",
128+
],
129+
"azure-ai-formrecognizer": [
130+
"sample_manage_custom_models.py",
131+
"sample_manage_custom_models_async.py",
128132
]
129133
}
130134

sdk/formrecognizer/azure-ai-formrecognizer/samples/v3.1/async_samples/sample_authentication_async.py

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -45,7 +45,7 @@ async def authentication_with_api_key_credential_form_recognizer_client_async(se
4545
endpoint = os.environ["AZURE_FORM_RECOGNIZER_ENDPOINT"]
4646
key = os.environ["AZURE_FORM_RECOGNIZER_KEY"]
4747

48-
form_recognizer_client = FormRecognizerClient(endpoint, AzureKeyCredential(key), api_version="2.1")
48+
form_recognizer_client = FormRecognizerClient(endpoint, AzureKeyCredential(key))
4949
# [END create_fr_client_with_key_async]
5050
async with form_recognizer_client:
5151
poller = await form_recognizer_client.begin_recognize_content_from_url(self.url)
@@ -62,7 +62,7 @@ async def authentication_with_azure_active_directory_form_recognizer_client_asyn
6262
endpoint = os.environ["AZURE_FORM_RECOGNIZER_ENDPOINT"]
6363
credential = DefaultAzureCredential()
6464

65-
form_recognizer_client = FormRecognizerClient(endpoint, credential, api_version="2.1")
65+
form_recognizer_client = FormRecognizerClient(endpoint, credential)
6666
# [END create_fr_client_with_aad_async]
6767
async with form_recognizer_client:
6868
poller = await form_recognizer_client.begin_recognize_content_from_url(self.url)
@@ -75,7 +75,7 @@ async def authentication_with_api_key_credential_form_training_client_async(self
7575
endpoint = os.environ["AZURE_FORM_RECOGNIZER_ENDPOINT"]
7676
key = os.environ["AZURE_FORM_RECOGNIZER_KEY"]
7777

78-
form_training_client = FormTrainingClient(endpoint, AzureKeyCredential(key), api_version="2.1")
78+
form_training_client = FormTrainingClient(endpoint, AzureKeyCredential(key))
7979
# [END create_ft_client_with_key_async]
8080
async with form_training_client:
8181
properties = await form_training_client.get_account_properties()
@@ -91,7 +91,7 @@ async def authentication_with_azure_active_directory_form_training_client_async(
9191
endpoint = os.environ["AZURE_FORM_RECOGNIZER_ENDPOINT"]
9292
credential = DefaultAzureCredential()
9393

94-
form_training_client = FormTrainingClient(endpoint, credential, api_version="2.1")
94+
form_training_client = FormTrainingClient(endpoint, credential)
9595
# [END create_ft_client_with_aad_async]
9696
async with form_training_client:
9797
properties = await form_training_client.get_account_properties()

sdk/formrecognizer/azure-ai-formrecognizer/samples/v3.1/async_samples/sample_copy_model_async.py

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -52,7 +52,7 @@ async def copy_model_async(self, custom_model_id):
5252
target_resource_id = os.environ["AZURE_FORM_RECOGNIZER_TARGET_RESOURCE_ID"]
5353

5454
# [START get_copy_authorization_async]
55-
target_client = FormTrainingClient(endpoint=target_endpoint, credential=AzureKeyCredential(target_key), api_version="2.1")
55+
target_client = FormTrainingClient(endpoint=target_endpoint, credential=AzureKeyCredential(target_key))
5656

5757
async with target_client:
5858
target = await target_client.get_copy_authorization(
@@ -64,7 +64,7 @@ async def copy_model_async(self, custom_model_id):
6464
# [END get_copy_authorization_async]
6565

6666
# [START copy_model_async]
67-
source_client = FormTrainingClient(endpoint=source_endpoint, credential=AzureKeyCredential(source_key), api_version="2.1")
67+
source_client = FormTrainingClient(endpoint=source_endpoint, credential=AzureKeyCredential(source_key))
6868

6969
async with source_client:
7070
poller = await source_client.begin_copy_model(
@@ -93,7 +93,7 @@ async def main():
9393
raise ValueError("Please provide endpoint and API key to run the samples.")
9494

9595
form_training_client = FormTrainingClient(
96-
endpoint=endpoint, credential=AzureKeyCredential(key), api_version="2.1"
96+
endpoint=endpoint, credential=AzureKeyCredential(key)
9797
)
9898
async with form_training_client:
9999
model = await (await form_training_client.begin_training(

sdk/formrecognizer/azure-ai-formrecognizer/samples/v3.1/async_samples/sample_create_composed_model_async.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -53,7 +53,7 @@ async def create_composed_model_async(self):
5353
po_furniture = os.environ['PURCHASE_ORDER_OFFICE_FURNITURE_SAS_URL_V2']
5454
po_cleaning_supplies = os.environ['PURCHASE_ORDER_OFFICE_CLEANING_SUPPLIES_SAS_URL_V2']
5555

56-
form_training_client = FormTrainingClient(endpoint=endpoint, credential=AzureKeyCredential(key), api_version="2.1")
56+
form_training_client = FormTrainingClient(endpoint=endpoint, credential=AzureKeyCredential(key))
5757
async with form_training_client:
5858
supplies_poller = await form_training_client.begin_training(
5959
po_supplies, use_training_labels=True, model_name="Purchase order - Office supplies"

sdk/formrecognizer/azure-ai-formrecognizer/samples/v3.1/async_samples/sample_differentiate_output_labeled_tables_async.py

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -53,7 +53,7 @@ async def test_recognize_tables_fixed_rows_async(self, custom_model_id):
5353
model_id_fixed_rows_table = os.getenv("MODEL_ID_FIXED_ROW_TABLES", custom_model_id)
5454

5555
form_recognizer_client = FormRecognizerClient(
56-
endpoint=endpoint, credential=AzureKeyCredential(key), api_version="2.1"
56+
endpoint=endpoint, credential=AzureKeyCredential(key)
5757
)
5858

5959
path_to_sample_forms = os.path.abspath(os.path.join(os.path.abspath(__file__),
@@ -96,7 +96,7 @@ async def test_recognize_tables_dynamic_rows_async(self, custom_model_id):
9696
model_id_dynamic_rows_table = os.getenv("MODEL_ID_DYNAMIC_ROW_TABLES", custom_model_id)
9797

9898
form_recognizer_client = FormRecognizerClient(
99-
endpoint=endpoint, credential=AzureKeyCredential(key), api_version="2.1"
99+
endpoint=endpoint, credential=AzureKeyCredential(key)
100100
)
101101

102102
path_to_sample_forms = os.path.abspath(os.path.join(os.path.abspath(__file__),
@@ -149,7 +149,7 @@ async def main():
149149
raise ValueError("Please provide endpoint and API key to run the samples.")
150150

151151
form_training_client = FormTrainingClient(
152-
endpoint=endpoint, credential=AzureKeyCredential(key), api_version="2.1"
152+
endpoint=endpoint, credential=AzureKeyCredential(key)
153153
)
154154

155155
async with form_training_client:

sdk/formrecognizer/azure-ai-formrecognizer/samples/v3.1/async_samples/sample_differentiate_output_models_trained_with_and_without_labels_async.py

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -59,7 +59,7 @@ async def recognize_custom_forms(self, labeled_model_id, unlabeled_model_id):
5959

6060
path_to_sample_forms = os.path.abspath(os.path.join(os.path.abspath(__file__), "..", "..", "..", "./sample_forms/forms/Form_1.jpg"))
6161
async with FormRecognizerClient(
62-
endpoint=endpoint, credential=AzureKeyCredential(key), api_version="2.1"
62+
endpoint=endpoint, credential=AzureKeyCredential(key)
6363
) as form_recognizer_client:
6464

6565
with open(path_to_sample_forms, "rb") as f:
@@ -143,7 +143,7 @@ async def main():
143143
raise ValueError("Please provide endpoint and API key to run the samples.")
144144

145145
form_training_client = FormTrainingClient(
146-
endpoint=endpoint, credential=AzureKeyCredential(key), api_version="2.1"
146+
endpoint=endpoint, credential=AzureKeyCredential(key)
147147
)
148148

149149
async with form_training_client:

sdk/formrecognizer/azure-ai-formrecognizer/samples/v3.1/async_samples/sample_get_bounding_boxes_async.py

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -51,7 +51,7 @@ async def get_bounding_boxes(self, custom_model_id):
5151
model_id = os.getenv("CUSTOM_TRAINED_MODEL_ID", custom_model_id)
5252

5353
form_recognizer_client = FormRecognizerClient(
54-
endpoint=endpoint, credential=AzureKeyCredential(key), api_version="2.1"
54+
endpoint=endpoint, credential=AzureKeyCredential(key)
5555
)
5656

5757
path_to_sample_forms = os.path.abspath(os.path.join(os.path.abspath(__file__),
@@ -135,7 +135,7 @@ async def main():
135135
raise ValueError("Please provide endpoint and API key to run the samples.")
136136

137137
form_training_client = FormTrainingClient(
138-
endpoint=endpoint, credential=AzureKeyCredential(key), api_version="2.1"
138+
endpoint=endpoint, credential=AzureKeyCredential(key)
139139
)
140140
async with form_training_client:
141141
model = await (await form_training_client.begin_training(

sdk/formrecognizer/azure-ai-formrecognizer/samples/v3.1/async_samples/sample_manage_custom_models_async.py

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -39,7 +39,7 @@ async def manage_custom_models(self):
3939

4040
# [START get_account_properties_async]
4141
async with FormTrainingClient(
42-
endpoint=endpoint, credential=AzureKeyCredential(key), api_version="2.1"
42+
endpoint=endpoint, credential=AzureKeyCredential(key)
4343
) as form_training_client:
4444
# First, we see how many custom models we have, and what our limit is
4545
account_properties = await form_training_client.get_account_properties()
@@ -52,9 +52,9 @@ async def manage_custom_models(self):
5252
# [START list_custom_models_async]
5353
custom_models = form_training_client.list_custom_models()
5454

55-
# print("We have models with the following IDs:") TODO list models is returning null for some models
56-
# async for model in custom_models:
57-
# print(model.model_id)
55+
print("We have models with the following IDs:")
56+
async for model in custom_models:
57+
print(model.model_id)
5858
# [END list_custom_models_async]
5959

6060
# let's train a model to use for this sample

sdk/formrecognizer/azure-ai-formrecognizer/samples/v3.1/async_samples/sample_recognize_business_cards_async.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -41,7 +41,7 @@ async def recognize_business_card_async(self):
4141
key = os.environ["AZURE_FORM_RECOGNIZER_KEY"]
4242

4343
form_recognizer_client = FormRecognizerClient(
44-
endpoint=endpoint, credential=AzureKeyCredential(key), api_version="2.1"
44+
endpoint=endpoint, credential=AzureKeyCredential(key)
4545
)
4646
async with form_recognizer_client:
4747
with open(path_to_sample_forms, "rb") as f:

sdk/formrecognizer/azure-ai-formrecognizer/samples/v3.1/async_samples/sample_recognize_content_async.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -48,7 +48,7 @@ async def recognize_content(self):
4848
key = os.environ["AZURE_FORM_RECOGNIZER_KEY"]
4949

5050
async with FormRecognizerClient(
51-
endpoint=endpoint, credential=AzureKeyCredential(key), api_version="2.1"
51+
endpoint=endpoint, credential=AzureKeyCredential(key)
5252
) as form_recognizer_client:
5353

5454
with open(path_to_sample_forms, "rb") as f:

0 commit comments

Comments
 (0)