Skip to content

Commit 718ff08

Browse files
[formrecognizer] Update code to language code (Azure#22921)
* update to language code * update samples * fix path for async sample
1 parent 0bd46b1 commit 718ff08

File tree

6 files changed

+16
-15
lines changed

6 files changed

+16
-15
lines changed

sdk/formrecognizer/azure-ai-formrecognizer/azure/ai/formrecognizer/_models.py

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -2252,9 +2252,9 @@ def from_dict(cls, data):
22522252
class DocumentLanguage(object):
22532253
"""An object representing the detected language for a given text span.
22542254
2255-
:ivar code: Detected language code. Value may be an ISO 639-1 language code (ex.
2255+
:ivar language_code: Detected language code. Value may be an ISO 639-1 language code (ex.
22562256
"en", "fr") or a BCP 47 language tag (ex. "zh-Hans").
2257-
:vartype code: str
2257+
:vartype language_code: str
22582258
:ivar spans: Location of the text elements in the concatenated content that the language
22592259
applies to.
22602260
:vartype spans: list[~azure.ai.formrecognizer.DocumentSpan]
@@ -2263,21 +2263,21 @@ class DocumentLanguage(object):
22632263
"""
22642264

22652265
def __init__(self, **kwargs):
2266-
self.code = kwargs.get("code", None)
2266+
self.language_code = kwargs.get("language_code", None)
22672267
self.spans = kwargs.get("spans", None)
22682268
self.confidence = kwargs.get("confidence", None)
22692269

22702270
@classmethod
22712271
def _from_generated(cls, language):
22722272
return cls(
2273-
code=language.language_code,
2273+
language_code=language.language_code,
22742274
spans=prepare_document_spans(language.spans),
22752275
confidence=language.confidence,
22762276
)
22772277

22782278
def __repr__(self):
2279-
return "DocumentLanguage(code={}, spans={}, confidence={})".format(
2280-
self.code,
2279+
return "DocumentLanguage(language_code={}, spans={}, confidence={})".format(
2280+
self.language_code,
22812281
repr(self.spans),
22822282
self.confidence,
22832283
)
@@ -2290,7 +2290,7 @@ def to_dict(self):
22902290
:rtype: dict
22912291
"""
22922292
return {
2293-
"code": self.code,
2293+
"language_code": self.language_code,
22942294
"spans": [f.to_dict() for f in self.spans]
22952295
if self.spans
22962296
else [],
@@ -2307,7 +2307,7 @@ def from_dict(cls, data):
23072307
:rtype: DocumentLanguage
23082308
"""
23092309
return cls(
2310-
code=data.get("code", None),
2310+
language_code=data.get("language_code", None),
23112311
spans=[DocumentSpan.from_dict(v) for v in data.get("spans")] # type: ignore
23122312
if len(data.get("spans", [])) > 0
23132313
else [],

sdk/formrecognizer/azure-ai-formrecognizer/samples/v3.2-beta/async_samples/sample_analyze_read_async.py

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -35,6 +35,7 @@ async def analyze_read():
3535
os.path.abspath(__file__),
3636
"..",
3737
"..",
38+
"..",
3839
"./sample_forms/forms/Form_1.jpg",
3940
)
4041
)
@@ -58,7 +59,7 @@ async def analyze_read():
5859

5960
print("----Languages detected in the document----")
6061
for language in result.languages:
61-
print("Language code: '{}' with confidence {}".format(language.code, language.confidence))
62+
print("Language code: '{}' with confidence {}".format(language.language_code, language.confidence))
6263

6364
for page in result.pages:
6465
print("----Analyzing document from page #{}----".format(page.page_number))

sdk/formrecognizer/azure-ai-formrecognizer/samples/v3.2-beta/sample_analyze_read.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -55,7 +55,7 @@ def analyze_read():
5555

5656
print("----Languages detected in the document----")
5757
for language in result.languages:
58-
print("Language code: '{}' with confidence {}".format(language.code, language.confidence))
58+
print("Language code: '{}' with confidence {}".format(language.language_code, language.confidence))
5959

6060
for page in result.pages:
6161
print("----Analyzing document from page #{}----".format(page.page_number))

sdk/formrecognizer/azure-ai-formrecognizer/tests/test_repr.py

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -231,8 +231,8 @@ def document_line(bounding_box, document_span):
231231

232232
@pytest.fixture
233233
def document_language(document_span):
234-
model = _models.DocumentLanguage(code="en", spans=[document_span[0]], confidence=0.99)
235-
model_repr = "DocumentLanguage(code={}, spans=[{}], confidence={})".format(
234+
model = _models.DocumentLanguage(language_code="en", spans=[document_span[0]], confidence=0.99)
235+
model_repr = "DocumentLanguage(language_code={}, spans=[{}], confidence={})".format(
236236
"en",
237237
document_span[1],
238238
0.99,

sdk/formrecognizer/azure-ai-formrecognizer/tests/test_to_dict_v3.py

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1024,7 +1024,7 @@ def test_analyze_result_to_dict(self):
10241024
content="Sample\nFile content.",
10251025
languages=[
10261026
_models.DocumentLanguage(
1027-
code="en",
1027+
language_code="en",
10281028
spans=[
10291029
_models.DocumentSpan(offset=5, length=2),
10301030
],
@@ -1259,7 +1259,7 @@ def test_analyze_result_to_dict(self):
12591259
"content": "Sample\nFile content.",
12601260
"languages": [
12611261
{
1262-
"code": "en",
1262+
"language_code": "en",
12631263
"spans": [
12641264
{
12651265
"offset": 5,

sdk/formrecognizer/azure-ai-formrecognizer/tests/testcase.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -541,7 +541,7 @@ def assertDocumentLanguagesTransformCorrect(self, transformed_languages, raw_lan
541541
if transformed_languages == [] and not raw_languages:
542542
return
543543
for lang, expected in zip(transformed_languages, raw_languages):
544-
assert lang.code == expected.language_code
544+
assert lang.language_code == expected.language_code
545545
for span, expected_span in zip(lang.spans or [], expected.spans or []):
546546
self.assertSpanTransformCorrect(span, expected_span)
547547
assert lang.confidence == expected.confidence

0 commit comments

Comments
 (0)