From 7873d3f9d30d058938ba38fcd34db7d0d7554de6 Mon Sep 17 00:00:00 2001 From: azure-sdk Date: Thu, 30 Jul 2026 17:21:23 +0000 Subject: [PATCH 01/16] Configurations: 'specification/cognitiveservices/ContentSafety/tspconfig.yaml', API Version: 2026-07-01-preview, SDK Release Type: beta, and CommitSHA: '829ccecea7e9c1609881104b9a8d0f8cb65ce644' in SpecRepo: 'https://github.com/Azure/azure-rest-api-specs' Pipeline run: https://dev.azure.com/azure-sdk/internal/_build/results?buildId=6640811 Refer to https://eng.ms/docs/products/azure-developer-experience/develop/sdk-release/sdk-release-prerequisites to prepare for SDK release. --- .../azure-ai-contentsafety/CHANGELOG.md | 4 + .../azure-ai-contentsafety/MANIFEST.in | 2 +- .../azure-ai-contentsafety/_metadata.json | 11 + .../azure-ai-contentsafety/api.md | 1201 +++++++++++ .../azure-ai-contentsafety/api.metadata.yml | 3 + .../apiview-properties.json | 67 + .../azure/ai/contentsafety/__init__.py | 16 +- .../azure/ai/contentsafety/_client.py | 138 +- .../azure/ai/contentsafety/_configuration.py | 90 +- .../azure/ai/contentsafety/_model_base.py | 831 -------- .../ai/contentsafety/_operations/__init__.py | 20 +- .../contentsafety/_operations/_operations.py | 1195 ++++++++--- .../ai/contentsafety/_operations/_patch.py | 13 +- .../azure/ai/contentsafety/_patch.py | 13 +- .../azure/ai/contentsafety/_utils/__init__.py | 6 + .../ai/contentsafety/_utils/model_base.py | 1771 +++++++++++++++++ .../serialization.py} | 760 ++++--- .../azure/ai/contentsafety/_utils/utils.py | 25 + .../azure/ai/contentsafety/_validation.py | 66 + .../azure/ai/contentsafety/_vendor.py | 35 - .../azure/ai/contentsafety/_version.py | 2 +- .../azure/ai/contentsafety/aio/__init__.py | 16 +- .../azure/ai/contentsafety/aio/_client.py | 142 +- .../ai/contentsafety/aio/_configuration.py | 92 +- .../contentsafety/aio/_operations/__init__.py | 20 +- .../aio/_operations/_operations.py | 948 +++++++-- .../contentsafety/aio/_operations/_patch.py | 13 +- .../azure/ai/contentsafety/aio/_patch.py | 13 +- .../azure/ai/contentsafety/aio/_vendor.py | 35 - .../azure/ai/contentsafety/models/__init__.py | 81 +- .../azure/ai/contentsafety/models/_enums.py | 53 +- .../azure/ai/contentsafety/models/_models.py | 710 +++++-- .../azure/ai/contentsafety/models/_patch.py | 13 +- .../azure/ai/contentsafety/types.py | 207 ++ .../add_or_update_blocklist_items.py | 34 + .../generated_samples/analyze_image.py | 37 + .../generated_samples/analyze_text.py | 39 + .../create_or_update_text_blocklist.py | 34 + .../delete_text_blocklist.py | 32 + .../detect_text_protected_material.py | 33 + .../generated_samples/get_text_blocklist.py | 33 + .../get_text_blocklist_item.py | 34 + .../list_text_blocklist_items.py | 34 + .../generated_samples/list_text_blocklists.py | 32 + .../generated_samples/provenance_detect.py | 33 + .../provenance_get_operation_status.py | 33 + .../remove_blocklist_items.py | 33 + .../generated_samples/shield_prompt.py | 33 + .../generated_tests/conftest.py | 59 + .../generated_tests/test_blocklist.py | 105 + .../generated_tests/test_blocklist_async.py | 106 + .../test_content_provenance.py | 35 + .../test_content_provenance_async.py | 38 + .../generated_tests/test_content_safety.py | 67 + .../test_content_safety_async.py | 68 + .../generated_tests/testpreparer.py | 58 + .../generated_tests/testpreparer_async.py | 42 + .../azure-ai-contentsafety/pyproject.toml | 72 + .../samples/sample_manage_blocklist.py | 1 + .../azure-ai-contentsafety/sdk_packaging.toml | 2 - .../azure-ai-contentsafety/setup.py | 71 - .../azure-ai-contentsafety/tests/conftest.py | 1 + .../azure-ai-contentsafety/tsp-location.yaml | 4 +- 63 files changed, 7810 insertions(+), 2005 deletions(-) create mode 100644 sdk/contentsafety/azure-ai-contentsafety/_metadata.json create mode 100644 sdk/contentsafety/azure-ai-contentsafety/api.md create mode 100644 sdk/contentsafety/azure-ai-contentsafety/api.metadata.yml create mode 100644 sdk/contentsafety/azure-ai-contentsafety/apiview-properties.json delete mode 100644 sdk/contentsafety/azure-ai-contentsafety/azure/ai/contentsafety/_model_base.py create mode 100644 sdk/contentsafety/azure-ai-contentsafety/azure/ai/contentsafety/_utils/__init__.py create mode 100644 sdk/contentsafety/azure-ai-contentsafety/azure/ai/contentsafety/_utils/model_base.py rename sdk/contentsafety/azure-ai-contentsafety/azure/ai/contentsafety/{_serialization.py => _utils/serialization.py} (75%) create mode 100644 sdk/contentsafety/azure-ai-contentsafety/azure/ai/contentsafety/_utils/utils.py create mode 100644 sdk/contentsafety/azure-ai-contentsafety/azure/ai/contentsafety/_validation.py delete mode 100644 sdk/contentsafety/azure-ai-contentsafety/azure/ai/contentsafety/_vendor.py delete mode 100644 sdk/contentsafety/azure-ai-contentsafety/azure/ai/contentsafety/aio/_vendor.py create mode 100644 sdk/contentsafety/azure-ai-contentsafety/azure/ai/contentsafety/types.py create mode 100644 sdk/contentsafety/azure-ai-contentsafety/generated_samples/add_or_update_blocklist_items.py create mode 100644 sdk/contentsafety/azure-ai-contentsafety/generated_samples/analyze_image.py create mode 100644 sdk/contentsafety/azure-ai-contentsafety/generated_samples/analyze_text.py create mode 100644 sdk/contentsafety/azure-ai-contentsafety/generated_samples/create_or_update_text_blocklist.py create mode 100644 sdk/contentsafety/azure-ai-contentsafety/generated_samples/delete_text_blocklist.py create mode 100644 sdk/contentsafety/azure-ai-contentsafety/generated_samples/detect_text_protected_material.py create mode 100644 sdk/contentsafety/azure-ai-contentsafety/generated_samples/get_text_blocklist.py create mode 100644 sdk/contentsafety/azure-ai-contentsafety/generated_samples/get_text_blocklist_item.py create mode 100644 sdk/contentsafety/azure-ai-contentsafety/generated_samples/list_text_blocklist_items.py create mode 100644 sdk/contentsafety/azure-ai-contentsafety/generated_samples/list_text_blocklists.py create mode 100644 sdk/contentsafety/azure-ai-contentsafety/generated_samples/provenance_detect.py create mode 100644 sdk/contentsafety/azure-ai-contentsafety/generated_samples/provenance_get_operation_status.py create mode 100644 sdk/contentsafety/azure-ai-contentsafety/generated_samples/remove_blocklist_items.py create mode 100644 sdk/contentsafety/azure-ai-contentsafety/generated_samples/shield_prompt.py create mode 100644 sdk/contentsafety/azure-ai-contentsafety/generated_tests/conftest.py create mode 100644 sdk/contentsafety/azure-ai-contentsafety/generated_tests/test_blocklist.py create mode 100644 sdk/contentsafety/azure-ai-contentsafety/generated_tests/test_blocklist_async.py create mode 100644 sdk/contentsafety/azure-ai-contentsafety/generated_tests/test_content_provenance.py create mode 100644 sdk/contentsafety/azure-ai-contentsafety/generated_tests/test_content_provenance_async.py create mode 100644 sdk/contentsafety/azure-ai-contentsafety/generated_tests/test_content_safety.py create mode 100644 sdk/contentsafety/azure-ai-contentsafety/generated_tests/test_content_safety_async.py create mode 100644 sdk/contentsafety/azure-ai-contentsafety/generated_tests/testpreparer.py create mode 100644 sdk/contentsafety/azure-ai-contentsafety/generated_tests/testpreparer_async.py delete mode 100644 sdk/contentsafety/azure-ai-contentsafety/sdk_packaging.toml delete mode 100644 sdk/contentsafety/azure-ai-contentsafety/setup.py diff --git a/sdk/contentsafety/azure-ai-contentsafety/CHANGELOG.md b/sdk/contentsafety/azure-ai-contentsafety/CHANGELOG.md index b39ad7858ae6..492429f33536 100644 --- a/sdk/contentsafety/azure-ai-contentsafety/CHANGELOG.md +++ b/sdk/contentsafety/azure-ai-contentsafety/CHANGELOG.md @@ -1,5 +1,9 @@ # Release History +## 1.1.0b1 (2026-07-30) + +skip changelog generation for data-plane package and please add changelog manually. + ## 1.0.0 (2023-12-15) ### Features Added diff --git a/sdk/contentsafety/azure-ai-contentsafety/MANIFEST.in b/sdk/contentsafety/azure-ai-contentsafety/MANIFEST.in index 29c8cb3cb485..3b2206d7e041 100644 --- a/sdk/contentsafety/azure-ai-contentsafety/MANIFEST.in +++ b/sdk/contentsafety/azure-ai-contentsafety/MANIFEST.in @@ -4,4 +4,4 @@ include azure/ai/contentsafety/py.typed recursive-include tests *.py recursive-include samples *.py *.md include azure/__init__.py -include azure/ai/__init__.py \ No newline at end of file +include azure/ai/__init__.py diff --git a/sdk/contentsafety/azure-ai-contentsafety/_metadata.json b/sdk/contentsafety/azure-ai-contentsafety/_metadata.json new file mode 100644 index 000000000000..b5f9a9ff4c8b --- /dev/null +++ b/sdk/contentsafety/azure-ai-contentsafety/_metadata.json @@ -0,0 +1,11 @@ +{ + "apiVersion": "2026-07-01-preview", + "apiVersions": { + "ContentSafety": "2026-07-01-preview" + }, + "commit": "829ccecea7e9c1609881104b9a8d0f8cb65ce644", + "repository_url": "https://github.com/Azure/azure-rest-api-specs", + "typespec_src": "specification/cognitiveservices/ContentSafety", + "emitterVersion": "0.63.3", + "httpClientPythonVersion": "^0.34.2" +} \ No newline at end of file diff --git a/sdk/contentsafety/azure-ai-contentsafety/api.md b/sdk/contentsafety/azure-ai-contentsafety/api.md new file mode 100644 index 000000000000..41444fb89dfe --- /dev/null +++ b/sdk/contentsafety/azure-ai-contentsafety/api.md @@ -0,0 +1,1201 @@ +```py +namespace azure.ai.contentsafety + + class azure.ai.contentsafety.BlocklistClient(_BlocklistClientOperationsMixin): implements ContextManager + + def __init__( + self, + endpoint: str, + credential: Union[AzureKeyCredential, TokenCredential], + *, + api_version: str = ..., + **kwargs: Any + ) -> None: ... + + @overload + def add_or_update_blocklist_items( + self, + blocklist_name: str, + options: AddOrUpdateTextBlocklistItemsOptions, + *, + content_type: str = "application/json", + **kwargs: Any + ) -> AddOrUpdateTextBlocklistItemsResult: ... + + @overload + def add_or_update_blocklist_items( + self, + blocklist_name: str, + options: AddOrUpdateTextBlocklistItemsOptions, + *, + content_type: str = "application/json", + **kwargs: Any + ) -> AddOrUpdateTextBlocklistItemsResult: ... + + @overload + def add_or_update_blocklist_items( + self, + blocklist_name: str, + options: IO[bytes], + *, + content_type: str = "application/json", + **kwargs: Any + ) -> AddOrUpdateTextBlocklistItemsResult: ... + + def close(self) -> None: ... + + @overload + def create_or_update_text_blocklist( + self, + blocklist_name: str, + options: TextBlocklist, + *, + content_type: str = "application/merge-patch+json", + **kwargs: Any + ) -> TextBlocklist: ... + + @overload + def create_or_update_text_blocklist( + self, + blocklist_name: str, + options: TextBlocklist, + *, + content_type: str = "application/merge-patch+json", + **kwargs: Any + ) -> TextBlocklist: ... + + @overload + def create_or_update_text_blocklist( + self, + blocklist_name: str, + options: IO[bytes], + *, + content_type: str = "application/merge-patch+json", + **kwargs: Any + ) -> TextBlocklist: ... + + @distributed_trace + def delete_text_blocklist( + self, + blocklist_name: str, + **kwargs: Any + ) -> None: ... + + @distributed_trace + def get_text_blocklist( + self, + blocklist_name: str, + **kwargs: Any + ) -> TextBlocklist: ... + + @distributed_trace + def get_text_blocklist_item( + self, + blocklist_name: str, + blocklist_item_id: str, + **kwargs: Any + ) -> TextBlocklistItem: ... + + @distributed_trace + def list_text_blocklist_items( + self, + blocklist_name: str, + *, + skip: Optional[int] = ..., + top: Optional[int] = ..., + **kwargs: Any + ) -> ItemPaged[TextBlocklistItem]: ... + + @distributed_trace + def list_text_blocklists(self, **kwargs: Any) -> ItemPaged[TextBlocklist]: ... + + @overload + def remove_blocklist_items( + self, + blocklist_name: str, + options: RemoveTextBlocklistItemsOptions, + *, + content_type: str = "application/json", + **kwargs: Any + ) -> None: ... + + @overload + def remove_blocklist_items( + self, + blocklist_name: str, + options: RemoveTextBlocklistItemsOptions, + *, + content_type: str = "application/json", + **kwargs: Any + ) -> None: ... + + @overload + def remove_blocklist_items( + self, + blocklist_name: str, + options: IO[bytes], + *, + content_type: str = "application/json", + **kwargs: Any + ) -> None: ... + + def send_request( + self, + request: HttpRequest, + *, + stream: bool = False, + **kwargs: Any + ) -> HttpResponse: ... + + + class azure.ai.contentsafety.ContentProvenanceClient(_ContentProvenanceClientOperationsMixin): implements ContextManager + + def __init__( + self, + endpoint: str, + credential: Union[AzureKeyCredential, TokenCredential], + *, + api_version: str = ..., + polling_interval: Optional[int] = ..., + **kwargs: Any + ) -> None: ... + + @overload + def begin_detect( + self, + options: DetectProvenanceOptions, + *, + content_type: str = "application/json", + **kwargs: Any + ) -> LROPoller[DetectProvenanceResult]: ... + + @overload + def begin_detect( + self, + options: DetectProvenanceOptions, + *, + content_type: str = "application/json", + **kwargs: Any + ) -> LROPoller[DetectProvenanceResult]: ... + + @overload + def begin_detect( + self, + options: IO[bytes], + *, + content_type: str = "application/json", + **kwargs: Any + ) -> LROPoller[DetectProvenanceResult]: ... + + def close(self) -> None: ... + + @distributed_trace + def get_operation_status( + self, + operation_id: str, + **kwargs: Any + ) -> ProvenanceDetectOperation: ... + + def send_request( + self, + request: HttpRequest, + *, + stream: bool = False, + **kwargs: Any + ) -> HttpResponse: ... + + + class azure.ai.contentsafety.ContentSafetyClient(_ContentSafetyClientOperationsMixin): implements ContextManager + + def __init__( + self, + endpoint: str, + credential: Union[AzureKeyCredential, TokenCredential], + *, + api_version: str = ..., + **kwargs: Any + ) -> None: ... + + @overload + def analyze_image( + self, + options: AnalyzeImageOptions, + *, + content_type: str = "application/json", + **kwargs: Any + ) -> AnalyzeImageResult: ... + + @overload + def analyze_image( + self, + options: AnalyzeImageOptions, + *, + content_type: str = "application/json", + **kwargs: Any + ) -> AnalyzeImageResult: ... + + @overload + def analyze_image( + self, + options: IO[bytes], + *, + content_type: str = "application/json", + **kwargs: Any + ) -> AnalyzeImageResult: ... + + @overload + def analyze_text( + self, + options: AnalyzeTextOptions, + *, + content_type: str = "application/json", + **kwargs: Any + ) -> AnalyzeTextResult: ... + + @overload + def analyze_text( + self, + options: AnalyzeTextOptions, + *, + content_type: str = "application/json", + **kwargs: Any + ) -> AnalyzeTextResult: ... + + @overload + def analyze_text( + self, + options: IO[bytes], + *, + content_type: str = "application/json", + **kwargs: Any + ) -> AnalyzeTextResult: ... + + def close(self) -> None: ... + + @overload + def detect_text_protected_material( + self, + options: DetectTextProtectedMaterialOptions, + *, + content_type: str = "application/json", + **kwargs: Any + ) -> DetectTextProtectedMaterialResult: ... + + @overload + def detect_text_protected_material( + self, + options: DetectTextProtectedMaterialOptions, + *, + content_type: str = "application/json", + **kwargs: Any + ) -> DetectTextProtectedMaterialResult: ... + + @overload + def detect_text_protected_material( + self, + options: IO[bytes], + *, + content_type: str = "application/json", + **kwargs: Any + ) -> DetectTextProtectedMaterialResult: ... + + def send_request( + self, + request: HttpRequest, + *, + stream: bool = False, + **kwargs: Any + ) -> HttpResponse: ... + + @overload + def shield_prompt( + self, + options: ShieldPromptOptions, + *, + content_type: str = "application/json", + **kwargs: Any + ) -> ShieldPromptResult: ... + + @overload + def shield_prompt( + self, + options: ShieldPromptOptions, + *, + content_type: str = "application/json", + **kwargs: Any + ) -> ShieldPromptResult: ... + + @overload + def shield_prompt( + self, + options: IO[bytes], + *, + content_type: str = "application/json", + **kwargs: Any + ) -> ShieldPromptResult: ... + + +namespace azure.ai.contentsafety.aio + + class azure.ai.contentsafety.aio.BlocklistClient(_BlocklistClientOperationsMixin): implements AsyncContextManager + + def __init__( + self, + endpoint: str, + credential: Union[AzureKeyCredential, AsyncTokenCredential], + *, + api_version: str = ..., + **kwargs: Any + ) -> None: ... + + @overload + async def add_or_update_blocklist_items( + self, + blocklist_name: str, + options: AddOrUpdateTextBlocklistItemsOptions, + *, + content_type: str = "application/json", + **kwargs: Any + ) -> AddOrUpdateTextBlocklistItemsResult: ... + + @overload + async def add_or_update_blocklist_items( + self, + blocklist_name: str, + options: AddOrUpdateTextBlocklistItemsOptions, + *, + content_type: str = "application/json", + **kwargs: Any + ) -> AddOrUpdateTextBlocklistItemsResult: ... + + @overload + async def add_or_update_blocklist_items( + self, + blocklist_name: str, + options: IO[bytes], + *, + content_type: str = "application/json", + **kwargs: Any + ) -> AddOrUpdateTextBlocklistItemsResult: ... + + async def close(self) -> None: ... + + @overload + async def create_or_update_text_blocklist( + self, + blocklist_name: str, + options: TextBlocklist, + *, + content_type: str = "application/merge-patch+json", + **kwargs: Any + ) -> TextBlocklist: ... + + @overload + async def create_or_update_text_blocklist( + self, + blocklist_name: str, + options: TextBlocklist, + *, + content_type: str = "application/merge-patch+json", + **kwargs: Any + ) -> TextBlocklist: ... + + @overload + async def create_or_update_text_blocklist( + self, + blocklist_name: str, + options: IO[bytes], + *, + content_type: str = "application/merge-patch+json", + **kwargs: Any + ) -> TextBlocklist: ... + + @distributed_trace_async + async def delete_text_blocklist( + self, + blocklist_name: str, + **kwargs: Any + ) -> None: ... + + @distributed_trace_async + async def get_text_blocklist( + self, + blocklist_name: str, + **kwargs: Any + ) -> TextBlocklist: ... + + @distributed_trace_async + async def get_text_blocklist_item( + self, + blocklist_name: str, + blocklist_item_id: str, + **kwargs: Any + ) -> TextBlocklistItem: ... + + @distributed_trace + def list_text_blocklist_items( + self, + blocklist_name: str, + *, + skip: Optional[int] = ..., + top: Optional[int] = ..., + **kwargs: Any + ) -> AsyncItemPaged[TextBlocklistItem]: ... + + @distributed_trace + def list_text_blocklists(self, **kwargs: Any) -> AsyncItemPaged[TextBlocklist]: ... + + @overload + async def remove_blocklist_items( + self, + blocklist_name: str, + options: RemoveTextBlocklistItemsOptions, + *, + content_type: str = "application/json", + **kwargs: Any + ) -> None: ... + + @overload + async def remove_blocklist_items( + self, + blocklist_name: str, + options: RemoveTextBlocklistItemsOptions, + *, + content_type: str = "application/json", + **kwargs: Any + ) -> None: ... + + @overload + async def remove_blocklist_items( + self, + blocklist_name: str, + options: IO[bytes], + *, + content_type: str = "application/json", + **kwargs: Any + ) -> None: ... + + def send_request( + self, + request: HttpRequest, + *, + stream: bool = False, + **kwargs: Any + ) -> Awaitable[AsyncHttpResponse]: ... + + + class azure.ai.contentsafety.aio.ContentProvenanceClient(_ContentProvenanceClientOperationsMixin): implements AsyncContextManager + + def __init__( + self, + endpoint: str, + credential: Union[AzureKeyCredential, AsyncTokenCredential], + *, + api_version: str = ..., + polling_interval: Optional[int] = ..., + **kwargs: Any + ) -> None: ... + + @overload + async def begin_detect( + self, + options: DetectProvenanceOptions, + *, + content_type: str = "application/json", + **kwargs: Any + ) -> AsyncLROPoller[DetectProvenanceResult]: ... + + @overload + async def begin_detect( + self, + options: DetectProvenanceOptions, + *, + content_type: str = "application/json", + **kwargs: Any + ) -> AsyncLROPoller[DetectProvenanceResult]: ... + + @overload + async def begin_detect( + self, + options: IO[bytes], + *, + content_type: str = "application/json", + **kwargs: Any + ) -> AsyncLROPoller[DetectProvenanceResult]: ... + + async def close(self) -> None: ... + + @distributed_trace_async + async def get_operation_status( + self, + operation_id: str, + **kwargs: Any + ) -> ProvenanceDetectOperation: ... + + def send_request( + self, + request: HttpRequest, + *, + stream: bool = False, + **kwargs: Any + ) -> Awaitable[AsyncHttpResponse]: ... + + + class azure.ai.contentsafety.aio.ContentSafetyClient(_ContentSafetyClientOperationsMixin): implements AsyncContextManager + + def __init__( + self, + endpoint: str, + credential: Union[AzureKeyCredential, AsyncTokenCredential], + *, + api_version: str = ..., + **kwargs: Any + ) -> None: ... + + @overload + async def analyze_image( + self, + options: AnalyzeImageOptions, + *, + content_type: str = "application/json", + **kwargs: Any + ) -> AnalyzeImageResult: ... + + @overload + async def analyze_image( + self, + options: AnalyzeImageOptions, + *, + content_type: str = "application/json", + **kwargs: Any + ) -> AnalyzeImageResult: ... + + @overload + async def analyze_image( + self, + options: IO[bytes], + *, + content_type: str = "application/json", + **kwargs: Any + ) -> AnalyzeImageResult: ... + + @overload + async def analyze_text( + self, + options: AnalyzeTextOptions, + *, + content_type: str = "application/json", + **kwargs: Any + ) -> AnalyzeTextResult: ... + + @overload + async def analyze_text( + self, + options: AnalyzeTextOptions, + *, + content_type: str = "application/json", + **kwargs: Any + ) -> AnalyzeTextResult: ... + + @overload + async def analyze_text( + self, + options: IO[bytes], + *, + content_type: str = "application/json", + **kwargs: Any + ) -> AnalyzeTextResult: ... + + async def close(self) -> None: ... + + @overload + async def detect_text_protected_material( + self, + options: DetectTextProtectedMaterialOptions, + *, + content_type: str = "application/json", + **kwargs: Any + ) -> DetectTextProtectedMaterialResult: ... + + @overload + async def detect_text_protected_material( + self, + options: DetectTextProtectedMaterialOptions, + *, + content_type: str = "application/json", + **kwargs: Any + ) -> DetectTextProtectedMaterialResult: ... + + @overload + async def detect_text_protected_material( + self, + options: IO[bytes], + *, + content_type: str = "application/json", + **kwargs: Any + ) -> DetectTextProtectedMaterialResult: ... + + def send_request( + self, + request: HttpRequest, + *, + stream: bool = False, + **kwargs: Any + ) -> Awaitable[AsyncHttpResponse]: ... + + @overload + async def shield_prompt( + self, + options: ShieldPromptOptions, + *, + content_type: str = "application/json", + **kwargs: Any + ) -> ShieldPromptResult: ... + + @overload + async def shield_prompt( + self, + options: ShieldPromptOptions, + *, + content_type: str = "application/json", + **kwargs: Any + ) -> ShieldPromptResult: ... + + @overload + async def shield_prompt( + self, + options: IO[bytes], + *, + content_type: str = "application/json", + **kwargs: Any + ) -> ShieldPromptResult: ... + + +namespace azure.ai.contentsafety.models + + class azure.ai.contentsafety.models.AddOrUpdateTextBlocklistItemsOptions(_Model): + blocklist_items: list[TextBlocklistItem] + + @overload + def __init__( + self, + *, + blocklist_items: list[TextBlocklistItem] + ) -> None: ... + + @overload + def __init__(self, mapping: Mapping[str, Any]) -> None: ... + + + class azure.ai.contentsafety.models.AddOrUpdateTextBlocklistItemsResult(_Model): + blocklist_items: list[TextBlocklistItem] + + @overload + def __init__( + self, + *, + blocklist_items: list[TextBlocklistItem] + ) -> None: ... + + @overload + def __init__(self, mapping: Mapping[str, Any]) -> None: ... + + + class azure.ai.contentsafety.models.AnalyzeImageOptions(_Model): + categories: Optional[list[Union[str, ImageCategory]]] + image: ImageData + output_type: Optional[Union[str, AnalyzeImageOutputType]] + + @overload + def __init__( + self, + *, + categories: Optional[list[Union[str, ImageCategory]]] = ..., + image: ImageData, + output_type: Optional[Union[str, AnalyzeImageOutputType]] = ... + ) -> None: ... + + @overload + def __init__(self, mapping: Mapping[str, Any]) -> None: ... + + + class azure.ai.contentsafety.models.AnalyzeImageOutputType(str, Enum, metaclass=CaseInsensitiveEnumMeta): + FOUR_SEVERITY_LEVELS = "FourSeverityLevels" + + + class azure.ai.contentsafety.models.AnalyzeImageResult(_Model): + categories_analysis: list[ImageCategoriesAnalysis] + + @overload + def __init__( + self, + *, + categories_analysis: list[ImageCategoriesAnalysis] + ) -> None: ... + + @overload + def __init__(self, mapping: Mapping[str, Any]) -> None: ... + + + class azure.ai.contentsafety.models.AnalyzeTextOptions(_Model): + blocklist_names: Optional[list[str]] + categories: Optional[list[Union[str, TextCategory]]] + halt_on_blocklist_hit: Optional[bool] + output_type: Optional[Union[str, AnalyzeTextOutputType]] + text: str + + @overload + def __init__( + self, + *, + blocklist_names: Optional[list[str]] = ..., + categories: Optional[list[Union[str, TextCategory]]] = ..., + halt_on_blocklist_hit: Optional[bool] = ..., + output_type: Optional[Union[str, AnalyzeTextOutputType]] = ..., + text: str + ) -> None: ... + + @overload + def __init__(self, mapping: Mapping[str, Any]) -> None: ... + + + class azure.ai.contentsafety.models.AnalyzeTextOutputType(str, Enum, metaclass=CaseInsensitiveEnumMeta): + EIGHT_SEVERITY_LEVELS = "EightSeverityLevels" + FOUR_SEVERITY_LEVELS = "FourSeverityLevels" + + + class azure.ai.contentsafety.models.AnalyzeTextResult(_Model): + blocklists_match: Optional[list[TextBlocklistMatch]] + categories_analysis: list[TextCategoriesAnalysis] + + @overload + def __init__( + self, + *, + blocklists_match: Optional[list[TextBlocklistMatch]] = ..., + categories_analysis: list[TextCategoriesAnalysis] + ) -> None: ... + + @overload + def __init__(self, mapping: Mapping[str, Any]) -> None: ... + + + class azure.ai.contentsafety.models.DetectOutcome(str, Enum, metaclass=CaseInsensitiveEnumMeta): + NO_PROVENANCE_DETECTED = "NoProvenanceDetected" + PROVENANCE_DETECTED = "ProvenanceDetected" + + + class azure.ai.contentsafety.models.DetectProvenanceOptions(_Model): + content: ProvenanceContent + + @overload + def __init__( + self, + *, + content: ProvenanceContent + ) -> None: ... + + @overload + def __init__(self, mapping: Mapping[str, Any]) -> None: ... + + + class azure.ai.contentsafety.models.DetectProvenanceResult(_Model): + outcome: Union[str, DetectOutcome] + results: Optional[list[DetectedProvenance]] + + @overload + def __init__( + self, + *, + outcome: Union[str, DetectOutcome], + results: Optional[list[DetectedProvenance]] = ... + ) -> None: ... + + @overload + def __init__(self, mapping: Mapping[str, Any]) -> None: ... + + + class azure.ai.contentsafety.models.DetectTextProtectedMaterialOptions(_Model): + text: str + + @overload + def __init__( + self, + *, + text: str + ) -> None: ... + + @overload + def __init__(self, mapping: Mapping[str, Any]) -> None: ... + + + class azure.ai.contentsafety.models.DetectTextProtectedMaterialResult(_Model): + protected_material_analysis: TextProtectedMaterialAnalysisResult + + @overload + def __init__( + self, + *, + protected_material_analysis: TextProtectedMaterialAnalysisResult + ) -> None: ... + + @overload + def __init__(self, mapping: Mapping[str, Any]) -> None: ... + + + class azure.ai.contentsafety.models.DetectedProvenance(_Model): + model_name: Optional[str] + provider: Optional[str] + timestamp: Optional[datetime] + type: Optional[Union[str, DetectedProvenanceType]] + + @overload + def __init__( + self, + *, + model_name: Optional[str] = ..., + provider: Optional[str] = ..., + timestamp: Optional[datetime] = ..., + type: Optional[Union[str, DetectedProvenanceType]] = ... + ) -> None: ... + + @overload + def __init__(self, mapping: Mapping[str, Any]) -> None: ... + + + class azure.ai.contentsafety.models.DetectedProvenanceType(str, Enum, metaclass=CaseInsensitiveEnumMeta): + C2_PA = "C2PA" + WATERMARK = "Watermark" + + + class azure.ai.contentsafety.models.DocumentInjectionAnalysisResult(_Model): + attack_detected: bool + + @overload + def __init__( + self, + *, + attack_detected: bool + ) -> None: ... + + @overload + def __init__(self, mapping: Mapping[str, Any]) -> None: ... + + + class azure.ai.contentsafety.models.ImageCategoriesAnalysis(_Model): + category: Union[str, ImageCategory] + severity: Optional[int] + + @overload + def __init__( + self, + *, + category: Union[str, ImageCategory], + severity: Optional[int] = ... + ) -> None: ... + + @overload + def __init__(self, mapping: Mapping[str, Any]) -> None: ... + + + class azure.ai.contentsafety.models.ImageCategory(str, Enum, metaclass=CaseInsensitiveEnumMeta): + HATE = "Hate" + SELF_HARM = "SelfHarm" + SEXUAL = "Sexual" + VIOLENCE = "Violence" + + + class azure.ai.contentsafety.models.ImageData(_Model): + blob_url: Optional[str] + content: Optional[bytes] + + @overload + def __init__( + self, + *, + blob_url: Optional[str] = ..., + content: Optional[bytes] = ... + ) -> None: ... + + @overload + def __init__(self, mapping: Mapping[str, Any]) -> None: ... + + + class azure.ai.contentsafety.models.OperationState(str, Enum, metaclass=CaseInsensitiveEnumMeta): + CANCELED = "Canceled" + FAILED = "Failed" + NOT_STARTED = "NotStarted" + RUNNING = "Running" + SUCCEEDED = "Succeeded" + + + class azure.ai.contentsafety.models.ProvenanceContent(_Model): + uri: str + + @overload + def __init__( + self, + *, + uri: str + ) -> None: ... + + @overload + def __init__(self, mapping: Mapping[str, Any]) -> None: ... + + + class azure.ai.contentsafety.models.ProvenanceDetectOperation(_Model): + created_at: Optional[datetime] + error: Optional[ODataV4Format] + id: str + kind: Union[str, ProvenanceOperationKind] + last_updated_at: Optional[datetime] + result: Optional[DetectProvenanceResult] + status: Union[str, OperationState] + + @overload + def __init__( + self, + *, + error: Optional[ODataV4Format] = ..., + id: str, + result: Optional[DetectProvenanceResult] = ..., + status: Union[str, OperationState] + ) -> None: ... + + @overload + def __init__(self, mapping: Mapping[str, Any]) -> None: ... + + + class azure.ai.contentsafety.models.ProvenanceOperationKind(str, Enum, metaclass=CaseInsensitiveEnumMeta): + DETECT = "Detect" + + + class azure.ai.contentsafety.models.RemoveTextBlocklistItemsOptions(_Model): + blocklist_item_ids: list[str] + + @overload + def __init__( + self, + *, + blocklist_item_ids: list[str] + ) -> None: ... + + @overload + def __init__(self, mapping: Mapping[str, Any]) -> None: ... + + + class azure.ai.contentsafety.models.ShieldPromptOptions(_Model): + documents: Optional[list[str]] + user_prompt: Optional[str] + + @overload + def __init__( + self, + *, + documents: Optional[list[str]] = ..., + user_prompt: Optional[str] = ... + ) -> None: ... + + @overload + def __init__(self, mapping: Mapping[str, Any]) -> None: ... + + + class azure.ai.contentsafety.models.ShieldPromptResult(_Model): + documents_analysis: Optional[list[DocumentInjectionAnalysisResult]] + user_prompt_analysis: Optional[UserPromptInjectionAnalysisResult] + + @overload + def __init__( + self, + *, + documents_analysis: Optional[list[DocumentInjectionAnalysisResult]] = ..., + user_prompt_analysis: Optional[UserPromptInjectionAnalysisResult] = ... + ) -> None: ... + + @overload + def __init__(self, mapping: Mapping[str, Any]) -> None: ... + + + class azure.ai.contentsafety.models.TextBlocklist(_Model): + blocklist_name: str + description: Optional[str] + + @overload + def __init__( + self, + *, + blocklist_name: str, + description: Optional[str] = ... + ) -> None: ... + + @overload + def __init__(self, mapping: Mapping[str, Any]) -> None: ... + + + class azure.ai.contentsafety.models.TextBlocklistItem(_Model): + blocklist_item_id: str + description: Optional[str] + is_regex: Optional[bool] + text: str + + @overload + def __init__( + self, + *, + description: Optional[str] = ..., + is_regex: Optional[bool] = ..., + text: str + ) -> None: ... + + @overload + def __init__(self, mapping: Mapping[str, Any]) -> None: ... + + + class azure.ai.contentsafety.models.TextBlocklistMatch(_Model): + blocklist_item_id: str + blocklist_item_text: str + blocklist_name: str + + @overload + def __init__( + self, + *, + blocklist_item_id: str, + blocklist_item_text: str, + blocklist_name: str + ) -> None: ... + + @overload + def __init__(self, mapping: Mapping[str, Any]) -> None: ... + + + class azure.ai.contentsafety.models.TextCategoriesAnalysis(_Model): + category: Union[str, TextCategory] + severity: Optional[int] + + @overload + def __init__( + self, + *, + category: Union[str, TextCategory], + severity: Optional[int] = ... + ) -> None: ... + + @overload + def __init__(self, mapping: Mapping[str, Any]) -> None: ... + + + class azure.ai.contentsafety.models.TextCategory(str, Enum, metaclass=CaseInsensitiveEnumMeta): + HATE = "Hate" + SELF_HARM = "SelfHarm" + SEXUAL = "Sexual" + VIOLENCE = "Violence" + + + class azure.ai.contentsafety.models.TextProtectedMaterialAnalysisResult(_Model): + detected: bool + + @overload + def __init__( + self, + *, + detected: bool + ) -> None: ... + + @overload + def __init__(self, mapping: Mapping[str, Any]) -> None: ... + + + class azure.ai.contentsafety.models.UserPromptInjectionAnalysisResult(_Model): + attack_detected: bool + + @overload + def __init__( + self, + *, + attack_detected: bool + ) -> None: ... + + @overload + def __init__(self, mapping: Mapping[str, Any]) -> None: ... + + +namespace azure.ai.contentsafety.types + + class azure.ai.contentsafety.types.AddOrUpdateTextBlocklistItemsOptions(TypedDict, total=False): + key "blocklistItems": Required[list[TextBlocklistItem]] + blocklist_items: list[TextBlocklistItem] + + + class azure.ai.contentsafety.types.AnalyzeImageOptions(TypedDict, total=False): + key "image": Required[ImageData] + key "outputType": Union[str, AnalyzeImageOutputType] + categories: list[Union[str, ImageCategory]] + image: ImageData + output_type: Union[str, AnalyzeImageOutputType] + + + class azure.ai.contentsafety.types.AnalyzeTextOptions(TypedDict, total=False): + key "haltOnBlocklistHit": bool + key "outputType": Union[str, AnalyzeTextOutputType] + key "text": Required[str] + blocklistNames: list[str] + blocklist_names: list[str] + categories: list[Union[str, TextCategory]] + halt_on_blocklist_hit: bool + output_type: Union[str, AnalyzeTextOutputType] + text: str + + + class azure.ai.contentsafety.types.DetectProvenanceOptions(TypedDict, total=False): + key "content": Required[ProvenanceContent] + content: ProvenanceContent + + + class azure.ai.contentsafety.types.DetectTextProtectedMaterialOptions(TypedDict, total=False): + key "text": Required[str] + text: str + + + class azure.ai.contentsafety.types.ImageData(TypedDict, total=False): + key "blobUrl": str + key "content": str + blob_url: str + content: str + + + class azure.ai.contentsafety.types.ProvenanceContent(TypedDict, total=False): + key "uri": Required[str] + uri: str + + + class azure.ai.contentsafety.types.RemoveTextBlocklistItemsOptions(TypedDict, total=False): + key "blocklistItemIds": Required[list[str]] + blocklist_item_ids: list[str] + + + class azure.ai.contentsafety.types.ShieldPromptOptions(TypedDict, total=False): + key "userPrompt": str + documents: list[str] + user_prompt: str + + + class azure.ai.contentsafety.types.TextBlocklist(TypedDict, total=False): + key "blocklistName": Required[str] + key "description": str + blocklist_name: str + description: str + + + class azure.ai.contentsafety.types.TextBlocklistItem(TypedDict, total=False): + key "blocklistItemId": Required[str] + key "description": str + key "isRegex": bool + key "text": Required[str] + blocklist_item_id: str + description: str + is_regex: bool + text: str + + +``` \ No newline at end of file diff --git a/sdk/contentsafety/azure-ai-contentsafety/api.metadata.yml b/sdk/contentsafety/azure-ai-contentsafety/api.metadata.yml new file mode 100644 index 000000000000..fbbc447e5b14 --- /dev/null +++ b/sdk/contentsafety/azure-ai-contentsafety/api.metadata.yml @@ -0,0 +1,3 @@ +apiMdSha256: 04f0f979de1fd4dad50f631b6bd0ba453b8bce4f12769ab558e9900324d4afb8 +parserVersion: 0.3.30 +pythonVersion: 3.13.14 diff --git a/sdk/contentsafety/azure-ai-contentsafety/apiview-properties.json b/sdk/contentsafety/azure-ai-contentsafety/apiview-properties.json new file mode 100644 index 000000000000..0d503a5f4d85 --- /dev/null +++ b/sdk/contentsafety/azure-ai-contentsafety/apiview-properties.json @@ -0,0 +1,67 @@ +{ + "CrossLanguagePackageId": "ContentSafety", + "CrossLanguageDefinitionId": { + "azure.ai.contentsafety.models.AddOrUpdateTextBlocklistItemsOptions": "ContentSafety.AddOrUpdateTextBlocklistItemsOptions", + "azure.ai.contentsafety.models.AddOrUpdateTextBlocklistItemsResult": "ContentSafety.AddOrUpdateTextBlocklistItemsResult", + "azure.ai.contentsafety.models.AnalyzeImageOptions": "ContentSafety.AnalyzeImageOptions", + "azure.ai.contentsafety.models.AnalyzeImageResult": "ContentSafety.AnalyzeImageResult", + "azure.ai.contentsafety.models.AnalyzeTextOptions": "ContentSafety.AnalyzeTextOptions", + "azure.ai.contentsafety.models.AnalyzeTextResult": "ContentSafety.AnalyzeTextResult", + "azure.ai.contentsafety.models.DetectedProvenance": "ContentSafety.DetectedProvenance", + "azure.ai.contentsafety.models.DetectProvenanceOptions": "ContentSafety.DetectProvenanceOptions", + "azure.ai.contentsafety.models.DetectProvenanceResult": "ContentSafety.DetectProvenanceResult", + "azure.ai.contentsafety.models.DetectTextProtectedMaterialOptions": "ContentSafety.DetectTextProtectedMaterialOptions", + "azure.ai.contentsafety.models.DetectTextProtectedMaterialResult": "ContentSafety.DetectTextProtectedMaterialResult", + "azure.ai.contentsafety.models.DocumentInjectionAnalysisResult": "ContentSafety.DocumentInjectionAnalysisResult", + "azure.ai.contentsafety.models.ImageCategoriesAnalysis": "ContentSafety.ImageCategoriesAnalysis", + "azure.ai.contentsafety.models.ImageData": "ContentSafety.ImageData", + "azure.ai.contentsafety.models.ProvenanceContent": "ContentSafety.ProvenanceContent", + "azure.ai.contentsafety.models.ProvenanceDetectOperation": "ContentSafety.ProvenanceDetectOperation", + "azure.ai.contentsafety.models.RemoveTextBlocklistItemsOptions": "ContentSafety.RemoveTextBlocklistItemsOptions", + "azure.ai.contentsafety.models.ShieldPromptOptions": "ContentSafety.ShieldPromptOptions", + "azure.ai.contentsafety.models.ShieldPromptResult": "ContentSafety.ShieldPromptResult", + "azure.ai.contentsafety.models.TextBlocklist": "ContentSafety.TextBlocklist", + "azure.ai.contentsafety.models.TextBlocklistItem": "ContentSafety.TextBlocklistItem", + "azure.ai.contentsafety.models.TextBlocklistMatch": "ContentSafety.TextBlocklistMatch", + "azure.ai.contentsafety.models.TextCategoriesAnalysis": "ContentSafety.TextCategoriesAnalysis", + "azure.ai.contentsafety.models.TextProtectedMaterialAnalysisResult": "ContentSafety.TextProtectedMaterialAnalysisResult", + "azure.ai.contentsafety.models.UserPromptInjectionAnalysisResult": "ContentSafety.UserPromptInjectionAnalysisResult", + "azure.ai.contentsafety.models.ImageCategory": "ContentSafety.ImageCategory", + "azure.ai.contentsafety.models.AnalyzeImageOutputType": "ContentSafety.AnalyzeImageOutputType", + "azure.ai.contentsafety.models.TextCategory": "ContentSafety.TextCategory", + "azure.ai.contentsafety.models.AnalyzeTextOutputType": "ContentSafety.AnalyzeTextOutputType", + "azure.ai.contentsafety.models.DetectOutcome": "ContentSafety.DetectOutcome", + "azure.ai.contentsafety.models.DetectedProvenanceType": "ContentSafety.DetectedProvenanceType", + "azure.ai.contentsafety.models.OperationState": "Azure.Core.Foundations.OperationState", + "azure.ai.contentsafety.models.ProvenanceOperationKind": "ContentSafety.ProvenanceOperationKind", + "azure.ai.contentsafety.ContentSafetyClient.analyze_image": "Customizations.ContentSafetyClient.analyzeImage", + "azure.ai.contentsafety.aio.ContentSafetyClient.analyze_image": "Customizations.ContentSafetyClient.analyzeImage", + "azure.ai.contentsafety.ContentSafetyClient.analyze_text": "Customizations.ContentSafetyClient.analyzeText", + "azure.ai.contentsafety.aio.ContentSafetyClient.analyze_text": "Customizations.ContentSafetyClient.analyzeText", + "azure.ai.contentsafety.ContentSafetyClient.detect_text_protected_material": "Customizations.ContentSafetyClient.detectTextProtectedMaterial", + "azure.ai.contentsafety.aio.ContentSafetyClient.detect_text_protected_material": "Customizations.ContentSafetyClient.detectTextProtectedMaterial", + "azure.ai.contentsafety.ContentSafetyClient.shield_prompt": "Customizations.ContentSafetyClient.shieldPrompt", + "azure.ai.contentsafety.aio.ContentSafetyClient.shield_prompt": "Customizations.ContentSafetyClient.shieldPrompt", + "azure.ai.contentsafety.ContentProvenanceClient.begin_detect": "Customizations.ContentProvenanceClient.detect", + "azure.ai.contentsafety.aio.ContentProvenanceClient.begin_detect": "Customizations.ContentProvenanceClient.detect", + "azure.ai.contentsafety.ContentProvenanceClient.get_operation_status": "Customizations.ContentProvenanceClient.getOperationStatus", + "azure.ai.contentsafety.aio.ContentProvenanceClient.get_operation_status": "Customizations.ContentProvenanceClient.getOperationStatus", + "azure.ai.contentsafety.BlocklistClient.add_or_update_blocklist_items": "Customizations.BlocklistClient.addOrUpdateBlocklistItems", + "azure.ai.contentsafety.aio.BlocklistClient.add_or_update_blocklist_items": "Customizations.BlocklistClient.addOrUpdateBlocklistItems", + "azure.ai.contentsafety.BlocklistClient.create_or_update_text_blocklist": "Customizations.BlocklistClient.createOrUpdateTextBlocklist", + "azure.ai.contentsafety.aio.BlocklistClient.create_or_update_text_blocklist": "Customizations.BlocklistClient.createOrUpdateTextBlocklist", + "azure.ai.contentsafety.BlocklistClient.delete_text_blocklist": "Customizations.BlocklistClient.deleteTextBlocklist", + "azure.ai.contentsafety.aio.BlocklistClient.delete_text_blocklist": "Customizations.BlocklistClient.deleteTextBlocklist", + "azure.ai.contentsafety.BlocklistClient.get_text_blocklist": "Customizations.BlocklistClient.getTextBlocklist", + "azure.ai.contentsafety.aio.BlocklistClient.get_text_blocklist": "Customizations.BlocklistClient.getTextBlocklist", + "azure.ai.contentsafety.BlocklistClient.get_text_blocklist_item": "Customizations.BlocklistClient.getTextBlocklistItem", + "azure.ai.contentsafety.aio.BlocklistClient.get_text_blocklist_item": "Customizations.BlocklistClient.getTextBlocklistItem", + "azure.ai.contentsafety.BlocklistClient.list_text_blocklist_items": "Customizations.BlocklistClient.listTextBlocklistItems", + "azure.ai.contentsafety.aio.BlocklistClient.list_text_blocklist_items": "Customizations.BlocklistClient.listTextBlocklistItems", + "azure.ai.contentsafety.BlocklistClient.list_text_blocklists": "Customizations.BlocklistClient.listTextBlocklists", + "azure.ai.contentsafety.aio.BlocklistClient.list_text_blocklists": "Customizations.BlocklistClient.listTextBlocklists", + "azure.ai.contentsafety.BlocklistClient.remove_blocklist_items": "Customizations.BlocklistClient.removeBlocklistItems", + "azure.ai.contentsafety.aio.BlocklistClient.remove_blocklist_items": "Customizations.BlocklistClient.removeBlocklistItems" + }, + "CrossLanguageVersion": "b51bf37f4d86" +} \ No newline at end of file diff --git a/sdk/contentsafety/azure-ai-contentsafety/azure/ai/contentsafety/__init__.py b/sdk/contentsafety/azure-ai-contentsafety/azure/ai/contentsafety/__init__.py index 7eee7d8f0096..567405a5332b 100644 --- a/sdk/contentsafety/azure-ai-contentsafety/azure/ai/contentsafety/__init__.py +++ b/sdk/contentsafety/azure-ai-contentsafety/azure/ai/contentsafety/__init__.py @@ -5,24 +5,32 @@ # Code generated by Microsoft (R) Python Code Generator. # Changes may cause incorrect behavior and will be lost if the code is regenerated. # -------------------------------------------------------------------------- +# pylint: disable=wrong-import-position -from ._client import ContentSafetyClient -from ._client import BlocklistClient +from typing import TYPE_CHECKING + +if TYPE_CHECKING: + from ._patch import * # pylint: disable=unused-wildcard-import + +from ._client import ContentSafetyClient # type: ignore +from ._client import ContentProvenanceClient # type: ignore +from ._client import BlocklistClient # type: ignore from ._version import VERSION __version__ = VERSION try: from ._patch import __all__ as _patch_all - from ._patch import * # pylint: disable=unused-wildcard-import + from ._patch import * except ImportError: _patch_all = [] from ._patch import patch_sdk as _patch_sdk __all__ = [ "ContentSafetyClient", + "ContentProvenanceClient", "BlocklistClient", ] -__all__.extend([p for p in _patch_all if p not in __all__]) +__all__.extend([p for p in _patch_all if p not in __all__]) # pyright: ignore _patch_sdk() diff --git a/sdk/contentsafety/azure-ai-contentsafety/azure/ai/contentsafety/_client.py b/sdk/contentsafety/azure-ai-contentsafety/azure/ai/contentsafety/_client.py index e2e1f2849fe6..5909dbec99c4 100644 --- a/sdk/contentsafety/azure-ai-contentsafety/azure/ai/contentsafety/_client.py +++ b/sdk/contentsafety/azure-ai-contentsafety/azure/ai/contentsafety/_client.py @@ -7,6 +7,7 @@ # -------------------------------------------------------------------------- from copy import deepcopy +import sys from typing import Any, TYPE_CHECKING, Union from azure.core import PipelineClient @@ -14,33 +15,131 @@ from azure.core.pipeline import policies from azure.core.rest import HttpRequest, HttpResponse -from ._configuration import BlocklistClientConfiguration, ContentSafetyClientConfiguration -from ._operations import BlocklistClientOperationsMixin, ContentSafetyClientOperationsMixin -from ._serialization import Deserializer, Serializer +from ._configuration import ( + BlocklistClientConfiguration, + ContentProvenanceClientConfiguration, + ContentSafetyClientConfiguration, +) +from ._operations import ( + _BlocklistClientOperationsMixin, + _ContentProvenanceClientOperationsMixin, + _ContentSafetyClientOperationsMixin, +) +from ._utils.serialization import Deserializer, Serializer + +if sys.version_info >= (3, 11): + from typing import Self +else: + from typing_extensions import Self # type: ignore if TYPE_CHECKING: - # pylint: disable=unused-import,ungrouped-imports from azure.core.credentials import TokenCredential -class ContentSafetyClient(ContentSafetyClientOperationsMixin): # pylint: disable=client-accepts-api-version-keyword +class ContentSafetyClient(_ContentSafetyClientOperationsMixin): """ContentSafetyClient. :param endpoint: Supported Cognitive Services endpoints (protocol and hostname, for example: - https://:code:``.cognitiveservices.azure.com). Required. + https://.cognitiveservices.azure.com). Required. :type endpoint: str - :param credential: Credential needed for the client to connect to Azure. Is either a - AzureKeyCredential type or a TokenCredential type. Required. + :param credential: Credential used to authenticate requests to the service. Is either a key + credential type or a token credential type. Required. :type credential: ~azure.core.credentials.AzureKeyCredential or ~azure.core.credentials.TokenCredential - :keyword api_version: The API version to use for this operation. Default value is "2023-10-01". - Note that overriding this default value may result in unsupported behavior. + :keyword api_version: The API version to use for this operation. Known values are + "2026-07-01-preview" and None. Default value is None. If not set, the operation's default API + version will be used. Note that overriding this default value may result in unsupported + behavior. :paramtype api_version: str """ def __init__(self, endpoint: str, credential: Union[AzureKeyCredential, "TokenCredential"], **kwargs: Any) -> None: _endpoint = "{endpoint}/contentsafety" self._config = ContentSafetyClientConfiguration(endpoint=endpoint, credential=credential, **kwargs) + + _policies = kwargs.pop("policies", None) + if _policies is None: + _policies = [ + policies.RequestIdPolicy(**kwargs), + self._config.headers_policy, + self._config.user_agent_policy, + self._config.proxy_policy, + policies.ContentDecodePolicy(**kwargs), + self._config.redirect_policy, + self._config.retry_policy, + self._config.authentication_policy, + self._config.custom_hook_policy, + self._config.logging_policy, + policies.DistributedTracingPolicy(**kwargs), + policies.SensitiveHeaderCleanupPolicy(**kwargs) if self._config.redirect_policy else None, + self._config.http_logging_policy, + ] + self._client: PipelineClient = PipelineClient(base_url=_endpoint, policies=_policies, **kwargs) + + self._serialize = Serializer() + self._deserialize = Deserializer() + self._serialize.client_side_validation = False + + def send_request(self, request: HttpRequest, *, stream: bool = False, **kwargs: Any) -> HttpResponse: + """Runs the network request through the client's chained policies. + + >>> from azure.core.rest import HttpRequest + >>> request = HttpRequest("GET", "https://www.example.org/") + + >>> response = client.send_request(request) + + + For more information on this code flow, see https://aka.ms/azsdk/dpcodegen/python/send_request + + :param request: The network request you want to make. Required. + :type request: ~azure.core.rest.HttpRequest + :keyword bool stream: Whether the response payload will be streamed. Defaults to False. + :return: The response of your network call. Does not do error handling on your response. + :rtype: ~azure.core.rest.HttpResponse + """ + + request_copy = deepcopy(request) + path_format_arguments = { + "endpoint": self._serialize.url("self._config.endpoint", self._config.endpoint, "str", skip_quote=True), + } + + request_copy.url = self._client.format_url(request_copy.url, **path_format_arguments) + return self._client.send_request(request_copy, stream=stream, **kwargs) # type: ignore + + def close(self) -> None: + self._client.close() + + def __enter__(self) -> Self: + self._client.__enter__() + return self + + def __exit__(self, *exc_details: Any) -> None: + self._client.__exit__(*exc_details) + + +class ContentProvenanceClient(_ContentProvenanceClientOperationsMixin): + """ContentProvenanceClient. + + :param endpoint: Supported Cognitive Services endpoints (protocol and hostname, for example: + https://.cognitiveservices.azure.com). Required. + :type endpoint: str + :param credential: Credential used to authenticate requests to the service. Is either a key + credential type or a token credential type. Required. + :type credential: ~azure.core.credentials.AzureKeyCredential or + ~azure.core.credentials.TokenCredential + :keyword api_version: The API version to use for this operation. Known values are + "2026-07-01-preview" and None. Default value is None. If not set, the operation's default API + version will be used. Note that overriding this default value may result in unsupported + behavior. + :paramtype api_version: str + :keyword int polling_interval: Default waiting time between two polls for LRO operations if no + Retry-After header is present. + """ + + def __init__(self, endpoint: str, credential: Union[AzureKeyCredential, "TokenCredential"], **kwargs: Any) -> None: + _endpoint = "{endpoint}/contentsafety" + self._config = ContentProvenanceClientConfiguration(endpoint=endpoint, credential=credential, **kwargs) + _policies = kwargs.pop("policies", None) if _policies is None: _policies = [ @@ -93,7 +192,7 @@ def send_request(self, request: HttpRequest, *, stream: bool = False, **kwargs: def close(self) -> None: self._client.close() - def __enter__(self) -> "ContentSafetyClient": + def __enter__(self) -> Self: self._client.__enter__() return self @@ -101,24 +200,27 @@ def __exit__(self, *exc_details: Any) -> None: self._client.__exit__(*exc_details) -class BlocklistClient(BlocklistClientOperationsMixin): # pylint: disable=client-accepts-api-version-keyword +class BlocklistClient(_BlocklistClientOperationsMixin): """BlocklistClient. :param endpoint: Supported Cognitive Services endpoints (protocol and hostname, for example: - https://:code:``.cognitiveservices.azure.com). Required. + https://.cognitiveservices.azure.com). Required. :type endpoint: str - :param credential: Credential needed for the client to connect to Azure. Is either a - AzureKeyCredential type or a TokenCredential type. Required. + :param credential: Credential used to authenticate requests to the service. Is either a key + credential type or a token credential type. Required. :type credential: ~azure.core.credentials.AzureKeyCredential or ~azure.core.credentials.TokenCredential - :keyword api_version: The API version to use for this operation. Default value is "2023-10-01". - Note that overriding this default value may result in unsupported behavior. + :keyword api_version: The API version to use for this operation. Known values are + "2026-07-01-preview" and None. Default value is None. If not set, the operation's default API + version will be used. Note that overriding this default value may result in unsupported + behavior. :paramtype api_version: str """ def __init__(self, endpoint: str, credential: Union[AzureKeyCredential, "TokenCredential"], **kwargs: Any) -> None: _endpoint = "{endpoint}/contentsafety" self._config = BlocklistClientConfiguration(endpoint=endpoint, credential=credential, **kwargs) + _policies = kwargs.pop("policies", None) if _policies is None: _policies = [ @@ -171,7 +273,7 @@ def send_request(self, request: HttpRequest, *, stream: bool = False, **kwargs: def close(self) -> None: self._client.close() - def __enter__(self) -> "BlocklistClient": + def __enter__(self) -> Self: self._client.__enter__() return self diff --git a/sdk/contentsafety/azure-ai-contentsafety/azure/ai/contentsafety/_configuration.py b/sdk/contentsafety/azure-ai-contentsafety/azure/ai/contentsafety/_configuration.py index 9d9a723f0355..1ddb093f1eca 100644 --- a/sdk/contentsafety/azure-ai-contentsafety/azure/ai/contentsafety/_configuration.py +++ b/sdk/contentsafety/azure-ai-contentsafety/azure/ai/contentsafety/_configuration.py @@ -14,30 +14,31 @@ from ._version import VERSION if TYPE_CHECKING: - # pylint: disable=unused-import,ungrouped-imports from azure.core.credentials import TokenCredential -class ContentSafetyClientConfiguration: # pylint: disable=too-many-instance-attributes,name-too-long +class ContentSafetyClientConfiguration: # pylint: disable=too-many-instance-attributes """Configuration for ContentSafetyClient. Note that all parameters used to create this instance are saved as instance attributes. :param endpoint: Supported Cognitive Services endpoints (protocol and hostname, for example: - https://:code:``.cognitiveservices.azure.com). Required. + https://.cognitiveservices.azure.com). Required. :type endpoint: str - :param credential: Credential needed for the client to connect to Azure. Is either a - AzureKeyCredential type or a TokenCredential type. Required. + :param credential: Credential used to authenticate requests to the service. Is either a key + credential type or a token credential type. Required. :type credential: ~azure.core.credentials.AzureKeyCredential or ~azure.core.credentials.TokenCredential - :keyword api_version: The API version to use for this operation. Default value is "2023-10-01". - Note that overriding this default value may result in unsupported behavior. + :keyword api_version: The API version to use for this operation. Known values are + "2026-07-01-preview" and None. Default value is None. If not set, the operation's default API + version will be used. Note that overriding this default value may result in unsupported + behavior. :paramtype api_version: str """ def __init__(self, endpoint: str, credential: Union[AzureKeyCredential, "TokenCredential"], **kwargs: Any) -> None: - api_version: str = kwargs.pop("api_version", "2023-10-01") + api_version: str = kwargs.pop("api_version", "2026-07-01-preview") if endpoint is None: raise ValueError("Parameter 'endpoint' must not be None.") @@ -73,26 +74,85 @@ def _configure(self, **kwargs: Any) -> None: self.authentication_policy = self._infer_policy(**kwargs) -class BlocklistClientConfiguration: # pylint: disable=too-many-instance-attributes,name-too-long +class ContentProvenanceClientConfiguration: # pylint: disable=too-many-instance-attributes + """Configuration for ContentProvenanceClient. + + Note that all parameters used to create this instance are saved as instance + attributes. + + :param endpoint: Supported Cognitive Services endpoints (protocol and hostname, for example: + https://.cognitiveservices.azure.com). Required. + :type endpoint: str + :param credential: Credential used to authenticate requests to the service. Is either a key + credential type or a token credential type. Required. + :type credential: ~azure.core.credentials.AzureKeyCredential or + ~azure.core.credentials.TokenCredential + :keyword api_version: The API version to use for this operation. Known values are + "2026-07-01-preview" and None. Default value is None. If not set, the operation's default API + version will be used. Note that overriding this default value may result in unsupported + behavior. + :paramtype api_version: str + """ + + def __init__(self, endpoint: str, credential: Union[AzureKeyCredential, "TokenCredential"], **kwargs: Any) -> None: + api_version: str = kwargs.pop("api_version", "2026-07-01-preview") + + if endpoint is None: + raise ValueError("Parameter 'endpoint' must not be None.") + if credential is None: + raise ValueError("Parameter 'credential' must not be None.") + + self.endpoint = endpoint + self.credential = credential + self.api_version = api_version + self.credential_scopes = kwargs.pop("credential_scopes", ["https://cognitiveservices.azure.com/.default"]) + kwargs.setdefault("sdk_moniker", "ai-contentsafety/{}".format(VERSION)) + self.polling_interval = kwargs.get("polling_interval", 30) + self._configure(**kwargs) + + def _infer_policy(self, **kwargs): + if isinstance(self.credential, AzureKeyCredential): + return policies.AzureKeyCredentialPolicy(self.credential, "Ocp-Apim-Subscription-Key", **kwargs) + if hasattr(self.credential, "get_token"): + return policies.BearerTokenCredentialPolicy(self.credential, *self.credential_scopes, **kwargs) + raise TypeError(f"Unsupported credential: {self.credential}") + + def _configure(self, **kwargs: Any) -> None: + self.user_agent_policy = kwargs.get("user_agent_policy") or policies.UserAgentPolicy(**kwargs) + self.headers_policy = kwargs.get("headers_policy") or policies.HeadersPolicy(**kwargs) + self.proxy_policy = kwargs.get("proxy_policy") or policies.ProxyPolicy(**kwargs) + self.logging_policy = kwargs.get("logging_policy") or policies.NetworkTraceLoggingPolicy(**kwargs) + self.http_logging_policy = kwargs.get("http_logging_policy") or policies.HttpLoggingPolicy(**kwargs) + self.custom_hook_policy = kwargs.get("custom_hook_policy") or policies.CustomHookPolicy(**kwargs) + self.redirect_policy = kwargs.get("redirect_policy") or policies.RedirectPolicy(**kwargs) + self.retry_policy = kwargs.get("retry_policy") or policies.RetryPolicy(**kwargs) + self.authentication_policy = kwargs.get("authentication_policy") + if self.credential and not self.authentication_policy: + self.authentication_policy = self._infer_policy(**kwargs) + + +class BlocklistClientConfiguration: # pylint: disable=too-many-instance-attributes """Configuration for BlocklistClient. Note that all parameters used to create this instance are saved as instance attributes. :param endpoint: Supported Cognitive Services endpoints (protocol and hostname, for example: - https://:code:``.cognitiveservices.azure.com). Required. + https://.cognitiveservices.azure.com). Required. :type endpoint: str - :param credential: Credential needed for the client to connect to Azure. Is either a - AzureKeyCredential type or a TokenCredential type. Required. + :param credential: Credential used to authenticate requests to the service. Is either a key + credential type or a token credential type. Required. :type credential: ~azure.core.credentials.AzureKeyCredential or ~azure.core.credentials.TokenCredential - :keyword api_version: The API version to use for this operation. Default value is "2023-10-01". - Note that overriding this default value may result in unsupported behavior. + :keyword api_version: The API version to use for this operation. Known values are + "2026-07-01-preview" and None. Default value is None. If not set, the operation's default API + version will be used. Note that overriding this default value may result in unsupported + behavior. :paramtype api_version: str """ def __init__(self, endpoint: str, credential: Union[AzureKeyCredential, "TokenCredential"], **kwargs: Any) -> None: - api_version: str = kwargs.pop("api_version", "2023-10-01") + api_version: str = kwargs.pop("api_version", "2026-07-01-preview") if endpoint is None: raise ValueError("Parameter 'endpoint' must not be None.") diff --git a/sdk/contentsafety/azure-ai-contentsafety/azure/ai/contentsafety/_model_base.py b/sdk/contentsafety/azure-ai-contentsafety/azure/ai/contentsafety/_model_base.py deleted file mode 100644 index aec056aba7b7..000000000000 --- a/sdk/contentsafety/azure-ai-contentsafety/azure/ai/contentsafety/_model_base.py +++ /dev/null @@ -1,831 +0,0 @@ -# coding=utf-8 -# -------------------------------------------------------------------------- -# Copyright (c) Microsoft Corporation. All rights reserved. -# Licensed under the MIT License. See License.txt in the project root for -# license information. -# -------------------------------------------------------------------------- -# pylint: disable=protected-access, arguments-differ, signature-differs, broad-except -# pyright: reportGeneralTypeIssues=false - -import calendar -import decimal -import functools -import sys -import logging -import base64 -import re -import copy -import typing -import email -from datetime import datetime, date, time, timedelta, timezone -from json import JSONEncoder -import isodate -from azure.core.exceptions import DeserializationError -from azure.core import CaseInsensitiveEnumMeta -from azure.core.pipeline import PipelineResponse -from azure.core.serialization import _Null - -if sys.version_info >= (3, 9): - from collections.abc import MutableMapping -else: - from typing import MutableMapping - -_LOGGER = logging.getLogger(__name__) - -__all__ = ["SdkJSONEncoder", "Model", "rest_field", "rest_discriminator"] - -TZ_UTC = timezone.utc - - -def _timedelta_as_isostr(td: timedelta) -> str: - """Converts a datetime.timedelta object into an ISO 8601 formatted string, e.g. 'P4DT12H30M05S' - - Function adapted from the Tin Can Python project: https://github.com/RusticiSoftware/TinCanPython - - :param timedelta td: The timedelta to convert - :rtype: str - :return: ISO8601 version of this timedelta - """ - - # Split seconds to larger units - seconds = td.total_seconds() - minutes, seconds = divmod(seconds, 60) - hours, minutes = divmod(minutes, 60) - days, hours = divmod(hours, 24) - - days, hours, minutes = list(map(int, (days, hours, minutes))) - seconds = round(seconds, 6) - - # Build date - date_str = "" - if days: - date_str = "%sD" % days - - if hours or minutes or seconds: - # Build time - time_str = "T" - - # Hours - bigger_exists = date_str or hours - if bigger_exists: - time_str += "{:02}H".format(hours) - - # Minutes - bigger_exists = bigger_exists or minutes - if bigger_exists: - time_str += "{:02}M".format(minutes) - - # Seconds - try: - if seconds.is_integer(): - seconds_string = "{:02}".format(int(seconds)) - else: - # 9 chars long w/ leading 0, 6 digits after decimal - seconds_string = "%09.6f" % seconds - # Remove trailing zeros - seconds_string = seconds_string.rstrip("0") - except AttributeError: # int.is_integer() raises - seconds_string = "{:02}".format(seconds) - - time_str += "{}S".format(seconds_string) - else: - time_str = "" - - return "P" + date_str + time_str - - -def _serialize_bytes(o, format: typing.Optional[str] = None) -> str: - encoded = base64.b64encode(o).decode() - if format == "base64url": - return encoded.strip("=").replace("+", "-").replace("/", "_") - return encoded - - -def _serialize_datetime(o, format: typing.Optional[str] = None): - if hasattr(o, "year") and hasattr(o, "hour"): - if format == "rfc7231": - return email.utils.format_datetime(o, usegmt=True) - if format == "unix-timestamp": - return int(calendar.timegm(o.utctimetuple())) - - # astimezone() fails for naive times in Python 2.7, so make make sure o is aware (tzinfo is set) - if not o.tzinfo: - iso_formatted = o.replace(tzinfo=TZ_UTC).isoformat() - else: - iso_formatted = o.astimezone(TZ_UTC).isoformat() - # Replace the trailing "+00:00" UTC offset with "Z" (RFC 3339: https://www.ietf.org/rfc/rfc3339.txt) - return iso_formatted.replace("+00:00", "Z") - # Next try datetime.date or datetime.time - return o.isoformat() - - -def _is_readonly(p): - try: - return p._visibility == ["read"] # pylint: disable=protected-access - except AttributeError: - return False - - -class SdkJSONEncoder(JSONEncoder): - """A JSON encoder that's capable of serializing datetime objects and bytes.""" - - def __init__(self, *args, exclude_readonly: bool = False, format: typing.Optional[str] = None, **kwargs): - super().__init__(*args, **kwargs) - self.exclude_readonly = exclude_readonly - self.format = format - - def default(self, o): # pylint: disable=too-many-return-statements - if _is_model(o): - if self.exclude_readonly: - readonly_props = [p._rest_name for p in o._attr_to_rest_field.values() if _is_readonly(p)] - return {k: v for k, v in o.items() if k not in readonly_props} - return dict(o.items()) - try: - return super(SdkJSONEncoder, self).default(o) - except TypeError: - if isinstance(o, _Null): - return None - if isinstance(o, decimal.Decimal): - return float(o) - if isinstance(o, (bytes, bytearray)): - return _serialize_bytes(o, self.format) - try: - # First try datetime.datetime - return _serialize_datetime(o, self.format) - except AttributeError: - pass - # Last, try datetime.timedelta - try: - return _timedelta_as_isostr(o) - except AttributeError: - # This will be raised when it hits value.total_seconds in the method above - pass - return super(SdkJSONEncoder, self).default(o) - - -_VALID_DATE = re.compile(r"\d{4}[-]\d{2}[-]\d{2}T\d{2}:\d{2}:\d{2}" + r"\.?\d*Z?[-+]?[\d{2}]?:?[\d{2}]?") -_VALID_RFC7231 = re.compile( - r"(Mon|Tue|Wed|Thu|Fri|Sat|Sun),\s\d{2}\s" - r"(Jan|Feb|Mar|Apr|May|Jun|Jul|Aug|Sep|Oct|Nov|Dec)\s\d{4}\s\d{2}:\d{2}:\d{2}\sGMT" -) - - -def _deserialize_datetime(attr: typing.Union[str, datetime]) -> datetime: - """Deserialize ISO-8601 formatted string into Datetime object. - - :param str attr: response string to be deserialized. - :rtype: ~datetime.datetime - :returns: The datetime object from that input - """ - if isinstance(attr, datetime): - # i'm already deserialized - return attr - attr = attr.upper() - match = _VALID_DATE.match(attr) - if not match: - raise ValueError("Invalid datetime string: " + attr) - - check_decimal = attr.split(".") - if len(check_decimal) > 1: - decimal_str = "" - for digit in check_decimal[1]: - if digit.isdigit(): - decimal_str += digit - else: - break - if len(decimal_str) > 6: - attr = attr.replace(decimal_str, decimal_str[0:6]) - - date_obj = isodate.parse_datetime(attr) - test_utc = date_obj.utctimetuple() - if test_utc.tm_year > 9999 or test_utc.tm_year < 1: - raise OverflowError("Hit max or min date") - return date_obj - - -def _deserialize_datetime_rfc7231(attr: typing.Union[str, datetime]) -> datetime: - """Deserialize RFC7231 formatted string into Datetime object. - - :param str attr: response string to be deserialized. - :rtype: ~datetime.datetime - :returns: The datetime object from that input - """ - if isinstance(attr, datetime): - # i'm already deserialized - return attr - match = _VALID_RFC7231.match(attr) - if not match: - raise ValueError("Invalid datetime string: " + attr) - - return email.utils.parsedate_to_datetime(attr) - - -def _deserialize_datetime_unix_timestamp(attr: typing.Union[float, datetime]) -> datetime: - """Deserialize unix timestamp into Datetime object. - - :param str attr: response string to be deserialized. - :rtype: ~datetime.datetime - :returns: The datetime object from that input - """ - if isinstance(attr, datetime): - # i'm already deserialized - return attr - return datetime.fromtimestamp(attr, TZ_UTC) - - -def _deserialize_date(attr: typing.Union[str, date]) -> date: - """Deserialize ISO-8601 formatted string into Date object. - :param str attr: response string to be deserialized. - :rtype: date - :returns: The date object from that input - """ - # This must NOT use defaultmonth/defaultday. Using None ensure this raises an exception. - if isinstance(attr, date): - return attr - return isodate.parse_date(attr, defaultmonth=None, defaultday=None) - - -def _deserialize_time(attr: typing.Union[str, time]) -> time: - """Deserialize ISO-8601 formatted string into time object. - - :param str attr: response string to be deserialized. - :rtype: datetime.time - :returns: The time object from that input - """ - if isinstance(attr, time): - return attr - return isodate.parse_time(attr) - - -def _deserialize_bytes(attr): - if isinstance(attr, (bytes, bytearray)): - return attr - return bytes(base64.b64decode(attr)) - - -def _deserialize_bytes_base64(attr): - if isinstance(attr, (bytes, bytearray)): - return attr - padding = "=" * (3 - (len(attr) + 3) % 4) # type: ignore - attr = attr + padding # type: ignore - encoded = attr.replace("-", "+").replace("_", "/") - return bytes(base64.b64decode(encoded)) - - -def _deserialize_duration(attr): - if isinstance(attr, timedelta): - return attr - return isodate.parse_duration(attr) - - -def _deserialize_decimal(attr): - if isinstance(attr, decimal.Decimal): - return attr - return decimal.Decimal(str(attr)) - - -_DESERIALIZE_MAPPING = { - datetime: _deserialize_datetime, - date: _deserialize_date, - time: _deserialize_time, - bytes: _deserialize_bytes, - bytearray: _deserialize_bytes, - timedelta: _deserialize_duration, - typing.Any: lambda x: x, - decimal.Decimal: _deserialize_decimal, -} - -_DESERIALIZE_MAPPING_WITHFORMAT = { - "rfc3339": _deserialize_datetime, - "rfc7231": _deserialize_datetime_rfc7231, - "unix-timestamp": _deserialize_datetime_unix_timestamp, - "base64": _deserialize_bytes, - "base64url": _deserialize_bytes_base64, -} - - -def get_deserializer(annotation: typing.Any, rf: typing.Optional["_RestField"] = None): - if rf and rf._format: - return _DESERIALIZE_MAPPING_WITHFORMAT.get(rf._format) - return _DESERIALIZE_MAPPING.get(annotation) - - -def _get_type_alias_type(module_name: str, alias_name: str): - types = { - k: v - for k, v in sys.modules[module_name].__dict__.items() - if isinstance(v, typing._GenericAlias) # type: ignore - } - if alias_name not in types: - return alias_name - return types[alias_name] - - -def _get_model(module_name: str, model_name: str): - models = {k: v for k, v in sys.modules[module_name].__dict__.items() if isinstance(v, type)} - module_end = module_name.rsplit(".", 1)[0] - models.update({k: v for k, v in sys.modules[module_end].__dict__.items() if isinstance(v, type)}) - if isinstance(model_name, str): - model_name = model_name.split(".")[-1] - if model_name not in models: - return model_name - return models[model_name] - - -_UNSET = object() - - -class _MyMutableMapping(MutableMapping[str, typing.Any]): # pylint: disable=unsubscriptable-object - def __init__(self, data: typing.Dict[str, typing.Any]) -> None: - self._data = copy.deepcopy(data) - - def __contains__(self, key: typing.Any) -> bool: - return key in self._data - - def __getitem__(self, key: str) -> typing.Any: - return self._data.__getitem__(key) - - def __setitem__(self, key: str, value: typing.Any) -> None: - self._data.__setitem__(key, value) - - def __delitem__(self, key: str) -> None: - self._data.__delitem__(key) - - def __iter__(self) -> typing.Iterator[typing.Any]: - return self._data.__iter__() - - def __len__(self) -> int: - return self._data.__len__() - - def __ne__(self, other: typing.Any) -> bool: - return not self.__eq__(other) - - def keys(self) -> typing.KeysView[str]: - return self._data.keys() - - def values(self) -> typing.ValuesView[typing.Any]: - return self._data.values() - - def items(self) -> typing.ItemsView[str, typing.Any]: - return self._data.items() - - def get(self, key: str, default: typing.Any = None) -> typing.Any: - try: - return self[key] - except KeyError: - return default - - @typing.overload # type: ignore - def pop(self, key: str) -> typing.Any: # pylint: disable=no-member - ... - - @typing.overload - def pop(self, key: str, default: typing.Any) -> typing.Any: - ... - - def pop(self, key: str, default: typing.Any = _UNSET) -> typing.Any: - if default is _UNSET: - return self._data.pop(key) - return self._data.pop(key, default) - - def popitem(self) -> typing.Tuple[str, typing.Any]: - return self._data.popitem() - - def clear(self) -> None: - self._data.clear() - - def update(self, *args: typing.Any, **kwargs: typing.Any) -> None: - self._data.update(*args, **kwargs) - - @typing.overload # type: ignore - def setdefault(self, key: str) -> typing.Any: - ... - - @typing.overload - def setdefault(self, key: str, default: typing.Any) -> typing.Any: - ... - - def setdefault(self, key: str, default: typing.Any = _UNSET) -> typing.Any: - if default is _UNSET: - return self._data.setdefault(key) - return self._data.setdefault(key, default) - - def __eq__(self, other: typing.Any) -> bool: - try: - other_model = self.__class__(other) - except Exception: - return False - return self._data == other_model._data - - def __repr__(self) -> str: - return str(self._data) - - -def _is_model(obj: typing.Any) -> bool: - return getattr(obj, "_is_model", False) - - -def _serialize(o, format: typing.Optional[str] = None): # pylint: disable=too-many-return-statements - if isinstance(o, list): - return [_serialize(x, format) for x in o] - if isinstance(o, dict): - return {k: _serialize(v, format) for k, v in o.items()} - if isinstance(o, set): - return {_serialize(x, format) for x in o} - if isinstance(o, tuple): - return tuple(_serialize(x, format) for x in o) - if isinstance(o, (bytes, bytearray)): - return _serialize_bytes(o, format) - if isinstance(o, decimal.Decimal): - return float(o) - try: - # First try datetime.datetime - return _serialize_datetime(o, format) - except AttributeError: - pass - # Last, try datetime.timedelta - try: - return _timedelta_as_isostr(o) - except AttributeError: - # This will be raised when it hits value.total_seconds in the method above - pass - return o - - -def _get_rest_field( - attr_to_rest_field: typing.Dict[str, "_RestField"], rest_name: str -) -> typing.Optional["_RestField"]: - try: - return next(rf for rf in attr_to_rest_field.values() if rf._rest_name == rest_name) - except StopIteration: - return None - - -def _create_value(rf: typing.Optional["_RestField"], value: typing.Any) -> typing.Any: - return _deserialize(rf._type, value) if (rf and rf._is_model) else _serialize(value, rf._format if rf else None) - - -class Model(_MyMutableMapping): - _is_model = True - - def __init__(self, *args: typing.Any, **kwargs: typing.Any) -> None: - class_name = self.__class__.__name__ - if len(args) > 1: - raise TypeError(f"{class_name}.__init__() takes 2 positional arguments but {len(args) + 1} were given") - dict_to_pass = { - rest_field._rest_name: rest_field._default - for rest_field in self._attr_to_rest_field.values() - if rest_field._default is not _UNSET - } - if args: - dict_to_pass.update( - {k: _create_value(_get_rest_field(self._attr_to_rest_field, k), v) for k, v in args[0].items()} - ) - else: - non_attr_kwargs = [k for k in kwargs if k not in self._attr_to_rest_field] - if non_attr_kwargs: - # actual type errors only throw the first wrong keyword arg they see, so following that. - raise TypeError(f"{class_name}.__init__() got an unexpected keyword argument '{non_attr_kwargs[0]}'") - dict_to_pass.update( - { - self._attr_to_rest_field[k]._rest_name: _create_value(self._attr_to_rest_field[k], v) - for k, v in kwargs.items() - if v is not None - } - ) - super().__init__(dict_to_pass) - - def copy(self) -> "Model": - return Model(self.__dict__) - - def __new__(cls, *args: typing.Any, **kwargs: typing.Any) -> "Model": # pylint: disable=unused-argument - # we know the last three classes in mro are going to be 'Model', 'dict', and 'object' - mros = cls.__mro__[:-3][::-1] # ignore model, dict, and object parents, and reverse the mro order - attr_to_rest_field: typing.Dict[str, _RestField] = { # map attribute name to rest_field property - k: v for mro_class in mros for k, v in mro_class.__dict__.items() if k[0] != "_" and hasattr(v, "_type") - } - annotations = { - k: v - for mro_class in mros - if hasattr(mro_class, "__annotations__") # pylint: disable=no-member - for k, v in mro_class.__annotations__.items() # pylint: disable=no-member - } - for attr, rf in attr_to_rest_field.items(): - rf._module = cls.__module__ - if not rf._type: - rf._type = rf._get_deserialize_callable_from_annotation(annotations.get(attr, None)) - if not rf._rest_name_input: - rf._rest_name_input = attr - cls._attr_to_rest_field: typing.Dict[str, _RestField] = dict(attr_to_rest_field.items()) - - return super().__new__(cls) # pylint: disable=no-value-for-parameter - - def __init_subclass__(cls, discriminator: typing.Optional[str] = None) -> None: - for base in cls.__bases__: - if hasattr(base, "__mapping__"): # pylint: disable=no-member - base.__mapping__[discriminator or cls.__name__] = cls # type: ignore # pylint: disable=no-member - - @classmethod - def _get_discriminator(cls, exist_discriminators) -> typing.Optional[str]: - for v in cls.__dict__.values(): - if ( - isinstance(v, _RestField) and v._is_discriminator and v._rest_name not in exist_discriminators - ): # pylint: disable=protected-access - return v._rest_name # pylint: disable=protected-access - return None - - @classmethod - def _deserialize(cls, data, exist_discriminators): - if not hasattr(cls, "__mapping__"): # pylint: disable=no-member - return cls(data) - discriminator = cls._get_discriminator(exist_discriminators) - exist_discriminators.append(discriminator) - mapped_cls = cls.__mapping__.get(data.get(discriminator), cls) # pylint: disable=no-member - if mapped_cls == cls: - return cls(data) - return mapped_cls._deserialize(data, exist_discriminators) # pylint: disable=protected-access - - def as_dict(self, *, exclude_readonly: bool = False) -> typing.Dict[str, typing.Any]: - """Return a dict that can be JSONify using json.dump. - - :keyword bool exclude_readonly: Whether to remove the readonly properties. - :returns: A dict JSON compatible object - :rtype: dict - """ - - result = {} - if exclude_readonly: - readonly_props = [p._rest_name for p in self._attr_to_rest_field.values() if _is_readonly(p)] - for k, v in self.items(): - if exclude_readonly and k in readonly_props: # pyright: ignore[reportUnboundVariable] - continue - result[k] = Model._as_dict_value(v, exclude_readonly=exclude_readonly) - return result - - @staticmethod - def _as_dict_value(v: typing.Any, exclude_readonly: bool = False) -> typing.Any: - if v is None or isinstance(v, _Null): - return None - if isinstance(v, (list, tuple, set)): - return [Model._as_dict_value(x, exclude_readonly=exclude_readonly) for x in v] - if isinstance(v, dict): - return {dk: Model._as_dict_value(dv, exclude_readonly=exclude_readonly) for dk, dv in v.items()} - return v.as_dict(exclude_readonly=exclude_readonly) if hasattr(v, "as_dict") else v - - -def _get_deserialize_callable_from_annotation( # pylint: disable=R0911, R0915, R0912 - annotation: typing.Any, - module: typing.Optional[str], - rf: typing.Optional["_RestField"] = None, -) -> typing.Optional[typing.Callable[[typing.Any], typing.Any]]: - if not annotation or annotation in [int, float]: - return None - - # is it a type alias? - if isinstance(annotation, str): - if module is not None: - annotation = _get_type_alias_type(module, annotation) - - # is it a forward ref / in quotes? - if isinstance(annotation, (str, typing.ForwardRef)): - try: - model_name = annotation.__forward_arg__ # type: ignore - except AttributeError: - model_name = annotation - if module is not None: - annotation = _get_model(module, model_name) - - try: - if module and _is_model(annotation): - if rf: - rf._is_model = True - - def _deserialize_model(model_deserializer: typing.Optional[typing.Callable], obj): - if _is_model(obj): - return obj - return _deserialize(model_deserializer, obj) - - return functools.partial(_deserialize_model, annotation) - except Exception: - pass - - # is it a literal? - try: - if sys.version_info >= (3, 8): - from typing import ( - Literal, - ) # pylint: disable=no-name-in-module, ungrouped-imports - else: - from typing_extensions import Literal # type: ignore # pylint: disable=ungrouped-imports - - if annotation.__origin__ == Literal: - return None - except AttributeError: - pass - - # is it optional? - try: - if any(a for a in annotation.__args__ if a == type(None)): - if_obj_deserializer = _get_deserialize_callable_from_annotation( - next(a for a in annotation.__args__ if a != type(None)), module, rf - ) - - def _deserialize_with_optional(if_obj_deserializer: typing.Optional[typing.Callable], obj): - if obj is None: - return obj - return _deserialize_with_callable(if_obj_deserializer, obj) - - return functools.partial(_deserialize_with_optional, if_obj_deserializer) - except AttributeError: - pass - - if getattr(annotation, "__origin__", None) is typing.Union: - deserializers = [_get_deserialize_callable_from_annotation(arg, module, rf) for arg in annotation.__args__] - - def _deserialize_with_union(deserializers, obj): - for deserializer in deserializers: - try: - return _deserialize(deserializer, obj) - except DeserializationError: - pass - raise DeserializationError() - - return functools.partial(_deserialize_with_union, deserializers) - - try: - if annotation._name == "Dict": - value_deserializer = _get_deserialize_callable_from_annotation(annotation.__args__[1], module, rf) - - def _deserialize_dict( - value_deserializer: typing.Optional[typing.Callable], - obj: typing.Dict[typing.Any, typing.Any], - ): - if obj is None: - return obj - return {k: _deserialize(value_deserializer, v, module) for k, v in obj.items()} - - return functools.partial( - _deserialize_dict, - value_deserializer, - ) - except (AttributeError, IndexError): - pass - try: - if annotation._name in ["List", "Set", "Tuple", "Sequence"]: - if len(annotation.__args__) > 1: - - def _deserialize_multiple_sequence( - entry_deserializers: typing.List[typing.Optional[typing.Callable]], - obj, - ): - if obj is None: - return obj - return type(obj)( - _deserialize(deserializer, entry, module) - for entry, deserializer in zip(obj, entry_deserializers) - ) - - entry_deserializers = [ - _get_deserialize_callable_from_annotation(dt, module, rf) for dt in annotation.__args__ - ] - return functools.partial(_deserialize_multiple_sequence, entry_deserializers) - deserializer = _get_deserialize_callable_from_annotation(annotation.__args__[0], module, rf) - - def _deserialize_sequence( - deserializer: typing.Optional[typing.Callable], - obj, - ): - if obj is None: - return obj - return type(obj)(_deserialize(deserializer, entry, module) for entry in obj) - - return functools.partial(_deserialize_sequence, deserializer) - except (TypeError, IndexError, AttributeError, SyntaxError): - pass - - def _deserialize_default( - deserializer, - obj, - ): - if obj is None: - return obj - return _deserialize_with_callable(deserializer, obj) - - if get_deserializer(annotation, rf): - return functools.partial(_deserialize_default, get_deserializer(annotation, rf)) - - return functools.partial(_deserialize_default, annotation) - - -def _deserialize_with_callable( - deserializer: typing.Optional[typing.Callable[[typing.Any], typing.Any]], - value: typing.Any, -): - try: - if value is None or isinstance(value, _Null): - return None - if deserializer is None: - return value - if isinstance(deserializer, CaseInsensitiveEnumMeta): - try: - return deserializer(value) - except ValueError: - # for unknown value, return raw value - return value - if isinstance(deserializer, type) and issubclass(deserializer, Model): - return deserializer._deserialize(value, []) - return typing.cast(typing.Callable[[typing.Any], typing.Any], deserializer)(value) - except Exception as e: - raise DeserializationError() from e - - -def _deserialize( - deserializer: typing.Any, - value: typing.Any, - module: typing.Optional[str] = None, - rf: typing.Optional["_RestField"] = None, - format: typing.Optional[str] = None, -) -> typing.Any: - if isinstance(value, PipelineResponse): - value = value.http_response.json() - if rf is None and format: - rf = _RestField(format=format) - if not isinstance(deserializer, functools.partial): - deserializer = _get_deserialize_callable_from_annotation(deserializer, module, rf) - return _deserialize_with_callable(deserializer, value) - - -class _RestField: - def __init__( - self, - *, - name: typing.Optional[str] = None, - type: typing.Optional[typing.Callable] = None, # pylint: disable=redefined-builtin - is_discriminator: bool = False, - visibility: typing.Optional[typing.List[str]] = None, - default: typing.Any = _UNSET, - format: typing.Optional[str] = None, - ): - self._type = type - self._rest_name_input = name - self._module: typing.Optional[str] = None - self._is_discriminator = is_discriminator - self._visibility = visibility - self._is_model = False - self._default = default - self._format = format - - @property - def _rest_name(self) -> str: - if self._rest_name_input is None: - raise ValueError("Rest name was never set") - return self._rest_name_input - - def __get__(self, obj: Model, type=None): # pylint: disable=redefined-builtin - # by this point, type and rest_name will have a value bc we default - # them in __new__ of the Model class - item = obj.get(self._rest_name) - if item is None: - return item - if self._is_model: - return item - return _deserialize(self._type, _serialize(item, self._format), rf=self) - - def __set__(self, obj: Model, value) -> None: - if value is None: - # we want to wipe out entries if users set attr to None - try: - obj.__delitem__(self._rest_name) - except KeyError: - pass - return - if self._is_model: - if not _is_model(value): - value = _deserialize(self._type, value) - obj.__setitem__(self._rest_name, value) - return - obj.__setitem__(self._rest_name, _serialize(value, self._format)) - - def _get_deserialize_callable_from_annotation( - self, annotation: typing.Any - ) -> typing.Optional[typing.Callable[[typing.Any], typing.Any]]: - return _get_deserialize_callable_from_annotation(annotation, self._module, self) - - -def rest_field( - *, - name: typing.Optional[str] = None, - type: typing.Optional[typing.Callable] = None, # pylint: disable=redefined-builtin - visibility: typing.Optional[typing.List[str]] = None, - default: typing.Any = _UNSET, - format: typing.Optional[str] = None, -) -> typing.Any: - return _RestField(name=name, type=type, visibility=visibility, default=default, format=format) - - -def rest_discriminator( - *, - name: typing.Optional[str] = None, - type: typing.Optional[typing.Callable] = None, # pylint: disable=redefined-builtin -) -> typing.Any: - return _RestField(name=name, type=type, is_discriminator=True) diff --git a/sdk/contentsafety/azure-ai-contentsafety/azure/ai/contentsafety/_operations/__init__.py b/sdk/contentsafety/azure-ai-contentsafety/azure/ai/contentsafety/_operations/__init__.py index 2f88364a4715..531d9a52f3f1 100644 --- a/sdk/contentsafety/azure-ai-contentsafety/azure/ai/contentsafety/_operations/__init__.py +++ b/sdk/contentsafety/azure-ai-contentsafety/azure/ai/contentsafety/_operations/__init__.py @@ -5,17 +5,21 @@ # Code generated by Microsoft (R) Python Code Generator. # Changes may cause incorrect behavior and will be lost if the code is regenerated. # -------------------------------------------------------------------------- +# pylint: disable=wrong-import-position -from ._operations import ContentSafetyClientOperationsMixin -from ._operations import BlocklistClientOperationsMixin +from typing import TYPE_CHECKING + +if TYPE_CHECKING: + from ._patch import * # pylint: disable=unused-wildcard-import + +from ._operations import _ContentSafetyClientOperationsMixin # type: ignore # pylint: disable=unused-import +from ._operations import _ContentProvenanceClientOperationsMixin # type: ignore # pylint: disable=unused-import +from ._operations import _BlocklistClientOperationsMixin # type: ignore # pylint: disable=unused-import from ._patch import __all__ as _patch_all -from ._patch import * # pylint: disable=unused-wildcard-import +from ._patch import * from ._patch import patch_sdk as _patch_sdk -__all__ = [ - "ContentSafetyClientOperationsMixin", - "BlocklistClientOperationsMixin", -] -__all__.extend([p for p in _patch_all if p not in __all__]) +__all__ = [] +__all__.extend([p for p in _patch_all if p not in __all__]) # pyright: ignore _patch_sdk() diff --git a/sdk/contentsafety/azure-ai-contentsafety/azure/ai/contentsafety/_operations/_operations.py b/sdk/contentsafety/azure-ai-contentsafety/azure/ai/contentsafety/_operations/_operations.py index 175bc5ca04d6..8c9cf373a9df 100644 --- a/sdk/contentsafety/azure-ai-contentsafety/azure/ai/contentsafety/_operations/_operations.py +++ b/sdk/contentsafety/azure-ai-contentsafety/azure/ai/contentsafety/_operations/_operations.py @@ -6,49 +6,77 @@ # Code generated by Microsoft (R) Python Code Generator. # Changes may cause incorrect behavior and will be lost if the code is regenerated. # -------------------------------------------------------------------------- +from collections.abc import MutableMapping from io import IOBase import json -import sys -from typing import Any, Callable, Dict, IO, Iterable, List, Optional, TypeVar, Union, overload +from typing import Any, Callable, IO, Iterator, Optional, TypeVar, Union, cast, overload import urllib.parse +from azure.core import PipelineClient from azure.core.exceptions import ( ClientAuthenticationError, HttpResponseError, ResourceExistsError, ResourceNotFoundError, ResourceNotModifiedError, + StreamClosedError, + StreamConsumedError, map_error, ) from azure.core.paging import ItemPaged from azure.core.pipeline import PipelineResponse +from azure.core.polling import LROPoller, NoPolling, PollingMethod +from azure.core.polling.base_polling import LROBasePolling from azure.core.rest import HttpRequest, HttpResponse from azure.core.tracing.decorator import distributed_trace from azure.core.utils import case_insensitive_dict -from .. import models as _models -from .._model_base import SdkJSONEncoder, _deserialize -from .._serialization import Serializer -from .._vendor import BlocklistClientMixinABC, ContentSafetyClientMixinABC +from .. import models as _models, types as _types +from .._configuration import ( + BlocklistClientConfiguration, + ContentProvenanceClientConfiguration, + ContentSafetyClientConfiguration, +) +from .._utils.model_base import SdkJSONEncoder, _deserialize +from .._utils.serialization import Serializer +from .._utils.utils import ClientMixinABC +from .._validation import api_version_validation -if sys.version_info >= (3, 9): - from collections.abc import MutableMapping -else: - from typing import MutableMapping # type: ignore # pylint: disable=ungrouped-imports -JSON = MutableMapping[str, Any] # pylint: disable=unsubscriptable-object T = TypeVar("T") -ClsType = Optional[Callable[[PipelineResponse[HttpRequest, HttpResponse], T, Dict[str, Any]], Any]] +ClsType = Optional[Callable[[PipelineResponse[HttpRequest, HttpResponse], T, dict[str, Any]], Any]] _SERIALIZER = Serializer() _SERIALIZER.client_side_validation = False +def build_content_safety_analyze_image_request(**kwargs: Any) -> HttpRequest: # pylint: disable=name-too-long + _headers = case_insensitive_dict(kwargs.pop("headers", {}) or {}) + _params = case_insensitive_dict(kwargs.pop("params", {}) or {}) + + content_type: Optional[str] = kwargs.pop("content_type", _headers.pop("Content-Type", None)) + api_version: str = kwargs.pop("api_version", _params.pop("api-version", "2026-07-01-preview")) + accept = _headers.pop("Accept", "application/json") + + # Construct URL + _url = "/image:analyze" + + # Construct parameters + _params["api-version"] = _SERIALIZER.query("api_version", api_version, "str") + + # Construct headers + if content_type is not None: + _headers["Content-Type"] = _SERIALIZER.header("content_type", content_type, "str") + _headers["Accept"] = _SERIALIZER.header("accept", accept, "str") + + return HttpRequest(method="POST", url=_url, params=_params, headers=_headers, **kwargs) + + def build_content_safety_analyze_text_request(**kwargs: Any) -> HttpRequest: # pylint: disable=name-too-long _headers = case_insensitive_dict(kwargs.pop("headers", {}) or {}) _params = case_insensitive_dict(kwargs.pop("params", {}) or {}) content_type: Optional[str] = kwargs.pop("content_type", _headers.pop("Content-Type", None)) - api_version: str = kwargs.pop("api_version", _params.pop("api-version", "2023-10-01")) + api_version: str = kwargs.pop("api_version", _params.pop("api-version", "2026-07-01-preview")) accept = _headers.pop("Accept", "application/json") # Construct URL @@ -58,35 +86,107 @@ def build_content_safety_analyze_text_request(**kwargs: Any) -> HttpRequest: # _params["api-version"] = _SERIALIZER.query("api_version", api_version, "str") # Construct headers + if content_type is not None: + _headers["Content-Type"] = _SERIALIZER.header("content_type", content_type, "str") _headers["Accept"] = _SERIALIZER.header("accept", accept, "str") + + return HttpRequest(method="POST", url=_url, params=_params, headers=_headers, **kwargs) + + +def build_content_safety_detect_text_protected_material_request( # pylint: disable=name-too-long + **kwargs: Any, +) -> HttpRequest: + _headers = case_insensitive_dict(kwargs.pop("headers", {}) or {}) + _params = case_insensitive_dict(kwargs.pop("params", {}) or {}) + + content_type: Optional[str] = kwargs.pop("content_type", _headers.pop("Content-Type", None)) + api_version: str = kwargs.pop("api_version", _params.pop("api-version", "2026-07-01-preview")) + accept = _headers.pop("Accept", "application/json") + + # Construct URL + _url = "/text:detectProtectedMaterial" + + # Construct parameters + _params["api-version"] = _SERIALIZER.query("api_version", api_version, "str") + + # Construct headers if content_type is not None: _headers["Content-Type"] = _SERIALIZER.header("content_type", content_type, "str") + _headers["Accept"] = _SERIALIZER.header("accept", accept, "str") return HttpRequest(method="POST", url=_url, params=_params, headers=_headers, **kwargs) -def build_content_safety_analyze_image_request(**kwargs: Any) -> HttpRequest: # pylint: disable=name-too-long +def build_content_safety_shield_prompt_request(**kwargs: Any) -> HttpRequest: # pylint: disable=name-too-long _headers = case_insensitive_dict(kwargs.pop("headers", {}) or {}) _params = case_insensitive_dict(kwargs.pop("params", {}) or {}) content_type: Optional[str] = kwargs.pop("content_type", _headers.pop("Content-Type", None)) - api_version: str = kwargs.pop("api_version", _params.pop("api-version", "2023-10-01")) + api_version: str = kwargs.pop("api_version", _params.pop("api-version", "2026-07-01-preview")) accept = _headers.pop("Accept", "application/json") # Construct URL - _url = "/image:analyze" + _url = "/text:shieldPrompt" # Construct parameters _params["api-version"] = _SERIALIZER.query("api_version", api_version, "str") # Construct headers + if content_type is not None: + _headers["Content-Type"] = _SERIALIZER.header("content_type", content_type, "str") _headers["Accept"] = _SERIALIZER.header("accept", accept, "str") + + return HttpRequest(method="POST", url=_url, params=_params, headers=_headers, **kwargs) + + +def build_content_provenance_detect_request(**kwargs: Any) -> HttpRequest: + _headers = case_insensitive_dict(kwargs.pop("headers", {}) or {}) + _params = case_insensitive_dict(kwargs.pop("params", {}) or {}) + + content_type: Optional[str] = kwargs.pop("content_type", _headers.pop("Content-Type", None)) + api_version: str = kwargs.pop("api_version", _params.pop("api-version", "2026-07-01-preview")) + accept = _headers.pop("Accept", "application/json") + + # Construct URL + _url = ":detect" + + # Construct parameters + _params["api-version"] = _SERIALIZER.query("api_version", api_version, "str") + + # Construct headers if content_type is not None: _headers["Content-Type"] = _SERIALIZER.header("content_type", content_type, "str") + _headers["Accept"] = _SERIALIZER.header("accept", accept, "str") return HttpRequest(method="POST", url=_url, params=_params, headers=_headers, **kwargs) +def build_content_provenance_get_operation_status_request( # pylint: disable=name-too-long + operation_id: str, **kwargs: Any +) -> HttpRequest: + _headers = case_insensitive_dict(kwargs.pop("headers", {}) or {}) + _params = case_insensitive_dict(kwargs.pop("params", {}) or {}) + + api_version: str = kwargs.pop("api_version", _params.pop("api-version", "2026-07-01-preview")) + accept = _headers.pop("Accept", "application/json") + + # Construct URL + _url = "/operations/{operationId}" + path_format_arguments = { + "operationId": _SERIALIZER.url("operation_id", operation_id, "str"), + } + + _url: str = _url.format(**path_format_arguments) # type: ignore + + # Construct parameters + _params["api-version"] = _SERIALIZER.query("api_version", api_version, "str") + + # Construct headers + _headers["Accept"] = _SERIALIZER.header("accept", accept, "str") + + return HttpRequest(method="GET", url=_url, params=_params, headers=_headers, **kwargs) + + def build_blocklist_add_or_update_blocklist_items_request( # pylint: disable=name-too-long blocklist_name: str, **kwargs: Any ) -> HttpRequest: @@ -94,7 +194,7 @@ def build_blocklist_add_or_update_blocklist_items_request( # pylint: disable=na _params = case_insensitive_dict(kwargs.pop("params", {}) or {}) content_type: Optional[str] = kwargs.pop("content_type", _headers.pop("Content-Type", None)) - api_version: str = kwargs.pop("api_version", _params.pop("api-version", "2023-10-01")) + api_version: str = kwargs.pop("api_version", _params.pop("api-version", "2026-07-01-preview")) accept = _headers.pop("Accept", "application/json") # Construct URL @@ -109,9 +209,9 @@ def build_blocklist_add_or_update_blocklist_items_request( # pylint: disable=na _params["api-version"] = _SERIALIZER.query("api_version", api_version, "str") # Construct headers - _headers["Accept"] = _SERIALIZER.header("accept", accept, "str") if content_type is not None: _headers["Content-Type"] = _SERIALIZER.header("content_type", content_type, "str") + _headers["Accept"] = _SERIALIZER.header("accept", accept, "str") return HttpRequest(method="POST", url=_url, params=_params, headers=_headers, **kwargs) @@ -123,7 +223,7 @@ def build_blocklist_create_or_update_text_blocklist_request( # pylint: disable= _params = case_insensitive_dict(kwargs.pop("params", {}) or {}) content_type: Optional[str] = kwargs.pop("content_type", _headers.pop("Content-Type", None)) - api_version: str = kwargs.pop("api_version", _params.pop("api-version", "2023-10-01")) + api_version: str = kwargs.pop("api_version", _params.pop("api-version", "2026-07-01-preview")) accept = _headers.pop("Accept", "application/json") # Construct URL @@ -150,7 +250,7 @@ def build_blocklist_delete_text_blocklist_request( # pylint: disable=name-too-l ) -> HttpRequest: _params = case_insensitive_dict(kwargs.pop("params", {}) or {}) - api_version: str = kwargs.pop("api_version", _params.pop("api-version", "2023-10-01")) + api_version: str = kwargs.pop("api_version", _params.pop("api-version", "2026-07-01-preview")) # Construct URL _url = "/text/blocklists/{blocklistName}" path_format_arguments = { @@ -171,7 +271,7 @@ def build_blocklist_get_text_blocklist_request( # pylint: disable=name-too-long _headers = case_insensitive_dict(kwargs.pop("headers", {}) or {}) _params = case_insensitive_dict(kwargs.pop("params", {}) or {}) - api_version: str = kwargs.pop("api_version", _params.pop("api-version", "2023-10-01")) + api_version: str = kwargs.pop("api_version", _params.pop("api-version", "2026-07-01-preview")) accept = _headers.pop("Accept", "application/json") # Construct URL @@ -197,7 +297,7 @@ def build_blocklist_get_text_blocklist_item_request( # pylint: disable=name-too _headers = case_insensitive_dict(kwargs.pop("headers", {}) or {}) _params = case_insensitive_dict(kwargs.pop("params", {}) or {}) - api_version: str = kwargs.pop("api_version", _params.pop("api-version", "2023-10-01")) + api_version: str = kwargs.pop("api_version", _params.pop("api-version", "2026-07-01-preview")) accept = _headers.pop("Accept", "application/json") # Construct URL @@ -224,12 +324,12 @@ def build_blocklist_list_text_blocklist_items_request( # pylint: disable=name-t top: Optional[int] = None, skip: Optional[int] = None, maxpagesize: Optional[int] = None, - **kwargs: Any + **kwargs: Any, ) -> HttpRequest: _headers = case_insensitive_dict(kwargs.pop("headers", {}) or {}) _params = case_insensitive_dict(kwargs.pop("params", {}) or {}) - api_version: str = kwargs.pop("api_version", _params.pop("api-version", "2023-10-01")) + api_version: str = kwargs.pop("api_version", _params.pop("api-version", "2026-07-01-preview")) accept = _headers.pop("Accept", "application/json") # Construct URL @@ -259,7 +359,7 @@ def build_blocklist_list_text_blocklists_request(**kwargs: Any) -> HttpRequest: _headers = case_insensitive_dict(kwargs.pop("headers", {}) or {}) _params = case_insensitive_dict(kwargs.pop("params", {}) or {}) - api_version: str = kwargs.pop("api_version", _params.pop("api-version", "2023-10-01")) + api_version: str = kwargs.pop("api_version", _params.pop("api-version", "2026-07-01-preview")) accept = _headers.pop("Accept", "application/json") # Construct URL @@ -280,112 +380,531 @@ def build_blocklist_remove_blocklist_items_request( # pylint: disable=name-too- _headers = case_insensitive_dict(kwargs.pop("headers", {}) or {}) _params = case_insensitive_dict(kwargs.pop("params", {}) or {}) - content_type: Optional[str] = kwargs.pop("content_type", _headers.pop("Content-Type", None)) - api_version: str = kwargs.pop("api_version", _params.pop("api-version", "2023-10-01")) - # Construct URL - _url = "/text/blocklists/{blocklistName}:removeBlocklistItems" - path_format_arguments = { - "blocklistName": _SERIALIZER.url("blocklist_name", blocklist_name, "str"), - } + content_type: Optional[str] = kwargs.pop("content_type", _headers.pop("Content-Type", None)) + api_version: str = kwargs.pop("api_version", _params.pop("api-version", "2026-07-01-preview")) + # Construct URL + _url = "/text/blocklists/{blocklistName}:removeBlocklistItems" + path_format_arguments = { + "blocklistName": _SERIALIZER.url("blocklist_name", blocklist_name, "str"), + } + + _url: str = _url.format(**path_format_arguments) # type: ignore + + # Construct parameters + _params["api-version"] = _SERIALIZER.query("api_version", api_version, "str") + + # Construct headers + if content_type is not None: + _headers["Content-Type"] = _SERIALIZER.header("content_type", content_type, "str") + + return HttpRequest(method="POST", url=_url, params=_params, headers=_headers, **kwargs) + + +class _ContentSafetyClientOperationsMixin( + ClientMixinABC[PipelineClient[HttpRequest, HttpResponse], ContentSafetyClientConfiguration] +): + + @overload + def analyze_image( + self, options: _models.AnalyzeImageOptions, *, content_type: str = "application/json", **kwargs: Any + ) -> _models.AnalyzeImageResult: + """Analyze Image. + + A synchronous API for the analysis of potentially harmful image content. Currently, it supports + four categories: Hate, SelfHarm, Sexual, and Violence. + + :param options: The image analysis request. Required. + :type options: ~azure.ai.contentsafety.models.AnalyzeImageOptions + :keyword content_type: Body Parameter content-type. Content type parameter for JSON body. + Default value is "application/json". + :paramtype content_type: str + :return: AnalyzeImageResult. The AnalyzeImageResult is compatible with MutableMapping + :rtype: ~azure.ai.contentsafety.models.AnalyzeImageResult + :raises ~azure.core.exceptions.HttpResponseError: + """ + + @overload + def analyze_image( + self, options: _types.AnalyzeImageOptions, *, content_type: str = "application/json", **kwargs: Any + ) -> _models.AnalyzeImageResult: + """Analyze Image. + + A synchronous API for the analysis of potentially harmful image content. Currently, it supports + four categories: Hate, SelfHarm, Sexual, and Violence. + + :param options: The image analysis request. Required. + :type options: ~azure.ai.contentsafety.types.AnalyzeImageOptions + :keyword content_type: Body Parameter content-type. Content type parameter for JSON body. + Default value is "application/json". + :paramtype content_type: str + :return: AnalyzeImageResult. The AnalyzeImageResult is compatible with MutableMapping + :rtype: ~azure.ai.contentsafety.models.AnalyzeImageResult + :raises ~azure.core.exceptions.HttpResponseError: + """ + + @overload + def analyze_image( + self, options: IO[bytes], *, content_type: str = "application/json", **kwargs: Any + ) -> _models.AnalyzeImageResult: + """Analyze Image. + + A synchronous API for the analysis of potentially harmful image content. Currently, it supports + four categories: Hate, SelfHarm, Sexual, and Violence. + + :param options: The image analysis request. Required. + :type options: IO[bytes] + :keyword content_type: Body Parameter content-type. Content type parameter for binary body. + Default value is "application/json". + :paramtype content_type: str + :return: AnalyzeImageResult. The AnalyzeImageResult is compatible with MutableMapping + :rtype: ~azure.ai.contentsafety.models.AnalyzeImageResult + :raises ~azure.core.exceptions.HttpResponseError: + """ + + @distributed_trace + def analyze_image( + self, options: Union[_models.AnalyzeImageOptions, _types.AnalyzeImageOptions, IO[bytes]], **kwargs: Any + ) -> _models.AnalyzeImageResult: + """Analyze Image. + + A synchronous API for the analysis of potentially harmful image content. Currently, it supports + four categories: Hate, SelfHarm, Sexual, and Violence. + + :param options: The image analysis request. Is either a AnalyzeImageOptions type or a IO[bytes] + type. Required. + :type options: ~azure.ai.contentsafety.models.AnalyzeImageOptions or + ~azure.ai.contentsafety.types.AnalyzeImageOptions or IO[bytes] + :return: AnalyzeImageResult. The AnalyzeImageResult is compatible with MutableMapping + :rtype: ~azure.ai.contentsafety.models.AnalyzeImageResult + :raises ~azure.core.exceptions.HttpResponseError: + """ + error_map: MutableMapping = { + 401: ClientAuthenticationError, + 404: ResourceNotFoundError, + 409: ResourceExistsError, + 304: ResourceNotModifiedError, + } + error_map.update(kwargs.pop("error_map", {}) or {}) + + _headers = case_insensitive_dict(kwargs.pop("headers", {}) or {}) + _params = kwargs.pop("params", {}) or {} + + content_type: Optional[str] = kwargs.pop("content_type", _headers.pop("Content-Type", None)) + cls: ClsType[_models.AnalyzeImageResult] = kwargs.pop("cls", None) + + content_type = content_type or "application/json" + _content = None + if isinstance(options, (IOBase, bytes)): + _content = options + else: + _content = json.dumps(options, cls=SdkJSONEncoder, exclude_readonly=True) # type: ignore + + _request = build_content_safety_analyze_image_request( + content_type=content_type, + api_version=self._config.api_version, + content=_content, + headers=_headers, + params=_params, + ) + path_format_arguments = { + "endpoint": self._serialize.url("self._config.endpoint", self._config.endpoint, "str", skip_quote=True), + } + _request.url = self._client.format_url(_request.url, **path_format_arguments) + + _decompress = kwargs.pop("decompress", True) + _stream = kwargs.pop("stream", False) + pipeline_response: PipelineResponse = self._client._pipeline.run( # pylint: disable=protected-access + _request, stream=_stream, **kwargs + ) + + response = pipeline_response.http_response + + if response.status_code not in [200]: + if _stream: + try: + response.read() # Load the body in memory and close the socket + except (StreamConsumedError, StreamClosedError): + pass + map_error(status_code=response.status_code, response=response, error_map=error_map) + raise HttpResponseError(response=response) + + if _stream: + deserialized = response.iter_bytes() if _decompress else response.iter_raw() + else: + deserialized = _deserialize(_models.AnalyzeImageResult, response.json()) + + if cls: + return cls(pipeline_response, deserialized, {}) # type: ignore + + return deserialized # type: ignore + + @overload + def analyze_text( + self, options: _models.AnalyzeTextOptions, *, content_type: str = "application/json", **kwargs: Any + ) -> _models.AnalyzeTextResult: + """Analyze Text. + + A synchronous API for the analysis of potentially harmful text content. Currently, it supports + four categories: Hate, SelfHarm, Sexual, and Violence. + + :param options: The text analysis request. Required. + :type options: ~azure.ai.contentsafety.models.AnalyzeTextOptions + :keyword content_type: Body Parameter content-type. Content type parameter for JSON body. + Default value is "application/json". + :paramtype content_type: str + :return: AnalyzeTextResult. The AnalyzeTextResult is compatible with MutableMapping + :rtype: ~azure.ai.contentsafety.models.AnalyzeTextResult + :raises ~azure.core.exceptions.HttpResponseError: + """ + + @overload + def analyze_text( + self, options: _types.AnalyzeTextOptions, *, content_type: str = "application/json", **kwargs: Any + ) -> _models.AnalyzeTextResult: + """Analyze Text. + + A synchronous API for the analysis of potentially harmful text content. Currently, it supports + four categories: Hate, SelfHarm, Sexual, and Violence. + + :param options: The text analysis request. Required. + :type options: ~azure.ai.contentsafety.types.AnalyzeTextOptions + :keyword content_type: Body Parameter content-type. Content type parameter for JSON body. + Default value is "application/json". + :paramtype content_type: str + :return: AnalyzeTextResult. The AnalyzeTextResult is compatible with MutableMapping + :rtype: ~azure.ai.contentsafety.models.AnalyzeTextResult + :raises ~azure.core.exceptions.HttpResponseError: + """ + + @overload + def analyze_text( + self, options: IO[bytes], *, content_type: str = "application/json", **kwargs: Any + ) -> _models.AnalyzeTextResult: + """Analyze Text. + + A synchronous API for the analysis of potentially harmful text content. Currently, it supports + four categories: Hate, SelfHarm, Sexual, and Violence. + + :param options: The text analysis request. Required. + :type options: IO[bytes] + :keyword content_type: Body Parameter content-type. Content type parameter for binary body. + Default value is "application/json". + :paramtype content_type: str + :return: AnalyzeTextResult. The AnalyzeTextResult is compatible with MutableMapping + :rtype: ~azure.ai.contentsafety.models.AnalyzeTextResult + :raises ~azure.core.exceptions.HttpResponseError: + """ + + @distributed_trace + def analyze_text( + self, options: Union[_models.AnalyzeTextOptions, _types.AnalyzeTextOptions, IO[bytes]], **kwargs: Any + ) -> _models.AnalyzeTextResult: + """Analyze Text. + + A synchronous API for the analysis of potentially harmful text content. Currently, it supports + four categories: Hate, SelfHarm, Sexual, and Violence. + + :param options: The text analysis request. Is either a AnalyzeTextOptions type or a IO[bytes] + type. Required. + :type options: ~azure.ai.contentsafety.models.AnalyzeTextOptions or + ~azure.ai.contentsafety.types.AnalyzeTextOptions or IO[bytes] + :return: AnalyzeTextResult. The AnalyzeTextResult is compatible with MutableMapping + :rtype: ~azure.ai.contentsafety.models.AnalyzeTextResult + :raises ~azure.core.exceptions.HttpResponseError: + """ + error_map: MutableMapping = { + 401: ClientAuthenticationError, + 404: ResourceNotFoundError, + 409: ResourceExistsError, + 304: ResourceNotModifiedError, + } + error_map.update(kwargs.pop("error_map", {}) or {}) + + _headers = case_insensitive_dict(kwargs.pop("headers", {}) or {}) + _params = kwargs.pop("params", {}) or {} + + content_type: Optional[str] = kwargs.pop("content_type", _headers.pop("Content-Type", None)) + cls: ClsType[_models.AnalyzeTextResult] = kwargs.pop("cls", None) + + content_type = content_type or "application/json" + _content = None + if isinstance(options, (IOBase, bytes)): + _content = options + else: + _content = json.dumps(options, cls=SdkJSONEncoder, exclude_readonly=True) # type: ignore + + _request = build_content_safety_analyze_text_request( + content_type=content_type, + api_version=self._config.api_version, + content=_content, + headers=_headers, + params=_params, + ) + path_format_arguments = { + "endpoint": self._serialize.url("self._config.endpoint", self._config.endpoint, "str", skip_quote=True), + } + _request.url = self._client.format_url(_request.url, **path_format_arguments) + + _decompress = kwargs.pop("decompress", True) + _stream = kwargs.pop("stream", False) + pipeline_response: PipelineResponse = self._client._pipeline.run( # pylint: disable=protected-access + _request, stream=_stream, **kwargs + ) + + response = pipeline_response.http_response + + if response.status_code not in [200]: + if _stream: + try: + response.read() # Load the body in memory and close the socket + except (StreamConsumedError, StreamClosedError): + pass + map_error(status_code=response.status_code, response=response, error_map=error_map) + raise HttpResponseError(response=response) + + if _stream: + deserialized = response.iter_bytes() if _decompress else response.iter_raw() + else: + deserialized = _deserialize(_models.AnalyzeTextResult, response.json()) + + if cls: + return cls(pipeline_response, deserialized, {}) # type: ignore + + return deserialized # type: ignore + + @overload + def detect_text_protected_material( + self, + options: _models.DetectTextProtectedMaterialOptions, + *, + content_type: str = "application/json", + **kwargs: Any, + ) -> _models.DetectTextProtectedMaterialResult: + """Detect Protected Material for Text. + + A synchronous API for detecting protected material in the given text. + + :param options: The request body to be detected, which may contain protected material. + Required. + :type options: ~azure.ai.contentsafety.models.DetectTextProtectedMaterialOptions + :keyword content_type: Body Parameter content-type. Content type parameter for JSON body. + Default value is "application/json". + :paramtype content_type: str + :return: DetectTextProtectedMaterialResult. The DetectTextProtectedMaterialResult is compatible + with MutableMapping + :rtype: ~azure.ai.contentsafety.models.DetectTextProtectedMaterialResult + :raises ~azure.core.exceptions.HttpResponseError: + """ + + @overload + def detect_text_protected_material( + self, + options: _types.DetectTextProtectedMaterialOptions, + *, + content_type: str = "application/json", + **kwargs: Any, + ) -> _models.DetectTextProtectedMaterialResult: + """Detect Protected Material for Text. + + A synchronous API for detecting protected material in the given text. + + :param options: The request body to be detected, which may contain protected material. + Required. + :type options: ~azure.ai.contentsafety.types.DetectTextProtectedMaterialOptions + :keyword content_type: Body Parameter content-type. Content type parameter for JSON body. + Default value is "application/json". + :paramtype content_type: str + :return: DetectTextProtectedMaterialResult. The DetectTextProtectedMaterialResult is compatible + with MutableMapping + :rtype: ~azure.ai.contentsafety.models.DetectTextProtectedMaterialResult + :raises ~azure.core.exceptions.HttpResponseError: + """ + + @overload + def detect_text_protected_material( + self, options: IO[bytes], *, content_type: str = "application/json", **kwargs: Any + ) -> _models.DetectTextProtectedMaterialResult: + """Detect Protected Material for Text. + + A synchronous API for detecting protected material in the given text. + + :param options: The request body to be detected, which may contain protected material. + Required. + :type options: IO[bytes] + :keyword content_type: Body Parameter content-type. Content type parameter for binary body. + Default value is "application/json". + :paramtype content_type: str + :return: DetectTextProtectedMaterialResult. The DetectTextProtectedMaterialResult is compatible + with MutableMapping + :rtype: ~azure.ai.contentsafety.models.DetectTextProtectedMaterialResult + :raises ~azure.core.exceptions.HttpResponseError: + """ + + @distributed_trace + @api_version_validation( + method_added_on="2024-09-01", + params_added_on={"2024-09-01": ["api_version", "content_type", "accept"]}, + api_versions_list=["2024-09-01", "2026-07-01-preview"], + ) + def detect_text_protected_material( + self, + options: Union[ + _models.DetectTextProtectedMaterialOptions, _types.DetectTextProtectedMaterialOptions, IO[bytes] + ], + **kwargs: Any, + ) -> _models.DetectTextProtectedMaterialResult: + """Detect Protected Material for Text. + + A synchronous API for detecting protected material in the given text. + + :param options: The request body to be detected, which may contain protected material. Is + either a DetectTextProtectedMaterialOptions type or a IO[bytes] type. Required. + :type options: ~azure.ai.contentsafety.models.DetectTextProtectedMaterialOptions or + ~azure.ai.contentsafety.types.DetectTextProtectedMaterialOptions or IO[bytes] + :return: DetectTextProtectedMaterialResult. The DetectTextProtectedMaterialResult is compatible + with MutableMapping + :rtype: ~azure.ai.contentsafety.models.DetectTextProtectedMaterialResult + :raises ~azure.core.exceptions.HttpResponseError: + """ + error_map: MutableMapping = { + 401: ClientAuthenticationError, + 404: ResourceNotFoundError, + 409: ResourceExistsError, + 304: ResourceNotModifiedError, + } + error_map.update(kwargs.pop("error_map", {}) or {}) + + _headers = case_insensitive_dict(kwargs.pop("headers", {}) or {}) + _params = kwargs.pop("params", {}) or {} + + content_type: Optional[str] = kwargs.pop("content_type", _headers.pop("Content-Type", None)) + cls: ClsType[_models.DetectTextProtectedMaterialResult] = kwargs.pop("cls", None) + + content_type = content_type or "application/json" + _content = None + if isinstance(options, (IOBase, bytes)): + _content = options + else: + _content = json.dumps(options, cls=SdkJSONEncoder, exclude_readonly=True) # type: ignore + + _request = build_content_safety_detect_text_protected_material_request( + content_type=content_type, + api_version=self._config.api_version, + content=_content, + headers=_headers, + params=_params, + ) + path_format_arguments = { + "endpoint": self._serialize.url("self._config.endpoint", self._config.endpoint, "str", skip_quote=True), + } + _request.url = self._client.format_url(_request.url, **path_format_arguments) - _url: str = _url.format(**path_format_arguments) # type: ignore + _decompress = kwargs.pop("decompress", True) + _stream = kwargs.pop("stream", False) + pipeline_response: PipelineResponse = self._client._pipeline.run( # pylint: disable=protected-access + _request, stream=_stream, **kwargs + ) - # Construct parameters - _params["api-version"] = _SERIALIZER.query("api_version", api_version, "str") + response = pipeline_response.http_response - # Construct headers - if content_type is not None: - _headers["Content-Type"] = _SERIALIZER.header("content_type", content_type, "str") + if response.status_code not in [200]: + if _stream: + try: + response.read() # Load the body in memory and close the socket + except (StreamConsumedError, StreamClosedError): + pass + map_error(status_code=response.status_code, response=response, error_map=error_map) + raise HttpResponseError(response=response) - return HttpRequest(method="POST", url=_url, params=_params, headers=_headers, **kwargs) + if _stream: + deserialized = response.iter_bytes() if _decompress else response.iter_raw() + else: + deserialized = _deserialize(_models.DetectTextProtectedMaterialResult, response.json()) + + if cls: + return cls(pipeline_response, deserialized, {}) # type: ignore + return deserialized # type: ignore -class ContentSafetyClientOperationsMixin(ContentSafetyClientMixinABC): @overload - def analyze_text( - self, options: _models.AnalyzeTextOptions, *, content_type: str = "application/json", **kwargs: Any - ) -> _models.AnalyzeTextResult: - """Analyze Text. + def shield_prompt( + self, options: _models.ShieldPromptOptions, *, content_type: str = "application/json", **kwargs: Any + ) -> _models.ShieldPromptResult: + """Shield Prompt. - A synchronous API for the analysis of potentially harmful text content. Currently, it supports - four categories: Hate, SelfHarm, Sexual, and Violence. + A synchronous API for shielding prompt from direct and indirect injection attacks. - :param options: The text analysis request. Required. - :type options: ~azure.ai.contentsafety.models.AnalyzeTextOptions + :param options: The request body to be detected, which may contain direct or indirect injection + attacks. Required. + :type options: ~azure.ai.contentsafety.models.ShieldPromptOptions :keyword content_type: Body Parameter content-type. Content type parameter for JSON body. Default value is "application/json". :paramtype content_type: str - :keyword bool stream: Whether to stream the response of this operation. Defaults to False. You - will have to context manage the returned stream. - :return: AnalyzeTextResult. The AnalyzeTextResult is compatible with MutableMapping - :rtype: ~azure.ai.contentsafety.models.AnalyzeTextResult + :return: ShieldPromptResult. The ShieldPromptResult is compatible with MutableMapping + :rtype: ~azure.ai.contentsafety.models.ShieldPromptResult :raises ~azure.core.exceptions.HttpResponseError: """ @overload - def analyze_text( - self, options: JSON, *, content_type: str = "application/json", **kwargs: Any - ) -> _models.AnalyzeTextResult: - """Analyze Text. + def shield_prompt( + self, options: _types.ShieldPromptOptions, *, content_type: str = "application/json", **kwargs: Any + ) -> _models.ShieldPromptResult: + """Shield Prompt. - A synchronous API for the analysis of potentially harmful text content. Currently, it supports - four categories: Hate, SelfHarm, Sexual, and Violence. + A synchronous API for shielding prompt from direct and indirect injection attacks. - :param options: The text analysis request. Required. - :type options: JSON + :param options: The request body to be detected, which may contain direct or indirect injection + attacks. Required. + :type options: ~azure.ai.contentsafety.types.ShieldPromptOptions :keyword content_type: Body Parameter content-type. Content type parameter for JSON body. Default value is "application/json". :paramtype content_type: str - :keyword bool stream: Whether to stream the response of this operation. Defaults to False. You - will have to context manage the returned stream. - :return: AnalyzeTextResult. The AnalyzeTextResult is compatible with MutableMapping - :rtype: ~azure.ai.contentsafety.models.AnalyzeTextResult + :return: ShieldPromptResult. The ShieldPromptResult is compatible with MutableMapping + :rtype: ~azure.ai.contentsafety.models.ShieldPromptResult :raises ~azure.core.exceptions.HttpResponseError: """ @overload - def analyze_text( + def shield_prompt( self, options: IO[bytes], *, content_type: str = "application/json", **kwargs: Any - ) -> _models.AnalyzeTextResult: - """Analyze Text. + ) -> _models.ShieldPromptResult: + """Shield Prompt. - A synchronous API for the analysis of potentially harmful text content. Currently, it supports - four categories: Hate, SelfHarm, Sexual, and Violence. + A synchronous API for shielding prompt from direct and indirect injection attacks. - :param options: The text analysis request. Required. + :param options: The request body to be detected, which may contain direct or indirect injection + attacks. Required. :type options: IO[bytes] :keyword content_type: Body Parameter content-type. Content type parameter for binary body. Default value is "application/json". :paramtype content_type: str - :keyword bool stream: Whether to stream the response of this operation. Defaults to False. You - will have to context manage the returned stream. - :return: AnalyzeTextResult. The AnalyzeTextResult is compatible with MutableMapping - :rtype: ~azure.ai.contentsafety.models.AnalyzeTextResult + :return: ShieldPromptResult. The ShieldPromptResult is compatible with MutableMapping + :rtype: ~azure.ai.contentsafety.models.ShieldPromptResult :raises ~azure.core.exceptions.HttpResponseError: """ @distributed_trace - def analyze_text( - self, options: Union[_models.AnalyzeTextOptions, JSON, IO[bytes]], **kwargs: Any - ) -> _models.AnalyzeTextResult: - """Analyze Text. - - A synchronous API for the analysis of potentially harmful text content. Currently, it supports - four categories: Hate, SelfHarm, Sexual, and Violence. - - :param options: The text analysis request. Is one of the following types: AnalyzeTextOptions, - JSON, IO[bytes] Required. - :type options: ~azure.ai.contentsafety.models.AnalyzeTextOptions or JSON or IO[bytes] - :keyword content_type: Body parameter Content-Type. Known values are: application/json. Default - value is None. - :paramtype content_type: str - :keyword bool stream: Whether to stream the response of this operation. Defaults to False. You - will have to context manage the returned stream. - :return: AnalyzeTextResult. The AnalyzeTextResult is compatible with MutableMapping - :rtype: ~azure.ai.contentsafety.models.AnalyzeTextResult + @api_version_validation( + method_added_on="2024-09-01", + params_added_on={"2024-09-01": ["api_version", "content_type", "accept"]}, + api_versions_list=["2024-09-01", "2026-07-01-preview"], + ) + def shield_prompt( + self, options: Union[_models.ShieldPromptOptions, _types.ShieldPromptOptions, IO[bytes]], **kwargs: Any + ) -> _models.ShieldPromptResult: + """Shield Prompt. + + A synchronous API for shielding prompt from direct and indirect injection attacks. + + :param options: The request body to be detected, which may contain direct or indirect injection + attacks. Is either a ShieldPromptOptions type or a IO[bytes] type. Required. + :type options: ~azure.ai.contentsafety.models.ShieldPromptOptions or + ~azure.ai.contentsafety.types.ShieldPromptOptions or IO[bytes] + :return: ShieldPromptResult. The ShieldPromptResult is compatible with MutableMapping + :rtype: ~azure.ai.contentsafety.models.ShieldPromptResult :raises ~azure.core.exceptions.HttpResponseError: """ - error_map = { + error_map: MutableMapping = { 401: ClientAuthenticationError, 404: ResourceNotFoundError, 409: ResourceExistsError, @@ -397,7 +916,7 @@ def analyze_text( _params = kwargs.pop("params", {}) or {} content_type: Optional[str] = kwargs.pop("content_type", _headers.pop("Content-Type", None)) - cls: ClsType[_models.AnalyzeTextResult] = kwargs.pop("cls", None) + cls: ClsType[_models.ShieldPromptResult] = kwargs.pop("cls", None) content_type = content_type or "application/json" _content = None @@ -406,7 +925,7 @@ def analyze_text( else: _content = json.dumps(options, cls=SdkJSONEncoder, exclude_readonly=True) # type: ignore - _request = build_content_safety_analyze_text_request( + _request = build_content_safety_shield_prompt_request( content_type=content_type, api_version=self._config.api_version, content=_content, @@ -418,6 +937,7 @@ def analyze_text( } _request.url = self._client.format_url(_request.url, **path_format_arguments) + _decompress = kwargs.pop("decompress", True) _stream = kwargs.pop("stream", False) pipeline_response: PipelineResponse = self._client._pipeline.run( # pylint: disable=protected-access _request, stream=_stream, **kwargs @@ -427,105 +947,244 @@ def analyze_text( if response.status_code not in [200]: if _stream: - response.read() # Load the body in memory and close the socket + try: + response.read() # Load the body in memory and close the socket + except (StreamConsumedError, StreamClosedError): + pass map_error(status_code=response.status_code, response=response, error_map=error_map) raise HttpResponseError(response=response) if _stream: - deserialized = response.iter_bytes() + deserialized = response.iter_bytes() if _decompress else response.iter_raw() else: - deserialized = _deserialize(_models.AnalyzeTextResult, response.json()) + deserialized = _deserialize(_models.ShieldPromptResult, response.json()) if cls: return cls(pipeline_response, deserialized, {}) # type: ignore return deserialized # type: ignore + +class _ContentProvenanceClientOperationsMixin( + ClientMixinABC[PipelineClient[HttpRequest, HttpResponse], ContentProvenanceClientConfiguration] +): + + def _detect_initial( + self, options: Union[_models.DetectProvenanceOptions, _types.DetectProvenanceOptions, IO[bytes]], **kwargs: Any + ) -> Iterator[bytes]: + error_map: MutableMapping = { + 401: ClientAuthenticationError, + 404: ResourceNotFoundError, + 409: ResourceExistsError, + 304: ResourceNotModifiedError, + } + error_map.update(kwargs.pop("error_map", {}) or {}) + + _headers = case_insensitive_dict(kwargs.pop("headers", {}) or {}) + _params = kwargs.pop("params", {}) or {} + + content_type: Optional[str] = kwargs.pop("content_type", _headers.pop("Content-Type", None)) + cls: ClsType[Iterator[bytes]] = kwargs.pop("cls", None) + + content_type = content_type or "application/json" + _content = None + if isinstance(options, (IOBase, bytes)): + _content = options + else: + _content = json.dumps(options, cls=SdkJSONEncoder, exclude_readonly=True) # type: ignore + + _request = build_content_provenance_detect_request( + content_type=content_type, + api_version=self._config.api_version, + content=_content, + headers=_headers, + params=_params, + ) + path_format_arguments = { + "endpoint": self._serialize.url("self._config.endpoint", self._config.endpoint, "str", skip_quote=True), + } + _request.url = self._client.format_url(_request.url, **path_format_arguments) + + _decompress = kwargs.pop("decompress", True) + _stream = True + pipeline_response: PipelineResponse = self._client._pipeline.run( # pylint: disable=protected-access + _request, stream=_stream, **kwargs + ) + + response = pipeline_response.http_response + + if response.status_code not in [202]: + try: + response.read() # Load the body in memory and close the socket + except (StreamConsumedError, StreamClosedError): + pass + map_error(status_code=response.status_code, response=response, error_map=error_map) + raise HttpResponseError(response=response) + + response_headers = {} + response_headers["Operation-Location"] = self._deserialize("str", response.headers.get("Operation-Location")) + + deserialized = response.iter_bytes() if _decompress else response.iter_raw() + + if cls: + return cls(pipeline_response, deserialized, response_headers) # type: ignore + + return deserialized # type: ignore + @overload - def analyze_image( - self, options: _models.AnalyzeImageOptions, *, content_type: str = "application/json", **kwargs: Any - ) -> _models.AnalyzeImageResult: - """Analyze Image. + def begin_detect( + self, options: _models.DetectProvenanceOptions, *, content_type: str = "application/json", **kwargs: Any + ) -> LROPoller[_models.DetectProvenanceResult]: + """Start Content Provenance Detection. - A synchronous API for the analysis of potentially harmful image content. Currently, it supports - four categories: Hate, SelfHarm, Sexual, and Violence. + Starts an asynchronous Content Provenance Detection operation that inspects the supplied media + for Microsoft-issued C2PA and imperceptible watermark signals indicating the content was + created or modified using AI. - :param options: The image analysis request. Required. - :type options: ~azure.ai.contentsafety.models.AnalyzeImageOptions + :param options: Options describing the media to inspect using Content Provenance Detection. + Required. + :type options: ~azure.ai.contentsafety.models.DetectProvenanceOptions :keyword content_type: Body Parameter content-type. Content type parameter for JSON body. Default value is "application/json". :paramtype content_type: str - :keyword bool stream: Whether to stream the response of this operation. Defaults to False. You - will have to context manage the returned stream. - :return: AnalyzeImageResult. The AnalyzeImageResult is compatible with MutableMapping - :rtype: ~azure.ai.contentsafety.models.AnalyzeImageResult + :return: An instance of LROPoller that returns DetectProvenanceResult. The + DetectProvenanceResult is compatible with MutableMapping + :rtype: ~azure.core.polling.LROPoller[~azure.ai.contentsafety.models.DetectProvenanceResult] :raises ~azure.core.exceptions.HttpResponseError: """ @overload - def analyze_image( - self, options: JSON, *, content_type: str = "application/json", **kwargs: Any - ) -> _models.AnalyzeImageResult: - """Analyze Image. + def begin_detect( + self, options: _types.DetectProvenanceOptions, *, content_type: str = "application/json", **kwargs: Any + ) -> LROPoller[_models.DetectProvenanceResult]: + """Start Content Provenance Detection. - A synchronous API for the analysis of potentially harmful image content. Currently, it supports - four categories: Hate, SelfHarm, Sexual, and Violence. + Starts an asynchronous Content Provenance Detection operation that inspects the supplied media + for Microsoft-issued C2PA and imperceptible watermark signals indicating the content was + created or modified using AI. - :param options: The image analysis request. Required. - :type options: JSON + :param options: Options describing the media to inspect using Content Provenance Detection. + Required. + :type options: ~azure.ai.contentsafety.types.DetectProvenanceOptions :keyword content_type: Body Parameter content-type. Content type parameter for JSON body. Default value is "application/json". :paramtype content_type: str - :keyword bool stream: Whether to stream the response of this operation. Defaults to False. You - will have to context manage the returned stream. - :return: AnalyzeImageResult. The AnalyzeImageResult is compatible with MutableMapping - :rtype: ~azure.ai.contentsafety.models.AnalyzeImageResult + :return: An instance of LROPoller that returns DetectProvenanceResult. The + DetectProvenanceResult is compatible with MutableMapping + :rtype: ~azure.core.polling.LROPoller[~azure.ai.contentsafety.models.DetectProvenanceResult] :raises ~azure.core.exceptions.HttpResponseError: """ @overload - def analyze_image( + def begin_detect( self, options: IO[bytes], *, content_type: str = "application/json", **kwargs: Any - ) -> _models.AnalyzeImageResult: - """Analyze Image. + ) -> LROPoller[_models.DetectProvenanceResult]: + """Start Content Provenance Detection. - A synchronous API for the analysis of potentially harmful image content. Currently, it supports - four categories: Hate, SelfHarm, Sexual, and Violence. + Starts an asynchronous Content Provenance Detection operation that inspects the supplied media + for Microsoft-issued C2PA and imperceptible watermark signals indicating the content was + created or modified using AI. - :param options: The image analysis request. Required. + :param options: Options describing the media to inspect using Content Provenance Detection. + Required. :type options: IO[bytes] :keyword content_type: Body Parameter content-type. Content type parameter for binary body. Default value is "application/json". :paramtype content_type: str - :keyword bool stream: Whether to stream the response of this operation. Defaults to False. You - will have to context manage the returned stream. - :return: AnalyzeImageResult. The AnalyzeImageResult is compatible with MutableMapping - :rtype: ~azure.ai.contentsafety.models.AnalyzeImageResult + :return: An instance of LROPoller that returns DetectProvenanceResult. The + DetectProvenanceResult is compatible with MutableMapping + :rtype: ~azure.core.polling.LROPoller[~azure.ai.contentsafety.models.DetectProvenanceResult] :raises ~azure.core.exceptions.HttpResponseError: """ @distributed_trace - def analyze_image( - self, options: Union[_models.AnalyzeImageOptions, JSON, IO[bytes]], **kwargs: Any - ) -> _models.AnalyzeImageResult: - """Analyze Image. + def begin_detect( + self, options: Union[_models.DetectProvenanceOptions, _types.DetectProvenanceOptions, IO[bytes]], **kwargs: Any + ) -> LROPoller[_models.DetectProvenanceResult]: + """Start Content Provenance Detection. + + Starts an asynchronous Content Provenance Detection operation that inspects the supplied media + for Microsoft-issued C2PA and imperceptible watermark signals indicating the content was + created or modified using AI. + + :param options: Options describing the media to inspect using Content Provenance Detection. Is + either a DetectProvenanceOptions type or a IO[bytes] type. Required. + :type options: ~azure.ai.contentsafety.models.DetectProvenanceOptions or + ~azure.ai.contentsafety.types.DetectProvenanceOptions or IO[bytes] + :return: An instance of LROPoller that returns DetectProvenanceResult. The + DetectProvenanceResult is compatible with MutableMapping + :rtype: ~azure.core.polling.LROPoller[~azure.ai.contentsafety.models.DetectProvenanceResult] + :raises ~azure.core.exceptions.HttpResponseError: + """ + _headers = case_insensitive_dict(kwargs.pop("headers", {}) or {}) + _params = kwargs.pop("params", {}) or {} - A synchronous API for the analysis of potentially harmful image content. Currently, it supports - four categories: Hate, SelfHarm, Sexual, and Violence. + content_type: Optional[str] = kwargs.pop("content_type", _headers.pop("Content-Type", None)) + cls: ClsType[_models.DetectProvenanceResult] = kwargs.pop("cls", None) + polling: Union[bool, PollingMethod] = kwargs.pop("polling", True) + lro_delay = kwargs.pop("polling_interval", self._config.polling_interval) + cont_token: Optional[str] = kwargs.pop("continuation_token", None) + if cont_token is None: + raw_result = self._detect_initial( + options=options, + content_type=content_type, + cls=lambda x, y, z: x, + headers=_headers, + params=_params, + **kwargs, + ) + raw_result.http_response.read() # type: ignore + kwargs.pop("error_map", None) - :param options: The image analysis request. Is one of the following types: AnalyzeImageOptions, - JSON, IO[bytes] Required. - :type options: ~azure.ai.contentsafety.models.AnalyzeImageOptions or JSON or IO[bytes] - :keyword content_type: Body parameter Content-Type. Known values are: application/json. Default - value is None. - :paramtype content_type: str - :keyword bool stream: Whether to stream the response of this operation. Defaults to False. You - will have to context manage the returned stream. - :return: AnalyzeImageResult. The AnalyzeImageResult is compatible with MutableMapping - :rtype: ~azure.ai.contentsafety.models.AnalyzeImageResult + def get_long_running_output(pipeline_response): + response_headers = {} + response = pipeline_response.http_response + response_headers["Operation-Location"] = self._deserialize( + "str", response.headers.get("Operation-Location") + ) + + deserialized = _deserialize(_models.DetectProvenanceResult, response.json().get("result", {})) + if cls: + return cls(pipeline_response, deserialized, response_headers) # type: ignore + return deserialized + + path_format_arguments = { + "endpoint": self._serialize.url("self._config.endpoint", self._config.endpoint, "str", skip_quote=True), + } + + if polling is True: + polling_method: PollingMethod = cast( + PollingMethod, LROBasePolling(lro_delay, path_format_arguments=path_format_arguments, **kwargs) + ) + elif polling is False: + polling_method = cast(PollingMethod, NoPolling()) + else: + polling_method = polling + if cont_token: + return LROPoller[_models.DetectProvenanceResult].from_continuation_token( + polling_method=polling_method, + continuation_token=cont_token, + client=self._client, + deserialization_callback=get_long_running_output, + ) + return LROPoller[_models.DetectProvenanceResult]( + self._client, raw_result, get_long_running_output, polling_method # type: ignore + ) + + @distributed_trace + def get_operation_status(self, operation_id: str, **kwargs: Any) -> _models.ProvenanceDetectOperation: + """Get Content Provenance Detection Status. + + Gets the status, result, or error of an asynchronous Content Provenance Detection operation. + + :param operation_id: The unique ID of the operation. Required. + :type operation_id: str + :return: ProvenanceDetectOperation. The ProvenanceDetectOperation is compatible with + MutableMapping + :rtype: ~azure.ai.contentsafety.models.ProvenanceDetectOperation :raises ~azure.core.exceptions.HttpResponseError: """ - error_map = { + error_map: MutableMapping = { 401: ClientAuthenticationError, 404: ResourceNotFoundError, 409: ResourceExistsError, @@ -533,23 +1192,14 @@ def analyze_image( } error_map.update(kwargs.pop("error_map", {}) or {}) - _headers = case_insensitive_dict(kwargs.pop("headers", {}) or {}) + _headers = kwargs.pop("headers", {}) or {} _params = kwargs.pop("params", {}) or {} - content_type: Optional[str] = kwargs.pop("content_type", _headers.pop("Content-Type", None)) - cls: ClsType[_models.AnalyzeImageResult] = kwargs.pop("cls", None) - - content_type = content_type or "application/json" - _content = None - if isinstance(options, (IOBase, bytes)): - _content = options - else: - _content = json.dumps(options, cls=SdkJSONEncoder, exclude_readonly=True) # type: ignore + cls: ClsType[_models.ProvenanceDetectOperation] = kwargs.pop("cls", None) - _request = build_content_safety_analyze_image_request( - content_type=content_type, + _request = build_content_provenance_get_operation_status_request( + operation_id=operation_id, api_version=self._config.api_version, - content=_content, headers=_headers, params=_params, ) @@ -558,6 +1208,7 @@ def analyze_image( } _request.url = self._client.format_url(_request.url, **path_format_arguments) + _decompress = kwargs.pop("decompress", True) _stream = kwargs.pop("stream", False) pipeline_response: PipelineResponse = self._client._pipeline.run( # pylint: disable=protected-access _request, stream=_stream, **kwargs @@ -567,22 +1218,31 @@ def analyze_image( if response.status_code not in [200]: if _stream: - response.read() # Load the body in memory and close the socket + try: + response.read() # Load the body in memory and close the socket + except (StreamConsumedError, StreamClosedError): + pass map_error(status_code=response.status_code, response=response, error_map=error_map) raise HttpResponseError(response=response) + response_headers = {} + response_headers["Retry-After"] = self._deserialize("int", response.headers.get("Retry-After")) + if _stream: - deserialized = response.iter_bytes() + deserialized = response.iter_bytes() if _decompress else response.iter_raw() else: - deserialized = _deserialize(_models.AnalyzeImageResult, response.json()) + deserialized = _deserialize(_models.ProvenanceDetectOperation, response.json()) if cls: - return cls(pipeline_response, deserialized, {}) # type: ignore + return cls(pipeline_response, deserialized, response_headers) # type: ignore return deserialized # type: ignore -class BlocklistClientOperationsMixin(BlocklistClientMixinABC): +class _BlocklistClientOperationsMixin( + ClientMixinABC[PipelineClient[HttpRequest, HttpResponse], BlocklistClientConfiguration] +): + @overload def add_or_update_blocklist_items( self, @@ -590,7 +1250,7 @@ def add_or_update_blocklist_items( options: _models.AddOrUpdateTextBlocklistItemsOptions, *, content_type: str = "application/json", - **kwargs: Any + **kwargs: Any, ) -> _models.AddOrUpdateTextBlocklistItemsResult: """Add or update BlocklistItems To Text Blocklist. @@ -604,8 +1264,6 @@ def add_or_update_blocklist_items( :keyword content_type: Body Parameter content-type. Content type parameter for JSON body. Default value is "application/json". :paramtype content_type: str - :keyword bool stream: Whether to stream the response of this operation. Defaults to False. You - will have to context manage the returned stream. :return: AddOrUpdateTextBlocklistItemsResult. The AddOrUpdateTextBlocklistItemsResult is compatible with MutableMapping :rtype: ~azure.ai.contentsafety.models.AddOrUpdateTextBlocklistItemsResult @@ -614,7 +1272,12 @@ def add_or_update_blocklist_items( @overload def add_or_update_blocklist_items( - self, blocklist_name: str, options: JSON, *, content_type: str = "application/json", **kwargs: Any + self, + blocklist_name: str, + options: _types.AddOrUpdateTextBlocklistItemsOptions, + *, + content_type: str = "application/json", + **kwargs: Any, ) -> _models.AddOrUpdateTextBlocklistItemsResult: """Add or update BlocklistItems To Text Blocklist. @@ -624,12 +1287,10 @@ def add_or_update_blocklist_items( :param blocklist_name: Text blocklist name. Required. :type blocklist_name: str :param options: Options for adding or updating blocklist items. Required. - :type options: JSON + :type options: ~azure.ai.contentsafety.types.AddOrUpdateTextBlocklistItemsOptions :keyword content_type: Body Parameter content-type. Content type parameter for JSON body. Default value is "application/json". :paramtype content_type: str - :keyword bool stream: Whether to stream the response of this operation. Defaults to False. You - will have to context manage the returned stream. :return: AddOrUpdateTextBlocklistItemsResult. The AddOrUpdateTextBlocklistItemsResult is compatible with MutableMapping :rtype: ~azure.ai.contentsafety.models.AddOrUpdateTextBlocklistItemsResult @@ -652,8 +1313,6 @@ def add_or_update_blocklist_items( :keyword content_type: Body Parameter content-type. Content type parameter for binary body. Default value is "application/json". :paramtype content_type: str - :keyword bool stream: Whether to stream the response of this operation. Defaults to False. You - will have to context manage the returned stream. :return: AddOrUpdateTextBlocklistItemsResult. The AddOrUpdateTextBlocklistItemsResult is compatible with MutableMapping :rtype: ~azure.ai.contentsafety.models.AddOrUpdateTextBlocklistItemsResult @@ -664,8 +1323,10 @@ def add_or_update_blocklist_items( def add_or_update_blocklist_items( self, blocklist_name: str, - options: Union[_models.AddOrUpdateTextBlocklistItemsOptions, JSON, IO[bytes]], - **kwargs: Any + options: Union[ + _models.AddOrUpdateTextBlocklistItemsOptions, _types.AddOrUpdateTextBlocklistItemsOptions, IO[bytes] + ], + **kwargs: Any, ) -> _models.AddOrUpdateTextBlocklistItemsResult: """Add or update BlocklistItems To Text Blocklist. @@ -674,21 +1335,16 @@ def add_or_update_blocklist_items( :param blocklist_name: Text blocklist name. Required. :type blocklist_name: str - :param options: Options for adding or updating blocklist items. Is one of the following types: - AddOrUpdateTextBlocklistItemsOptions, JSON, IO[bytes] Required. - :type options: ~azure.ai.contentsafety.models.AddOrUpdateTextBlocklistItemsOptions or JSON or - IO[bytes] - :keyword content_type: Body parameter Content-Type. Known values are: application/json. Default - value is None. - :paramtype content_type: str - :keyword bool stream: Whether to stream the response of this operation. Defaults to False. You - will have to context manage the returned stream. + :param options: Options for adding or updating blocklist items. Is either a + AddOrUpdateTextBlocklistItemsOptions type or a IO[bytes] type. Required. + :type options: ~azure.ai.contentsafety.models.AddOrUpdateTextBlocklistItemsOptions or + ~azure.ai.contentsafety.types.AddOrUpdateTextBlocklistItemsOptions or IO[bytes] :return: AddOrUpdateTextBlocklistItemsResult. The AddOrUpdateTextBlocklistItemsResult is compatible with MutableMapping :rtype: ~azure.ai.contentsafety.models.AddOrUpdateTextBlocklistItemsResult :raises ~azure.core.exceptions.HttpResponseError: """ - error_map = { + error_map: MutableMapping = { 401: ClientAuthenticationError, 404: ResourceNotFoundError, 409: ResourceExistsError, @@ -722,6 +1378,7 @@ def add_or_update_blocklist_items( } _request.url = self._client.format_url(_request.url, **path_format_arguments) + _decompress = kwargs.pop("decompress", True) _stream = kwargs.pop("stream", False) pipeline_response: PipelineResponse = self._client._pipeline.run( # pylint: disable=protected-access _request, stream=_stream, **kwargs @@ -731,12 +1388,15 @@ def add_or_update_blocklist_items( if response.status_code not in [200]: if _stream: - response.read() # Load the body in memory and close the socket + try: + response.read() # Load the body in memory and close the socket + except (StreamConsumedError, StreamClosedError): + pass map_error(status_code=response.status_code, response=response, error_map=error_map) raise HttpResponseError(response=response) if _stream: - deserialized = response.iter_bytes() + deserialized = response.iter_bytes() if _decompress else response.iter_raw() else: deserialized = _deserialize(_models.AddOrUpdateTextBlocklistItemsResult, response.json()) @@ -752,7 +1412,7 @@ def create_or_update_text_blocklist( options: _models.TextBlocklist, *, content_type: str = "application/merge-patch+json", - **kwargs: Any + **kwargs: Any, ) -> _models.TextBlocklist: """Create Or Update Text Blocklist. @@ -765,8 +1425,6 @@ def create_or_update_text_blocklist( :keyword content_type: Body Parameter content-type. Content type parameter for JSON body. Default value is "application/merge-patch+json". :paramtype content_type: str - :keyword bool stream: Whether to stream the response of this operation. Defaults to False. You - will have to context manage the returned stream. :return: TextBlocklist. The TextBlocklist is compatible with MutableMapping :rtype: ~azure.ai.contentsafety.models.TextBlocklist :raises ~azure.core.exceptions.HttpResponseError: @@ -774,7 +1432,12 @@ def create_or_update_text_blocklist( @overload def create_or_update_text_blocklist( - self, blocklist_name: str, options: JSON, *, content_type: str = "application/merge-patch+json", **kwargs: Any + self, + blocklist_name: str, + options: _types.TextBlocklist, + *, + content_type: str = "application/merge-patch+json", + **kwargs: Any, ) -> _models.TextBlocklist: """Create Or Update Text Blocklist. @@ -783,12 +1446,10 @@ def create_or_update_text_blocklist( :param blocklist_name: Text blocklist name. Required. :type blocklist_name: str :param options: The resource instance. Required. - :type options: JSON + :type options: ~azure.ai.contentsafety.types.TextBlocklist :keyword content_type: Body Parameter content-type. Content type parameter for JSON body. Default value is "application/merge-patch+json". :paramtype content_type: str - :keyword bool stream: Whether to stream the response of this operation. Defaults to False. You - will have to context manage the returned stream. :return: TextBlocklist. The TextBlocklist is compatible with MutableMapping :rtype: ~azure.ai.contentsafety.models.TextBlocklist :raises ~azure.core.exceptions.HttpResponseError: @@ -801,7 +1462,7 @@ def create_or_update_text_blocklist( options: IO[bytes], *, content_type: str = "application/merge-patch+json", - **kwargs: Any + **kwargs: Any, ) -> _models.TextBlocklist: """Create Or Update Text Blocklist. @@ -814,8 +1475,6 @@ def create_or_update_text_blocklist( :keyword content_type: Body Parameter content-type. Content type parameter for binary body. Default value is "application/merge-patch+json". :paramtype content_type: str - :keyword bool stream: Whether to stream the response of this operation. Defaults to False. You - will have to context manage the returned stream. :return: TextBlocklist. The TextBlocklist is compatible with MutableMapping :rtype: ~azure.ai.contentsafety.models.TextBlocklist :raises ~azure.core.exceptions.HttpResponseError: @@ -823,7 +1482,7 @@ def create_or_update_text_blocklist( @distributed_trace def create_or_update_text_blocklist( - self, blocklist_name: str, options: Union[_models.TextBlocklist, JSON, IO[bytes]], **kwargs: Any + self, blocklist_name: str, options: Union[_models.TextBlocklist, _types.TextBlocklist, IO[bytes]], **kwargs: Any ) -> _models.TextBlocklist: """Create Or Update Text Blocklist. @@ -831,18 +1490,15 @@ def create_or_update_text_blocklist( :param blocklist_name: Text blocklist name. Required. :type blocklist_name: str - :param options: The resource instance. Is one of the following types: TextBlocklist, JSON, - IO[bytes] Required. - :type options: ~azure.ai.contentsafety.models.TextBlocklist or JSON or IO[bytes] - :keyword content_type: This request has a JSON Merge Patch body. Default value is None. - :paramtype content_type: str - :keyword bool stream: Whether to stream the response of this operation. Defaults to False. You - will have to context manage the returned stream. + :param options: The resource instance. Is either a TextBlocklist type or a IO[bytes] type. + Required. + :type options: ~azure.ai.contentsafety.models.TextBlocklist or + ~azure.ai.contentsafety.types.TextBlocklist or IO[bytes] :return: TextBlocklist. The TextBlocklist is compatible with MutableMapping :rtype: ~azure.ai.contentsafety.models.TextBlocklist :raises ~azure.core.exceptions.HttpResponseError: """ - error_map = { + error_map: MutableMapping = { 401: ClientAuthenticationError, 404: ResourceNotFoundError, 409: ResourceExistsError, @@ -876,6 +1532,7 @@ def create_or_update_text_blocklist( } _request.url = self._client.format_url(_request.url, **path_format_arguments) + _decompress = kwargs.pop("decompress", True) _stream = kwargs.pop("stream", False) pipeline_response: PipelineResponse = self._client._pipeline.run( # pylint: disable=protected-access _request, stream=_stream, **kwargs @@ -885,21 +1542,17 @@ def create_or_update_text_blocklist( if response.status_code not in [200, 201]: if _stream: - response.read() # Load the body in memory and close the socket + try: + response.read() # Load the body in memory and close the socket + except (StreamConsumedError, StreamClosedError): + pass map_error(status_code=response.status_code, response=response, error_map=error_map) raise HttpResponseError(response=response) - if response.status_code == 200: - if _stream: - deserialized = response.iter_bytes() - else: - deserialized = _deserialize(_models.TextBlocklist, response.json()) - - if response.status_code == 201: - if _stream: - deserialized = response.iter_bytes() - else: - deserialized = _deserialize(_models.TextBlocklist, response.json()) + if _stream: + deserialized = response.iter_bytes() if _decompress else response.iter_raw() + else: + deserialized = _deserialize(_models.TextBlocklist, response.json()) if cls: return cls(pipeline_response, deserialized, {}) # type: ignore @@ -920,7 +1573,7 @@ def delete_text_blocklist( # pylint: disable=inconsistent-return-statements :rtype: None :raises ~azure.core.exceptions.HttpResponseError: """ - error_map = { + error_map: MutableMapping = { 401: ClientAuthenticationError, 404: ResourceNotFoundError, 409: ResourceExistsError, @@ -952,8 +1605,6 @@ def delete_text_blocklist( # pylint: disable=inconsistent-return-statements response = pipeline_response.http_response if response.status_code not in [204]: - if _stream: - response.read() # Load the body in memory and close the socket map_error(status_code=response.status_code, response=response, error_map=error_map) raise HttpResponseError(response=response) @@ -968,13 +1619,11 @@ def get_text_blocklist(self, blocklist_name: str, **kwargs: Any) -> _models.Text :param blocklist_name: Text blocklist name. Required. :type blocklist_name: str - :keyword bool stream: Whether to stream the response of this operation. Defaults to False. You - will have to context manage the returned stream. :return: TextBlocklist. The TextBlocklist is compatible with MutableMapping :rtype: ~azure.ai.contentsafety.models.TextBlocklist :raises ~azure.core.exceptions.HttpResponseError: """ - error_map = { + error_map: MutableMapping = { 401: ClientAuthenticationError, 404: ResourceNotFoundError, 409: ResourceExistsError, @@ -998,6 +1647,7 @@ def get_text_blocklist(self, blocklist_name: str, **kwargs: Any) -> _models.Text } _request.url = self._client.format_url(_request.url, **path_format_arguments) + _decompress = kwargs.pop("decompress", True) _stream = kwargs.pop("stream", False) pipeline_response: PipelineResponse = self._client._pipeline.run( # pylint: disable=protected-access _request, stream=_stream, **kwargs @@ -1007,12 +1657,15 @@ def get_text_blocklist(self, blocklist_name: str, **kwargs: Any) -> _models.Text if response.status_code not in [200]: if _stream: - response.read() # Load the body in memory and close the socket + try: + response.read() # Load the body in memory and close the socket + except (StreamConsumedError, StreamClosedError): + pass map_error(status_code=response.status_code, response=response, error_map=error_map) raise HttpResponseError(response=response) if _stream: - deserialized = response.iter_bytes() + deserialized = response.iter_bytes() if _decompress else response.iter_raw() else: deserialized = _deserialize(_models.TextBlocklist, response.json()) @@ -1034,13 +1687,11 @@ def get_text_blocklist_item( :param blocklist_item_id: The service will generate a BlocklistItemId, which will be a UUID. Required. :type blocklist_item_id: str - :keyword bool stream: Whether to stream the response of this operation. Defaults to False. You - will have to context manage the returned stream. :return: TextBlocklistItem. The TextBlocklistItem is compatible with MutableMapping :rtype: ~azure.ai.contentsafety.models.TextBlocklistItem :raises ~azure.core.exceptions.HttpResponseError: """ - error_map = { + error_map: MutableMapping = { 401: ClientAuthenticationError, 404: ResourceNotFoundError, 409: ResourceExistsError, @@ -1065,6 +1716,7 @@ def get_text_blocklist_item( } _request.url = self._client.format_url(_request.url, **path_format_arguments) + _decompress = kwargs.pop("decompress", True) _stream = kwargs.pop("stream", False) pipeline_response: PipelineResponse = self._client._pipeline.run( # pylint: disable=protected-access _request, stream=_stream, **kwargs @@ -1074,12 +1726,15 @@ def get_text_blocklist_item( if response.status_code not in [200]: if _stream: - response.read() # Load the body in memory and close the socket + try: + response.read() # Load the body in memory and close the socket + except (StreamConsumedError, StreamClosedError): + pass map_error(status_code=response.status_code, response=response, error_map=error_map) raise HttpResponseError(response=response) if _stream: - deserialized = response.iter_bytes() + deserialized = response.iter_bytes() if _decompress else response.iter_raw() else: deserialized = _deserialize(_models.TextBlocklistItem, response.json()) @@ -1091,7 +1746,7 @@ def get_text_blocklist_item( @distributed_trace def list_text_blocklist_items( self, blocklist_name: str, *, top: Optional[int] = None, skip: Optional[int] = None, **kwargs: Any - ) -> Iterable["_models.TextBlocklistItem"]: + ) -> ItemPaged["_models.TextBlocklistItem"]: """Get All BlocklistItems By blocklistName. Get all blocklistItems in a text blocklist. @@ -1110,9 +1765,9 @@ def list_text_blocklist_items( _params = kwargs.pop("params", {}) or {} maxpagesize = kwargs.pop("maxpagesize", None) - cls: ClsType[List[_models.TextBlocklistItem]] = kwargs.pop("cls", None) + cls: ClsType[list[_models.TextBlocklistItem]] = kwargs.pop("cls", None) - error_map = { + error_map: MutableMapping = { 401: ClientAuthenticationError, 404: ResourceNotFoundError, 409: ResourceExistsError, @@ -1150,7 +1805,10 @@ def prepare_request(next_link=None): ) _next_request_params["api-version"] = self._config.api_version _request = HttpRequest( - "GET", urllib.parse.urljoin(next_link, _parsed_next_link.path), params=_next_request_params + "GET", + urllib.parse.urljoin(next_link, _parsed_next_link.path), + headers=_headers, + params=_next_request_params, ) path_format_arguments = { "endpoint": self._serialize.url( @@ -1163,7 +1821,10 @@ def prepare_request(next_link=None): def extract_data(pipeline_response): deserialized = pipeline_response.http_response.json() - list_of_elem = _deserialize(List[_models.TextBlocklistItem], deserialized["value"]) + list_of_elem = _deserialize( + list[_models.TextBlocklistItem], + deserialized.get("value", []), + ) if cls: list_of_elem = cls(list_of_elem) # type: ignore return deserialized.get("nextLink") or None, iter(list_of_elem) @@ -1178,8 +1839,6 @@ def get_next(next_link=None): response = pipeline_response.http_response if response.status_code not in [200]: - if _stream: - response.read() # Load the body in memory and close the socket map_error(status_code=response.status_code, response=response, error_map=error_map) raise HttpResponseError(response=response) @@ -1188,7 +1847,7 @@ def get_next(next_link=None): return ItemPaged(get_next, extract_data) @distributed_trace - def list_text_blocklists(self, **kwargs: Any) -> Iterable["_models.TextBlocklist"]: + def list_text_blocklists(self, **kwargs: Any) -> ItemPaged["_models.TextBlocklist"]: """Get All Text Blocklists. Get all text blocklists details. @@ -1200,9 +1859,9 @@ def list_text_blocklists(self, **kwargs: Any) -> Iterable["_models.TextBlocklist _headers = kwargs.pop("headers", {}) or {} _params = kwargs.pop("params", {}) or {} - cls: ClsType[List[_models.TextBlocklist]] = kwargs.pop("cls", None) + cls: ClsType[list[_models.TextBlocklist]] = kwargs.pop("cls", None) - error_map = { + error_map: MutableMapping = { 401: ClientAuthenticationError, 404: ResourceNotFoundError, 409: ResourceExistsError, @@ -1236,7 +1895,10 @@ def prepare_request(next_link=None): ) _next_request_params["api-version"] = self._config.api_version _request = HttpRequest( - "GET", urllib.parse.urljoin(next_link, _parsed_next_link.path), params=_next_request_params + "GET", + urllib.parse.urljoin(next_link, _parsed_next_link.path), + headers=_headers, + params=_next_request_params, ) path_format_arguments = { "endpoint": self._serialize.url( @@ -1249,7 +1911,10 @@ def prepare_request(next_link=None): def extract_data(pipeline_response): deserialized = pipeline_response.http_response.json() - list_of_elem = _deserialize(List[_models.TextBlocklist], deserialized["value"]) + list_of_elem = _deserialize( + list[_models.TextBlocklist], + deserialized.get("value", []), + ) if cls: list_of_elem = cls(list_of_elem) # type: ignore return deserialized.get("nextLink") or None, iter(list_of_elem) @@ -1264,8 +1929,6 @@ def get_next(next_link=None): response = pipeline_response.http_response if response.status_code not in [200]: - if _stream: - response.read() # Load the body in memory and close the socket map_error(status_code=response.status_code, response=response, error_map=error_map) raise HttpResponseError(response=response) @@ -1274,13 +1937,13 @@ def get_next(next_link=None): return ItemPaged(get_next, extract_data) @overload - def remove_blocklist_items( # pylint: disable=inconsistent-return-statements + def remove_blocklist_items( self, blocklist_name: str, options: _models.RemoveTextBlocklistItemsOptions, *, content_type: str = "application/json", - **kwargs: Any + **kwargs: Any, ) -> None: """Remove BlocklistItems From Text Blocklist. @@ -1300,8 +1963,13 @@ def remove_blocklist_items( # pylint: disable=inconsistent-return-statements """ @overload - def remove_blocklist_items( # pylint: disable=inconsistent-return-statements - self, blocklist_name: str, options: JSON, *, content_type: str = "application/json", **kwargs: Any + def remove_blocklist_items( + self, + blocklist_name: str, + options: _types.RemoveTextBlocklistItemsOptions, + *, + content_type: str = "application/json", + **kwargs: Any, ) -> None: """Remove BlocklistItems From Text Blocklist. @@ -1311,7 +1979,7 @@ def remove_blocklist_items( # pylint: disable=inconsistent-return-statements :param blocklist_name: Text blocklist name. Required. :type blocklist_name: str :param options: Options for removing blocklist items. Required. - :type options: JSON + :type options: ~azure.ai.contentsafety.types.RemoveTextBlocklistItemsOptions :keyword content_type: Body Parameter content-type. Content type parameter for JSON body. Default value is "application/json". :paramtype content_type: str @@ -1321,7 +1989,7 @@ def remove_blocklist_items( # pylint: disable=inconsistent-return-statements """ @overload - def remove_blocklist_items( # pylint: disable=inconsistent-return-statements + def remove_blocklist_items( self, blocklist_name: str, options: IO[bytes], *, content_type: str = "application/json", **kwargs: Any ) -> None: """Remove BlocklistItems From Text Blocklist. @@ -1345,8 +2013,8 @@ def remove_blocklist_items( # pylint: disable=inconsistent-return-statements def remove_blocklist_items( # pylint: disable=inconsistent-return-statements self, blocklist_name: str, - options: Union[_models.RemoveTextBlocklistItemsOptions, JSON, IO[bytes]], - **kwargs: Any + options: Union[_models.RemoveTextBlocklistItemsOptions, _types.RemoveTextBlocklistItemsOptions, IO[bytes]], + **kwargs: Any, ) -> None: """Remove BlocklistItems From Text Blocklist. @@ -1355,18 +2023,15 @@ def remove_blocklist_items( # pylint: disable=inconsistent-return-statements :param blocklist_name: Text blocklist name. Required. :type blocklist_name: str - :param options: Options for removing blocklist items. Is one of the following types: - RemoveTextBlocklistItemsOptions, JSON, IO[bytes] Required. - :type options: ~azure.ai.contentsafety.models.RemoveTextBlocklistItemsOptions or JSON or - IO[bytes] - :keyword content_type: Body parameter Content-Type. Known values are: application/json. Default - value is None. - :paramtype content_type: str + :param options: Options for removing blocklist items. Is either a + RemoveTextBlocklistItemsOptions type or a IO[bytes] type. Required. + :type options: ~azure.ai.contentsafety.models.RemoveTextBlocklistItemsOptions or + ~azure.ai.contentsafety.types.RemoveTextBlocklistItemsOptions or IO[bytes] :return: None :rtype: None :raises ~azure.core.exceptions.HttpResponseError: """ - error_map = { + error_map: MutableMapping = { 401: ClientAuthenticationError, 404: ResourceNotFoundError, 409: ResourceExistsError, @@ -1408,8 +2073,6 @@ def remove_blocklist_items( # pylint: disable=inconsistent-return-statements response = pipeline_response.http_response if response.status_code not in [204]: - if _stream: - response.read() # Load the body in memory and close the socket map_error(status_code=response.status_code, response=response, error_map=error_map) raise HttpResponseError(response=response) diff --git a/sdk/contentsafety/azure-ai-contentsafety/azure/ai/contentsafety/_operations/_patch.py b/sdk/contentsafety/azure-ai-contentsafety/azure/ai/contentsafety/_operations/_patch.py index f7dd32510333..87676c65a8f0 100644 --- a/sdk/contentsafety/azure-ai-contentsafety/azure/ai/contentsafety/_operations/_patch.py +++ b/sdk/contentsafety/azure-ai-contentsafety/azure/ai/contentsafety/_operations/_patch.py @@ -1,14 +1,15 @@ -# ------------------------------------ -# Copyright (c) Microsoft Corporation. -# Licensed under the MIT License. -# ------------------------------------ +# coding=utf-8 +# -------------------------------------------------------------------------- +# Copyright (c) Microsoft Corporation. All rights reserved. +# Licensed under the MIT License. See License.txt in the project root for license information. +# -------------------------------------------------------------------------- """Customize generated code here. Follow our quickstart for examples: https://aka.ms/azsdk/python/dpcodegen/python/customize """ -from typing import List -__all__: List[str] = [] # Add all objects you want publicly available to users at this package level + +__all__: list[str] = [] # Add all objects you want publicly available to users at this package level def patch_sdk(): diff --git a/sdk/contentsafety/azure-ai-contentsafety/azure/ai/contentsafety/_patch.py b/sdk/contentsafety/azure-ai-contentsafety/azure/ai/contentsafety/_patch.py index f7dd32510333..87676c65a8f0 100644 --- a/sdk/contentsafety/azure-ai-contentsafety/azure/ai/contentsafety/_patch.py +++ b/sdk/contentsafety/azure-ai-contentsafety/azure/ai/contentsafety/_patch.py @@ -1,14 +1,15 @@ -# ------------------------------------ -# Copyright (c) Microsoft Corporation. -# Licensed under the MIT License. -# ------------------------------------ +# coding=utf-8 +# -------------------------------------------------------------------------- +# Copyright (c) Microsoft Corporation. All rights reserved. +# Licensed under the MIT License. See License.txt in the project root for license information. +# -------------------------------------------------------------------------- """Customize generated code here. Follow our quickstart for examples: https://aka.ms/azsdk/python/dpcodegen/python/customize """ -from typing import List -__all__: List[str] = [] # Add all objects you want publicly available to users at this package level + +__all__: list[str] = [] # Add all objects you want publicly available to users at this package level def patch_sdk(): diff --git a/sdk/contentsafety/azure-ai-contentsafety/azure/ai/contentsafety/_utils/__init__.py b/sdk/contentsafety/azure-ai-contentsafety/azure/ai/contentsafety/_utils/__init__.py new file mode 100644 index 000000000000..8026245c2abc --- /dev/null +++ b/sdk/contentsafety/azure-ai-contentsafety/azure/ai/contentsafety/_utils/__init__.py @@ -0,0 +1,6 @@ +# -------------------------------------------------------------------------- +# Copyright (c) Microsoft Corporation. All rights reserved. +# Licensed under the MIT License. See License.txt in the project root for license information. +# Code generated by Microsoft (R) Python Code Generator. +# Changes may cause incorrect behavior and will be lost if the code is regenerated. +# -------------------------------------------------------------------------- diff --git a/sdk/contentsafety/azure-ai-contentsafety/azure/ai/contentsafety/_utils/model_base.py b/sdk/contentsafety/azure-ai-contentsafety/azure/ai/contentsafety/_utils/model_base.py new file mode 100644 index 000000000000..0f2c5bdfe70f --- /dev/null +++ b/sdk/contentsafety/azure-ai-contentsafety/azure/ai/contentsafety/_utils/model_base.py @@ -0,0 +1,1771 @@ +# pylint: disable=line-too-long,useless-suppression,too-many-lines +# coding=utf-8 +# -------------------------------------------------------------------------- +# Copyright (c) Microsoft Corporation. All rights reserved. +# Licensed under the MIT License. See License.txt in the project root for license information. +# Code generated by Microsoft (R) Python Code Generator. +# Changes may cause incorrect behavior and will be lost if the code is regenerated. +# -------------------------------------------------------------------------- +# pylint: disable=protected-access, broad-except + +import copy +import calendar +import decimal +import functools +import sys +import logging +import base64 +import re +import typing +import enum +import email.utils +from datetime import datetime, date, time, timedelta, timezone +from json import JSONEncoder +import xml.etree.ElementTree as ET +from collections.abc import MutableMapping +import isodate +from azure.core.exceptions import DeserializationError +from azure.core import CaseInsensitiveEnumMeta +from azure.core.pipeline import PipelineResponse +from azure.core.serialization import _Null + +from azure.core.rest import HttpResponse + +if sys.version_info >= (3, 11): + from typing import Self +else: + from typing_extensions import Self + +_LOGGER = logging.getLogger(__name__) + +__all__ = ["SdkJSONEncoder", "Model", "rest_field", "rest_discriminator"] + +TZ_UTC = timezone.utc +_T = typing.TypeVar("_T") +_NONE_TYPE = type(None) + + +def _timedelta_as_isostr(td: timedelta) -> str: + """Converts a datetime.timedelta object into an ISO 8601 formatted string, e.g. 'P4DT12H30M05S' + + Function adapted from the Tin Can Python project: https://github.com/RusticiSoftware/TinCanPython + + :param timedelta td: The timedelta to convert + :rtype: str + :return: ISO8601 version of this timedelta + """ + + # Split seconds to larger units + seconds = td.total_seconds() + minutes, seconds = divmod(seconds, 60) + hours, minutes = divmod(minutes, 60) + days, hours = divmod(hours, 24) + + days, hours, minutes = list(map(int, (days, hours, minutes))) + seconds = round(seconds, 6) + + # Build date + date_str = "" + if days: + date_str = "%sD" % days + + if hours or minutes or seconds: + # Build time + time_str = "T" + + # Hours + bigger_exists = date_str or hours + if bigger_exists: + time_str += "{:02}H".format(hours) + + # Minutes + bigger_exists = bigger_exists or minutes + if bigger_exists: + time_str += "{:02}M".format(minutes) + + # Seconds + try: + if seconds.is_integer(): + seconds_string = "{:02}".format(int(seconds)) + else: + # 9 chars long w/ leading 0, 6 digits after decimal + seconds_string = "%09.6f" % seconds + # Remove trailing zeros + seconds_string = seconds_string.rstrip("0") + except AttributeError: # int.is_integer() raises + seconds_string = "{:02}".format(seconds) + + time_str += "{}S".format(seconds_string) + else: + time_str = "" + + return "P" + date_str + time_str + + +def _serialize_bytes(o, format: typing.Optional[str] = None) -> str: + encoded = base64.b64encode(o).decode() + if format == "base64url": + return encoded.strip("=").replace("+", "-").replace("/", "_") + return encoded + + +def _serialize_duration(td: timedelta, format: typing.Optional[str] = None): + """Serialize a timedelta to its wire representation. + + For the ``seconds``/``milliseconds`` encodings the value is converted to a + numeric value, otherwise it falls back to an ISO 8601 duration string. + + :param timedelta td: The timedelta to serialize. + :param str format: The duration encoding format. + :rtype: int or float or str + :return: serialized duration + """ + seconds = td.total_seconds() + if format == "duration-seconds-int": + return int(seconds) + if format == "duration-seconds-float": + return seconds + if format == "duration-milliseconds-int": + return int(seconds * 1000) + if format == "duration-milliseconds-float": + return seconds * 1000 + return _timedelta_as_isostr(td) + + +def _serialize_datetime(o, format: typing.Optional[str] = None): + if hasattr(o, "year") and hasattr(o, "hour"): + if format == "rfc7231": + return email.utils.format_datetime(o, usegmt=True) + if format == "unix-timestamp": + return int(calendar.timegm(o.utctimetuple())) + + # astimezone() fails for naive times in Python 2.7, so make make sure o is aware (tzinfo is set) + if not o.tzinfo: + iso_formatted = o.replace(tzinfo=TZ_UTC).isoformat() + else: + iso_formatted = o.astimezone(TZ_UTC).isoformat() + # Replace the trailing "+00:00" UTC offset with "Z" (RFC 3339: https://www.ietf.org/rfc/rfc3339.txt) + return iso_formatted.replace("+00:00", "Z") + # Next try datetime.date or datetime.time + return o.isoformat() + + +def _is_readonly(p): + try: + return p._visibility == ["read"] + except AttributeError: + return False + + +class SdkJSONEncoder(JSONEncoder): + """A JSON encoder that's capable of serializing datetime objects and bytes.""" + + def __init__(self, *args, exclude_readonly: bool = False, format: typing.Optional[str] = None, **kwargs): + super().__init__(*args, **kwargs) + self.exclude_readonly = exclude_readonly + self.format = format + + def default(self, o): # pylint: disable=too-many-return-statements + if _is_model(o): + if self.exclude_readonly: + readonly_props = [p._rest_name for p in o._attr_to_rest_field.values() if _is_readonly(p)] + return {k: v for k, v in o.items() if k not in readonly_props} + return dict(o.items()) + try: + return super(SdkJSONEncoder, self).default(o) + except TypeError: + if isinstance(o, _Null): + return None + if isinstance(o, decimal.Decimal): + return float(o) + if isinstance(o, (bytes, bytearray)): + return _serialize_bytes(o, self.format) + try: + # First try datetime.datetime + return _serialize_datetime(o, self.format) + except AttributeError: + pass + # Last, try datetime.timedelta + try: + return _timedelta_as_isostr(o) + except AttributeError: + # This will be raised when it hits value.total_seconds in the method above + pass + return super(SdkJSONEncoder, self).default(o) + + +_VALID_DATE = re.compile(r"\d{4}[-]\d{2}[-]\d{2}T\d{2}:\d{2}:\d{2}" + r"\.?\d*Z?[-+]?[\d{2}]?:?[\d{2}]?") +_VALID_RFC7231 = re.compile( + r"(Mon|Tue|Wed|Thu|Fri|Sat|Sun),\s\d{2}\s" + r"(Jan|Feb|Mar|Apr|May|Jun|Jul|Aug|Sep|Oct|Nov|Dec)\s\d{4}\s\d{2}:\d{2}:\d{2}\sGMT" +) + +_ARRAY_ENCODE_MAPPING = { + "pipeDelimited": "|", + "spaceDelimited": " ", + "commaDelimited": ",", + "newlineDelimited": "\n", +} + + +def _deserialize_array_encoded(delimit: str, attr): + if isinstance(attr, str): + if attr == "": + return [] + return attr.split(delimit) + return attr + + +def _deserialize_datetime(attr: typing.Union[str, datetime]) -> datetime: + """Deserialize ISO-8601 formatted string into Datetime object. + + :param str attr: response string to be deserialized. + :rtype: ~datetime.datetime + :returns: The datetime object from that input + """ + if isinstance(attr, datetime): + # i'm already deserialized + return attr + attr = attr.upper() + match = _VALID_DATE.match(attr) + if not match: + raise ValueError("Invalid datetime string: " + attr) + + check_decimal = attr.split(".") + if len(check_decimal) > 1: + decimal_str = "" + for digit in check_decimal[1]: + if digit.isdigit(): + decimal_str += digit + else: + break + if len(decimal_str) > 6: + attr = attr.replace(decimal_str, decimal_str[0:6]) + + date_obj = isodate.parse_datetime(attr) + test_utc = date_obj.utctimetuple() + if test_utc.tm_year > 9999 or test_utc.tm_year < 1: + raise OverflowError("Hit max or min date") + return date_obj # type: ignore[no-any-return] + + +def _deserialize_datetime_rfc7231(attr: typing.Union[str, datetime]) -> datetime: + """Deserialize RFC7231 formatted string into Datetime object. + + :param str attr: response string to be deserialized. + :rtype: ~datetime.datetime + :returns: The datetime object from that input + """ + if isinstance(attr, datetime): + # i'm already deserialized + return attr + match = _VALID_RFC7231.match(attr) + if not match: + raise ValueError("Invalid datetime string: " + attr) + + return email.utils.parsedate_to_datetime(attr) + + +def _deserialize_datetime_unix_timestamp(attr: typing.Union[float, datetime]) -> datetime: + """Deserialize unix timestamp into Datetime object. + + :param str attr: response string to be deserialized. + :rtype: ~datetime.datetime + :returns: The datetime object from that input + """ + if isinstance(attr, datetime): + # i'm already deserialized + return attr + return datetime.fromtimestamp(attr, TZ_UTC) + + +def _deserialize_date(attr: typing.Union[str, date]) -> date: + """Deserialize ISO-8601 formatted string into Date object. + :param str attr: response string to be deserialized. + :rtype: date + :returns: The date object from that input + """ + # This must NOT use defaultmonth/defaultday. Using None ensure this raises an exception. + if isinstance(attr, date): + return attr + return isodate.parse_date(attr, defaultmonth=None, defaultday=None) # type: ignore + + +def _deserialize_time(attr: typing.Union[str, time]) -> time: + """Deserialize ISO-8601 formatted string into time object. + + :param str attr: response string to be deserialized. + :rtype: datetime.time + :returns: The time object from that input + """ + if isinstance(attr, time): + return attr + return isodate.parse_time(attr) # type: ignore[no-any-return] + + +def _deserialize_bytes(attr): + if isinstance(attr, (bytes, bytearray)): + return attr + return bytes(base64.b64decode(attr)) + + +def _deserialize_bytes_base64(attr): + if isinstance(attr, (bytes, bytearray)): + return attr + padding = "=" * (3 - (len(attr) + 3) % 4) # type: ignore + attr = attr + padding # type: ignore + encoded = attr.replace("-", "+").replace("_", "/") + return bytes(base64.b64decode(encoded)) + + +def _deserialize_duration(attr): + if isinstance(attr, timedelta): + return attr + return isodate.parse_duration(attr) + + +def _deserialize_duration_numeric(attr, unit): + if isinstance(attr, timedelta): + return attr + return timedelta(**{unit: float(attr)}) + + +def _deserialize_decimal(attr): + if isinstance(attr, decimal.Decimal): + return attr + return decimal.Decimal(str(attr)) + + +def _deserialize_int_as_str(attr): + if isinstance(attr, int): + return attr + return int(attr) + + +_DESERIALIZE_MAPPING = { + datetime: _deserialize_datetime, + date: _deserialize_date, + time: _deserialize_time, + bytes: _deserialize_bytes, + bytearray: _deserialize_bytes, + timedelta: _deserialize_duration, + typing.Any: lambda x: x, + decimal.Decimal: _deserialize_decimal, +} + +_DESERIALIZE_MAPPING_WITHFORMAT = { + "rfc3339": _deserialize_datetime, + "rfc7231": _deserialize_datetime_rfc7231, + "unix-timestamp": _deserialize_datetime_unix_timestamp, + "base64": _deserialize_bytes, + "base64url": _deserialize_bytes_base64, + "duration-seconds-int": functools.partial(_deserialize_duration_numeric, unit="seconds"), + "duration-seconds-float": functools.partial(_deserialize_duration_numeric, unit="seconds"), + "duration-milliseconds-int": functools.partial(_deserialize_duration_numeric, unit="milliseconds"), + "duration-milliseconds-float": functools.partial(_deserialize_duration_numeric, unit="milliseconds"), +} + + +def get_deserializer(annotation: typing.Any, rf: typing.Optional["_RestField"] = None): + if annotation is int and rf and rf._format == "str": + return _deserialize_int_as_str + if annotation is str and rf and rf._format in _ARRAY_ENCODE_MAPPING: + return functools.partial(_deserialize_array_encoded, _ARRAY_ENCODE_MAPPING[rf._format]) + if rf and rf._format: + return _DESERIALIZE_MAPPING_WITHFORMAT.get(rf._format) + return _DESERIALIZE_MAPPING.get(annotation) # pyright: ignore + + +def _get_type_alias_type(module_name: str, alias_name: str): + types = { + k: v + for k, v in sys.modules[module_name].__dict__.items() + if isinstance(v, typing._GenericAlias) # type: ignore + } + if alias_name not in types: + return alias_name + return types[alias_name] + + +def _get_model(module_name: str, model_name: str): + models = {k: v for k, v in sys.modules[module_name].__dict__.items() if isinstance(v, type)} + module_end = module_name.rsplit(".", 1)[0] + models.update({k: v for k, v in sys.modules[module_end].__dict__.items() if isinstance(v, type)}) + if isinstance(model_name, str): + model_name = model_name.split(".")[-1] + if model_name not in models: + return model_name + return models[model_name] + + +_UNSET = object() + + +class _MyMutableMapping(MutableMapping[str, typing.Any]): + def __init__(self, data: dict[str, typing.Any]) -> None: + self._data = data + + def __contains__(self, key: typing.Any) -> bool: + return key in self._data + + def __getitem__(self, key: str) -> typing.Any: + # If this key has been deserialized (for mutable types), we need to handle serialization + if hasattr(self, "_attr_to_rest_field"): + cache_attr = f"_deserialized_{key}" + if hasattr(self, cache_attr): + rf = _get_rest_field(getattr(self, "_attr_to_rest_field"), key) + if rf: + value = self._data.get(key) + if isinstance(value, (dict, list, set)): + # For mutable types, serialize and return + # But also update _data with serialized form and clear flag + # so mutations via this returned value affect _data + serialized = _serialize(value, rf._format) + # If serialized form is same type (no transformation needed), + # return _data directly so mutations work + if isinstance(serialized, type(value)) and serialized == value: + return self._data.get(key) + # Otherwise return serialized copy and clear flag + try: + object.__delattr__(self, cache_attr) + except AttributeError: + pass + # Store serialized form back + self._data[key] = serialized + return serialized + return self._data.__getitem__(key) + + def __setitem__(self, key: str, value: typing.Any) -> None: + # Clear any cached deserialized value when setting through dictionary access + cache_attr = f"_deserialized_{key}" + try: + object.__delattr__(self, cache_attr) + except AttributeError: + pass + self._data.__setitem__(key, value) + + def __delitem__(self, key: str) -> None: + self._data.__delitem__(key) + + def __iter__(self) -> typing.Iterator[typing.Any]: + return self._data.__iter__() + + def __len__(self) -> int: + return self._data.__len__() + + def __ne__(self, other: typing.Any) -> bool: + return not self.__eq__(other) + + def keys(self) -> typing.KeysView[str]: + """ + :returns: a set-like object providing a view on the mapping's keys + :rtype: ~typing.KeysView + """ + return self._data.keys() + + def values(self) -> typing.ValuesView[typing.Any]: + """ + :returns: an object providing a view on the mapping's values + :rtype: ~typing.ValuesView + """ + return self._data.values() + + def items(self) -> typing.ItemsView[str, typing.Any]: + """ + :returns: a set-like object providing a view on the mapping's items + :rtype: ~typing.ItemsView + """ + return self._data.items() + + def get(self, key: str, default: typing.Any = None) -> typing.Any: + """ + Get the value for key if key is in the dictionary, else default. + :param str key: The key to look up. + :param any default: The value to return if key is not in the dictionary. Defaults to None + :returns: The value for key if key is in the dictionary, else default. + :rtype: any + """ + try: + return self[key] + except KeyError: + return default + + @typing.overload + def pop(self, key: str) -> typing.Any: ... # pylint: disable=arguments-differ + + @typing.overload + def pop(self, key: str, default: _T) -> _T: ... # pylint: disable=signature-differs + + @typing.overload + def pop(self, key: str, default: typing.Any) -> typing.Any: ... # pylint: disable=signature-differs + + def pop(self, key: str, default: typing.Any = _UNSET) -> typing.Any: + """ + Removes specified key and return the corresponding value. + :param str key: The key to pop. + :param any default: The value to return if key is not in the dictionary + :returns: The value corresponding to the key. + :rtype: any + :raises KeyError: If key is not found and default is not given. + """ + if default is _UNSET: + return self._data.pop(key) + return self._data.pop(key, default) + + def popitem(self) -> tuple[str, typing.Any]: + """ + Removes and returns some (key, value) pair + :returns: The (key, value) pair. + :rtype: tuple + :raises KeyError: if the dictionary is empty. + """ + return self._data.popitem() + + def clear(self) -> None: + """ + Remove all items from the dictionary. + """ + self._data.clear() + + def update(self, *args: typing.Any, **kwargs: typing.Any) -> None: # pylint: disable=arguments-differ + """ + Update the dictionary from a mapping or an iterable of key-value pairs. + :param any args: Either a mapping object or an iterable of key-value pairs. + """ + self._data.update(*args, **kwargs) + + @typing.overload + def setdefault(self, key: str, default: None = None) -> None: ... + + @typing.overload + def setdefault(self, key: str, default: typing.Any) -> typing.Any: ... # pylint: disable=signature-differs + + def setdefault(self, key: str, default: typing.Any = _UNSET) -> typing.Any: + """ + Return the value for key if key is in the dictionary; otherwise set the key to + default and return default. + :param str key: The key to look up. + :param any default: The value to set if key is not in the dictionary + :returns: The value for key if key is in the dictionary, else default. + :rtype: any + """ + if default is _UNSET: + return self._data.setdefault(key) + return self._data.setdefault(key, default) + + def __eq__(self, other: typing.Any) -> bool: + if isinstance(other, _MyMutableMapping): + return self._data == other._data + try: + other_model = self.__class__(other) + except Exception: + return False + return self._data == other_model._data + + def __repr__(self) -> str: + return str(self._data) + + +def _is_model(obj: typing.Any) -> bool: + return getattr(obj, "_is_model", False) + + +def _serialize(o, format: typing.Optional[str] = None): # pylint: disable=too-many-return-statements + if isinstance(o, list): + if format in _ARRAY_ENCODE_MAPPING and all(isinstance(x, str) for x in o): + return _ARRAY_ENCODE_MAPPING[format].join(o) + return [_serialize(x, format) for x in o] + if isinstance(o, dict): + return {k: _serialize(v, format) for k, v in o.items()} + if isinstance(o, set): + return {_serialize(x, format) for x in o} + if isinstance(o, tuple): + return tuple(_serialize(x, format) for x in o) + if isinstance(o, (bytes, bytearray)): + return _serialize_bytes(o, format) + if isinstance(o, decimal.Decimal): + return float(o) + if isinstance(o, enum.Enum): + return o.value + if isinstance(o, int): + if format == "str": + return str(o) + return o + try: + # First try datetime.datetime + return _serialize_datetime(o, format) + except AttributeError: + pass + # Last, try datetime.timedelta + try: + return _serialize_duration(o, format) + except AttributeError: + # This will be raised when it hits value.total_seconds in the method above + pass + return o + + +def _get_rest_field(attr_to_rest_field: dict[str, "_RestField"], rest_name: str) -> typing.Optional["_RestField"]: + try: + return next(rf for rf in attr_to_rest_field.values() if rf._rest_name == rest_name) + except StopIteration: + return None + + +def _create_value(rf: typing.Optional["_RestField"], value: typing.Any) -> typing.Any: + if not rf: + return _serialize(value, None) + if rf._is_multipart_file_input: + return value + if rf._is_model: + return _deserialize(rf._type, value) + if isinstance(value, ET.Element): + value = _deserialize(rf._type, value) + return _serialize(value, rf._format) + + +# ============================================================================ +# Fast-path scalar deserializer functions for rest_field(deserializer=...) +# These are referenced from rest_field declarations to bypass the generic +# _deserialize -> _deserialize_with_callable chain. +# Only simple/primitive types — no models or container types. +# ============================================================================ + + +def _xml_deser_str(value): + if isinstance(value, ET.Element): + return value.text or "" + return str(value) if value is not None else None + + +def _xml_deser_int(value): + if isinstance(value, ET.Element): + return int(value.text) if value.text else None + return int(value) if value is not None else None + + +def _xml_deser_float(value): + if isinstance(value, ET.Element): + return float(value.text) if value.text else None + return float(value) if value is not None else None + + +def _xml_deser_bool(value): + if isinstance(value, ET.Element): + text = value.text + else: + text = value + if text is None: + return None + if text in (True, False): + return text + return text.lower() == "true" + + +# pylint: disable=docstring-missing-param +def _xml_deser_bytes(value): + """Deserialize bytes from XML (base64).""" + if isinstance(value, ET.Element): + text = value.text + else: + text = value + if text is None: + return None + return _deserialize_bytes(text) + + +def _xml_deser_bytes_base64url(value): + """Deserialize bytes from XML (base64url).""" + if isinstance(value, ET.Element): + text = value.text + else: + text = value + if text is None: + return None + return _deserialize_bytes_base64(text) + + +def _xml_deser_datetime(value): + """Deserialize a datetime from XML (ISO 8601 / rfc3339).""" + if isinstance(value, ET.Element): + text = value.text + else: + text = value + if text is None: + return None + return _deserialize_datetime(text) + + +def _xml_deser_datetime_rfc7231(value): + """Deserialize a datetime from XML (RFC7231 format).""" + if isinstance(value, ET.Element): + text = value.text + else: + text = value + if text is None: + return None + return _deserialize_datetime_rfc7231(text) + + +def _xml_deser_datetime_unix_timestamp(value): + """Deserialize a datetime from XML (Unix timestamp).""" + if isinstance(value, ET.Element): + text = value.text + else: + text = value + if text is None: + return None + return _deserialize_datetime_unix_timestamp(float(text)) + + +def _xml_deser_date(value): + """Deserialize a date from XML (ISO 8601).""" + if isinstance(value, ET.Element): + text = value.text + else: + text = value + if text is None: + return None + return _deserialize_date(text) + + +def _xml_deser_time(value): + """Deserialize a time from XML (ISO 8601).""" + if isinstance(value, ET.Element): + text = value.text + else: + text = value + if text is None: + return None + return _deserialize_time(text) + + +def _xml_deser_duration(value): + """Deserialize a timedelta from XML (ISO 8601 duration).""" + if isinstance(value, ET.Element): + text = value.text + else: + text = value + if text is None: + return None + return _deserialize_duration(text) + + +def _xml_deser_decimal(value): + """Deserialize a Decimal from XML.""" + if isinstance(value, ET.Element): + text = value.text + else: + text = value + if text is None: + return None + return _deserialize_decimal(text) + + +def _xml_deser_enum_or_str(enum_cls, value): + """Deserialize a Union[EnumType, str] from XML.""" + text = value.text if isinstance(value, ET.Element) else value + if text is None: + return None + try: + return enum_cls(text) + except ValueError: + return text + + +def _extract_xml_model_type(rf_type): + """Extract the concrete Model class from a resolved rf._type partial chain. + + Unwraps ``Optional[Model]`` and ``_deserialize_model(Model, ...)`` + wrappers. Only handles Model and Optional[Model] — other composite + types (List, Dict, Union, etc.) return None and fall through to the + generic ``_deserialize`` path at runtime. + """ + if rf_type is None: + return None + if isinstance(rf_type, type) and _is_model(rf_type): + return rf_type + if not isinstance(rf_type, functools.partial): + return None + func = rf_type.func + args = rf_type.args + if func is _deserialize_with_optional and args: + return _extract_xml_model_type(args[0]) + if func is _deserialize_model and args: + cls = args[0] + return cls if isinstance(cls, type) and _is_model(cls) else None + return None + + +def _build_xml_field_plan( # pylint: disable=docstring-missing-return, docstring-missing-rtype, unused-variable + cls, attr_to_rest_field: dict +) -> list: + """Build a precomputed XML field plan for fast _init_from_xml iteration. + + Called once per model class in __new__. Returns a list of tuples: + (rest_name, xml_name, kind, deser, rf_type, is_optional, items_name) + + kind: 0=wrapped, 1=attribute, 2=unwrapped, 3=text + + For Model and Optional[Model] fields that lack a scalar + ``_deserializer``, this function precomputes the Model class as the + deserializer so ``_init_from_xml`` can call ``ModelClass(element)`` + directly instead of going through the expensive + ``_get_deserialize_callable_from_annotation`` chain at runtime. + """ + model_meta = getattr(cls, "_xml", {}) + model_ns = model_meta.get("ns") or model_meta.get("namespace") + plan = [] + + for rf in attr_to_rest_field.values(): + prop_meta = getattr(rf, "_xml", {}) + deser = rf._deserializer + + xml_name = prop_meta.get("name", rf._rest_name) + xml_ns = _resolve_xml_ns(prop_meta, model_meta) + if xml_ns: + xml_name = "{" + xml_ns + "}" + xml_name + + is_optional = rf._is_optional + + # For Model / Optional[Model] fields without a scalar deserializer, + # precompute the Model class as the deserializer. + if deser is None and rf._type is not None: + model_cls = _extract_xml_model_type(rf._type) + if model_cls is not None: + deser = model_cls + + if prop_meta.get("attribute", False): + plan.append((rf._rest_name, xml_name, 1, deser, rf._type, is_optional, None)) + elif prop_meta.get("unwrapped", False): + items_name = prop_meta.get("itemsName") + if items_name: + items_ns = prop_meta.get("itemsNs") + if items_ns is not None: + xml_ns = items_ns + if xml_ns: + items_name = "{" + xml_ns + "}" + items_name + else: + items_name = xml_name + plan.append((rf._rest_name, xml_name, 2, deser, rf._type, is_optional, items_name)) + elif prop_meta.get("text", False): + plan.append((rf._rest_name, xml_name, 3, deser, rf._type, is_optional, None)) + else: + plan.append((rf._rest_name, xml_name, 0, deser, rf._type, is_optional, None)) + + return plan + + +# pylint: enable=docstring-missing-param +class Model(_MyMutableMapping): + _is_model = True + # label whether current class's _attr_to_rest_field has been calculated + # could not see _attr_to_rest_field directly because subclass inherits it from parent class + _calculated: set[str] = set() + + def __init__(self, *args: typing.Any, **kwargs: typing.Any) -> None: + class_name = self.__class__.__name__ + if len(args) > 1: + raise TypeError(f"{class_name}.__init__() takes 2 positional arguments but {len(args) + 1} were given") + dict_to_pass: dict[str, typing.Any] = {} + if args: + if isinstance(args[0], ET.Element): + dict_to_pass.update(self._init_from_xml(args[0])) + else: + dict_to_pass.update( + {k: _create_value(_get_rest_field(self._attr_to_rest_field, k), v) for k, v in args[0].items()} + ) + else: + non_attr_kwargs = [k for k in kwargs if k not in self._attr_to_rest_field] + if non_attr_kwargs: + # actual type errors only throw the first wrong keyword arg they see, so following that. + raise TypeError(f"{class_name}.__init__() got an unexpected keyword argument '{non_attr_kwargs[0]}'") + dict_to_pass.update( + { + self._attr_to_rest_field[k]._rest_name: _create_value(self._attr_to_rest_field[k], v) + for k, v in kwargs.items() + if v is not None + } + ) + # Apply client default values for fields the caller didn't set so that + # defaults are part of `_data` and therefore included during serialization. + for rf in self._attr_to_rest_field.values(): + if rf._default is _UNSET: + continue + if rf._rest_name in dict_to_pass: + continue + dict_to_pass[rf._rest_name] = _create_value(rf, rf._default) + super().__init__(dict_to_pass) + + def _init_from_xml( # pylint: disable=too-many-branches, too-many-statements + self, element: ET.Element + ) -> dict[str, typing.Any]: + """Deserialize an XML element into a dict mapping rest field names to values. + + :param ET.Element element: The XML element to deserialize from. + :returns: A dictionary of rest_name to deserialized value pairs. + :rtype: dict + """ + result: dict[str, typing.Any] = {} + existed_attr_keys: list[str] = [] + + field_plan = getattr(self, "_xml_field_plan", None) + if field_plan: + for rest_name, xml_name, kind, deser, rf_type, is_optional, items_name in field_plan: + if kind == 0: # wrapped element (most common) + item = element.find(xml_name) + if item is not None: + existed_attr_keys.append(xml_name) + if deser: + result[rest_name] = deser(item) + else: + result[rest_name] = _deserialize(rf_type, item) + elif kind == 1: # attribute + attr_val = element.get(xml_name) + if attr_val is not None: + existed_attr_keys.append(xml_name) + if deser: + result[rest_name] = deser(attr_val) + else: + result[rest_name] = attr_val + elif kind == 2: # unwrapped array + items = element.findall(items_name) # pyright: ignore + if len(items) > 0: + existed_attr_keys.append(items_name) + if deser: + result[rest_name] = deser(items) + else: + result[rest_name] = _deserialize(rf_type, items) + elif not is_optional: + existed_attr_keys.append(items_name) + result[rest_name] = [] + elif kind == 3: # text + if element.text is not None: + if deser: + result[rest_name] = deser(element.text) + else: + result[rest_name] = element.text + else: + model_meta = getattr(self, "_xml", {}) + for rf in self._attr_to_rest_field.values(): + prop_meta = getattr(rf, "_xml", {}) + xml_name = prop_meta.get("name", rf._rest_name) + xml_ns = _resolve_xml_ns(prop_meta, model_meta) + if xml_ns: + xml_name = "{" + xml_ns + "}" + xml_name + + # attribute + if prop_meta.get("attribute", False) and element.get(xml_name) is not None: + existed_attr_keys.append(xml_name) + result[rf._rest_name] = _deserialize(rf._type, element.get(xml_name)) + continue + + # unwrapped element is array + if prop_meta.get("unwrapped", False): + _items_name = prop_meta.get("itemsName") + if _items_name: + xml_name = _items_name + _items_ns = prop_meta.get("itemsNs") + if _items_ns is not None: + xml_ns = _items_ns + if xml_ns: + xml_name = "{" + xml_ns + "}" + xml_name + items = element.findall(xml_name) # pyright: ignore + if len(items) > 0: + existed_attr_keys.append(xml_name) + result[rf._rest_name] = _deserialize(rf._type, items) + elif not rf._is_optional: + existed_attr_keys.append(xml_name) + result[rf._rest_name] = [] + continue + + # text element is primitive type + if prop_meta.get("text", False): + if element.text is not None: + result[rf._rest_name] = _deserialize(rf._type, element.text) + continue + + # wrapped element could be normal property or array + item = element.find(xml_name) + if item is not None: + existed_attr_keys.append(xml_name) + result[rf._rest_name] = _deserialize(rf._type, item) + + # rest thing is additional properties + for e in element: + if e.tag not in existed_attr_keys: + result[e.tag] = _convert_element(e) + + return result + + def copy(self) -> "Model": + return Model(self.__dict__) + + def __new__(cls, *args: typing.Any, **kwargs: typing.Any) -> Self: + if f"{cls.__module__}.{cls.__qualname__}" not in cls._calculated: + # we know the last nine classes in mro are going to be 'Model', '_MyMutableMapping', 'MutableMapping', + # 'Mapping', 'Collection', 'Sized', 'Iterable', 'Container' and 'object' + mros = cls.__mro__[:-9][::-1] # ignore parents, and reverse the mro order + attr_to_rest_field: dict[str, _RestField] = { # map attribute name to rest_field property + k: v for mro_class in mros for k, v in mro_class.__dict__.items() if k[0] != "_" and hasattr(v, "_type") + } + annotations = { + k: v + for mro_class in mros + if hasattr(mro_class, "__annotations__") + for k, v in mro_class.__annotations__.items() + } + for attr, rf in attr_to_rest_field.items(): + rf._module = cls.__module__ + if not rf._type: + rf._type = rf._get_deserialize_callable_from_annotation(annotations.get(attr, None)) + if not rf._rest_name_input: + rf._rest_name_input = attr + cls._attr_to_rest_field: dict[str, _RestField] = dict(attr_to_rest_field.items()) + # Build XML field plan for fast _init_from_xml (only for XML models) + if getattr(cls, "_xml", None): + cls._xml_field_plan = _build_xml_field_plan(cls, attr_to_rest_field) + cls._calculated.add(f"{cls.__module__}.{cls.__qualname__}") + + return super().__new__(cls) + + def __init_subclass__(cls, discriminator: typing.Optional[str] = None) -> None: + for base in cls.__bases__: + if hasattr(base, "__mapping__"): + base.__mapping__[discriminator or cls.__name__] = cls # type: ignore + + @classmethod + def _get_discriminator(cls, exist_discriminators) -> typing.Optional["_RestField"]: + for v in cls.__dict__.values(): + if isinstance(v, _RestField) and v._is_discriminator and v._rest_name not in exist_discriminators: + return v + return None + + @classmethod + def _deserialize(cls, data, exist_discriminators): + if not hasattr(cls, "__mapping__"): + return cls(data) + discriminator = cls._get_discriminator(exist_discriminators) + if discriminator is None: + return cls(data) + exist_discriminators.append(discriminator._rest_name) + if isinstance(data, ET.Element): + model_meta = getattr(cls, "_xml", {}) + prop_meta = getattr(discriminator, "_xml", {}) + xml_name = prop_meta.get("name", discriminator._rest_name) + xml_ns = _resolve_xml_ns(prop_meta, model_meta) + if xml_ns: + xml_name = "{" + xml_ns + "}" + xml_name + + if data.get(xml_name) is not None: + discriminator_value = data.get(xml_name) + else: + discriminator_value = data.find(xml_name).text # pyright: ignore + else: + discriminator_value = data.get(discriminator._rest_name) + mapped_cls = cls.__mapping__.get(discriminator_value, cls) # pyright: ignore # pylint: disable=no-member + return mapped_cls._deserialize(data, exist_discriminators) + + def as_dict(self, *, exclude_readonly: bool = False) -> dict[str, typing.Any]: + """Return a dict that can be turned into json using json.dump. + + :keyword bool exclude_readonly: Whether to remove the readonly properties. + :returns: A dict JSON compatible object + :rtype: dict + """ + + result = {} + readonly_props = [] + if exclude_readonly: + readonly_props = [p._rest_name for p in self._attr_to_rest_field.values() if _is_readonly(p)] + for k, v in self.items(): + if exclude_readonly and k in readonly_props: # pyright: ignore + continue + is_multipart_file_input = False + try: + is_multipart_file_input = next( + rf for rf in self._attr_to_rest_field.values() if rf._rest_name == k + )._is_multipart_file_input + except StopIteration: + pass + result[k] = v if is_multipart_file_input else Model._as_dict_value(v, exclude_readonly=exclude_readonly) + return result + + @staticmethod + def _as_dict_value(v: typing.Any, exclude_readonly: bool = False) -> typing.Any: + if v is None or isinstance(v, _Null): + return None + if isinstance(v, (list, tuple, set)): + return type(v)(Model._as_dict_value(x, exclude_readonly=exclude_readonly) for x in v) + if isinstance(v, dict): + return {dk: Model._as_dict_value(dv, exclude_readonly=exclude_readonly) for dk, dv in v.items()} + return v.as_dict(exclude_readonly=exclude_readonly) if hasattr(v, "as_dict") else v + + +def _deserialize_model(model_deserializer: typing.Optional[typing.Callable], obj): + if _is_model(obj): + return obj + return _deserialize(model_deserializer, obj) + + +def _deserialize_with_optional(if_obj_deserializer: typing.Optional[typing.Callable], obj): + if obj is None: + return obj + return _deserialize_with_callable(if_obj_deserializer, obj) + + +def _deserialize_with_union(deserializers, obj): + for deserializer in deserializers: + try: + return _deserialize(deserializer, obj) + except DeserializationError: + pass + raise DeserializationError() + + +def _deserialize_dict( + value_deserializer: typing.Optional[typing.Callable], + module: typing.Optional[str], + obj: dict[typing.Any, typing.Any], +): + if obj is None: + return obj + if isinstance(obj, ET.Element): + obj = {child.tag: child for child in obj} + return {k: _deserialize(value_deserializer, v, module) for k, v in obj.items()} + + +def _deserialize_multiple_sequence( + entry_deserializers: list[typing.Optional[typing.Callable]], + module: typing.Optional[str], + obj, +): + if obj is None: + return obj + return type(obj)(_deserialize(deserializer, entry, module) for entry, deserializer in zip(obj, entry_deserializers)) + + +def _is_array_encoded_deserializer(deserializer: functools.partial) -> bool: + return ( + isinstance(deserializer, functools.partial) + and isinstance(deserializer.args[0], functools.partial) + and deserializer.args[0].func == _deserialize_array_encoded # pylint: disable=comparison-with-callable + ) + + +def _deserialize_sequence( + deserializer: typing.Optional[typing.Callable], + module: typing.Optional[str], + obj, +): + if obj is None: + return obj + if isinstance(obj, ET.Element): + obj = list(obj) + + # encoded string may be deserialized to sequence + if isinstance(obj, str) and isinstance(deserializer, functools.partial): + # for list[str] + if _is_array_encoded_deserializer(deserializer): + return deserializer(obj) + + # for list[Union[...]] + if isinstance(deserializer.args[0], list): + for sub_deserializer in deserializer.args[0]: + if _is_array_encoded_deserializer(sub_deserializer): + return sub_deserializer(obj) + + return type(obj)(_deserialize(deserializer, entry, module) for entry in obj) + + +def _sorted_annotations(types: list[typing.Any]) -> list[typing.Any]: + return sorted( + types, + key=lambda x: hasattr(x, "__name__") and x.__name__.lower() in ("str", "float", "int", "bool"), + ) + + +def _get_deserialize_callable_from_annotation( # pylint: disable=too-many-return-statements, too-many-statements, too-many-branches + annotation: typing.Any, + module: typing.Optional[str], + rf: typing.Optional["_RestField"] = None, +) -> typing.Optional[typing.Callable[[typing.Any], typing.Any]]: + if not annotation: + return None + + # is it a type alias? + if isinstance(annotation, str): + if module is not None: + annotation = _get_type_alias_type(module, annotation) + + # is it a forward ref / in quotes? + if isinstance(annotation, (str, typing.ForwardRef)): + try: + model_name = annotation.__forward_arg__ # type: ignore + except AttributeError: + model_name = annotation + if module is not None: + annotation = _get_model(module, model_name) # type: ignore + + try: + if module and _is_model(annotation): + if rf: + rf._is_model = True + + return functools.partial(_deserialize_model, annotation) # pyright: ignore + except Exception: + pass + + # is it a literal? + try: + if annotation.__origin__ is typing.Literal: # pyright: ignore + return None + except AttributeError: + pass + + # is it optional? + try: + if any(a is _NONE_TYPE for a in annotation.__args__): # pyright: ignore + if rf: + rf._is_optional = True + if len(annotation.__args__) <= 2: # pyright: ignore + if_obj_deserializer = _get_deserialize_callable_from_annotation( + next(a for a in annotation.__args__ if a is not _NONE_TYPE), module, rf # pyright: ignore + ) + + return functools.partial(_deserialize_with_optional, if_obj_deserializer) + # the type is Optional[Union[...]], we need to remove the None type from the Union + annotation_copy = copy.copy(annotation) + annotation_copy.__args__ = [a for a in annotation_copy.__args__ if a is not _NONE_TYPE] # pyright: ignore + return _get_deserialize_callable_from_annotation(annotation_copy, module, rf) + except AttributeError: + pass + + # is it union? + if getattr(annotation, "__origin__", None) is typing.Union: + # initial ordering is we make `string` the last deserialization option, because it is often them most generic + deserializers = [ + _get_deserialize_callable_from_annotation(arg, module, rf) + for arg in _sorted_annotations(annotation.__args__) # pyright: ignore + ] + + return functools.partial(_deserialize_with_union, deserializers) + + try: + annotation_name = ( + annotation.__name__ if hasattr(annotation, "__name__") else annotation._name # pyright: ignore + ) + if annotation_name.lower() == "dict": + value_deserializer = _get_deserialize_callable_from_annotation( + annotation.__args__[1], module, rf # pyright: ignore + ) + + return functools.partial( + _deserialize_dict, + value_deserializer, + module, + ) + except (AttributeError, IndexError): + pass + try: + annotation_name = ( + annotation.__name__ if hasattr(annotation, "__name__") else annotation._name # pyright: ignore + ) + if annotation_name.lower() in ["list", "set", "tuple", "sequence"]: + if len(annotation.__args__) > 1: # pyright: ignore + entry_deserializers = [ + _get_deserialize_callable_from_annotation(dt, module, rf) + for dt in annotation.__args__ # pyright: ignore + ] + return functools.partial(_deserialize_multiple_sequence, entry_deserializers, module) + deserializer = _get_deserialize_callable_from_annotation( + annotation.__args__[0], module, rf # pyright: ignore + ) + + return functools.partial(_deserialize_sequence, deserializer, module) + except (TypeError, IndexError, AttributeError, SyntaxError): + pass + + def _deserialize_default( + deserializer, + obj, + ): + if obj is None: + return obj + try: + return _deserialize_with_callable(deserializer, obj) + except Exception: + pass + return obj + + if get_deserializer(annotation, rf): + return functools.partial(_deserialize_default, get_deserializer(annotation, rf)) + + return functools.partial(_deserialize_default, annotation) + + +def _deserialize_with_callable( + deserializer: typing.Optional[typing.Callable[[typing.Any], typing.Any]], + value: typing.Any, +): # pylint: disable=too-many-return-statements + try: + if value is None or isinstance(value, _Null): + return None + if isinstance(value, ET.Element): + if deserializer is str: + return value.text or "" + if deserializer is int: + return int(value.text) if value.text else None + if deserializer is float: + return float(value.text) if value.text else None + if deserializer is bool: + return value.text == "true" if value.text else None + if deserializer and deserializer in _DESERIALIZE_MAPPING.values(): + return deserializer(value.text) if value.text else None + if deserializer and deserializer in _DESERIALIZE_MAPPING_WITHFORMAT.values(): + return deserializer(value.text) if value.text else None + if deserializer is None: + return value + if deserializer in [int, float, bool]: + return deserializer(value) + if isinstance(deserializer, CaseInsensitiveEnumMeta): + try: + return deserializer(value.text if isinstance(value, ET.Element) else value) + except ValueError: + # for unknown value, return raw value + return value.text if isinstance(value, ET.Element) else value + if isinstance(deserializer, type) and issubclass(deserializer, Model): + return deserializer._deserialize(value, []) + return typing.cast(typing.Callable[[typing.Any], typing.Any], deserializer)(value) + except Exception as e: + raise DeserializationError() from e + + +def _deserialize( + deserializer: typing.Any, + value: typing.Any, + module: typing.Optional[str] = None, + rf: typing.Optional["_RestField"] = None, + format: typing.Optional[str] = None, +) -> typing.Any: + if isinstance(value, PipelineResponse): + value = value.http_response.json() + if rf is None and format: + rf = _RestField(format=format) + if not isinstance(deserializer, functools.partial): + deserializer = _get_deserialize_callable_from_annotation(deserializer, module, rf) + return _deserialize_with_callable(deserializer, value) + + +def _failsafe_deserialize( + deserializer: typing.Any, + response: HttpResponse, + module: typing.Optional[str] = None, + rf: typing.Optional["_RestField"] = None, + format: typing.Optional[str] = None, +) -> typing.Any: + try: + return _deserialize(deserializer, response.json(), module, rf, format) + except Exception: # pylint: disable=broad-except + _LOGGER.warning( + "Ran into a deserialization error. Ignoring since this is failsafe deserialization", exc_info=True + ) + return None + + +def _failsafe_deserialize_xml( + deserializer: typing.Any, + response: HttpResponse, +) -> typing.Any: + try: + return _deserialize_xml(deserializer, response.text()) + except Exception: # pylint: disable=broad-except + _LOGGER.warning( + "Ran into a deserialization error. Ignoring since this is failsafe deserialization", exc_info=True + ) + return None + + +# pylint: disable=too-many-instance-attributes +class _RestField: + def __init__( + self, + *, + name: typing.Optional[str] = None, + type: typing.Optional[typing.Callable] = None, # pylint: disable=redefined-builtin + is_discriminator: bool = False, + visibility: typing.Optional[list[str]] = None, + default: typing.Any = _UNSET, + format: typing.Optional[str] = None, + is_multipart_file_input: bool = False, + xml: typing.Optional[dict[str, typing.Any]] = None, + deserializer: typing.Optional[typing.Callable] = None, + ): + self._type = type + self._rest_name_input = name + self._module: typing.Optional[str] = None + self._is_discriminator = is_discriminator + self._visibility = visibility + self._is_model = False + self._is_optional = False + self._default = default + self._format = format + self._is_multipart_file_input = is_multipart_file_input + self._xml = xml if xml is not None else {} + self._deserializer = deserializer + + @property + def _class_type(self) -> typing.Any: + result = getattr(self._type, "args", [None])[0] + # type may be wrapped by nested functools.partial so we need to check for that + if isinstance(result, functools.partial): + return getattr(result, "args", [None])[0] + return result + + @property + def _rest_name(self) -> str: + if self._rest_name_input is None: + raise ValueError("Rest name was never set") + return self._rest_name_input + + def __get__(self, obj: Model, type=None): # pylint: disable=redefined-builtin + # by this point, type and rest_name will have a value bc we default + # them in __new__ of the Model class + # Use _data.get() directly to avoid triggering __getitem__ which clears the cache + item = obj._data.get(self._rest_name, _UNSET) + if item is _UNSET: + # Field not set by user; return the client default if one exists, otherwise None + return self._default if self._default is not _UNSET else None + if item is None: + return item + if self._is_model: + return item + + # For mutable types, we want mutations to directly affect _data + # Check if we've already deserialized this value + cache_attr = f"_deserialized_{self._rest_name}" + if hasattr(obj, cache_attr): + # Return the value from _data directly (it's been deserialized in place) + return obj._data.get(self._rest_name) + + # Fast path: use _deserializer directly (avoids _serialize/_deserialize chain) + if self._deserializer: + deserialized = self._deserializer(item) + else: + deserialized = _deserialize(self._type, _serialize(item, self._format), rf=self) + + # For mutable types, store the deserialized value back in _data + # so mutations directly affect _data + if isinstance(deserialized, (dict, list, set)): + obj._data[self._rest_name] = deserialized + object.__setattr__(obj, cache_attr, True) # Mark as deserialized + return deserialized + + return deserialized + + def __set__(self, obj: Model, value) -> None: + # Clear the cached deserialized object when setting a new value + cache_attr = f"_deserialized_{self._rest_name}" + if hasattr(obj, cache_attr): + object.__delattr__(obj, cache_attr) + + if value is None: + # we want to wipe out entries if users set attr to None + try: + obj.__delitem__(self._rest_name) + except KeyError: + pass + return + if self._is_model: + if not _is_model(value): + value = _deserialize(self._type, value) + obj.__setitem__(self._rest_name, value) + return + obj.__setitem__(self._rest_name, _serialize(value, self._format)) + + def _get_deserialize_callable_from_annotation( + self, annotation: typing.Any + ) -> typing.Optional[typing.Callable[[typing.Any], typing.Any]]: + return _get_deserialize_callable_from_annotation(annotation, self._module, self) + + +def rest_field( + *, + name: typing.Optional[str] = None, + type: typing.Optional[typing.Callable] = None, # pylint: disable=redefined-builtin + visibility: typing.Optional[list[str]] = None, + default: typing.Any = _UNSET, + format: typing.Optional[str] = None, + is_multipart_file_input: bool = False, + xml: typing.Optional[dict[str, typing.Any]] = None, + deserializer: typing.Optional[typing.Callable] = None, +) -> typing.Any: + return _RestField( + name=name, + type=type, + visibility=visibility, + default=default, + format=format, + is_multipart_file_input=is_multipart_file_input, + xml=xml, + deserializer=deserializer, + ) + + +def rest_discriminator( + *, + name: typing.Optional[str] = None, + type: typing.Optional[typing.Callable] = None, # pylint: disable=redefined-builtin + visibility: typing.Optional[list[str]] = None, + xml: typing.Optional[dict[str, typing.Any]] = None, +) -> typing.Any: + return _RestField(name=name, type=type, is_discriminator=True, visibility=visibility, xml=xml) + + +def serialize_xml(model: Model, exclude_readonly: bool = False) -> str: + """Serialize a model to XML. + + :param Model model: The model to serialize. + :param bool exclude_readonly: Whether to exclude readonly properties. + :returns: The XML representation of the model. + :rtype: str + """ + return ET.tostring(_get_element(model, exclude_readonly), encoding="unicode") # type: ignore + + +def _get_xml_ns(meta: dict[str, typing.Any]) -> typing.Optional[str]: + """Return the XML namespace from a metadata dict, checking both 'ns' (old-style) and 'namespace' (DPG) keys. + + :param dict meta: The metadata dictionary to extract namespace from. + :returns: The namespace string if 'ns' or 'namespace' key is present, None otherwise. + :rtype: str or None + """ + ns = meta.get("ns") + if ns is None: + ns = meta.get("namespace") + return ns + + +def _resolve_xml_ns( + prop_meta: dict[str, typing.Any], model_meta: typing.Optional[dict[str, typing.Any]] = None +) -> typing.Optional[str]: + """Resolve XML namespace for a property, falling back to model namespace when appropriate. + + Checks the property metadata first; if no namespace is found and the model does not declare + an explicit prefix, falls back to the model-level namespace. + + :param dict prop_meta: The property metadata dictionary. + :param dict model_meta: The model metadata dictionary, used as fallback. + :returns: The resolved namespace string, or None. + :rtype: str or None + """ + ns = _get_xml_ns(prop_meta) + if ns is None and model_meta is not None and not model_meta.get("prefix"): + ns = _get_xml_ns(model_meta) + return ns + + +def _set_xml_attribute(element: ET.Element, name: str, value: typing.Any, prop_meta: dict[str, typing.Any]) -> None: + """Set an XML attribute on an element, handling namespace prefix registration. + + :param ET.Element element: The element to set the attribute on. + :param str name: The default attribute name (wire name). + :param any value: The attribute value. + :param dict prop_meta: The property metadata dictionary. + """ + xml_name = prop_meta.get("name", name) + _attr_ns = _get_xml_ns(prop_meta) + if _attr_ns: + _attr_prefix = prop_meta.get("prefix") + if _attr_prefix: + _safe_register_namespace(_attr_prefix, _attr_ns) + xml_name = "{" + _attr_ns + "}" + xml_name + element.set(xml_name, _get_primitive_type_value(value)) + + +def _get_element( + o: typing.Any, + exclude_readonly: bool = False, + parent_meta: typing.Optional[dict[str, typing.Any]] = None, + wrapped_element: typing.Optional[ET.Element] = None, +) -> typing.Union[ET.Element, list[ET.Element]]: + if _is_model(o): + model_meta = getattr(o, "_xml", {}) + + # if prop is a model, then use the prop element directly, else generate a wrapper of model + if wrapped_element is None: + # When serializing as an array item (parent_meta is set), check if the parent has an + # explicit itemsName. This ensures correct element names for unwrapped arrays (where + # the element tag is the property/items name, not the model type name). + _items_name = parent_meta.get("itemsName") if parent_meta is not None else None + element_name = _items_name if _items_name else (model_meta.get("name") or o.__class__.__name__) + _model_ns = _get_xml_ns(model_meta) + wrapped_element = _create_xml_element( + element_name, + model_meta.get("prefix"), + _model_ns, + ) + + readonly_props = [] + if exclude_readonly: + readonly_props = [p._rest_name for p in o._attr_to_rest_field.values() if _is_readonly(p)] + + for k, v in o.items(): + # do not serialize readonly properties + if exclude_readonly and k in readonly_props: + continue + + prop_rest_field = _get_rest_field(o._attr_to_rest_field, k) + if prop_rest_field: + prop_meta = getattr(prop_rest_field, "_xml").copy() + # use the wire name as xml name if no specific name is set + if prop_meta.get("name") is None: + prop_meta["name"] = k + else: + # additional properties will not have rest field, use the wire name as xml name + prop_meta = {"name": k} + + # Propagate model namespace to properties only for old-style "ns"-keyed models. + # DPG-generated models use the "namespace" key and explicitly declare namespace on + # each property that needs it, so propagation is intentionally skipped for them. + if prop_meta.get("ns") is None and model_meta.get("ns"): + prop_meta["ns"] = model_meta.get("ns") + prop_meta["prefix"] = model_meta.get("prefix") + + if prop_meta.get("unwrapped", False): + # unwrapped could only set on array + wrapped_element.extend(_get_element(v, exclude_readonly, prop_meta)) + elif prop_meta.get("text", False): + # text could only set on primitive type + wrapped_element.text = _get_primitive_type_value(v) + elif prop_meta.get("attribute", False): + _set_xml_attribute(wrapped_element, k, v, prop_meta) + else: + # other wrapped prop element + wrapped_element.append(_get_wrapped_element(v, exclude_readonly, prop_meta)) + return wrapped_element + if isinstance(o, list): + return [_get_element(x, exclude_readonly, parent_meta) for x in o] # type: ignore + if isinstance(o, dict): + result = [] + _dict_ns = _get_xml_ns(parent_meta) if parent_meta else None + for k, v in o.items(): + result.append( + _get_wrapped_element( + v, + exclude_readonly, + { + "name": k, + "ns": _dict_ns, + "prefix": parent_meta.get("prefix") if parent_meta else None, + }, + ) + ) + return result + + # primitive case need to create element based on parent_meta + if parent_meta: + _items_ns = parent_meta.get("itemsNs") + if _items_ns is None: + _items_ns = _get_xml_ns(parent_meta) + return _get_wrapped_element( + o, + exclude_readonly, + { + "name": parent_meta.get("itemsName", parent_meta.get("name")), + "prefix": parent_meta.get("itemsPrefix", parent_meta.get("prefix")), + "ns": _items_ns, + }, + ) + + raise ValueError("Could not serialize value into xml: " + o) + + +def _get_wrapped_element( + v: typing.Any, + exclude_readonly: bool, + meta: typing.Optional[dict[str, typing.Any]], +) -> ET.Element: + _meta_ns = _get_xml_ns(meta) if meta else None + wrapped_element = _create_xml_element( + meta.get("name") if meta else None, meta.get("prefix") if meta else None, _meta_ns + ) + if isinstance(v, (dict, list)): + wrapped_element.extend(_get_element(v, exclude_readonly, meta)) + elif _is_model(v): + _get_element(v, exclude_readonly, meta, wrapped_element) + else: + wrapped_element.text = _get_primitive_type_value(v) + return wrapped_element # type: ignore[no-any-return] + + +def _get_primitive_type_value(v) -> str: + if v is True: + return "true" + if v is False: + return "false" + if isinstance(v, _Null): + return "" + return str(v) + + +def _safe_register_namespace(prefix: str, ns: str) -> None: + """Register an XML namespace prefix, handling reserved prefix patterns. + + Some prefixes (e.g. 'ns2') match Python's reserved 'ns\\d+' pattern used for + auto-generated prefixes, causing register_namespace to raise ValueError. + Falls back to directly registering in the internal namespace map. + + :param str prefix: The namespace prefix to register. + :param str ns: The namespace URI. + """ + try: + ET.register_namespace(prefix, ns) + except ValueError: + _ns_map = getattr(ET, "_namespace_map", None) + if _ns_map is not None: + _ns_map[ns] = prefix + + +def _create_xml_element( + tag: typing.Any, prefix: typing.Optional[str] = None, ns: typing.Optional[str] = None +) -> ET.Element: + if prefix and ns: + _safe_register_namespace(prefix, ns) + if ns: + return ET.Element("{" + ns + "}" + tag) + return ET.Element(tag) + + +def _deserialize_xml( + deserializer: typing.Any, + value: str, +) -> typing.Any: + element = ET.fromstring(value) # nosec + if _is_model(deserializer): + return deserializer._deserialize(element, []) + return _deserialize(deserializer, element) + + +def _convert_element(e: ET.Element): + # dict case + if len(e.attrib) > 0 or len({child.tag for child in e}) > 1: + dict_result: dict[str, typing.Any] = {} + for child in e: + if dict_result.get(child.tag) is not None: + if isinstance(dict_result[child.tag], list): + dict_result[child.tag].append(_convert_element(child)) + else: + dict_result[child.tag] = [dict_result[child.tag], _convert_element(child)] + else: + dict_result[child.tag] = _convert_element(child) + dict_result.update(e.attrib) + return dict_result + # array case + if len(e) > 0: + array_result: list[typing.Any] = [] + for child in e: + array_result.append(_convert_element(child)) + return array_result + # primitive case + return e.text diff --git a/sdk/contentsafety/azure-ai-contentsafety/azure/ai/contentsafety/_serialization.py b/sdk/contentsafety/azure-ai-contentsafety/azure/ai/contentsafety/_utils/serialization.py similarity index 75% rename from sdk/contentsafety/azure-ai-contentsafety/azure/ai/contentsafety/_serialization.py rename to sdk/contentsafety/azure-ai-contentsafety/azure/ai/contentsafety/_utils/serialization.py index baa661cb82d2..75906e2eb77f 100644 --- a/sdk/contentsafety/azure-ai-contentsafety/azure/ai/contentsafety/_serialization.py +++ b/sdk/contentsafety/azure-ai-contentsafety/azure/ai/contentsafety/_utils/serialization.py @@ -1,30 +1,12 @@ +# pylint: disable=line-too-long,useless-suppression,too-many-lines +# coding=utf-8 # -------------------------------------------------------------------------- -# # Copyright (c) Microsoft Corporation. All rights reserved. -# -# The MIT License (MIT) -# -# Permission is hereby granted, free of charge, to any person obtaining a copy -# of this software and associated documentation files (the ""Software""), to -# deal in the Software without restriction, including without limitation the -# rights to use, copy, modify, merge, publish, distribute, sublicense, and/or -# sell copies of the Software, and to permit persons to whom the Software is -# furnished to do so, subject to the following conditions: -# -# The above copyright notice and this permission notice shall be included in -# all copies or substantial portions of the Software. -# -# THE SOFTWARE IS PROVIDED *AS IS*, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR -# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, -# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE -# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER -# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING -# FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS -# IN THE SOFTWARE. -# +# Licensed under the MIT License. See License.txt in the project root for license information. +# Code generated by Microsoft (R) Python Code Generator. +# Changes may cause incorrect behavior and will be lost if the code is regenerated. # -------------------------------------------------------------------------- -# pylint: skip-file # pyright: reportUnnecessaryTypeIgnoreComment=false from base64 import b64decode, b64encode @@ -39,7 +21,6 @@ import sys import codecs from typing import ( - Dict, Any, cast, Optional, @@ -48,11 +29,7 @@ IO, Mapping, Callable, - TypeVar, MutableMapping, - Type, - List, - Mapping, ) try: @@ -66,9 +43,13 @@ from azure.core.exceptions import DeserializationError, SerializationError from azure.core.serialization import NULL as CoreNull +if sys.version_info >= (3, 11): + from typing import Self +else: + from typing_extensions import Self + _BOM = codecs.BOM_UTF8.decode(encoding="utf-8") -ModelType = TypeVar("ModelType", bound="Model") JSON = MutableMapping[str, Any] @@ -91,6 +72,8 @@ def deserialize_from_text(cls, data: Optional[Union[AnyStr, IO]], content_type: :param data: Input, could be bytes or stream (will be decoded with UTF8) or text :type data: str or bytes or IO :param str content_type: The content type. + :return: The deserialized data. + :rtype: object """ if hasattr(data, "read"): # Assume a stream @@ -112,7 +95,7 @@ def deserialize_from_text(cls, data: Optional[Union[AnyStr, IO]], content_type: try: return json.loads(data_as_str) except ValueError as err: - raise DeserializationError("JSON is invalid: {}".format(err), err) + raise DeserializationError("JSON is invalid: {}".format(err), err) from err elif "xml" in (content_type or []): try: @@ -144,6 +127,8 @@ def _json_attemp(data): # context otherwise. _LOGGER.critical("Wasn't XML not JSON, failing") raise DeserializationError("XML is invalid") from err + elif content_type.startswith("text/"): + return data_as_str raise DeserializationError("Cannot deserialize content-type: {}".format(content_type)) @classmethod @@ -153,6 +138,11 @@ def deserialize_from_http_generics(cls, body_bytes: Optional[Union[AnyStr, IO]], Use bytes and headers to NOT use any requests/aiohttp or whatever specific implementation. Headers will tested for "content-type" + + :param bytes body_bytes: The body of the response. + :param dict headers: The headers of the response. + :returns: The deserialized data. + :rtype: object """ # Try to use content-type from headers if available content_type = None @@ -170,13 +160,6 @@ def deserialize_from_http_generics(cls, body_bytes: Optional[Union[AnyStr, IO]], return None -try: - basestring # type: ignore - unicode_str = unicode # type: ignore -except NameError: - basestring = str - unicode_str = str - _LOGGER = logging.getLogger(__name__) try: @@ -184,80 +167,31 @@ def deserialize_from_http_generics(cls, body_bytes: Optional[Union[AnyStr, IO]], except NameError: _long_type = int - -class UTC(datetime.tzinfo): - """Time Zone info for handling UTC""" - - def utcoffset(self, dt): - """UTF offset for UTC is 0.""" - return datetime.timedelta(0) - - def tzname(self, dt): - """Timestamp representation.""" - return "Z" - - def dst(self, dt): - """No daylight saving for UTC.""" - return datetime.timedelta(hours=1) - - -try: - from datetime import timezone as _FixedOffset # type: ignore -except ImportError: # Python 2.7 - - class _FixedOffset(datetime.tzinfo): # type: ignore - """Fixed offset in minutes east from UTC. - Copy/pasted from Python doc - :param datetime.timedelta offset: offset in timedelta format - """ - - def __init__(self, offset): - self.__offset = offset - - def utcoffset(self, dt): - return self.__offset - - def tzname(self, dt): - return str(self.__offset.total_seconds() / 3600) - - def __repr__(self): - return "".format(self.tzname(None)) - - def dst(self, dt): - return datetime.timedelta(0) - - def __getinitargs__(self): - return (self.__offset,) - - -try: - from datetime import timezone - - TZ_UTC = timezone.utc -except ImportError: - TZ_UTC = UTC() # type: ignore +TZ_UTC = datetime.timezone.utc _FLATTEN = re.compile(r"(? None: - self.additional_properties: Optional[Dict[str, Any]] = {} - for k in kwargs: + self.additional_properties: Optional[dict[str, Any]] = {} + for k in kwargs: # pylint: disable=consider-using-dict-items if k not in self._attribute_map: _LOGGER.warning("%s is not a known attribute of class %s and will be ignored", k, self.__class__) elif k in self._validation and self._validation[k].get("readonly", False): @@ -305,13 +246,23 @@ def __init__(self, **kwargs: Any) -> None: setattr(self, k, kwargs[k]) def __eq__(self, other: Any) -> bool: - """Compare objects by comparing all attributes.""" + """Compare objects by comparing all attributes. + + :param object other: The object to compare + :returns: True if objects are equal + :rtype: bool + """ if isinstance(other, self.__class__): return self.__dict__ == other.__dict__ return False def __ne__(self, other: Any) -> bool: - """Compare objects by comparing all attributes.""" + """Compare objects by comparing all attributes. + + :param object other: The object to compare + :returns: True if objects are not equal + :rtype: bool + """ return not self.__eq__(other) def __str__(self) -> str: @@ -331,7 +282,11 @@ def is_xml_model(cls) -> bool: @classmethod def _create_xml_node(cls): - """Create XML node.""" + """Create XML node. + + :returns: The XML node + :rtype: xml.etree.ElementTree.Element + """ try: xml_map = cls._xml_map # type: ignore except AttributeError: @@ -351,12 +306,14 @@ def serialize(self, keep_readonly: bool = False, **kwargs: Any) -> JSON: :rtype: dict """ serializer = Serializer(self._infer_class_models()) - return serializer._serialize(self, keep_readonly=keep_readonly, **kwargs) # type: ignore + return serializer._serialize( # type: ignore # pylint: disable=protected-access + self, keep_readonly=keep_readonly, **kwargs + ) def as_dict( self, keep_readonly: bool = True, - key_transformer: Callable[[str, Dict[str, Any], Any], Any] = attribute_transformer, + key_transformer: Callable[[str, dict[str, Any], Any], Any] = attribute_transformer, **kwargs: Any ) -> JSON: """Return a dict that can be serialized using json.dump. @@ -385,12 +342,15 @@ def my_key_transformer(key, attr_desc, value): If you want XML serialization, you can pass the kwargs is_xml=True. + :param bool keep_readonly: If you want to serialize the readonly attributes :param function key_transformer: A key transformer function. :returns: A dict JSON compatible object :rtype: dict """ serializer = Serializer(self._infer_class_models()) - return serializer._serialize(self, key_transformer=key_transformer, keep_readonly=keep_readonly, **kwargs) # type: ignore + return serializer._serialize( # type: ignore # pylint: disable=protected-access + self, key_transformer=key_transformer, keep_readonly=keep_readonly, **kwargs + ) @classmethod def _infer_class_models(cls): @@ -400,30 +360,31 @@ def _infer_class_models(cls): client_models = {k: v for k, v in models.__dict__.items() if isinstance(v, type)} if cls.__name__ not in client_models: raise ValueError("Not Autorest generated code") - except Exception: + except Exception: # pylint: disable=broad-exception-caught # Assume it's not Autorest generated (tests?). Add ourselves as dependencies. client_models = {cls.__name__: cls} return client_models @classmethod - def deserialize(cls: Type[ModelType], data: Any, content_type: Optional[str] = None) -> ModelType: + def deserialize(cls, data: Any, content_type: Optional[str] = None) -> Self: """Parse a str using the RestAPI syntax and return a model. :param str data: A str using RestAPI structure. JSON by default. :param str content_type: JSON by default, set application/xml if XML. :returns: An instance of this model - :raises: DeserializationError if something went wrong + :raises DeserializationError: if something went wrong + :rtype: Self """ deserializer = Deserializer(cls._infer_class_models()) return deserializer(cls.__name__, data, content_type=content_type) # type: ignore @classmethod def from_dict( - cls: Type[ModelType], + cls, data: Any, - key_extractors: Optional[Callable[[str, Dict[str, Any], Any], Any]] = None, + key_extractors: Optional[Callable[[str, dict[str, Any], Any], Any]] = None, content_type: Optional[str] = None, - ) -> ModelType: + ) -> Self: """Parse a dict using given key extractor return a model. By default consider key @@ -431,9 +392,11 @@ def from_dict( and last_rest_key_case_insensitive_extractor) :param dict data: A dict using RestAPI structure + :param function key_extractors: A key extractor function. :param str content_type: JSON by default, set application/xml if XML. :returns: An instance of this model - :raises: DeserializationError if something went wrong + :raises DeserializationError: if something went wrong + :rtype: Self """ deserializer = Deserializer(cls._infer_class_models()) deserializer.key_extractors = ( # type: ignore @@ -453,21 +416,25 @@ def _flatten_subtype(cls, key, objects): return {} result = dict(cls._subtype_map[key]) for valuetype in cls._subtype_map[key].values(): - result.update(objects[valuetype]._flatten_subtype(key, objects)) + result |= objects[valuetype]._flatten_subtype(key, objects) # pylint: disable=protected-access return result @classmethod def _classify(cls, response, objects): """Check the class _subtype_map for any child classes. We want to ignore any inherited _subtype_maps. - Remove the polymorphic key from the initial data. + + :param dict response: The initial data + :param dict objects: The class objects + :returns: The class to be used + :rtype: class """ for subtype_key in cls.__dict__.get("_subtype_map", {}).keys(): subtype_value = None if not isinstance(response, ET.Element): rest_api_response_key = cls._get_rest_key_parts(subtype_key)[-1] - subtype_value = response.pop(rest_api_response_key, None) or response.pop(subtype_key, None) + subtype_value = response.get(rest_api_response_key, None) or response.get(subtype_key, None) else: subtype_value = xml_key_extractor(subtype_key, cls._attribute_map[subtype_key], response) if subtype_value: @@ -506,11 +473,13 @@ def _decode_attribute_map_key(key): inside the received data. :param str key: A key string from the generated code + :returns: The decoded key + :rtype: str """ return key.replace("\\.", ".") -class Serializer(object): +class Serializer: # pylint: disable=too-many-public-methods """Request object model serializer.""" basic_types = {str: "str", int: "int", bool: "bool", float: "float"} @@ -545,12 +514,16 @@ class Serializer(object): "multiple": lambda x, y: x % y != 0, } - def __init__(self, classes: Optional[Mapping[str, Type[ModelType]]] = None): + def __init__(self, classes: Optional[Mapping[str, type]] = None) -> None: self.serialize_type = { "iso-8601": Serializer.serialize_iso, "rfc-1123": Serializer.serialize_rfc, "unix-time": Serializer.serialize_unix, "duration": Serializer.serialize_duration, + "duration-seconds-int": Serializer.serialize_duration_seconds_int, + "duration-seconds-float": Serializer.serialize_duration_seconds_float, + "duration-milliseconds-int": Serializer.serialize_duration_milliseconds_int, + "duration-milliseconds-float": Serializer.serialize_duration_milliseconds_float, "date": Serializer.serialize_date, "time": Serializer.serialize_time, "decimal": Serializer.serialize_decimal, @@ -561,17 +534,20 @@ def __init__(self, classes: Optional[Mapping[str, Type[ModelType]]] = None): "[]": self.serialize_iter, "{}": self.serialize_dict, } - self.dependencies: Dict[str, Type[ModelType]] = dict(classes) if classes else {} + self.dependencies: dict[str, type] = dict(classes) if classes else {} self.key_transformer = full_restapi_key_transformer self.client_side_validation = True - def _serialize(self, target_obj, data_type=None, **kwargs): + def _serialize( # pylint: disable=too-many-nested-blocks, too-many-branches, too-many-statements, too-many-locals + self, target_obj, data_type=None, **kwargs + ): """Serialize data into a string according to type. - :param target_obj: The data to be serialized. + :param object target_obj: The data to be serialized. :param str data_type: The type to be serialized from. :rtype: str, dict - :raises: SerializationError if serialization fails. + :raises SerializationError: if serialization fails. + :returns: The serialized data. """ key_transformer = kwargs.get("key_transformer", self.key_transformer) keep_readonly = kwargs.get("keep_readonly", False) @@ -597,17 +573,19 @@ def _serialize(self, target_obj, data_type=None, **kwargs): serialized = {} if is_xml_model_serialization: - serialized = target_obj._create_xml_node() + serialized = target_obj._create_xml_node() # pylint: disable=protected-access try: - attributes = target_obj._attribute_map + attributes = target_obj._attribute_map # pylint: disable=protected-access for attr, attr_desc in attributes.items(): attr_name = attr - if not keep_readonly and target_obj._validation.get(attr_name, {}).get("readonly", False): + if not keep_readonly and target_obj._validation.get( # pylint: disable=protected-access + attr_name, {} + ).get("readonly", False): continue if attr_name == "additional_properties" and attr_desc["key"] == "": if target_obj.additional_properties is not None: - serialized.update(target_obj.additional_properties) + serialized |= target_obj.additional_properties continue try: @@ -638,7 +616,8 @@ def _serialize(self, target_obj, data_type=None, **kwargs): if isinstance(new_attr, list): serialized.extend(new_attr) # type: ignore elif isinstance(new_attr, ET.Element): - # If the down XML has no XML/Name, we MUST replace the tag with the local tag. But keeping the namespaces. + # If the down XML has no XML/Name, + # we MUST replace the tag with the local tag. But keeping the namespaces. if "name" not in getattr(orig_attr, "_xml_map", {}): splitted_tag = new_attr.tag.split("}") if len(splitted_tag) == 2: # Namespace @@ -649,7 +628,7 @@ def _serialize(self, target_obj, data_type=None, **kwargs): else: # That's a basic type # Integrate namespace if necessary local_node = _create_xml_node(xml_name, xml_prefix, xml_ns) - local_node.text = unicode_str(new_attr) + local_node.text = str(new_attr) serialized.append(local_node) # type: ignore else: # JSON for k in reversed(keys): # type: ignore @@ -669,17 +648,17 @@ def _serialize(self, target_obj, data_type=None, **kwargs): except (AttributeError, KeyError, TypeError) as err: msg = "Attribute {} in object {} cannot be serialized.\n{}".format(attr_name, class_name, str(target_obj)) raise SerializationError(msg) from err - else: - return serialized + return serialized def body(self, data, data_type, **kwargs): """Serialize data intended for a request body. - :param data: The data to be serialized. + :param object data: The data to be serialized. :param str data_type: The type to be serialized from. :rtype: dict - :raises: SerializationError if serialization fails. - :raises: ValueError if data is None + :raises SerializationError: if serialization fails. + :raises ValueError: if data is None + :returns: The serialized request body """ # Just in case this is a dict @@ -708,7 +687,7 @@ def body(self, data, data_type, **kwargs): attribute_key_case_insensitive_extractor, last_rest_key_case_insensitive_extractor, ] - data = deserializer._deserialize(data_type, data) + data = deserializer._deserialize(data_type, data) # pylint: disable=protected-access except DeserializationError as err: raise SerializationError("Unable to build a model: " + str(err)) from err @@ -717,11 +696,13 @@ def body(self, data, data_type, **kwargs): def url(self, name, data, data_type, **kwargs): """Serialize data intended for a URL path. - :param data: The data to be serialized. + :param str name: The name of the URL path parameter. + :param object data: The data to be serialized. :param str data_type: The type to be serialized from. :rtype: str - :raises: TypeError if serialization fails. - :raises: ValueError if data is None + :returns: The serialized URL path + :raises TypeError: if serialization fails. + :raises ValueError: if data is None """ try: output = self.serialize_data(data, data_type, **kwargs) @@ -733,21 +714,20 @@ def url(self, name, data, data_type, **kwargs): output = output.replace("{", quote("{")).replace("}", quote("}")) else: output = quote(str(output), safe="") - except SerializationError: - raise TypeError("{} must be type {}.".format(name, data_type)) - else: - return output + except SerializationError as exc: + raise TypeError("{} must be type {}.".format(name, data_type)) from exc + return output def query(self, name, data, data_type, **kwargs): """Serialize data intended for a URL query. - :param data: The data to be serialized. + :param str name: The name of the query parameter. + :param object data: The data to be serialized. :param str data_type: The type to be serialized from. - :keyword bool skip_quote: Whether to skip quote the serialized result. - Defaults to False. :rtype: str, list - :raises: TypeError if serialization fails. - :raises: ValueError if data is None + :raises TypeError: if serialization fails. + :raises ValueError: if data is None + :returns: The serialized query parameter """ try: # Treat the list aside, since we don't want to encode the div separator @@ -764,19 +744,20 @@ def query(self, name, data, data_type, **kwargs): output = str(output) else: output = quote(str(output), safe="") - except SerializationError: - raise TypeError("{} must be type {}.".format(name, data_type)) - else: - return str(output) + except SerializationError as exc: + raise TypeError("{} must be type {}.".format(name, data_type)) from exc + return str(output) def header(self, name, data, data_type, **kwargs): """Serialize data intended for a request header. - :param data: The data to be serialized. + :param str name: The name of the header. + :param object data: The data to be serialized. :param str data_type: The type to be serialized from. :rtype: str - :raises: TypeError if serialization fails. - :raises: ValueError if data is None + :raises TypeError: if serialization fails. + :raises ValueError: if data is None + :returns: The serialized header """ try: if data_type in ["[str]"]: @@ -785,21 +766,20 @@ def header(self, name, data, data_type, **kwargs): output = self.serialize_data(data, data_type, **kwargs) if data_type == "bool": output = json.dumps(output) - except SerializationError: - raise TypeError("{} must be type {}.".format(name, data_type)) - else: - return str(output) + except SerializationError as exc: + raise TypeError("{} must be type {}.".format(name, data_type)) from exc + return str(output) def serialize_data(self, data, data_type, **kwargs): """Serialize generic data according to supplied data type. - :param data: The data to be serialized. + :param object data: The data to be serialized. :param str data_type: The type to be serialized from. - :param bool required: Whether it's essential that the data not be - empty or None - :raises: AttributeError if required data is None. - :raises: ValueError if data is None - :raises: SerializationError if serialization fails. + :raises AttributeError: if required data is None. + :raises ValueError: if data is None + :raises SerializationError: if serialization fails. + :returns: The serialized data. + :rtype: str, int, float, bool, dict, list """ if data is None: raise ValueError("No value for given attribute") @@ -810,12 +790,12 @@ def serialize_data(self, data, data_type, **kwargs): if data_type in self.basic_types.values(): return self.serialize_basic(data, data_type, **kwargs) - elif data_type in self.serialize_type: + if data_type in self.serialize_type: return self.serialize_type[data_type](data, **kwargs) # If dependencies is empty, try with current data class # It has to be a subclass of Enum anyway - enum_type = self.dependencies.get(data_type, data.__class__) + enum_type = self.dependencies.get(data_type, cast(type, data.__class__)) if issubclass(enum_type, Enum): return Serializer.serialize_enum(data, enum_obj=enum_type) @@ -826,11 +806,10 @@ def serialize_data(self, data, data_type, **kwargs): except (ValueError, TypeError) as err: msg = "Unable to serialize value: {!r} as type: {!r}." raise SerializationError(msg.format(data, data_type)) from err - else: - return self._serialize(data, **kwargs) + return self._serialize(data, **kwargs) @classmethod - def _get_custom_serializers(cls, data_type, **kwargs): + def _get_custom_serializers(cls, data_type, **kwargs): # pylint: disable=inconsistent-return-statements custom_serializer = kwargs.get("basic_types_serializers", {}).get(data_type) if custom_serializer: return custom_serializer @@ -846,23 +825,33 @@ def serialize_basic(cls, data, data_type, **kwargs): - basic_types_serializers dict[str, callable] : If set, use the callable as serializer - is_xml bool : If set, use xml_basic_types_serializers - :param data: Object to be serialized. + :param obj data: Object to be serialized. :param str data_type: Type of object in the iterable. + :rtype: str, int, float, bool + :return: serialized object + :raises TypeError: raise if data_type is not one of str, int, float, bool. """ custom_serializer = cls._get_custom_serializers(data_type, **kwargs) if custom_serializer: return custom_serializer(data) if data_type == "str": return cls.serialize_unicode(data) - return eval(data_type)(data) # nosec + if data_type == "int": + return int(data) + if data_type == "float": + return float(data) + if data_type == "bool": + return bool(data) + raise TypeError("Unknown basic data type: {}".format(data_type)) @classmethod def serialize_unicode(cls, data): """Special handling for serializing unicode strings in Py2. Encode to UTF-8 if unicode, otherwise handle as a str. - :param data: Object to be serialized. + :param str data: Object to be serialized. :rtype: str + :return: serialized object """ try: # If I received an enum, return its value return data.value @@ -876,8 +865,7 @@ def serialize_unicode(cls, data): return data except NameError: return str(data) - else: - return str(data) + return str(data) def serialize_iter(self, data, iter_type, div=None, **kwargs): """Serialize iterable. @@ -887,15 +875,13 @@ def serialize_iter(self, data, iter_type, div=None, **kwargs): serialization_ctxt['type'] should be same as data_type. - is_xml bool : If set, serialize as XML - :param list attr: Object to be serialized. + :param list data: Object to be serialized. :param str iter_type: Type of object in the iterable. - :param bool required: Whether the objects in the iterable must - not be None or empty. :param str div: If set, this str will be used to combine the elements in the iterable into a combined string. Default is 'None'. - :keyword bool do_quote: Whether to quote the serialized result of each iterable element. Defaults to False. :rtype: list, str + :return: serialized iterable """ if isinstance(data, str): raise SerializationError("Refuse str type as a valid iter type.") @@ -950,9 +936,8 @@ def serialize_dict(self, attr, dict_type, **kwargs): :param dict attr: Object to be serialized. :param str dict_type: Type of object in the dictionary. - :param bool required: Whether the objects in the dictionary must - not be None or empty. :rtype: dict + :return: serialized dictionary """ serialization_ctxt = kwargs.get("serialization_ctxt", {}) serialized = {} @@ -976,7 +961,7 @@ def serialize_dict(self, attr, dict_type, **kwargs): return serialized - def serialize_object(self, attr, **kwargs): + def serialize_object(self, attr, **kwargs): # pylint: disable=too-many-return-statements """Serialize a generic object. This will be handled as a dictionary. If object passed in is not a basic type (str, int, float, dict, list) it will simply be @@ -984,6 +969,7 @@ def serialize_object(self, attr, **kwargs): :param dict attr: Object to be serialized. :rtype: dict or str + :return: serialized object """ if attr is None: return None @@ -994,7 +980,7 @@ def serialize_object(self, attr, **kwargs): return self.serialize_basic(attr, self.basic_types[obj_type], **kwargs) if obj_type is _long_type: return self.serialize_long(attr) - if obj_type is unicode_str: + if obj_type is str: return self.serialize_unicode(attr) if obj_type is datetime.datetime: return self.serialize_iso(attr) @@ -1008,7 +994,7 @@ def serialize_object(self, attr, **kwargs): return self.serialize_decimal(attr) # If it's a model or I know this dependency, serialize as a Model - elif obj_type in self.dependencies.values() or isinstance(attr, Model): + if obj_type in self.dependencies.values() or isinstance(attr, Model): return self._serialize(attr) if obj_type == dict: @@ -1039,56 +1025,61 @@ def serialize_enum(attr, enum_obj=None): try: enum_obj(result) # type: ignore return result - except ValueError: + except ValueError as exc: for enum_value in enum_obj: # type: ignore if enum_value.value.lower() == str(attr).lower(): return enum_value.value error = "{!r} is not valid value for enum {!r}" - raise SerializationError(error.format(attr, enum_obj)) + raise SerializationError(error.format(attr, enum_obj)) from exc @staticmethod - def serialize_bytearray(attr, **kwargs): + def serialize_bytearray(attr, **kwargs): # pylint: disable=unused-argument """Serialize bytearray into base-64 string. - :param attr: Object to be serialized. + :param str attr: Object to be serialized. :rtype: str + :return: serialized base64 """ return b64encode(attr).decode() @staticmethod - def serialize_base64(attr, **kwargs): + def serialize_base64(attr, **kwargs): # pylint: disable=unused-argument """Serialize str into base-64 string. - :param attr: Object to be serialized. + :param str attr: Object to be serialized. :rtype: str + :return: serialized base64 """ encoded = b64encode(attr).decode("ascii") return encoded.strip("=").replace("+", "-").replace("/", "_") @staticmethod - def serialize_decimal(attr, **kwargs): + def serialize_decimal(attr, **kwargs): # pylint: disable=unused-argument """Serialize Decimal object to float. - :param attr: Object to be serialized. + :param decimal attr: Object to be serialized. :rtype: float + :return: serialized decimal """ return float(attr) @staticmethod - def serialize_long(attr, **kwargs): + def serialize_long(attr, **kwargs): # pylint: disable=unused-argument """Serialize long (Py2) or int (Py3). - :param attr: Object to be serialized. + :param int attr: Object to be serialized. :rtype: int/long + :return: serialized long """ return _long_type(attr) @staticmethod - def serialize_date(attr, **kwargs): + def serialize_date(attr, **kwargs): # pylint: disable=unused-argument """Serialize Date object into ISO-8601 formatted string. :param Date attr: Object to be serialized. :rtype: str + :return: serialized date """ if isinstance(attr, str): attr = isodate.parse_date(attr) @@ -1096,11 +1087,12 @@ def serialize_date(attr, **kwargs): return t @staticmethod - def serialize_time(attr, **kwargs): + def serialize_time(attr, **kwargs): # pylint: disable=unused-argument """Serialize Time object into ISO-8601 formatted string. :param datetime.time attr: Object to be serialized. :rtype: str + :return: serialized time """ if isinstance(attr, str): attr = isodate.parse_time(attr) @@ -1110,30 +1102,87 @@ def serialize_time(attr, **kwargs): return t @staticmethod - def serialize_duration(attr, **kwargs): + def serialize_duration(attr, **kwargs): # pylint: disable=unused-argument """Serialize TimeDelta object into ISO-8601 formatted string. :param TimeDelta attr: Object to be serialized. :rtype: str + :return: serialized duration """ if isinstance(attr, str): attr = isodate.parse_duration(attr) return isodate.duration_isoformat(attr) @staticmethod - def serialize_rfc(attr, **kwargs): + def _serialize_duration_numeric(attr, scale, as_int): + """Serialize a TimeDelta into a numeric value scaled to the wire unit. + + :param TimeDelta attr: Object to be serialized. + :param int scale: Multiplier applied to total seconds (1 for seconds, 1000 for milliseconds). + :param bool as_int: Whether to truncate the result to an int. + :rtype: int or float + :return: serialized duration + """ + if isinstance(attr, str): + attr = isodate.parse_duration(attr) + value = attr.total_seconds() * scale if isinstance(attr, datetime.timedelta) else attr + return int(value) if as_int else float(value) + + @staticmethod + def serialize_duration_seconds_int(attr, **kwargs): # pylint: disable=unused-argument + """Serialize TimeDelta object into an integer number of seconds. + + :param TimeDelta attr: Object to be serialized. + :rtype: int + :return: serialized duration + """ + return Serializer._serialize_duration_numeric(attr, 1, True) + + @staticmethod + def serialize_duration_seconds_float(attr, **kwargs): # pylint: disable=unused-argument + """Serialize TimeDelta object into a floating point number of seconds. + + :param TimeDelta attr: Object to be serialized. + :rtype: float + :return: serialized duration + """ + return Serializer._serialize_duration_numeric(attr, 1, False) + + @staticmethod + def serialize_duration_milliseconds_int(attr, **kwargs): # pylint: disable=unused-argument + """Serialize TimeDelta object into an integer number of milliseconds. + + :param TimeDelta attr: Object to be serialized. + :rtype: int + :return: serialized duration + """ + return Serializer._serialize_duration_numeric(attr, 1000, True) + + @staticmethod + def serialize_duration_milliseconds_float(attr, **kwargs): # pylint: disable=unused-argument + """Serialize TimeDelta object into a floating point number of milliseconds. + + :param TimeDelta attr: Object to be serialized. + :rtype: float + :return: serialized duration + """ + return Serializer._serialize_duration_numeric(attr, 1000, False) + + @staticmethod + def serialize_rfc(attr, **kwargs): # pylint: disable=unused-argument """Serialize Datetime object into RFC-1123 formatted string. :param Datetime attr: Object to be serialized. :rtype: str - :raises: TypeError if format invalid. + :raises TypeError: if format invalid. + :return: serialized rfc """ try: if not attr.tzinfo: _LOGGER.warning("Datetime with no tzinfo will be considered UTC.") utc = attr.utctimetuple() - except AttributeError: - raise TypeError("RFC1123 object must be valid Datetime object.") + except AttributeError as exc: + raise TypeError("RFC1123 object must be valid Datetime object.") from exc return "{}, {:02} {} {:04} {:02}:{:02}:{:02} GMT".format( Serializer.days[utc.tm_wday], @@ -1146,12 +1195,13 @@ def serialize_rfc(attr, **kwargs): ) @staticmethod - def serialize_iso(attr, **kwargs): + def serialize_iso(attr, **kwargs): # pylint: disable=unused-argument """Serialize Datetime object into ISO-8601 formatted string. :param Datetime attr: Object to be serialized. :rtype: str - :raises: SerializationError if format invalid. + :raises SerializationError: if format invalid. + :return: serialized iso """ if isinstance(attr, str): attr = isodate.parse_datetime(attr) @@ -1177,13 +1227,14 @@ def serialize_iso(attr, **kwargs): raise TypeError(msg) from err @staticmethod - def serialize_unix(attr, **kwargs): + def serialize_unix(attr, **kwargs): # pylint: disable=unused-argument """Serialize Datetime object into IntTime format. This is represented as seconds. :param Datetime attr: Object to be serialized. :rtype: int - :raises: SerializationError if format invalid + :raises SerializationError: if format invalid + :return: serialied unix """ if isinstance(attr, int): return attr @@ -1191,17 +1242,17 @@ def serialize_unix(attr, **kwargs): if not attr.tzinfo: _LOGGER.warning("Datetime with no tzinfo will be considered UTC.") return int(calendar.timegm(attr.utctimetuple())) - except AttributeError: - raise TypeError("Unix time object must be valid Datetime object.") + except AttributeError as exc: + raise TypeError("Unix time object must be valid Datetime object.") from exc -def rest_key_extractor(attr, attr_desc, data): +def rest_key_extractor(attr, attr_desc, data): # pylint: disable=unused-argument key = attr_desc["key"] working_data = data while "." in key: # Need the cast, as for some reasons "split" is typed as list[str | Any] - dict_keys = cast(List[str], _FLATTEN.split(key)) + dict_keys = cast(list[str], _FLATTEN.split(key)) if len(dict_keys) == 1: key = _decode_attribute_map_key(dict_keys[0]) break @@ -1216,7 +1267,9 @@ def rest_key_extractor(attr, attr_desc, data): return working_data.get(key) -def rest_key_case_insensitive_extractor(attr, attr_desc, data): +def rest_key_case_insensitive_extractor( # pylint: disable=unused-argument, inconsistent-return-statements + attr, attr_desc, data +): key = attr_desc["key"] working_data = data @@ -1237,17 +1290,29 @@ def rest_key_case_insensitive_extractor(attr, attr_desc, data): return attribute_key_case_insensitive_extractor(key, None, working_data) -def last_rest_key_extractor(attr, attr_desc, data): - """Extract the attribute in "data" based on the last part of the JSON path key.""" +def last_rest_key_extractor(attr, attr_desc, data): # pylint: disable=unused-argument + """Extract the attribute in "data" based on the last part of the JSON path key. + + :param str attr: The attribute to extract + :param dict attr_desc: The attribute description + :param dict data: The data to extract from + :rtype: object + :returns: The extracted attribute + """ key = attr_desc["key"] dict_keys = _FLATTEN.split(key) return attribute_key_extractor(dict_keys[-1], None, data) -def last_rest_key_case_insensitive_extractor(attr, attr_desc, data): +def last_rest_key_case_insensitive_extractor(attr, attr_desc, data): # pylint: disable=unused-argument """Extract the attribute in "data" based on the last part of the JSON path key. This is the case insensitive version of "last_rest_key_extractor" + :param str attr: The attribute to extract + :param dict attr_desc: The attribute description + :param dict data: The data to extract from + :rtype: object + :returns: The extracted attribute """ key = attr_desc["key"] dict_keys = _FLATTEN.split(key) @@ -1284,7 +1349,7 @@ def _extract_name_from_internal_type(internal_type): return xml_name -def xml_key_extractor(attr, attr_desc, data): +def xml_key_extractor(attr, attr_desc, data): # pylint: disable=unused-argument,too-many-return-statements if isinstance(data, dict): return None @@ -1336,22 +1401,21 @@ def xml_key_extractor(attr, attr_desc, data): if is_iter_type: if is_wrapped: return None # is_wrapped no node, we want None - else: - return [] # not wrapped, assume empty list + return [] # not wrapped, assume empty list return None # Assume it's not there, maybe an optional node. # If is_iter_type and not wrapped, return all found children if is_iter_type: if not is_wrapped: return children - else: # Iter and wrapped, should have found one node only (the wrap one) - if len(children) != 1: - raise DeserializationError( - "Tried to deserialize an array not wrapped, and found several nodes '{}'. Maybe you should declare this array as wrapped?".format( - xml_name - ) + # Iter and wrapped, should have found one node only (the wrap one) + if len(children) != 1: + raise DeserializationError( + "Tried to deserialize an array not wrapped, and found several nodes '{}'. Maybe you should declare this array as wrapped?".format( + xml_name ) - return list(children[0]) # Might be empty list and that's ok. + ) + return list(children[0]) # Might be empty list and that's ok. # Here it's not a itertype, we should have found one element only or empty if len(children) > 1: @@ -1359,7 +1423,7 @@ def xml_key_extractor(attr, attr_desc, data): return children[0] -class Deserializer(object): +class Deserializer: """Response object model deserializer. :param dict classes: Class type dictionary for deserializing complex types. @@ -1368,14 +1432,18 @@ class Deserializer(object): basic_types = {str: "str", int: "int", bool: "bool", float: "float"} - valid_date = re.compile(r"\d{4}[-]\d{2}[-]\d{2}T\d{2}:\d{2}:\d{2}" r"\.?\d*Z?[-+]?[\d{2}]?:?[\d{2}]?") + valid_date = re.compile(r"\d{4}[-]\d{2}[-]\d{2}T\d{2}:\d{2}:\d{2}\.?\d*Z?[-+]?[\d{2}]?:?[\d{2}]?") - def __init__(self, classes: Optional[Mapping[str, Type[ModelType]]] = None): + def __init__(self, classes: Optional[Mapping[str, type]] = None) -> None: self.deserialize_type = { "iso-8601": Deserializer.deserialize_iso, "rfc-1123": Deserializer.deserialize_rfc, "unix-time": Deserializer.deserialize_unix, "duration": Deserializer.deserialize_duration, + "duration-seconds-int": Deserializer.deserialize_duration_seconds, + "duration-seconds-float": Deserializer.deserialize_duration_seconds, + "duration-milliseconds-int": Deserializer.deserialize_duration_milliseconds, + "duration-milliseconds-float": Deserializer.deserialize_duration_milliseconds, "date": Deserializer.deserialize_date, "time": Deserializer.deserialize_time, "decimal": Deserializer.deserialize_decimal, @@ -1388,9 +1456,13 @@ def __init__(self, classes: Optional[Mapping[str, Type[ModelType]]] = None): } self.deserialize_expected_types = { "duration": (isodate.Duration, datetime.timedelta), + "duration-seconds-int": (isodate.Duration, datetime.timedelta), + "duration-seconds-float": (isodate.Duration, datetime.timedelta), + "duration-milliseconds-int": (isodate.Duration, datetime.timedelta), + "duration-milliseconds-float": (isodate.Duration, datetime.timedelta), "iso-8601": (datetime.datetime), } - self.dependencies: Dict[str, Type[ModelType]] = dict(classes) if classes else {} + self.dependencies: dict[str, type] = dict(classes) if classes else {} self.key_extractors = [rest_key_extractor, xml_key_extractor] # Additional properties only works if the "rest_key_extractor" is used to # extract the keys. Making it to work whatever the key extractor is too much @@ -1400,33 +1472,56 @@ def __init__(self, classes: Optional[Mapping[str, Type[ModelType]]] = None): # Otherwise, result are unexpected self.additional_properties_detection = True - def __call__(self, target_obj, response_data, content_type=None): + def __call__(self, target_obj, response_data, content_type=None): # pylint: disable=too-many-return-statements """Call the deserializer to process a REST response. :param str target_obj: Target data type to deserialize to. :param requests.Response response_data: REST response object. :param str content_type: Swagger "produces" if available. - :raises: DeserializationError if deserialization fails. + :raises DeserializationError: if deserialization fails. :return: Deserialized object. + :rtype: object """ + # Fast path for header deserialization: response_data is a plain str or None + # and target_obj is a simple scalar type. This avoids the expensive + # _unpack_content → _deserialize → _classify_target → deserialize_data chain. + if response_data is None: + return None + if target_obj == "str" and isinstance(response_data, str): + return response_data + if isinstance(response_data, str): + if target_obj == "int": + return int(response_data) + if target_obj == "bool": + if response_data in ("true", "1", "True"): + return True + if response_data in ("false", "0", "False"): + return False + return bool(response_data) + if target_obj == "rfc-1123": + return Deserializer.deserialize_rfc(response_data) + if target_obj == "bytearray": + return Deserializer.deserialize_bytearray(response_data) + data = self._unpack_content(response_data, content_type) return self._deserialize(target_obj, data) - def _deserialize(self, target_obj, data): + def _deserialize(self, target_obj, data): # pylint: disable=inconsistent-return-statements """Call the deserializer on a model. Data needs to be already deserialized as JSON or XML ElementTree :param str target_obj: Target data type to deserialize to. :param object data: Object to deserialize. - :raises: DeserializationError if deserialization fails. + :raises DeserializationError: if deserialization fails. :return: Deserialized object. + :rtype: object """ # This is already a model, go recursive just in case if hasattr(data, "_attribute_map"): constants = [name for name, config in getattr(data, "_validation", {}).items() if config.get("constant")] try: - for attr, mapconfig in data._attribute_map.items(): + for attr, mapconfig in data._attribute_map.items(): # pylint: disable=protected-access if attr in constants: continue value = getattr(data, attr) @@ -1443,15 +1538,15 @@ def _deserialize(self, target_obj, data): response, class_name = self._classify_target(target_obj, data) - if isinstance(response, basestring): + if isinstance(response, str): return self.deserialize_data(data, response) - elif isinstance(response, type) and issubclass(response, Enum): + if isinstance(response, type) and issubclass(response, Enum): return self.deserialize_enum(data, response) - if data is None: + if data is None or data is CoreNull: return data try: - attributes = response._attribute_map # type: ignore + attributes = response._attribute_map # type: ignore # pylint: disable=protected-access d_attrs = {} for attr, attr_desc in attributes.items(): # Check empty string. If it's not empty, someone has a real "additionalProperties"... @@ -1481,9 +1576,8 @@ def _deserialize(self, target_obj, data): except (AttributeError, TypeError, KeyError) as err: msg = "Unable to deserialize to object: " + class_name # type: ignore raise DeserializationError(msg) from err - else: - additional_properties = self._build_additional_properties(attributes, data) - return self._instantiate_model(response, d_attrs, additional_properties) + additional_properties = self._build_additional_properties(attributes, data) + return self._instantiate_model(response, d_attrs, additional_properties) def _build_additional_properties(self, attribute_map, data): if not self.additional_properties_detection: @@ -1510,18 +1604,20 @@ def _classify_target(self, target, data): :param str target: The target object type to deserialize to. :param str/dict data: The response data to deserialize. + :return: The classified target object and its class name. + :rtype: tuple """ if target is None: return None, None - if isinstance(target, basestring): + if isinstance(target, str): try: target = self.dependencies[target] except KeyError: return target, target try: - target = target._classify(data, self.dependencies) + target = target._classify(data, self.dependencies) # type: ignore # pylint: disable=protected-access except AttributeError: pass # Target is not a Model, no classify return target, target.__class__.__name__ # type: ignore @@ -1536,10 +1632,12 @@ def failsafe_deserialize(self, target_obj, data, content_type=None): :param str target_obj: The target object type to deserialize to. :param str/dict data: The response data to deserialize. :param str content_type: Swagger "produces" if available. + :return: Deserialized object. + :rtype: object """ try: return self(target_obj, data, content_type=content_type) - except: + except: # pylint: disable=bare-except _LOGGER.debug( "Ran into a deserialization error. Ignoring since this is failsafe deserialization", exc_info=True ) @@ -1557,10 +1655,12 @@ def _unpack_content(raw_data, content_type=None): If raw_data is something else, bypass all logic and return it directly. - :param raw_data: Data to be processed. - :param content_type: How to parse if raw_data is a string/bytes. + :param obj raw_data: Data to be processed. + :param str content_type: How to parse if raw_data is a string/bytes. :raises JSONDecodeError: If JSON is requested and parsing is impossible. :raises UnicodeDecodeError: If bytes is not UTF8 + :rtype: object + :return: Unpacked content. """ # Assume this is enough to detect a Pipeline Response without importing it context = getattr(raw_data, "context", {}) @@ -1577,31 +1677,42 @@ def _unpack_content(raw_data, content_type=None): if hasattr(raw_data, "_content_consumed"): return RawDeserializer.deserialize_from_http_generics(raw_data.text, raw_data.headers) - if isinstance(raw_data, (basestring, bytes)) or hasattr(raw_data, "read"): + if isinstance(raw_data, (str, bytes)) or hasattr(raw_data, "read"): return RawDeserializer.deserialize_from_text(raw_data, content_type) # type: ignore return raw_data def _instantiate_model(self, response, attrs, additional_properties=None): """Instantiate a response model passing in deserialized args. - :param response: The response model class. - :param d_attrs: The deserialized response attributes. + :param Response response: The response model class. + :param dict attrs: The deserialized response attributes. + :param dict additional_properties: Additional properties to be set. + :rtype: Response + :return: The instantiated response model. """ if callable(response): subtype = getattr(response, "_subtype_map", {}) try: - readonly = [k for k, v in response._validation.items() if v.get("readonly")] - const = [k for k, v in response._validation.items() if v.get("constant")] + readonly = [ + k + for k, v in response._validation.items() # pylint: disable=protected-access # type: ignore + if v.get("readonly") + ] + const = [ + k + for k, v in response._validation.items() # pylint: disable=protected-access # type: ignore + if v.get("constant") + ] kwargs = {k: v for k, v in attrs.items() if k not in subtype and k not in readonly + const} response_obj = response(**kwargs) for attr in readonly: setattr(response_obj, attr, attrs.get(attr)) if additional_properties: - response_obj.additional_properties = additional_properties + response_obj.additional_properties = additional_properties # type: ignore return response_obj except TypeError as err: msg = "Unable to deserialize {} into model {}. ".format(kwargs, response) # type: ignore - raise DeserializationError(msg + str(err)) + raise DeserializationError(msg + str(err)) from err else: try: for attr, value in attrs.items(): @@ -1610,15 +1721,16 @@ def _instantiate_model(self, response, attrs, additional_properties=None): except Exception as exp: msg = "Unable to populate response model. " msg += "Type: {}, Error: {}".format(type(response), exp) - raise DeserializationError(msg) + raise DeserializationError(msg) from exp - def deserialize_data(self, data, data_type): + def deserialize_data(self, data, data_type): # pylint: disable=too-many-return-statements """Process data for deserialization according to data type. :param str data: The response string to be deserialized. :param str data_type: The type to deserialize to. - :raises: DeserializationError if deserialization fails. + :raises DeserializationError: if deserialization fails. :return: Deserialized object. + :rtype: object """ if data is None: return data @@ -1632,7 +1744,11 @@ def deserialize_data(self, data, data_type): if isinstance(data, self.deserialize_expected_types.get(data_type, tuple())): return data - is_a_text_parsing_type = lambda x: x not in ["object", "[]", r"{}"] + is_a_text_parsing_type = lambda x: x not in [ # pylint: disable=unnecessary-lambda-assignment + "object", + "[]", + r"{}", + ] if isinstance(data, ET.Element) and is_a_text_parsing_type(data_type) and not data.text: return None data_val = self.deserialize_type[data_type](data) @@ -1652,14 +1768,14 @@ def deserialize_data(self, data, data_type): msg = "Unable to deserialize response data." msg += " Data: {}, {}".format(data, data_type) raise DeserializationError(msg) from err - else: - return self._deserialize(obj_type, data) + return self._deserialize(obj_type, data) def deserialize_iter(self, attr, iter_type): """Deserialize an iterable. :param list attr: Iterable to be deserialized. :param str iter_type: The type of object in the iterable. + :return: Deserialized iterable. :rtype: list """ if attr is None: @@ -1676,6 +1792,7 @@ def deserialize_dict(self, attr, dict_type): :param dict/list attr: Dictionary to be deserialized. Also accepts a list of key, value pairs. :param str dict_type: The object type of the items in the dictionary. + :return: Deserialized dictionary. :rtype: dict """ if isinstance(attr, list): @@ -1686,20 +1803,21 @@ def deserialize_dict(self, attr, dict_type): attr = {el.tag: el.text for el in attr} return {k: self.deserialize_data(v, dict_type) for k, v in attr.items()} - def deserialize_object(self, attr, **kwargs): + def deserialize_object(self, attr, **kwargs): # pylint: disable=too-many-return-statements """Deserialize a generic object. This will be handled as a dictionary. :param dict attr: Dictionary to be deserialized. + :return: Deserialized object. :rtype: dict - :raises: TypeError if non-builtin datatype encountered. + :raises TypeError: if non-builtin datatype encountered. """ if attr is None: return None if isinstance(attr, ET.Element): # Do no recurse on XML, just return the tree as-is return attr - if isinstance(attr, basestring): + if isinstance(attr, str): return self.deserialize_basic(attr, "str") obj_type = type(attr) if obj_type in self.basic_types: @@ -1725,11 +1843,10 @@ def deserialize_object(self, attr, **kwargs): pass return deserialized - else: - error = "Cannot deserialize generic object with type: " - raise TypeError(error + str(obj_type)) + error = "Cannot deserialize generic object with type: " + raise TypeError(error + str(obj_type)) - def deserialize_basic(self, attr, data_type): + def deserialize_basic(self, attr, data_type): # pylint: disable=too-many-return-statements """Deserialize basic builtin data type from string. Will attempt to convert to str, int, float and bool. This function will also accept '1', '0', 'true' and 'false' as @@ -1737,8 +1854,9 @@ def deserialize_basic(self, attr, data_type): :param str attr: response string to be deserialized. :param str data_type: deserialization data type. + :return: Deserialized basic type. :rtype: str, int, float or bool - :raises: TypeError if string format is not valid. + :raises TypeError: if string format is not valid or data_type is not one of str, int, float, bool. """ # If we're here, data is supposed to be a basic type. # If it's still an XML node, take the text @@ -1748,24 +1866,27 @@ def deserialize_basic(self, attr, data_type): if data_type == "str": # None or '', node is empty string. return "" - else: - # None or '', node with a strong type is None. - # Don't try to model "empty bool" or "empty int" - return None + # None or '', node with a strong type is None. + # Don't try to model "empty bool" or "empty int" + return None if data_type == "bool": if attr in [True, False, 1, 0]: return bool(attr) - elif isinstance(attr, basestring): + if isinstance(attr, str): if attr.lower() in ["true", "1"]: return True - elif attr.lower() in ["false", "0"]: + if attr.lower() in ["false", "0"]: return False raise TypeError("Invalid boolean value: {}".format(attr)) if data_type == "str": return self.deserialize_unicode(attr) - return eval(data_type)(attr) # nosec + if data_type == "int": + return int(attr) + if data_type == "float": + return float(attr) + raise TypeError("Unknown basic data type: {}".format(data_type)) @staticmethod def deserialize_unicode(data): @@ -1773,6 +1894,7 @@ def deserialize_unicode(data): as a string. :param str data: response string to be deserialized. + :return: Deserialized string. :rtype: str or unicode """ # We might be here because we have an enum modeled as string, @@ -1786,8 +1908,7 @@ def deserialize_unicode(data): return data except NameError: return str(data) - else: - return str(data) + return str(data) @staticmethod def deserialize_enum(data, enum_obj): @@ -1799,6 +1920,7 @@ def deserialize_enum(data, enum_obj): :param str data: Response string to be deserialized. If this value is None or invalid it will be returned as-is. :param Enum enum_obj: Enum object to deserialize to. + :return: Deserialized enum object. :rtype: Enum """ if isinstance(data, enum_obj) or data is None: @@ -1809,9 +1931,9 @@ def deserialize_enum(data, enum_obj): # Workaround. We might consider remove it in the future. try: return list(enum_obj.__members__.values())[data] - except IndexError: + except IndexError as exc: error = "{!r} is not a valid index for enum {!r}" - raise DeserializationError(error.format(data, enum_obj)) + raise DeserializationError(error.format(data, enum_obj)) from exc try: return enum_obj(str(data)) except ValueError: @@ -1827,8 +1949,9 @@ def deserialize_bytearray(attr): """Deserialize string into bytearray. :param str attr: response string to be deserialized. + :return: Deserialized bytearray :rtype: bytearray - :raises: TypeError if string format invalid. + :raises TypeError: if string format invalid. """ if isinstance(attr, ET.Element): attr = attr.text @@ -1839,8 +1962,9 @@ def deserialize_base64(attr): """Deserialize base64 encoded string into string. :param str attr: response string to be deserialized. + :return: Deserialized base64 string :rtype: bytearray - :raises: TypeError if string format invalid. + :raises TypeError: if string format invalid. """ if isinstance(attr, ET.Element): attr = attr.text @@ -1854,8 +1978,9 @@ def deserialize_decimal(attr): """Deserialize string into Decimal object. :param str attr: response string to be deserialized. - :rtype: Decimal - :raises: DeserializationError if string format invalid. + :return: Deserialized decimal + :raises DeserializationError: if string format invalid. + :rtype: decimal """ if isinstance(attr, ET.Element): attr = attr.text @@ -1870,8 +1995,9 @@ def deserialize_long(attr): """Deserialize string into long (Py2) or int (Py3). :param str attr: response string to be deserialized. + :return: Deserialized int :rtype: long or int - :raises: ValueError if string format invalid. + :raises ValueError: if string format invalid. """ if isinstance(attr, ET.Element): attr = attr.text @@ -1882,8 +2008,9 @@ def deserialize_duration(attr): """Deserialize ISO-8601 formatted string into TimeDelta object. :param str attr: response string to be deserialized. + :return: Deserialized duration :rtype: TimeDelta - :raises: DeserializationError if string format invalid. + :raises DeserializationError: if string format invalid. """ if isinstance(attr, ET.Element): attr = attr.text @@ -1892,16 +2019,58 @@ def deserialize_duration(attr): except (ValueError, OverflowError, AttributeError) as err: msg = "Cannot deserialize duration object." raise DeserializationError(msg) from err - else: - return duration + return duration + + @staticmethod + def _deserialize_duration_numeric(attr, unit): + """Deserialize a numeric duration value into a TimeDelta object. + + :param float attr: response value to be deserialized. + :param str unit: The wire unit, used as the ``timedelta`` keyword + (``"seconds"`` or ``"milliseconds"``). + :return: Deserialized duration + :rtype: TimeDelta + :raises DeserializationError: if value is invalid. + """ + if isinstance(attr, ET.Element): + attr = attr.text + try: + duration = datetime.timedelta(**{unit: float(attr)}) # type: ignore + except (ValueError, OverflowError, TypeError) as err: + msg = "Cannot deserialize duration object." + raise DeserializationError(msg) from err + return duration + + @staticmethod + def deserialize_duration_seconds(attr): + """Deserialize a numeric number of seconds into a TimeDelta object. + + :param float attr: response value to be deserialized. + :return: Deserialized duration + :rtype: TimeDelta + :raises DeserializationError: if value is invalid. + """ + return Deserializer._deserialize_duration_numeric(attr, "seconds") + + @staticmethod + def deserialize_duration_milliseconds(attr): + """Deserialize a numeric number of milliseconds into a TimeDelta object. + + :param float attr: response value to be deserialized. + :return: Deserialized duration + :rtype: TimeDelta + :raises DeserializationError: if value is invalid. + """ + return Deserializer._deserialize_duration_numeric(attr, "milliseconds") @staticmethod def deserialize_date(attr): """Deserialize ISO-8601 formatted string into Date object. :param str attr: response string to be deserialized. + :return: Deserialized date :rtype: Date - :raises: DeserializationError if string format invalid. + :raises DeserializationError: if string format invalid. """ if isinstance(attr, ET.Element): attr = attr.text @@ -1915,8 +2084,9 @@ def deserialize_time(attr): """Deserialize ISO-8601 formatted string into time object. :param str attr: response string to be deserialized. + :return: Deserialized time :rtype: datetime.time - :raises: DeserializationError if string format invalid. + :raises DeserializationError: if string format invalid. """ if isinstance(attr, ET.Element): attr = attr.text @@ -1929,31 +2099,32 @@ def deserialize_rfc(attr): """Deserialize RFC-1123 formatted string into Datetime object. :param str attr: response string to be deserialized. + :return: Deserialized RFC datetime :rtype: Datetime - :raises: DeserializationError if string format invalid. + :raises DeserializationError: if string format invalid. """ if isinstance(attr, ET.Element): attr = attr.text try: parsed_date = email.utils.parsedate_tz(attr) # type: ignore date_obj = datetime.datetime( - *parsed_date[:6], tzinfo=_FixedOffset(datetime.timedelta(minutes=(parsed_date[9] or 0) / 60)) + *parsed_date[:6], tzinfo=datetime.timezone(datetime.timedelta(minutes=(parsed_date[9] or 0) / 60)) ) if not date_obj.tzinfo: date_obj = date_obj.astimezone(tz=TZ_UTC) except ValueError as err: msg = "Cannot deserialize to rfc datetime object." raise DeserializationError(msg) from err - else: - return date_obj + return date_obj @staticmethod def deserialize_iso(attr): """Deserialize ISO-8601 formatted string into Datetime object. :param str attr: response string to be deserialized. + :return: Deserialized ISO datetime :rtype: Datetime - :raises: DeserializationError if string format invalid. + :raises DeserializationError: if string format invalid. """ if isinstance(attr, ET.Element): attr = attr.text @@ -1981,8 +2152,7 @@ def deserialize_iso(attr): except (ValueError, OverflowError, AttributeError) as err: msg = "Cannot deserialize datetime object." raise DeserializationError(msg) from err - else: - return date_obj + return date_obj @staticmethod def deserialize_unix(attr): @@ -1990,8 +2160,9 @@ def deserialize_unix(attr): This is represented as seconds. :param int attr: Object to be serialized. + :return: Deserialized datetime :rtype: Datetime - :raises: DeserializationError if format invalid + :raises DeserializationError: if format invalid """ if isinstance(attr, ET.Element): attr = int(attr.text) # type: ignore @@ -2001,5 +2172,4 @@ def deserialize_unix(attr): except ValueError as err: msg = "Cannot deserialize to unix datetime object." raise DeserializationError(msg) from err - else: - return date_obj + return date_obj diff --git a/sdk/contentsafety/azure-ai-contentsafety/azure/ai/contentsafety/_utils/utils.py b/sdk/contentsafety/azure-ai-contentsafety/azure/ai/contentsafety/_utils/utils.py new file mode 100644 index 000000000000..35c9c836f85f --- /dev/null +++ b/sdk/contentsafety/azure-ai-contentsafety/azure/ai/contentsafety/_utils/utils.py @@ -0,0 +1,25 @@ +# -------------------------------------------------------------------------- +# Copyright (c) Microsoft Corporation. All rights reserved. +# Licensed under the MIT License. See License.txt in the project root for license information. +# Code generated by Microsoft (R) Python Code Generator. +# Changes may cause incorrect behavior and will be lost if the code is regenerated. +# -------------------------------------------------------------------------- + +from abc import ABC +from typing import Generic, TYPE_CHECKING, TypeVar + +if TYPE_CHECKING: + from .serialization import Deserializer, Serializer + + +TClient = TypeVar("TClient") +TConfig = TypeVar("TConfig") + + +class ClientMixinABC(ABC, Generic[TClient, TConfig]): + """DO NOT use this class. It is for internal typing use only.""" + + _client: TClient + _config: TConfig + _serialize: "Serializer" + _deserialize: "Deserializer" diff --git a/sdk/contentsafety/azure-ai-contentsafety/azure/ai/contentsafety/_validation.py b/sdk/contentsafety/azure-ai-contentsafety/azure/ai/contentsafety/_validation.py new file mode 100644 index 000000000000..f5af3a4eb8a2 --- /dev/null +++ b/sdk/contentsafety/azure-ai-contentsafety/azure/ai/contentsafety/_validation.py @@ -0,0 +1,66 @@ +# -------------------------------------------------------------------------- +# Copyright (c) Microsoft Corporation. All rights reserved. +# Licensed under the MIT License. See License.txt in the project root for license information. +# Code generated by Microsoft (R) Python Code Generator. +# Changes may cause incorrect behavior and will be lost if the code is regenerated. +# -------------------------------------------------------------------------- +import functools + + +def api_version_validation(**kwargs): + params_added_on = kwargs.pop("params_added_on", {}) + method_added_on = kwargs.pop("method_added_on", "") + api_versions_list = kwargs.pop("api_versions_list", []) + + def _index_with_default(value: str, default: int = -1) -> int: + """Get the index of value in lst, or return default if not found. + + :param value: The value to search for in the api_versions_list. + :type value: str + :param default: The default value to return if the value is not found. + :type default: int + :return: The index of the value in the list, or the default value if not found. + :rtype: int + """ + try: + return api_versions_list.index(value) + except ValueError: + return default + + def decorator(func): + @functools.wraps(func) + def wrapper(*args, **kwargs): + try: + # this assumes the client has an _api_version attribute + client = args[0] + client_api_version = client._config.api_version # pylint: disable=protected-access + except AttributeError: + return func(*args, **kwargs) + + if _index_with_default(method_added_on) > _index_with_default(client_api_version): + raise ValueError( + f"'{func.__name__}' is not available in API version " + f"{client_api_version}. Pass service API version {method_added_on} or newer to your client." + ) + + unsupported = { + parameter: api_version + for api_version, parameters in params_added_on.items() + for parameter in parameters + if parameter in kwargs and _index_with_default(api_version) > _index_with_default(client_api_version) + } + if unsupported: + raise ValueError( + "".join( + [ + f"'{param}' is not available in API version {client_api_version}. " + f"Use service API version {version} or newer.\n" + for param, version in unsupported.items() + ] + ) + ) + return func(*args, **kwargs) + + return wrapper + + return decorator diff --git a/sdk/contentsafety/azure-ai-contentsafety/azure/ai/contentsafety/_vendor.py b/sdk/contentsafety/azure-ai-contentsafety/azure/ai/contentsafety/_vendor.py deleted file mode 100644 index 3a907524ca0c..000000000000 --- a/sdk/contentsafety/azure-ai-contentsafety/azure/ai/contentsafety/_vendor.py +++ /dev/null @@ -1,35 +0,0 @@ -# -------------------------------------------------------------------------- -# Copyright (c) Microsoft Corporation. All rights reserved. -# Licensed under the MIT License. See License.txt in the project root for license information. -# Code generated by Microsoft (R) Python Code Generator. -# Changes may cause incorrect behavior and will be lost if the code is regenerated. -# -------------------------------------------------------------------------- - -from abc import ABC -from typing import TYPE_CHECKING - -from ._configuration import BlocklistClientConfiguration, ContentSafetyClientConfiguration - -if TYPE_CHECKING: - # pylint: disable=unused-import,ungrouped-imports - from azure.core import PipelineClient - - from ._serialization import Deserializer, Serializer - - -class ContentSafetyClientMixinABC(ABC): - """DO NOT use this class. It is for internal typing use only.""" - - _client: "PipelineClient" - _config: ContentSafetyClientConfiguration - _serialize: "Serializer" - _deserialize: "Deserializer" - - -class BlocklistClientMixinABC(ABC): - """DO NOT use this class. It is for internal typing use only.""" - - _client: "PipelineClient" - _config: BlocklistClientConfiguration - _serialize: "Serializer" - _deserialize: "Deserializer" diff --git a/sdk/contentsafety/azure-ai-contentsafety/azure/ai/contentsafety/_version.py b/sdk/contentsafety/azure-ai-contentsafety/azure/ai/contentsafety/_version.py index 0ec13ea52bbf..a1f432eddc4e 100644 --- a/sdk/contentsafety/azure-ai-contentsafety/azure/ai/contentsafety/_version.py +++ b/sdk/contentsafety/azure-ai-contentsafety/azure/ai/contentsafety/_version.py @@ -6,4 +6,4 @@ # Changes may cause incorrect behavior and will be lost if the code is regenerated. # -------------------------------------------------------------------------- -VERSION = "1.0.0" +VERSION = "1.1.0b1" diff --git a/sdk/contentsafety/azure-ai-contentsafety/azure/ai/contentsafety/aio/__init__.py b/sdk/contentsafety/azure-ai-contentsafety/azure/ai/contentsafety/aio/__init__.py index 93236600dc7b..3ba848ea5acd 100644 --- a/sdk/contentsafety/azure-ai-contentsafety/azure/ai/contentsafety/aio/__init__.py +++ b/sdk/contentsafety/azure-ai-contentsafety/azure/ai/contentsafety/aio/__init__.py @@ -5,21 +5,29 @@ # Code generated by Microsoft (R) Python Code Generator. # Changes may cause incorrect behavior and will be lost if the code is regenerated. # -------------------------------------------------------------------------- +# pylint: disable=wrong-import-position -from ._client import ContentSafetyClient -from ._client import BlocklistClient +from typing import TYPE_CHECKING + +if TYPE_CHECKING: + from ._patch import * # pylint: disable=unused-wildcard-import + +from ._client import ContentSafetyClient # type: ignore +from ._client import ContentProvenanceClient # type: ignore +from ._client import BlocklistClient # type: ignore try: from ._patch import __all__ as _patch_all - from ._patch import * # pylint: disable=unused-wildcard-import + from ._patch import * except ImportError: _patch_all = [] from ._patch import patch_sdk as _patch_sdk __all__ = [ "ContentSafetyClient", + "ContentProvenanceClient", "BlocklistClient", ] -__all__.extend([p for p in _patch_all if p not in __all__]) +__all__.extend([p for p in _patch_all if p not in __all__]) # pyright: ignore _patch_sdk() diff --git a/sdk/contentsafety/azure-ai-contentsafety/azure/ai/contentsafety/aio/_client.py b/sdk/contentsafety/azure-ai-contentsafety/azure/ai/contentsafety/aio/_client.py index 5b3f2b75f678..19d2c1f2cdec 100644 --- a/sdk/contentsafety/azure-ai-contentsafety/azure/ai/contentsafety/aio/_client.py +++ b/sdk/contentsafety/azure-ai-contentsafety/azure/ai/contentsafety/aio/_client.py @@ -7,6 +7,7 @@ # -------------------------------------------------------------------------- from copy import deepcopy +import sys from typing import Any, Awaitable, TYPE_CHECKING, Union from azure.core import AsyncPipelineClient @@ -14,27 +15,41 @@ from azure.core.pipeline import policies from azure.core.rest import AsyncHttpResponse, HttpRequest -from .._serialization import Deserializer, Serializer -from ._configuration import BlocklistClientConfiguration, ContentSafetyClientConfiguration -from ._operations import BlocklistClientOperationsMixin, ContentSafetyClientOperationsMixin +from .._utils.serialization import Deserializer, Serializer +from ._configuration import ( + BlocklistClientConfiguration, + ContentProvenanceClientConfiguration, + ContentSafetyClientConfiguration, +) +from ._operations import ( + _BlocklistClientOperationsMixin, + _ContentProvenanceClientOperationsMixin, + _ContentSafetyClientOperationsMixin, +) + +if sys.version_info >= (3, 11): + from typing import Self +else: + from typing_extensions import Self # type: ignore if TYPE_CHECKING: - # pylint: disable=unused-import,ungrouped-imports from azure.core.credentials_async import AsyncTokenCredential -class ContentSafetyClient(ContentSafetyClientOperationsMixin): # pylint: disable=client-accepts-api-version-keyword +class ContentSafetyClient(_ContentSafetyClientOperationsMixin): """ContentSafetyClient. :param endpoint: Supported Cognitive Services endpoints (protocol and hostname, for example: - https://:code:``.cognitiveservices.azure.com). Required. + https://.cognitiveservices.azure.com). Required. :type endpoint: str - :param credential: Credential needed for the client to connect to Azure. Is either a - AzureKeyCredential type or a TokenCredential type. Required. + :param credential: Credential used to authenticate requests to the service. Is either a key + credential type or a token credential type. Required. :type credential: ~azure.core.credentials.AzureKeyCredential or ~azure.core.credentials_async.AsyncTokenCredential - :keyword api_version: The API version to use for this operation. Default value is "2023-10-01". - Note that overriding this default value may result in unsupported behavior. + :keyword api_version: The API version to use for this operation. Known values are + "2026-07-01-preview" and None. Default value is None. If not set, the operation's default API + version will be used. Note that overriding this default value may result in unsupported + behavior. :paramtype api_version: str """ @@ -43,6 +58,94 @@ def __init__( ) -> None: _endpoint = "{endpoint}/contentsafety" self._config = ContentSafetyClientConfiguration(endpoint=endpoint, credential=credential, **kwargs) + + _policies = kwargs.pop("policies", None) + if _policies is None: + _policies = [ + policies.RequestIdPolicy(**kwargs), + self._config.headers_policy, + self._config.user_agent_policy, + self._config.proxy_policy, + policies.ContentDecodePolicy(**kwargs), + self._config.redirect_policy, + self._config.retry_policy, + self._config.authentication_policy, + self._config.custom_hook_policy, + self._config.logging_policy, + policies.DistributedTracingPolicy(**kwargs), + policies.SensitiveHeaderCleanupPolicy(**kwargs) if self._config.redirect_policy else None, + self._config.http_logging_policy, + ] + self._client: AsyncPipelineClient = AsyncPipelineClient(base_url=_endpoint, policies=_policies, **kwargs) + + self._serialize = Serializer() + self._deserialize = Deserializer() + self._serialize.client_side_validation = False + + def send_request( + self, request: HttpRequest, *, stream: bool = False, **kwargs: Any + ) -> Awaitable[AsyncHttpResponse]: + """Runs the network request through the client's chained policies. + + >>> from azure.core.rest import HttpRequest + >>> request = HttpRequest("GET", "https://www.example.org/") + + >>> response = await client.send_request(request) + + + For more information on this code flow, see https://aka.ms/azsdk/dpcodegen/python/send_request + + :param request: The network request you want to make. Required. + :type request: ~azure.core.rest.HttpRequest + :keyword bool stream: Whether the response payload will be streamed. Defaults to False. + :return: The response of your network call. Does not do error handling on your response. + :rtype: ~azure.core.rest.AsyncHttpResponse + """ + + request_copy = deepcopy(request) + path_format_arguments = { + "endpoint": self._serialize.url("self._config.endpoint", self._config.endpoint, "str", skip_quote=True), + } + + request_copy.url = self._client.format_url(request_copy.url, **path_format_arguments) + return self._client.send_request(request_copy, stream=stream, **kwargs) # type: ignore + + async def close(self) -> None: + await self._client.close() + + async def __aenter__(self) -> Self: + await self._client.__aenter__() + return self + + async def __aexit__(self, *exc_details: Any) -> None: + await self._client.__aexit__(*exc_details) + + +class ContentProvenanceClient(_ContentProvenanceClientOperationsMixin): + """ContentProvenanceClient. + + :param endpoint: Supported Cognitive Services endpoints (protocol and hostname, for example: + https://.cognitiveservices.azure.com). Required. + :type endpoint: str + :param credential: Credential used to authenticate requests to the service. Is either a key + credential type or a token credential type. Required. + :type credential: ~azure.core.credentials.AzureKeyCredential or + ~azure.core.credentials_async.AsyncTokenCredential + :keyword api_version: The API version to use for this operation. Known values are + "2026-07-01-preview" and None. Default value is None. If not set, the operation's default API + version will be used. Note that overriding this default value may result in unsupported + behavior. + :paramtype api_version: str + :keyword int polling_interval: Default waiting time between two polls for LRO operations if no + Retry-After header is present. + """ + + def __init__( + self, endpoint: str, credential: Union[AzureKeyCredential, "AsyncTokenCredential"], **kwargs: Any + ) -> None: + _endpoint = "{endpoint}/contentsafety" + self._config = ContentProvenanceClientConfiguration(endpoint=endpoint, credential=credential, **kwargs) + _policies = kwargs.pop("policies", None) if _policies is None: _policies = [ @@ -97,7 +200,7 @@ def send_request( async def close(self) -> None: await self._client.close() - async def __aenter__(self) -> "ContentSafetyClient": + async def __aenter__(self) -> Self: await self._client.__aenter__() return self @@ -105,18 +208,20 @@ async def __aexit__(self, *exc_details: Any) -> None: await self._client.__aexit__(*exc_details) -class BlocklistClient(BlocklistClientOperationsMixin): # pylint: disable=client-accepts-api-version-keyword +class BlocklistClient(_BlocklistClientOperationsMixin): """BlocklistClient. :param endpoint: Supported Cognitive Services endpoints (protocol and hostname, for example: - https://:code:``.cognitiveservices.azure.com). Required. + https://.cognitiveservices.azure.com). Required. :type endpoint: str - :param credential: Credential needed for the client to connect to Azure. Is either a - AzureKeyCredential type or a TokenCredential type. Required. + :param credential: Credential used to authenticate requests to the service. Is either a key + credential type or a token credential type. Required. :type credential: ~azure.core.credentials.AzureKeyCredential or ~azure.core.credentials_async.AsyncTokenCredential - :keyword api_version: The API version to use for this operation. Default value is "2023-10-01". - Note that overriding this default value may result in unsupported behavior. + :keyword api_version: The API version to use for this operation. Known values are + "2026-07-01-preview" and None. Default value is None. If not set, the operation's default API + version will be used. Note that overriding this default value may result in unsupported + behavior. :paramtype api_version: str """ @@ -125,6 +230,7 @@ def __init__( ) -> None: _endpoint = "{endpoint}/contentsafety" self._config = BlocklistClientConfiguration(endpoint=endpoint, credential=credential, **kwargs) + _policies = kwargs.pop("policies", None) if _policies is None: _policies = [ @@ -179,7 +285,7 @@ def send_request( async def close(self) -> None: await self._client.close() - async def __aenter__(self) -> "BlocklistClient": + async def __aenter__(self) -> Self: await self._client.__aenter__() return self diff --git a/sdk/contentsafety/azure-ai-contentsafety/azure/ai/contentsafety/aio/_configuration.py b/sdk/contentsafety/azure-ai-contentsafety/azure/ai/contentsafety/aio/_configuration.py index c19698582c6d..15967c598dc8 100644 --- a/sdk/contentsafety/azure-ai-contentsafety/azure/ai/contentsafety/aio/_configuration.py +++ b/sdk/contentsafety/azure-ai-contentsafety/azure/ai/contentsafety/aio/_configuration.py @@ -14,32 +14,33 @@ from .._version import VERSION if TYPE_CHECKING: - # pylint: disable=unused-import,ungrouped-imports from azure.core.credentials_async import AsyncTokenCredential -class ContentSafetyClientConfiguration: # pylint: disable=too-many-instance-attributes,name-too-long +class ContentSafetyClientConfiguration: # pylint: disable=too-many-instance-attributes """Configuration for ContentSafetyClient. Note that all parameters used to create this instance are saved as instance attributes. :param endpoint: Supported Cognitive Services endpoints (protocol and hostname, for example: - https://:code:``.cognitiveservices.azure.com). Required. + https://.cognitiveservices.azure.com). Required. :type endpoint: str - :param credential: Credential needed for the client to connect to Azure. Is either a - AzureKeyCredential type or a TokenCredential type. Required. + :param credential: Credential used to authenticate requests to the service. Is either a key + credential type or a token credential type. Required. :type credential: ~azure.core.credentials.AzureKeyCredential or ~azure.core.credentials_async.AsyncTokenCredential - :keyword api_version: The API version to use for this operation. Default value is "2023-10-01". - Note that overriding this default value may result in unsupported behavior. + :keyword api_version: The API version to use for this operation. Known values are + "2026-07-01-preview" and None. Default value is None. If not set, the operation's default API + version will be used. Note that overriding this default value may result in unsupported + behavior. :paramtype api_version: str """ def __init__( self, endpoint: str, credential: Union[AzureKeyCredential, "AsyncTokenCredential"], **kwargs: Any ) -> None: - api_version: str = kwargs.pop("api_version", "2023-10-01") + api_version: str = kwargs.pop("api_version", "2026-07-01-preview") if endpoint is None: raise ValueError("Parameter 'endpoint' must not be None.") @@ -75,28 +76,89 @@ def _configure(self, **kwargs: Any) -> None: self.authentication_policy = self._infer_policy(**kwargs) -class BlocklistClientConfiguration: # pylint: disable=too-many-instance-attributes,name-too-long +class ContentProvenanceClientConfiguration: # pylint: disable=too-many-instance-attributes + """Configuration for ContentProvenanceClient. + + Note that all parameters used to create this instance are saved as instance + attributes. + + :param endpoint: Supported Cognitive Services endpoints (protocol and hostname, for example: + https://.cognitiveservices.azure.com). Required. + :type endpoint: str + :param credential: Credential used to authenticate requests to the service. Is either a key + credential type or a token credential type. Required. + :type credential: ~azure.core.credentials.AzureKeyCredential or + ~azure.core.credentials_async.AsyncTokenCredential + :keyword api_version: The API version to use for this operation. Known values are + "2026-07-01-preview" and None. Default value is None. If not set, the operation's default API + version will be used. Note that overriding this default value may result in unsupported + behavior. + :paramtype api_version: str + """ + + def __init__( + self, endpoint: str, credential: Union[AzureKeyCredential, "AsyncTokenCredential"], **kwargs: Any + ) -> None: + api_version: str = kwargs.pop("api_version", "2026-07-01-preview") + + if endpoint is None: + raise ValueError("Parameter 'endpoint' must not be None.") + if credential is None: + raise ValueError("Parameter 'credential' must not be None.") + + self.endpoint = endpoint + self.credential = credential + self.api_version = api_version + self.credential_scopes = kwargs.pop("credential_scopes", ["https://cognitiveservices.azure.com/.default"]) + kwargs.setdefault("sdk_moniker", "ai-contentsafety/{}".format(VERSION)) + self.polling_interval = kwargs.get("polling_interval", 30) + self._configure(**kwargs) + + def _infer_policy(self, **kwargs): + if isinstance(self.credential, AzureKeyCredential): + return policies.AzureKeyCredentialPolicy(self.credential, "Ocp-Apim-Subscription-Key", **kwargs) + if hasattr(self.credential, "get_token"): + return policies.AsyncBearerTokenCredentialPolicy(self.credential, *self.credential_scopes, **kwargs) + raise TypeError(f"Unsupported credential: {self.credential}") + + def _configure(self, **kwargs: Any) -> None: + self.user_agent_policy = kwargs.get("user_agent_policy") or policies.UserAgentPolicy(**kwargs) + self.headers_policy = kwargs.get("headers_policy") or policies.HeadersPolicy(**kwargs) + self.proxy_policy = kwargs.get("proxy_policy") or policies.ProxyPolicy(**kwargs) + self.logging_policy = kwargs.get("logging_policy") or policies.NetworkTraceLoggingPolicy(**kwargs) + self.http_logging_policy = kwargs.get("http_logging_policy") or policies.HttpLoggingPolicy(**kwargs) + self.custom_hook_policy = kwargs.get("custom_hook_policy") or policies.CustomHookPolicy(**kwargs) + self.redirect_policy = kwargs.get("redirect_policy") or policies.AsyncRedirectPolicy(**kwargs) + self.retry_policy = kwargs.get("retry_policy") or policies.AsyncRetryPolicy(**kwargs) + self.authentication_policy = kwargs.get("authentication_policy") + if self.credential and not self.authentication_policy: + self.authentication_policy = self._infer_policy(**kwargs) + + +class BlocklistClientConfiguration: # pylint: disable=too-many-instance-attributes """Configuration for BlocklistClient. Note that all parameters used to create this instance are saved as instance attributes. :param endpoint: Supported Cognitive Services endpoints (protocol and hostname, for example: - https://:code:``.cognitiveservices.azure.com). Required. + https://.cognitiveservices.azure.com). Required. :type endpoint: str - :param credential: Credential needed for the client to connect to Azure. Is either a - AzureKeyCredential type or a TokenCredential type. Required. + :param credential: Credential used to authenticate requests to the service. Is either a key + credential type or a token credential type. Required. :type credential: ~azure.core.credentials.AzureKeyCredential or ~azure.core.credentials_async.AsyncTokenCredential - :keyword api_version: The API version to use for this operation. Default value is "2023-10-01". - Note that overriding this default value may result in unsupported behavior. + :keyword api_version: The API version to use for this operation. Known values are + "2026-07-01-preview" and None. Default value is None. If not set, the operation's default API + version will be used. Note that overriding this default value may result in unsupported + behavior. :paramtype api_version: str """ def __init__( self, endpoint: str, credential: Union[AzureKeyCredential, "AsyncTokenCredential"], **kwargs: Any ) -> None: - api_version: str = kwargs.pop("api_version", "2023-10-01") + api_version: str = kwargs.pop("api_version", "2026-07-01-preview") if endpoint is None: raise ValueError("Parameter 'endpoint' must not be None.") diff --git a/sdk/contentsafety/azure-ai-contentsafety/azure/ai/contentsafety/aio/_operations/__init__.py b/sdk/contentsafety/azure-ai-contentsafety/azure/ai/contentsafety/aio/_operations/__init__.py index 2f88364a4715..531d9a52f3f1 100644 --- a/sdk/contentsafety/azure-ai-contentsafety/azure/ai/contentsafety/aio/_operations/__init__.py +++ b/sdk/contentsafety/azure-ai-contentsafety/azure/ai/contentsafety/aio/_operations/__init__.py @@ -5,17 +5,21 @@ # Code generated by Microsoft (R) Python Code Generator. # Changes may cause incorrect behavior and will be lost if the code is regenerated. # -------------------------------------------------------------------------- +# pylint: disable=wrong-import-position -from ._operations import ContentSafetyClientOperationsMixin -from ._operations import BlocklistClientOperationsMixin +from typing import TYPE_CHECKING + +if TYPE_CHECKING: + from ._patch import * # pylint: disable=unused-wildcard-import + +from ._operations import _ContentSafetyClientOperationsMixin # type: ignore # pylint: disable=unused-import +from ._operations import _ContentProvenanceClientOperationsMixin # type: ignore # pylint: disable=unused-import +from ._operations import _BlocklistClientOperationsMixin # type: ignore # pylint: disable=unused-import from ._patch import __all__ as _patch_all -from ._patch import * # pylint: disable=unused-wildcard-import +from ._patch import * from ._patch import patch_sdk as _patch_sdk -__all__ = [ - "ContentSafetyClientOperationsMixin", - "BlocklistClientOperationsMixin", -] -__all__.extend([p for p in _patch_all if p not in __all__]) +__all__ = [] +__all__.extend([p for p in _patch_all if p not in __all__]) # pyright: ignore _patch_sdk() diff --git a/sdk/contentsafety/azure-ai-contentsafety/azure/ai/contentsafety/aio/_operations/_operations.py b/sdk/contentsafety/azure-ai-contentsafety/azure/ai/contentsafety/aio/_operations/_operations.py index 51040e157e2b..0cf7e536260b 100644 --- a/sdk/contentsafety/azure-ai-contentsafety/azure/ai/contentsafety/aio/_operations/_operations.py +++ b/sdk/contentsafety/azure-ai-contentsafety/azure/ai/contentsafety/aio/_operations/_operations.py @@ -1,4 +1,4 @@ -# pylint: disable=too-many-lines +# pylint: disable=line-too-long,useless-suppression,too-many-lines # coding=utf-8 # -------------------------------------------------------------------------- # Copyright (c) Microsoft Corporation. All rights reserved. @@ -6,12 +6,13 @@ # Code generated by Microsoft (R) Python Code Generator. # Changes may cause incorrect behavior and will be lost if the code is regenerated. # -------------------------------------------------------------------------- +from collections.abc import MutableMapping from io import IOBase import json -import sys -from typing import Any, AsyncIterable, Callable, Dict, IO, List, Optional, TypeVar, Union, overload +from typing import Any, AsyncIterator, Callable, IO, Optional, TypeVar, Union, cast, overload import urllib.parse +from azure.core import AsyncPipelineClient from azure.core.async_paging import AsyncItemPaged, AsyncList from azure.core.exceptions import ( ClientAuthenticationError, @@ -19,16 +20,19 @@ ResourceExistsError, ResourceNotFoundError, ResourceNotModifiedError, + StreamClosedError, + StreamConsumedError, map_error, ) from azure.core.pipeline import PipelineResponse +from azure.core.polling import AsyncLROPoller, AsyncNoPolling, AsyncPollingMethod +from azure.core.polling.async_base_polling import AsyncLROBasePolling from azure.core.rest import AsyncHttpResponse, HttpRequest from azure.core.tracing.decorator import distributed_trace from azure.core.tracing.decorator_async import distributed_trace_async from azure.core.utils import case_insensitive_dict -from ... import models as _models -from ..._model_base import SdkJSONEncoder, _deserialize +from ... import models as _models, types as _types from ..._operations._operations import ( build_blocklist_add_or_update_blocklist_items_request, build_blocklist_create_or_update_text_blocklist_request, @@ -38,21 +42,164 @@ build_blocklist_list_text_blocklist_items_request, build_blocklist_list_text_blocklists_request, build_blocklist_remove_blocklist_items_request, + build_content_provenance_detect_request, + build_content_provenance_get_operation_status_request, build_content_safety_analyze_image_request, build_content_safety_analyze_text_request, + build_content_safety_detect_text_protected_material_request, + build_content_safety_shield_prompt_request, +) +from ..._utils.model_base import SdkJSONEncoder, _deserialize +from ..._utils.utils import ClientMixinABC +from ..._validation import api_version_validation +from .._configuration import ( + BlocklistClientConfiguration, + ContentProvenanceClientConfiguration, + ContentSafetyClientConfiguration, ) -from .._vendor import BlocklistClientMixinABC, ContentSafetyClientMixinABC -if sys.version_info >= (3, 9): - from collections.abc import MutableMapping -else: - from typing import MutableMapping # type: ignore # pylint: disable=ungrouped-imports -JSON = MutableMapping[str, Any] # pylint: disable=unsubscriptable-object T = TypeVar("T") -ClsType = Optional[Callable[[PipelineResponse[HttpRequest, AsyncHttpResponse], T, Dict[str, Any]], Any]] +ClsType = Optional[Callable[[PipelineResponse[HttpRequest, AsyncHttpResponse], T, dict[str, Any]], Any]] + + +class _ContentSafetyClientOperationsMixin( + ClientMixinABC[AsyncPipelineClient[HttpRequest, AsyncHttpResponse], ContentSafetyClientConfiguration] +): + + @overload + async def analyze_image( + self, options: _models.AnalyzeImageOptions, *, content_type: str = "application/json", **kwargs: Any + ) -> _models.AnalyzeImageResult: + """Analyze Image. + + A synchronous API for the analysis of potentially harmful image content. Currently, it supports + four categories: Hate, SelfHarm, Sexual, and Violence. + + :param options: The image analysis request. Required. + :type options: ~azure.ai.contentsafety.models.AnalyzeImageOptions + :keyword content_type: Body Parameter content-type. Content type parameter for JSON body. + Default value is "application/json". + :paramtype content_type: str + :return: AnalyzeImageResult. The AnalyzeImageResult is compatible with MutableMapping + :rtype: ~azure.ai.contentsafety.models.AnalyzeImageResult + :raises ~azure.core.exceptions.HttpResponseError: + """ + + @overload + async def analyze_image( + self, options: _types.AnalyzeImageOptions, *, content_type: str = "application/json", **kwargs: Any + ) -> _models.AnalyzeImageResult: + """Analyze Image. + + A synchronous API for the analysis of potentially harmful image content. Currently, it supports + four categories: Hate, SelfHarm, Sexual, and Violence. + :param options: The image analysis request. Required. + :type options: ~azure.ai.contentsafety.types.AnalyzeImageOptions + :keyword content_type: Body Parameter content-type. Content type parameter for JSON body. + Default value is "application/json". + :paramtype content_type: str + :return: AnalyzeImageResult. The AnalyzeImageResult is compatible with MutableMapping + :rtype: ~azure.ai.contentsafety.models.AnalyzeImageResult + :raises ~azure.core.exceptions.HttpResponseError: + """ + + @overload + async def analyze_image( + self, options: IO[bytes], *, content_type: str = "application/json", **kwargs: Any + ) -> _models.AnalyzeImageResult: + """Analyze Image. + + A synchronous API for the analysis of potentially harmful image content. Currently, it supports + four categories: Hate, SelfHarm, Sexual, and Violence. + + :param options: The image analysis request. Required. + :type options: IO[bytes] + :keyword content_type: Body Parameter content-type. Content type parameter for binary body. + Default value is "application/json". + :paramtype content_type: str + :return: AnalyzeImageResult. The AnalyzeImageResult is compatible with MutableMapping + :rtype: ~azure.ai.contentsafety.models.AnalyzeImageResult + :raises ~azure.core.exceptions.HttpResponseError: + """ + + @distributed_trace_async + async def analyze_image( + self, options: Union[_models.AnalyzeImageOptions, _types.AnalyzeImageOptions, IO[bytes]], **kwargs: Any + ) -> _models.AnalyzeImageResult: + """Analyze Image. + + A synchronous API for the analysis of potentially harmful image content. Currently, it supports + four categories: Hate, SelfHarm, Sexual, and Violence. + + :param options: The image analysis request. Is either a AnalyzeImageOptions type or a IO[bytes] + type. Required. + :type options: ~azure.ai.contentsafety.models.AnalyzeImageOptions or + ~azure.ai.contentsafety.types.AnalyzeImageOptions or IO[bytes] + :return: AnalyzeImageResult. The AnalyzeImageResult is compatible with MutableMapping + :rtype: ~azure.ai.contentsafety.models.AnalyzeImageResult + :raises ~azure.core.exceptions.HttpResponseError: + """ + error_map: MutableMapping = { + 401: ClientAuthenticationError, + 404: ResourceNotFoundError, + 409: ResourceExistsError, + 304: ResourceNotModifiedError, + } + error_map.update(kwargs.pop("error_map", {}) or {}) + + _headers = case_insensitive_dict(kwargs.pop("headers", {}) or {}) + _params = kwargs.pop("params", {}) or {} + + content_type: Optional[str] = kwargs.pop("content_type", _headers.pop("Content-Type", None)) + cls: ClsType[_models.AnalyzeImageResult] = kwargs.pop("cls", None) + + content_type = content_type or "application/json" + _content = None + if isinstance(options, (IOBase, bytes)): + _content = options + else: + _content = json.dumps(options, cls=SdkJSONEncoder, exclude_readonly=True) # type: ignore + + _request = build_content_safety_analyze_image_request( + content_type=content_type, + api_version=self._config.api_version, + content=_content, + headers=_headers, + params=_params, + ) + path_format_arguments = { + "endpoint": self._serialize.url("self._config.endpoint", self._config.endpoint, "str", skip_quote=True), + } + _request.url = self._client.format_url(_request.url, **path_format_arguments) + + _decompress = kwargs.pop("decompress", True) + _stream = kwargs.pop("stream", False) + pipeline_response: PipelineResponse = await self._client._pipeline.run( # type: ignore # pylint: disable=protected-access + _request, stream=_stream, **kwargs + ) + + response = pipeline_response.http_response + + if response.status_code not in [200]: + if _stream: + try: + await response.read() # Load the body in memory and close the socket + except (StreamConsumedError, StreamClosedError): + pass + map_error(status_code=response.status_code, response=response, error_map=error_map) + raise HttpResponseError(response=response) + + if _stream: + deserialized = response.iter_bytes() if _decompress else response.iter_raw() + else: + deserialized = _deserialize(_models.AnalyzeImageResult, response.json()) + + if cls: + return cls(pipeline_response, deserialized, {}) # type: ignore + + return deserialized # type: ignore -class ContentSafetyClientOperationsMixin(ContentSafetyClientMixinABC): @overload async def analyze_text( self, options: _models.AnalyzeTextOptions, *, content_type: str = "application/json", **kwargs: Any @@ -67,8 +214,6 @@ async def analyze_text( :keyword content_type: Body Parameter content-type. Content type parameter for JSON body. Default value is "application/json". :paramtype content_type: str - :keyword bool stream: Whether to stream the response of this operation. Defaults to False. You - will have to context manage the returned stream. :return: AnalyzeTextResult. The AnalyzeTextResult is compatible with MutableMapping :rtype: ~azure.ai.contentsafety.models.AnalyzeTextResult :raises ~azure.core.exceptions.HttpResponseError: @@ -76,7 +221,7 @@ async def analyze_text( @overload async def analyze_text( - self, options: JSON, *, content_type: str = "application/json", **kwargs: Any + self, options: _types.AnalyzeTextOptions, *, content_type: str = "application/json", **kwargs: Any ) -> _models.AnalyzeTextResult: """Analyze Text. @@ -84,12 +229,10 @@ async def analyze_text( four categories: Hate, SelfHarm, Sexual, and Violence. :param options: The text analysis request. Required. - :type options: JSON + :type options: ~azure.ai.contentsafety.types.AnalyzeTextOptions :keyword content_type: Body Parameter content-type. Content type parameter for JSON body. Default value is "application/json". :paramtype content_type: str - :keyword bool stream: Whether to stream the response of this operation. Defaults to False. You - will have to context manage the returned stream. :return: AnalyzeTextResult. The AnalyzeTextResult is compatible with MutableMapping :rtype: ~azure.ai.contentsafety.models.AnalyzeTextResult :raises ~azure.core.exceptions.HttpResponseError: @@ -109,8 +252,6 @@ async def analyze_text( :keyword content_type: Body Parameter content-type. Content type parameter for binary body. Default value is "application/json". :paramtype content_type: str - :keyword bool stream: Whether to stream the response of this operation. Defaults to False. You - will have to context manage the returned stream. :return: AnalyzeTextResult. The AnalyzeTextResult is compatible with MutableMapping :rtype: ~azure.ai.contentsafety.models.AnalyzeTextResult :raises ~azure.core.exceptions.HttpResponseError: @@ -118,26 +259,22 @@ async def analyze_text( @distributed_trace_async async def analyze_text( - self, options: Union[_models.AnalyzeTextOptions, JSON, IO[bytes]], **kwargs: Any + self, options: Union[_models.AnalyzeTextOptions, _types.AnalyzeTextOptions, IO[bytes]], **kwargs: Any ) -> _models.AnalyzeTextResult: """Analyze Text. A synchronous API for the analysis of potentially harmful text content. Currently, it supports four categories: Hate, SelfHarm, Sexual, and Violence. - :param options: The text analysis request. Is one of the following types: AnalyzeTextOptions, - JSON, IO[bytes] Required. - :type options: ~azure.ai.contentsafety.models.AnalyzeTextOptions or JSON or IO[bytes] - :keyword content_type: Body parameter Content-Type. Known values are: application/json. Default - value is None. - :paramtype content_type: str - :keyword bool stream: Whether to stream the response of this operation. Defaults to False. You - will have to context manage the returned stream. + :param options: The text analysis request. Is either a AnalyzeTextOptions type or a IO[bytes] + type. Required. + :type options: ~azure.ai.contentsafety.models.AnalyzeTextOptions or + ~azure.ai.contentsafety.types.AnalyzeTextOptions or IO[bytes] :return: AnalyzeTextResult. The AnalyzeTextResult is compatible with MutableMapping :rtype: ~azure.ai.contentsafety.models.AnalyzeTextResult :raises ~azure.core.exceptions.HttpResponseError: """ - error_map = { + error_map: MutableMapping = { 401: ClientAuthenticationError, 404: ResourceNotFoundError, 409: ResourceExistsError, @@ -170,6 +307,7 @@ async def analyze_text( } _request.url = self._client.format_url(_request.url, **path_format_arguments) + _decompress = kwargs.pop("decompress", True) _stream = kwargs.pop("stream", False) pipeline_response: PipelineResponse = await self._client._pipeline.run( # type: ignore # pylint: disable=protected-access _request, stream=_stream, **kwargs @@ -179,12 +317,15 @@ async def analyze_text( if response.status_code not in [200]: if _stream: - await response.read() # Load the body in memory and close the socket + try: + await response.read() # Load the body in memory and close the socket + except (StreamConsumedError, StreamClosedError): + pass map_error(status_code=response.status_code, response=response, error_map=error_map) raise HttpResponseError(response=response) if _stream: - deserialized = response.iter_bytes() + deserialized = response.iter_bytes() if _decompress else response.iter_raw() else: deserialized = _deserialize(_models.AnalyzeTextResult, response.json()) @@ -194,90 +335,238 @@ async def analyze_text( return deserialized # type: ignore @overload - async def analyze_image( - self, options: _models.AnalyzeImageOptions, *, content_type: str = "application/json", **kwargs: Any - ) -> _models.AnalyzeImageResult: - """Analyze Image. + async def detect_text_protected_material( + self, + options: _models.DetectTextProtectedMaterialOptions, + *, + content_type: str = "application/json", + **kwargs: Any + ) -> _models.DetectTextProtectedMaterialResult: + """Detect Protected Material for Text. - A synchronous API for the analysis of potentially harmful image content. Currently, it supports - four categories: Hate, SelfHarm, Sexual, and Violence. + A synchronous API for detecting protected material in the given text. - :param options: The image analysis request. Required. - :type options: ~azure.ai.contentsafety.models.AnalyzeImageOptions + :param options: The request body to be detected, which may contain protected material. + Required. + :type options: ~azure.ai.contentsafety.models.DetectTextProtectedMaterialOptions :keyword content_type: Body Parameter content-type. Content type parameter for JSON body. Default value is "application/json". :paramtype content_type: str - :keyword bool stream: Whether to stream the response of this operation. Defaults to False. You - will have to context manage the returned stream. - :return: AnalyzeImageResult. The AnalyzeImageResult is compatible with MutableMapping - :rtype: ~azure.ai.contentsafety.models.AnalyzeImageResult + :return: DetectTextProtectedMaterialResult. The DetectTextProtectedMaterialResult is compatible + with MutableMapping + :rtype: ~azure.ai.contentsafety.models.DetectTextProtectedMaterialResult :raises ~azure.core.exceptions.HttpResponseError: """ @overload - async def analyze_image( - self, options: JSON, *, content_type: str = "application/json", **kwargs: Any - ) -> _models.AnalyzeImageResult: - """Analyze Image. + async def detect_text_protected_material( + self, + options: _types.DetectTextProtectedMaterialOptions, + *, + content_type: str = "application/json", + **kwargs: Any + ) -> _models.DetectTextProtectedMaterialResult: + """Detect Protected Material for Text. - A synchronous API for the analysis of potentially harmful image content. Currently, it supports - four categories: Hate, SelfHarm, Sexual, and Violence. + A synchronous API for detecting protected material in the given text. - :param options: The image analysis request. Required. - :type options: JSON + :param options: The request body to be detected, which may contain protected material. + Required. + :type options: ~azure.ai.contentsafety.types.DetectTextProtectedMaterialOptions :keyword content_type: Body Parameter content-type. Content type parameter for JSON body. Default value is "application/json". :paramtype content_type: str - :keyword bool stream: Whether to stream the response of this operation. Defaults to False. You - will have to context manage the returned stream. - :return: AnalyzeImageResult. The AnalyzeImageResult is compatible with MutableMapping - :rtype: ~azure.ai.contentsafety.models.AnalyzeImageResult + :return: DetectTextProtectedMaterialResult. The DetectTextProtectedMaterialResult is compatible + with MutableMapping + :rtype: ~azure.ai.contentsafety.models.DetectTextProtectedMaterialResult :raises ~azure.core.exceptions.HttpResponseError: """ @overload - async def analyze_image( + async def detect_text_protected_material( self, options: IO[bytes], *, content_type: str = "application/json", **kwargs: Any - ) -> _models.AnalyzeImageResult: - """Analyze Image. + ) -> _models.DetectTextProtectedMaterialResult: + """Detect Protected Material for Text. - A synchronous API for the analysis of potentially harmful image content. Currently, it supports - four categories: Hate, SelfHarm, Sexual, and Violence. + A synchronous API for detecting protected material in the given text. - :param options: The image analysis request. Required. + :param options: The request body to be detected, which may contain protected material. + Required. :type options: IO[bytes] :keyword content_type: Body Parameter content-type. Content type parameter for binary body. Default value is "application/json". :paramtype content_type: str - :keyword bool stream: Whether to stream the response of this operation. Defaults to False. You - will have to context manage the returned stream. - :return: AnalyzeImageResult. The AnalyzeImageResult is compatible with MutableMapping - :rtype: ~azure.ai.contentsafety.models.AnalyzeImageResult + :return: DetectTextProtectedMaterialResult. The DetectTextProtectedMaterialResult is compatible + with MutableMapping + :rtype: ~azure.ai.contentsafety.models.DetectTextProtectedMaterialResult :raises ~azure.core.exceptions.HttpResponseError: """ @distributed_trace_async - async def analyze_image( - self, options: Union[_models.AnalyzeImageOptions, JSON, IO[bytes]], **kwargs: Any - ) -> _models.AnalyzeImageResult: - """Analyze Image. + @api_version_validation( + method_added_on="2024-09-01", + params_added_on={"2024-09-01": ["api_version", "content_type", "accept"]}, + api_versions_list=["2024-09-01", "2026-07-01-preview"], + ) + async def detect_text_protected_material( + self, + options: Union[ + _models.DetectTextProtectedMaterialOptions, _types.DetectTextProtectedMaterialOptions, IO[bytes] + ], + **kwargs: Any + ) -> _models.DetectTextProtectedMaterialResult: + """Detect Protected Material for Text. + + A synchronous API for detecting protected material in the given text. + + :param options: The request body to be detected, which may contain protected material. Is + either a DetectTextProtectedMaterialOptions type or a IO[bytes] type. Required. + :type options: ~azure.ai.contentsafety.models.DetectTextProtectedMaterialOptions or + ~azure.ai.contentsafety.types.DetectTextProtectedMaterialOptions or IO[bytes] + :return: DetectTextProtectedMaterialResult. The DetectTextProtectedMaterialResult is compatible + with MutableMapping + :rtype: ~azure.ai.contentsafety.models.DetectTextProtectedMaterialResult + :raises ~azure.core.exceptions.HttpResponseError: + """ + error_map: MutableMapping = { + 401: ClientAuthenticationError, + 404: ResourceNotFoundError, + 409: ResourceExistsError, + 304: ResourceNotModifiedError, + } + error_map.update(kwargs.pop("error_map", {}) or {}) - A synchronous API for the analysis of potentially harmful image content. Currently, it supports - four categories: Hate, SelfHarm, Sexual, and Violence. + _headers = case_insensitive_dict(kwargs.pop("headers", {}) or {}) + _params = kwargs.pop("params", {}) or {} - :param options: The image analysis request. Is one of the following types: AnalyzeImageOptions, - JSON, IO[bytes] Required. - :type options: ~azure.ai.contentsafety.models.AnalyzeImageOptions or JSON or IO[bytes] - :keyword content_type: Body parameter Content-Type. Known values are: application/json. Default - value is None. + content_type: Optional[str] = kwargs.pop("content_type", _headers.pop("Content-Type", None)) + cls: ClsType[_models.DetectTextProtectedMaterialResult] = kwargs.pop("cls", None) + + content_type = content_type or "application/json" + _content = None + if isinstance(options, (IOBase, bytes)): + _content = options + else: + _content = json.dumps(options, cls=SdkJSONEncoder, exclude_readonly=True) # type: ignore + + _request = build_content_safety_detect_text_protected_material_request( + content_type=content_type, + api_version=self._config.api_version, + content=_content, + headers=_headers, + params=_params, + ) + path_format_arguments = { + "endpoint": self._serialize.url("self._config.endpoint", self._config.endpoint, "str", skip_quote=True), + } + _request.url = self._client.format_url(_request.url, **path_format_arguments) + + _decompress = kwargs.pop("decompress", True) + _stream = kwargs.pop("stream", False) + pipeline_response: PipelineResponse = await self._client._pipeline.run( # type: ignore # pylint: disable=protected-access + _request, stream=_stream, **kwargs + ) + + response = pipeline_response.http_response + + if response.status_code not in [200]: + if _stream: + try: + await response.read() # Load the body in memory and close the socket + except (StreamConsumedError, StreamClosedError): + pass + map_error(status_code=response.status_code, response=response, error_map=error_map) + raise HttpResponseError(response=response) + + if _stream: + deserialized = response.iter_bytes() if _decompress else response.iter_raw() + else: + deserialized = _deserialize(_models.DetectTextProtectedMaterialResult, response.json()) + + if cls: + return cls(pipeline_response, deserialized, {}) # type: ignore + + return deserialized # type: ignore + + @overload + async def shield_prompt( + self, options: _models.ShieldPromptOptions, *, content_type: str = "application/json", **kwargs: Any + ) -> _models.ShieldPromptResult: + """Shield Prompt. + + A synchronous API for shielding prompt from direct and indirect injection attacks. + + :param options: The request body to be detected, which may contain direct or indirect injection + attacks. Required. + :type options: ~azure.ai.contentsafety.models.ShieldPromptOptions + :keyword content_type: Body Parameter content-type. Content type parameter for JSON body. + Default value is "application/json". :paramtype content_type: str - :keyword bool stream: Whether to stream the response of this operation. Defaults to False. You - will have to context manage the returned stream. - :return: AnalyzeImageResult. The AnalyzeImageResult is compatible with MutableMapping - :rtype: ~azure.ai.contentsafety.models.AnalyzeImageResult + :return: ShieldPromptResult. The ShieldPromptResult is compatible with MutableMapping + :rtype: ~azure.ai.contentsafety.models.ShieldPromptResult :raises ~azure.core.exceptions.HttpResponseError: """ - error_map = { + + @overload + async def shield_prompt( + self, options: _types.ShieldPromptOptions, *, content_type: str = "application/json", **kwargs: Any + ) -> _models.ShieldPromptResult: + """Shield Prompt. + + A synchronous API for shielding prompt from direct and indirect injection attacks. + + :param options: The request body to be detected, which may contain direct or indirect injection + attacks. Required. + :type options: ~azure.ai.contentsafety.types.ShieldPromptOptions + :keyword content_type: Body Parameter content-type. Content type parameter for JSON body. + Default value is "application/json". + :paramtype content_type: str + :return: ShieldPromptResult. The ShieldPromptResult is compatible with MutableMapping + :rtype: ~azure.ai.contentsafety.models.ShieldPromptResult + :raises ~azure.core.exceptions.HttpResponseError: + """ + + @overload + async def shield_prompt( + self, options: IO[bytes], *, content_type: str = "application/json", **kwargs: Any + ) -> _models.ShieldPromptResult: + """Shield Prompt. + + A synchronous API for shielding prompt from direct and indirect injection attacks. + + :param options: The request body to be detected, which may contain direct or indirect injection + attacks. Required. + :type options: IO[bytes] + :keyword content_type: Body Parameter content-type. Content type parameter for binary body. + Default value is "application/json". + :paramtype content_type: str + :return: ShieldPromptResult. The ShieldPromptResult is compatible with MutableMapping + :rtype: ~azure.ai.contentsafety.models.ShieldPromptResult + :raises ~azure.core.exceptions.HttpResponseError: + """ + + @distributed_trace_async + @api_version_validation( + method_added_on="2024-09-01", + params_added_on={"2024-09-01": ["api_version", "content_type", "accept"]}, + api_versions_list=["2024-09-01", "2026-07-01-preview"], + ) + async def shield_prompt( + self, options: Union[_models.ShieldPromptOptions, _types.ShieldPromptOptions, IO[bytes]], **kwargs: Any + ) -> _models.ShieldPromptResult: + """Shield Prompt. + + A synchronous API for shielding prompt from direct and indirect injection attacks. + + :param options: The request body to be detected, which may contain direct or indirect injection + attacks. Is either a ShieldPromptOptions type or a IO[bytes] type. Required. + :type options: ~azure.ai.contentsafety.models.ShieldPromptOptions or + ~azure.ai.contentsafety.types.ShieldPromptOptions or IO[bytes] + :return: ShieldPromptResult. The ShieldPromptResult is compatible with MutableMapping + :rtype: ~azure.ai.contentsafety.models.ShieldPromptResult + :raises ~azure.core.exceptions.HttpResponseError: + """ + error_map: MutableMapping = { 401: ClientAuthenticationError, 404: ResourceNotFoundError, 409: ResourceExistsError, @@ -289,7 +578,7 @@ async def analyze_image( _params = kwargs.pop("params", {}) or {} content_type: Optional[str] = kwargs.pop("content_type", _headers.pop("Content-Type", None)) - cls: ClsType[_models.AnalyzeImageResult] = kwargs.pop("cls", None) + cls: ClsType[_models.ShieldPromptResult] = kwargs.pop("cls", None) content_type = content_type or "application/json" _content = None @@ -298,7 +587,7 @@ async def analyze_image( else: _content = json.dumps(options, cls=SdkJSONEncoder, exclude_readonly=True) # type: ignore - _request = build_content_safety_analyze_image_request( + _request = build_content_safety_shield_prompt_request( content_type=content_type, api_version=self._config.api_version, content=_content, @@ -310,6 +599,7 @@ async def analyze_image( } _request.url = self._client.format_url(_request.url, **path_format_arguments) + _decompress = kwargs.pop("decompress", True) _stream = kwargs.pop("stream", False) pipeline_response: PipelineResponse = await self._client._pipeline.run( # type: ignore # pylint: disable=protected-access _request, stream=_stream, **kwargs @@ -319,14 +609,17 @@ async def analyze_image( if response.status_code not in [200]: if _stream: - await response.read() # Load the body in memory and close the socket + try: + await response.read() # Load the body in memory and close the socket + except (StreamConsumedError, StreamClosedError): + pass map_error(status_code=response.status_code, response=response, error_map=error_map) raise HttpResponseError(response=response) if _stream: - deserialized = response.iter_bytes() + deserialized = response.iter_bytes() if _decompress else response.iter_raw() else: - deserialized = _deserialize(_models.AnalyzeImageResult, response.json()) + deserialized = _deserialize(_models.ShieldPromptResult, response.json()) if cls: return cls(pipeline_response, deserialized, {}) # type: ignore @@ -334,7 +627,289 @@ async def analyze_image( return deserialized # type: ignore -class BlocklistClientOperationsMixin(BlocklistClientMixinABC): +class _ContentProvenanceClientOperationsMixin( + ClientMixinABC[AsyncPipelineClient[HttpRequest, AsyncHttpResponse], ContentProvenanceClientConfiguration] +): + + async def _detect_initial( + self, options: Union[_models.DetectProvenanceOptions, _types.DetectProvenanceOptions, IO[bytes]], **kwargs: Any + ) -> AsyncIterator[bytes]: + error_map: MutableMapping = { + 401: ClientAuthenticationError, + 404: ResourceNotFoundError, + 409: ResourceExistsError, + 304: ResourceNotModifiedError, + } + error_map.update(kwargs.pop("error_map", {}) or {}) + + _headers = case_insensitive_dict(kwargs.pop("headers", {}) or {}) + _params = kwargs.pop("params", {}) or {} + + content_type: Optional[str] = kwargs.pop("content_type", _headers.pop("Content-Type", None)) + cls: ClsType[AsyncIterator[bytes]] = kwargs.pop("cls", None) + + content_type = content_type or "application/json" + _content = None + if isinstance(options, (IOBase, bytes)): + _content = options + else: + _content = json.dumps(options, cls=SdkJSONEncoder, exclude_readonly=True) # type: ignore + + _request = build_content_provenance_detect_request( + content_type=content_type, + api_version=self._config.api_version, + content=_content, + headers=_headers, + params=_params, + ) + path_format_arguments = { + "endpoint": self._serialize.url("self._config.endpoint", self._config.endpoint, "str", skip_quote=True), + } + _request.url = self._client.format_url(_request.url, **path_format_arguments) + + _decompress = kwargs.pop("decompress", True) + _stream = True + pipeline_response: PipelineResponse = await self._client._pipeline.run( # type: ignore # pylint: disable=protected-access + _request, stream=_stream, **kwargs + ) + + response = pipeline_response.http_response + + if response.status_code not in [202]: + try: + await response.read() # Load the body in memory and close the socket + except (StreamConsumedError, StreamClosedError): + pass + map_error(status_code=response.status_code, response=response, error_map=error_map) + raise HttpResponseError(response=response) + + response_headers = {} + response_headers["Operation-Location"] = self._deserialize("str", response.headers.get("Operation-Location")) + + deserialized = response.iter_bytes() if _decompress else response.iter_raw() + + if cls: + return cls(pipeline_response, deserialized, response_headers) # type: ignore + + return deserialized # type: ignore + + @overload + async def begin_detect( + self, options: _models.DetectProvenanceOptions, *, content_type: str = "application/json", **kwargs: Any + ) -> AsyncLROPoller[_models.DetectProvenanceResult]: + """Start Content Provenance Detection. + + Starts an asynchronous Content Provenance Detection operation that inspects the supplied media + for Microsoft-issued C2PA and imperceptible watermark signals indicating the content was + created or modified using AI. + + :param options: Options describing the media to inspect using Content Provenance Detection. + Required. + :type options: ~azure.ai.contentsafety.models.DetectProvenanceOptions + :keyword content_type: Body Parameter content-type. Content type parameter for JSON body. + Default value is "application/json". + :paramtype content_type: str + :return: An instance of AsyncLROPoller that returns DetectProvenanceResult. The + DetectProvenanceResult is compatible with MutableMapping + :rtype: + ~azure.core.polling.AsyncLROPoller[~azure.ai.contentsafety.models.DetectProvenanceResult] + :raises ~azure.core.exceptions.HttpResponseError: + """ + + @overload + async def begin_detect( + self, options: _types.DetectProvenanceOptions, *, content_type: str = "application/json", **kwargs: Any + ) -> AsyncLROPoller[_models.DetectProvenanceResult]: + """Start Content Provenance Detection. + + Starts an asynchronous Content Provenance Detection operation that inspects the supplied media + for Microsoft-issued C2PA and imperceptible watermark signals indicating the content was + created or modified using AI. + + :param options: Options describing the media to inspect using Content Provenance Detection. + Required. + :type options: ~azure.ai.contentsafety.types.DetectProvenanceOptions + :keyword content_type: Body Parameter content-type. Content type parameter for JSON body. + Default value is "application/json". + :paramtype content_type: str + :return: An instance of AsyncLROPoller that returns DetectProvenanceResult. The + DetectProvenanceResult is compatible with MutableMapping + :rtype: + ~azure.core.polling.AsyncLROPoller[~azure.ai.contentsafety.models.DetectProvenanceResult] + :raises ~azure.core.exceptions.HttpResponseError: + """ + + @overload + async def begin_detect( + self, options: IO[bytes], *, content_type: str = "application/json", **kwargs: Any + ) -> AsyncLROPoller[_models.DetectProvenanceResult]: + """Start Content Provenance Detection. + + Starts an asynchronous Content Provenance Detection operation that inspects the supplied media + for Microsoft-issued C2PA and imperceptible watermark signals indicating the content was + created or modified using AI. + + :param options: Options describing the media to inspect using Content Provenance Detection. + Required. + :type options: IO[bytes] + :keyword content_type: Body Parameter content-type. Content type parameter for binary body. + Default value is "application/json". + :paramtype content_type: str + :return: An instance of AsyncLROPoller that returns DetectProvenanceResult. The + DetectProvenanceResult is compatible with MutableMapping + :rtype: + ~azure.core.polling.AsyncLROPoller[~azure.ai.contentsafety.models.DetectProvenanceResult] + :raises ~azure.core.exceptions.HttpResponseError: + """ + + @distributed_trace_async + async def begin_detect( + self, options: Union[_models.DetectProvenanceOptions, _types.DetectProvenanceOptions, IO[bytes]], **kwargs: Any + ) -> AsyncLROPoller[_models.DetectProvenanceResult]: + """Start Content Provenance Detection. + + Starts an asynchronous Content Provenance Detection operation that inspects the supplied media + for Microsoft-issued C2PA and imperceptible watermark signals indicating the content was + created or modified using AI. + + :param options: Options describing the media to inspect using Content Provenance Detection. Is + either a DetectProvenanceOptions type or a IO[bytes] type. Required. + :type options: ~azure.ai.contentsafety.models.DetectProvenanceOptions or + ~azure.ai.contentsafety.types.DetectProvenanceOptions or IO[bytes] + :return: An instance of AsyncLROPoller that returns DetectProvenanceResult. The + DetectProvenanceResult is compatible with MutableMapping + :rtype: + ~azure.core.polling.AsyncLROPoller[~azure.ai.contentsafety.models.DetectProvenanceResult] + :raises ~azure.core.exceptions.HttpResponseError: + """ + _headers = case_insensitive_dict(kwargs.pop("headers", {}) or {}) + _params = kwargs.pop("params", {}) or {} + + content_type: Optional[str] = kwargs.pop("content_type", _headers.pop("Content-Type", None)) + cls: ClsType[_models.DetectProvenanceResult] = kwargs.pop("cls", None) + polling: Union[bool, AsyncPollingMethod] = kwargs.pop("polling", True) + lro_delay = kwargs.pop("polling_interval", self._config.polling_interval) + cont_token: Optional[str] = kwargs.pop("continuation_token", None) + if cont_token is None: + raw_result = await self._detect_initial( + options=options, + content_type=content_type, + cls=lambda x, y, z: x, + headers=_headers, + params=_params, + **kwargs + ) + await raw_result.http_response.read() # type: ignore + kwargs.pop("error_map", None) + + def get_long_running_output(pipeline_response): + response_headers = {} + response = pipeline_response.http_response + response_headers["Operation-Location"] = self._deserialize( + "str", response.headers.get("Operation-Location") + ) + + deserialized = _deserialize(_models.DetectProvenanceResult, response.json().get("result", {})) + if cls: + return cls(pipeline_response, deserialized, response_headers) # type: ignore + return deserialized + + path_format_arguments = { + "endpoint": self._serialize.url("self._config.endpoint", self._config.endpoint, "str", skip_quote=True), + } + + if polling is True: + polling_method: AsyncPollingMethod = cast( + AsyncPollingMethod, + AsyncLROBasePolling(lro_delay, path_format_arguments=path_format_arguments, **kwargs), + ) + elif polling is False: + polling_method = cast(AsyncPollingMethod, AsyncNoPolling()) + else: + polling_method = polling + if cont_token: + return AsyncLROPoller[_models.DetectProvenanceResult].from_continuation_token( + polling_method=polling_method, + continuation_token=cont_token, + client=self._client, + deserialization_callback=get_long_running_output, + ) + return AsyncLROPoller[_models.DetectProvenanceResult]( + self._client, raw_result, get_long_running_output, polling_method # type: ignore + ) + + @distributed_trace_async + async def get_operation_status(self, operation_id: str, **kwargs: Any) -> _models.ProvenanceDetectOperation: + """Get Content Provenance Detection Status. + + Gets the status, result, or error of an asynchronous Content Provenance Detection operation. + + :param operation_id: The unique ID of the operation. Required. + :type operation_id: str + :return: ProvenanceDetectOperation. The ProvenanceDetectOperation is compatible with + MutableMapping + :rtype: ~azure.ai.contentsafety.models.ProvenanceDetectOperation + :raises ~azure.core.exceptions.HttpResponseError: + """ + error_map: MutableMapping = { + 401: ClientAuthenticationError, + 404: ResourceNotFoundError, + 409: ResourceExistsError, + 304: ResourceNotModifiedError, + } + error_map.update(kwargs.pop("error_map", {}) or {}) + + _headers = kwargs.pop("headers", {}) or {} + _params = kwargs.pop("params", {}) or {} + + cls: ClsType[_models.ProvenanceDetectOperation] = kwargs.pop("cls", None) + + _request = build_content_provenance_get_operation_status_request( + operation_id=operation_id, + api_version=self._config.api_version, + headers=_headers, + params=_params, + ) + path_format_arguments = { + "endpoint": self._serialize.url("self._config.endpoint", self._config.endpoint, "str", skip_quote=True), + } + _request.url = self._client.format_url(_request.url, **path_format_arguments) + + _decompress = kwargs.pop("decompress", True) + _stream = kwargs.pop("stream", False) + pipeline_response: PipelineResponse = await self._client._pipeline.run( # type: ignore # pylint: disable=protected-access + _request, stream=_stream, **kwargs + ) + + response = pipeline_response.http_response + + if response.status_code not in [200]: + if _stream: + try: + await response.read() # Load the body in memory and close the socket + except (StreamConsumedError, StreamClosedError): + pass + map_error(status_code=response.status_code, response=response, error_map=error_map) + raise HttpResponseError(response=response) + + response_headers = {} + response_headers["Retry-After"] = self._deserialize("int", response.headers.get("Retry-After")) + + if _stream: + deserialized = response.iter_bytes() if _decompress else response.iter_raw() + else: + deserialized = _deserialize(_models.ProvenanceDetectOperation, response.json()) + + if cls: + return cls(pipeline_response, deserialized, response_headers) # type: ignore + + return deserialized # type: ignore + + +class _BlocklistClientOperationsMixin( + ClientMixinABC[AsyncPipelineClient[HttpRequest, AsyncHttpResponse], BlocklistClientConfiguration] +): + @overload async def add_or_update_blocklist_items( self, @@ -356,8 +931,6 @@ async def add_or_update_blocklist_items( :keyword content_type: Body Parameter content-type. Content type parameter for JSON body. Default value is "application/json". :paramtype content_type: str - :keyword bool stream: Whether to stream the response of this operation. Defaults to False. You - will have to context manage the returned stream. :return: AddOrUpdateTextBlocklistItemsResult. The AddOrUpdateTextBlocklistItemsResult is compatible with MutableMapping :rtype: ~azure.ai.contentsafety.models.AddOrUpdateTextBlocklistItemsResult @@ -366,7 +939,12 @@ async def add_or_update_blocklist_items( @overload async def add_or_update_blocklist_items( - self, blocklist_name: str, options: JSON, *, content_type: str = "application/json", **kwargs: Any + self, + blocklist_name: str, + options: _types.AddOrUpdateTextBlocklistItemsOptions, + *, + content_type: str = "application/json", + **kwargs: Any ) -> _models.AddOrUpdateTextBlocklistItemsResult: """Add or update BlocklistItems To Text Blocklist. @@ -376,12 +954,10 @@ async def add_or_update_blocklist_items( :param blocklist_name: Text blocklist name. Required. :type blocklist_name: str :param options: Options for adding or updating blocklist items. Required. - :type options: JSON + :type options: ~azure.ai.contentsafety.types.AddOrUpdateTextBlocklistItemsOptions :keyword content_type: Body Parameter content-type. Content type parameter for JSON body. Default value is "application/json". :paramtype content_type: str - :keyword bool stream: Whether to stream the response of this operation. Defaults to False. You - will have to context manage the returned stream. :return: AddOrUpdateTextBlocklistItemsResult. The AddOrUpdateTextBlocklistItemsResult is compatible with MutableMapping :rtype: ~azure.ai.contentsafety.models.AddOrUpdateTextBlocklistItemsResult @@ -404,8 +980,6 @@ async def add_or_update_blocklist_items( :keyword content_type: Body Parameter content-type. Content type parameter for binary body. Default value is "application/json". :paramtype content_type: str - :keyword bool stream: Whether to stream the response of this operation. Defaults to False. You - will have to context manage the returned stream. :return: AddOrUpdateTextBlocklistItemsResult. The AddOrUpdateTextBlocklistItemsResult is compatible with MutableMapping :rtype: ~azure.ai.contentsafety.models.AddOrUpdateTextBlocklistItemsResult @@ -416,7 +990,9 @@ async def add_or_update_blocklist_items( async def add_or_update_blocklist_items( self, blocklist_name: str, - options: Union[_models.AddOrUpdateTextBlocklistItemsOptions, JSON, IO[bytes]], + options: Union[ + _models.AddOrUpdateTextBlocklistItemsOptions, _types.AddOrUpdateTextBlocklistItemsOptions, IO[bytes] + ], **kwargs: Any ) -> _models.AddOrUpdateTextBlocklistItemsResult: """Add or update BlocklistItems To Text Blocklist. @@ -426,21 +1002,16 @@ async def add_or_update_blocklist_items( :param blocklist_name: Text blocklist name. Required. :type blocklist_name: str - :param options: Options for adding or updating blocklist items. Is one of the following types: - AddOrUpdateTextBlocklistItemsOptions, JSON, IO[bytes] Required. - :type options: ~azure.ai.contentsafety.models.AddOrUpdateTextBlocklistItemsOptions or JSON or - IO[bytes] - :keyword content_type: Body parameter Content-Type. Known values are: application/json. Default - value is None. - :paramtype content_type: str - :keyword bool stream: Whether to stream the response of this operation. Defaults to False. You - will have to context manage the returned stream. + :param options: Options for adding or updating blocklist items. Is either a + AddOrUpdateTextBlocklistItemsOptions type or a IO[bytes] type. Required. + :type options: ~azure.ai.contentsafety.models.AddOrUpdateTextBlocklistItemsOptions or + ~azure.ai.contentsafety.types.AddOrUpdateTextBlocklistItemsOptions or IO[bytes] :return: AddOrUpdateTextBlocklistItemsResult. The AddOrUpdateTextBlocklistItemsResult is compatible with MutableMapping :rtype: ~azure.ai.contentsafety.models.AddOrUpdateTextBlocklistItemsResult :raises ~azure.core.exceptions.HttpResponseError: """ - error_map = { + error_map: MutableMapping = { 401: ClientAuthenticationError, 404: ResourceNotFoundError, 409: ResourceExistsError, @@ -474,6 +1045,7 @@ async def add_or_update_blocklist_items( } _request.url = self._client.format_url(_request.url, **path_format_arguments) + _decompress = kwargs.pop("decompress", True) _stream = kwargs.pop("stream", False) pipeline_response: PipelineResponse = await self._client._pipeline.run( # type: ignore # pylint: disable=protected-access _request, stream=_stream, **kwargs @@ -483,12 +1055,15 @@ async def add_or_update_blocklist_items( if response.status_code not in [200]: if _stream: - await response.read() # Load the body in memory and close the socket + try: + await response.read() # Load the body in memory and close the socket + except (StreamConsumedError, StreamClosedError): + pass map_error(status_code=response.status_code, response=response, error_map=error_map) raise HttpResponseError(response=response) if _stream: - deserialized = response.iter_bytes() + deserialized = response.iter_bytes() if _decompress else response.iter_raw() else: deserialized = _deserialize(_models.AddOrUpdateTextBlocklistItemsResult, response.json()) @@ -517,8 +1092,6 @@ async def create_or_update_text_blocklist( :keyword content_type: Body Parameter content-type. Content type parameter for JSON body. Default value is "application/merge-patch+json". :paramtype content_type: str - :keyword bool stream: Whether to stream the response of this operation. Defaults to False. You - will have to context manage the returned stream. :return: TextBlocklist. The TextBlocklist is compatible with MutableMapping :rtype: ~azure.ai.contentsafety.models.TextBlocklist :raises ~azure.core.exceptions.HttpResponseError: @@ -526,7 +1099,12 @@ async def create_or_update_text_blocklist( @overload async def create_or_update_text_blocklist( - self, blocklist_name: str, options: JSON, *, content_type: str = "application/merge-patch+json", **kwargs: Any + self, + blocklist_name: str, + options: _types.TextBlocklist, + *, + content_type: str = "application/merge-patch+json", + **kwargs: Any ) -> _models.TextBlocklist: """Create Or Update Text Blocklist. @@ -535,12 +1113,10 @@ async def create_or_update_text_blocklist( :param blocklist_name: Text blocklist name. Required. :type blocklist_name: str :param options: The resource instance. Required. - :type options: JSON + :type options: ~azure.ai.contentsafety.types.TextBlocklist :keyword content_type: Body Parameter content-type. Content type parameter for JSON body. Default value is "application/merge-patch+json". :paramtype content_type: str - :keyword bool stream: Whether to stream the response of this operation. Defaults to False. You - will have to context manage the returned stream. :return: TextBlocklist. The TextBlocklist is compatible with MutableMapping :rtype: ~azure.ai.contentsafety.models.TextBlocklist :raises ~azure.core.exceptions.HttpResponseError: @@ -566,8 +1142,6 @@ async def create_or_update_text_blocklist( :keyword content_type: Body Parameter content-type. Content type parameter for binary body. Default value is "application/merge-patch+json". :paramtype content_type: str - :keyword bool stream: Whether to stream the response of this operation. Defaults to False. You - will have to context manage the returned stream. :return: TextBlocklist. The TextBlocklist is compatible with MutableMapping :rtype: ~azure.ai.contentsafety.models.TextBlocklist :raises ~azure.core.exceptions.HttpResponseError: @@ -575,7 +1149,7 @@ async def create_or_update_text_blocklist( @distributed_trace_async async def create_or_update_text_blocklist( - self, blocklist_name: str, options: Union[_models.TextBlocklist, JSON, IO[bytes]], **kwargs: Any + self, blocklist_name: str, options: Union[_models.TextBlocklist, _types.TextBlocklist, IO[bytes]], **kwargs: Any ) -> _models.TextBlocklist: """Create Or Update Text Blocklist. @@ -583,18 +1157,15 @@ async def create_or_update_text_blocklist( :param blocklist_name: Text blocklist name. Required. :type blocklist_name: str - :param options: The resource instance. Is one of the following types: TextBlocklist, JSON, - IO[bytes] Required. - :type options: ~azure.ai.contentsafety.models.TextBlocklist or JSON or IO[bytes] - :keyword content_type: This request has a JSON Merge Patch body. Default value is None. - :paramtype content_type: str - :keyword bool stream: Whether to stream the response of this operation. Defaults to False. You - will have to context manage the returned stream. + :param options: The resource instance. Is either a TextBlocklist type or a IO[bytes] type. + Required. + :type options: ~azure.ai.contentsafety.models.TextBlocklist or + ~azure.ai.contentsafety.types.TextBlocklist or IO[bytes] :return: TextBlocklist. The TextBlocklist is compatible with MutableMapping :rtype: ~azure.ai.contentsafety.models.TextBlocklist :raises ~azure.core.exceptions.HttpResponseError: """ - error_map = { + error_map: MutableMapping = { 401: ClientAuthenticationError, 404: ResourceNotFoundError, 409: ResourceExistsError, @@ -628,6 +1199,7 @@ async def create_or_update_text_blocklist( } _request.url = self._client.format_url(_request.url, **path_format_arguments) + _decompress = kwargs.pop("decompress", True) _stream = kwargs.pop("stream", False) pipeline_response: PipelineResponse = await self._client._pipeline.run( # type: ignore # pylint: disable=protected-access _request, stream=_stream, **kwargs @@ -637,21 +1209,17 @@ async def create_or_update_text_blocklist( if response.status_code not in [200, 201]: if _stream: - await response.read() # Load the body in memory and close the socket + try: + await response.read() # Load the body in memory and close the socket + except (StreamConsumedError, StreamClosedError): + pass map_error(status_code=response.status_code, response=response, error_map=error_map) raise HttpResponseError(response=response) - if response.status_code == 200: - if _stream: - deserialized = response.iter_bytes() - else: - deserialized = _deserialize(_models.TextBlocklist, response.json()) - - if response.status_code == 201: - if _stream: - deserialized = response.iter_bytes() - else: - deserialized = _deserialize(_models.TextBlocklist, response.json()) + if _stream: + deserialized = response.iter_bytes() if _decompress else response.iter_raw() + else: + deserialized = _deserialize(_models.TextBlocklist, response.json()) if cls: return cls(pipeline_response, deserialized, {}) # type: ignore @@ -659,9 +1227,7 @@ async def create_or_update_text_blocklist( return deserialized # type: ignore @distributed_trace_async - async def delete_text_blocklist( # pylint: disable=inconsistent-return-statements - self, blocklist_name: str, **kwargs: Any - ) -> None: + async def delete_text_blocklist(self, blocklist_name: str, **kwargs: Any) -> None: """Delete Text Blocklist By blocklistName. Deletes a text blocklist. @@ -672,7 +1238,7 @@ async def delete_text_blocklist( # pylint: disable=inconsistent-return-statemen :rtype: None :raises ~azure.core.exceptions.HttpResponseError: """ - error_map = { + error_map: MutableMapping = { 401: ClientAuthenticationError, 404: ResourceNotFoundError, 409: ResourceExistsError, @@ -704,8 +1270,6 @@ async def delete_text_blocklist( # pylint: disable=inconsistent-return-statemen response = pipeline_response.http_response if response.status_code not in [204]: - if _stream: - await response.read() # Load the body in memory and close the socket map_error(status_code=response.status_code, response=response, error_map=error_map) raise HttpResponseError(response=response) @@ -720,13 +1284,11 @@ async def get_text_blocklist(self, blocklist_name: str, **kwargs: Any) -> _model :param blocklist_name: Text blocklist name. Required. :type blocklist_name: str - :keyword bool stream: Whether to stream the response of this operation. Defaults to False. You - will have to context manage the returned stream. :return: TextBlocklist. The TextBlocklist is compatible with MutableMapping :rtype: ~azure.ai.contentsafety.models.TextBlocklist :raises ~azure.core.exceptions.HttpResponseError: """ - error_map = { + error_map: MutableMapping = { 401: ClientAuthenticationError, 404: ResourceNotFoundError, 409: ResourceExistsError, @@ -750,6 +1312,7 @@ async def get_text_blocklist(self, blocklist_name: str, **kwargs: Any) -> _model } _request.url = self._client.format_url(_request.url, **path_format_arguments) + _decompress = kwargs.pop("decompress", True) _stream = kwargs.pop("stream", False) pipeline_response: PipelineResponse = await self._client._pipeline.run( # type: ignore # pylint: disable=protected-access _request, stream=_stream, **kwargs @@ -759,12 +1322,15 @@ async def get_text_blocklist(self, blocklist_name: str, **kwargs: Any) -> _model if response.status_code not in [200]: if _stream: - await response.read() # Load the body in memory and close the socket + try: + await response.read() # Load the body in memory and close the socket + except (StreamConsumedError, StreamClosedError): + pass map_error(status_code=response.status_code, response=response, error_map=error_map) raise HttpResponseError(response=response) if _stream: - deserialized = response.iter_bytes() + deserialized = response.iter_bytes() if _decompress else response.iter_raw() else: deserialized = _deserialize(_models.TextBlocklist, response.json()) @@ -786,13 +1352,11 @@ async def get_text_blocklist_item( :param blocklist_item_id: The service will generate a BlocklistItemId, which will be a UUID. Required. :type blocklist_item_id: str - :keyword bool stream: Whether to stream the response of this operation. Defaults to False. You - will have to context manage the returned stream. :return: TextBlocklistItem. The TextBlocklistItem is compatible with MutableMapping :rtype: ~azure.ai.contentsafety.models.TextBlocklistItem :raises ~azure.core.exceptions.HttpResponseError: """ - error_map = { + error_map: MutableMapping = { 401: ClientAuthenticationError, 404: ResourceNotFoundError, 409: ResourceExistsError, @@ -817,6 +1381,7 @@ async def get_text_blocklist_item( } _request.url = self._client.format_url(_request.url, **path_format_arguments) + _decompress = kwargs.pop("decompress", True) _stream = kwargs.pop("stream", False) pipeline_response: PipelineResponse = await self._client._pipeline.run( # type: ignore # pylint: disable=protected-access _request, stream=_stream, **kwargs @@ -826,12 +1391,15 @@ async def get_text_blocklist_item( if response.status_code not in [200]: if _stream: - await response.read() # Load the body in memory and close the socket + try: + await response.read() # Load the body in memory and close the socket + except (StreamConsumedError, StreamClosedError): + pass map_error(status_code=response.status_code, response=response, error_map=error_map) raise HttpResponseError(response=response) if _stream: - deserialized = response.iter_bytes() + deserialized = response.iter_bytes() if _decompress else response.iter_raw() else: deserialized = _deserialize(_models.TextBlocklistItem, response.json()) @@ -843,7 +1411,7 @@ async def get_text_blocklist_item( @distributed_trace def list_text_blocklist_items( self, blocklist_name: str, *, top: Optional[int] = None, skip: Optional[int] = None, **kwargs: Any - ) -> AsyncIterable["_models.TextBlocklistItem"]: + ) -> AsyncItemPaged["_models.TextBlocklistItem"]: """Get All BlocklistItems By blocklistName. Get all blocklistItems in a text blocklist. @@ -863,9 +1431,9 @@ def list_text_blocklist_items( _params = kwargs.pop("params", {}) or {} maxpagesize = kwargs.pop("maxpagesize", None) - cls: ClsType[List[_models.TextBlocklistItem]] = kwargs.pop("cls", None) + cls: ClsType[list[_models.TextBlocklistItem]] = kwargs.pop("cls", None) - error_map = { + error_map: MutableMapping = { 401: ClientAuthenticationError, 404: ResourceNotFoundError, 409: ResourceExistsError, @@ -903,7 +1471,10 @@ def prepare_request(next_link=None): ) _next_request_params["api-version"] = self._config.api_version _request = HttpRequest( - "GET", urllib.parse.urljoin(next_link, _parsed_next_link.path), params=_next_request_params + "GET", + urllib.parse.urljoin(next_link, _parsed_next_link.path), + headers=_headers, + params=_next_request_params, ) path_format_arguments = { "endpoint": self._serialize.url( @@ -916,7 +1487,10 @@ def prepare_request(next_link=None): async def extract_data(pipeline_response): deserialized = pipeline_response.http_response.json() - list_of_elem = _deserialize(List[_models.TextBlocklistItem], deserialized["value"]) + list_of_elem = _deserialize( + list[_models.TextBlocklistItem], + deserialized.get("value", []), + ) if cls: list_of_elem = cls(list_of_elem) # type: ignore return deserialized.get("nextLink") or None, AsyncList(list_of_elem) @@ -931,8 +1505,6 @@ async def get_next(next_link=None): response = pipeline_response.http_response if response.status_code not in [200]: - if _stream: - await response.read() # Load the body in memory and close the socket map_error(status_code=response.status_code, response=response, error_map=error_map) raise HttpResponseError(response=response) @@ -941,7 +1513,7 @@ async def get_next(next_link=None): return AsyncItemPaged(get_next, extract_data) @distributed_trace - def list_text_blocklists(self, **kwargs: Any) -> AsyncIterable["_models.TextBlocklist"]: + def list_text_blocklists(self, **kwargs: Any) -> AsyncItemPaged["_models.TextBlocklist"]: """Get All Text Blocklists. Get all text blocklists details. @@ -953,9 +1525,9 @@ def list_text_blocklists(self, **kwargs: Any) -> AsyncIterable["_models.TextBloc _headers = kwargs.pop("headers", {}) or {} _params = kwargs.pop("params", {}) or {} - cls: ClsType[List[_models.TextBlocklist]] = kwargs.pop("cls", None) + cls: ClsType[list[_models.TextBlocklist]] = kwargs.pop("cls", None) - error_map = { + error_map: MutableMapping = { 401: ClientAuthenticationError, 404: ResourceNotFoundError, 409: ResourceExistsError, @@ -989,7 +1561,10 @@ def prepare_request(next_link=None): ) _next_request_params["api-version"] = self._config.api_version _request = HttpRequest( - "GET", urllib.parse.urljoin(next_link, _parsed_next_link.path), params=_next_request_params + "GET", + urllib.parse.urljoin(next_link, _parsed_next_link.path), + headers=_headers, + params=_next_request_params, ) path_format_arguments = { "endpoint": self._serialize.url( @@ -1002,7 +1577,10 @@ def prepare_request(next_link=None): async def extract_data(pipeline_response): deserialized = pipeline_response.http_response.json() - list_of_elem = _deserialize(List[_models.TextBlocklist], deserialized["value"]) + list_of_elem = _deserialize( + list[_models.TextBlocklist], + deserialized.get("value", []), + ) if cls: list_of_elem = cls(list_of_elem) # type: ignore return deserialized.get("nextLink") or None, AsyncList(list_of_elem) @@ -1017,8 +1595,6 @@ async def get_next(next_link=None): response = pipeline_response.http_response if response.status_code not in [200]: - if _stream: - await response.read() # Load the body in memory and close the socket map_error(status_code=response.status_code, response=response, error_map=error_map) raise HttpResponseError(response=response) @@ -1027,7 +1603,7 @@ async def get_next(next_link=None): return AsyncItemPaged(get_next, extract_data) @overload - async def remove_blocklist_items( # pylint: disable=inconsistent-return-statements + async def remove_blocklist_items( self, blocklist_name: str, options: _models.RemoveTextBlocklistItemsOptions, @@ -1053,8 +1629,13 @@ async def remove_blocklist_items( # pylint: disable=inconsistent-return-stateme """ @overload - async def remove_blocklist_items( # pylint: disable=inconsistent-return-statements - self, blocklist_name: str, options: JSON, *, content_type: str = "application/json", **kwargs: Any + async def remove_blocklist_items( + self, + blocklist_name: str, + options: _types.RemoveTextBlocklistItemsOptions, + *, + content_type: str = "application/json", + **kwargs: Any ) -> None: """Remove BlocklistItems From Text Blocklist. @@ -1064,7 +1645,7 @@ async def remove_blocklist_items( # pylint: disable=inconsistent-return-stateme :param blocklist_name: Text blocklist name. Required. :type blocklist_name: str :param options: Options for removing blocklist items. Required. - :type options: JSON + :type options: ~azure.ai.contentsafety.types.RemoveTextBlocklistItemsOptions :keyword content_type: Body Parameter content-type. Content type parameter for JSON body. Default value is "application/json". :paramtype content_type: str @@ -1074,7 +1655,7 @@ async def remove_blocklist_items( # pylint: disable=inconsistent-return-stateme """ @overload - async def remove_blocklist_items( # pylint: disable=inconsistent-return-statements + async def remove_blocklist_items( self, blocklist_name: str, options: IO[bytes], *, content_type: str = "application/json", **kwargs: Any ) -> None: """Remove BlocklistItems From Text Blocklist. @@ -1095,10 +1676,10 @@ async def remove_blocklist_items( # pylint: disable=inconsistent-return-stateme """ @distributed_trace_async - async def remove_blocklist_items( # pylint: disable=inconsistent-return-statements + async def remove_blocklist_items( self, blocklist_name: str, - options: Union[_models.RemoveTextBlocklistItemsOptions, JSON, IO[bytes]], + options: Union[_models.RemoveTextBlocklistItemsOptions, _types.RemoveTextBlocklistItemsOptions, IO[bytes]], **kwargs: Any ) -> None: """Remove BlocklistItems From Text Blocklist. @@ -1108,18 +1689,15 @@ async def remove_blocklist_items( # pylint: disable=inconsistent-return-stateme :param blocklist_name: Text blocklist name. Required. :type blocklist_name: str - :param options: Options for removing blocklist items. Is one of the following types: - RemoveTextBlocklistItemsOptions, JSON, IO[bytes] Required. - :type options: ~azure.ai.contentsafety.models.RemoveTextBlocklistItemsOptions or JSON or - IO[bytes] - :keyword content_type: Body parameter Content-Type. Known values are: application/json. Default - value is None. - :paramtype content_type: str + :param options: Options for removing blocklist items. Is either a + RemoveTextBlocklistItemsOptions type or a IO[bytes] type. Required. + :type options: ~azure.ai.contentsafety.models.RemoveTextBlocklistItemsOptions or + ~azure.ai.contentsafety.types.RemoveTextBlocklistItemsOptions or IO[bytes] :return: None :rtype: None :raises ~azure.core.exceptions.HttpResponseError: """ - error_map = { + error_map: MutableMapping = { 401: ClientAuthenticationError, 404: ResourceNotFoundError, 409: ResourceExistsError, @@ -1161,8 +1739,6 @@ async def remove_blocklist_items( # pylint: disable=inconsistent-return-stateme response = pipeline_response.http_response if response.status_code not in [204]: - if _stream: - await response.read() # Load the body in memory and close the socket map_error(status_code=response.status_code, response=response, error_map=error_map) raise HttpResponseError(response=response) diff --git a/sdk/contentsafety/azure-ai-contentsafety/azure/ai/contentsafety/aio/_operations/_patch.py b/sdk/contentsafety/azure-ai-contentsafety/azure/ai/contentsafety/aio/_operations/_patch.py index f7dd32510333..87676c65a8f0 100644 --- a/sdk/contentsafety/azure-ai-contentsafety/azure/ai/contentsafety/aio/_operations/_patch.py +++ b/sdk/contentsafety/azure-ai-contentsafety/azure/ai/contentsafety/aio/_operations/_patch.py @@ -1,14 +1,15 @@ -# ------------------------------------ -# Copyright (c) Microsoft Corporation. -# Licensed under the MIT License. -# ------------------------------------ +# coding=utf-8 +# -------------------------------------------------------------------------- +# Copyright (c) Microsoft Corporation. All rights reserved. +# Licensed under the MIT License. See License.txt in the project root for license information. +# -------------------------------------------------------------------------- """Customize generated code here. Follow our quickstart for examples: https://aka.ms/azsdk/python/dpcodegen/python/customize """ -from typing import List -__all__: List[str] = [] # Add all objects you want publicly available to users at this package level + +__all__: list[str] = [] # Add all objects you want publicly available to users at this package level def patch_sdk(): diff --git a/sdk/contentsafety/azure-ai-contentsafety/azure/ai/contentsafety/aio/_patch.py b/sdk/contentsafety/azure-ai-contentsafety/azure/ai/contentsafety/aio/_patch.py index f7dd32510333..87676c65a8f0 100644 --- a/sdk/contentsafety/azure-ai-contentsafety/azure/ai/contentsafety/aio/_patch.py +++ b/sdk/contentsafety/azure-ai-contentsafety/azure/ai/contentsafety/aio/_patch.py @@ -1,14 +1,15 @@ -# ------------------------------------ -# Copyright (c) Microsoft Corporation. -# Licensed under the MIT License. -# ------------------------------------ +# coding=utf-8 +# -------------------------------------------------------------------------- +# Copyright (c) Microsoft Corporation. All rights reserved. +# Licensed under the MIT License. See License.txt in the project root for license information. +# -------------------------------------------------------------------------- """Customize generated code here. Follow our quickstart for examples: https://aka.ms/azsdk/python/dpcodegen/python/customize """ -from typing import List -__all__: List[str] = [] # Add all objects you want publicly available to users at this package level + +__all__: list[str] = [] # Add all objects you want publicly available to users at this package level def patch_sdk(): diff --git a/sdk/contentsafety/azure-ai-contentsafety/azure/ai/contentsafety/aio/_vendor.py b/sdk/contentsafety/azure-ai-contentsafety/azure/ai/contentsafety/aio/_vendor.py deleted file mode 100644 index aaf8f213e731..000000000000 --- a/sdk/contentsafety/azure-ai-contentsafety/azure/ai/contentsafety/aio/_vendor.py +++ /dev/null @@ -1,35 +0,0 @@ -# -------------------------------------------------------------------------- -# Copyright (c) Microsoft Corporation. All rights reserved. -# Licensed under the MIT License. See License.txt in the project root for license information. -# Code generated by Microsoft (R) Python Code Generator. -# Changes may cause incorrect behavior and will be lost if the code is regenerated. -# -------------------------------------------------------------------------- - -from abc import ABC -from typing import TYPE_CHECKING - -from ._configuration import BlocklistClientConfiguration, ContentSafetyClientConfiguration - -if TYPE_CHECKING: - # pylint: disable=unused-import,ungrouped-imports - from azure.core import AsyncPipelineClient - - from .._serialization import Deserializer, Serializer - - -class ContentSafetyClientMixinABC(ABC): - """DO NOT use this class. It is for internal typing use only.""" - - _client: "AsyncPipelineClient" - _config: ContentSafetyClientConfiguration - _serialize: "Serializer" - _deserialize: "Deserializer" - - -class BlocklistClientMixinABC(ABC): - """DO NOT use this class. It is for internal typing use only.""" - - _client: "AsyncPipelineClient" - _config: BlocklistClientConfiguration - _serialize: "Serializer" - _deserialize: "Deserializer" diff --git a/sdk/contentsafety/azure-ai-contentsafety/azure/ai/contentsafety/models/__init__.py b/sdk/contentsafety/azure-ai-contentsafety/azure/ai/contentsafety/models/__init__.py index a4cd06fb66cf..2f19a04be1bd 100644 --- a/sdk/contentsafety/azure-ai-contentsafety/azure/ai/contentsafety/models/__init__.py +++ b/sdk/contentsafety/azure-ai-contentsafety/azure/ai/contentsafety/models/__init__.py @@ -5,27 +5,54 @@ # Code generated by Microsoft (R) Python Code Generator. # Changes may cause incorrect behavior and will be lost if the code is regenerated. # -------------------------------------------------------------------------- +# pylint: disable=wrong-import-position -from ._models import AddOrUpdateTextBlocklistItemsOptions -from ._models import AddOrUpdateTextBlocklistItemsResult -from ._models import AnalyzeImageOptions -from ._models import AnalyzeImageResult -from ._models import AnalyzeTextOptions -from ._models import AnalyzeTextResult -from ._models import ImageCategoriesAnalysis -from ._models import ImageData -from ._models import RemoveTextBlocklistItemsOptions -from ._models import TextBlocklist -from ._models import TextBlocklistItem -from ._models import TextBlocklistMatch -from ._models import TextCategoriesAnalysis +from typing import TYPE_CHECKING -from ._enums import AnalyzeImageOutputType -from ._enums import AnalyzeTextOutputType -from ._enums import ImageCategory -from ._enums import TextCategory +if TYPE_CHECKING: + from ._patch import * # pylint: disable=unused-wildcard-import + + +from ._models import ( # type: ignore + AddOrUpdateTextBlocklistItemsOptions, + AddOrUpdateTextBlocklistItemsResult, + AnalyzeImageOptions, + AnalyzeImageResult, + AnalyzeTextOptions, + AnalyzeTextResult, + DetectProvenanceOptions, + DetectProvenanceResult, + DetectTextProtectedMaterialOptions, + DetectTextProtectedMaterialResult, + DetectedProvenance, + DocumentInjectionAnalysisResult, + ImageCategoriesAnalysis, + ImageData, + ProvenanceContent, + ProvenanceDetectOperation, + RemoveTextBlocklistItemsOptions, + ShieldPromptOptions, + ShieldPromptResult, + TextBlocklist, + TextBlocklistItem, + TextBlocklistMatch, + TextCategoriesAnalysis, + TextProtectedMaterialAnalysisResult, + UserPromptInjectionAnalysisResult, +) + +from ._enums import ( # type: ignore + AnalyzeImageOutputType, + AnalyzeTextOutputType, + DetectOutcome, + DetectedProvenanceType, + ImageCategory, + OperationState, + ProvenanceOperationKind, + TextCategory, +) from ._patch import __all__ as _patch_all -from ._patch import * # pylint: disable=unused-wildcard-import +from ._patch import * from ._patch import patch_sdk as _patch_sdk __all__ = [ @@ -35,17 +62,33 @@ "AnalyzeImageResult", "AnalyzeTextOptions", "AnalyzeTextResult", + "DetectProvenanceOptions", + "DetectProvenanceResult", + "DetectTextProtectedMaterialOptions", + "DetectTextProtectedMaterialResult", + "DetectedProvenance", + "DocumentInjectionAnalysisResult", "ImageCategoriesAnalysis", "ImageData", + "ProvenanceContent", + "ProvenanceDetectOperation", "RemoveTextBlocklistItemsOptions", + "ShieldPromptOptions", + "ShieldPromptResult", "TextBlocklist", "TextBlocklistItem", "TextBlocklistMatch", "TextCategoriesAnalysis", + "TextProtectedMaterialAnalysisResult", + "UserPromptInjectionAnalysisResult", "AnalyzeImageOutputType", "AnalyzeTextOutputType", + "DetectOutcome", + "DetectedProvenanceType", "ImageCategory", + "OperationState", + "ProvenanceOperationKind", "TextCategory", ] -__all__.extend([p for p in _patch_all if p not in __all__]) +__all__.extend([p for p in _patch_all if p not in __all__]) # pyright: ignore _patch_sdk() diff --git a/sdk/contentsafety/azure-ai-contentsafety/azure/ai/contentsafety/models/_enums.py b/sdk/contentsafety/azure-ai-contentsafety/azure/ai/contentsafety/models/_enums.py index 6e91fad1a406..c0709f8b75e9 100644 --- a/sdk/contentsafety/azure-ai-contentsafety/azure/ai/contentsafety/models/_enums.py +++ b/sdk/contentsafety/azure-ai-contentsafety/azure/ai/contentsafety/models/_enums.py @@ -26,19 +26,68 @@ class AnalyzeTextOutputType(str, Enum, metaclass=CaseInsensitiveEnumMeta): """Output severities in eight levels, the value could be 0,1,2,3,4,5,6,7.""" +class DetectedProvenanceType(str, Enum, metaclass=CaseInsensitiveEnumMeta): + """Detected provenance record type.""" + + C2_PA = "C2PA" + """Provenance came from a C2PA Content Credential (manifest).""" + WATERMARK = "Watermark" + """Provenance came from an imperceptible watermark.""" + + +class DetectOutcome(str, Enum, metaclass=CaseInsensitiveEnumMeta): + """Top-level outcome of a Content Provenance Detection operation.""" + + NO_PROVENANCE_DETECTED = "NoProvenanceDetected" + """No supported Microsoft-issued C2PA or imperceptible watermark signal was detected. This doesn't + necessarily mean the content wasn't AI-generated; it means no supported signal was found.""" + PROVENANCE_DETECTED = "ProvenanceDetected" + """At least one supported Microsoft-issued C2PA or imperceptible watermark signal was detected.""" + + class ImageCategory(str, Enum, metaclass=CaseInsensitiveEnumMeta): - """Image analyze category.""" + """The harm category supported in Image content analysis.""" HATE = "Hate" + """The harm category for Image - Hate.""" SELF_HARM = "SelfHarm" + """The harm category for Image - SelfHarm.""" SEXUAL = "Sexual" + """The harm category for Image - Sexual.""" VIOLENCE = "Violence" + """The harm category for Image - Violence.""" + + +class OperationState(str, Enum, metaclass=CaseInsensitiveEnumMeta): + """Enum describing allowed operation states.""" + + NOT_STARTED = "NotStarted" + """The operation has not started.""" + RUNNING = "Running" + """The operation is in progress.""" + SUCCEEDED = "Succeeded" + """The operation has completed successfully.""" + FAILED = "Failed" + """The operation has failed.""" + CANCELED = "Canceled" + """The operation has been canceled by the user.""" + + +class ProvenanceOperationKind(str, Enum, metaclass=CaseInsensitiveEnumMeta): + """Kind of asynchronous Content Provenance Detection operation.""" + + DETECT = "Detect" + """Content Provenance Detection operation.""" class TextCategory(str, Enum, metaclass=CaseInsensitiveEnumMeta): - """Text analyze category.""" + """The harm category supported in Text content analysis.""" HATE = "Hate" + """The harm category for Text - Hate.""" SELF_HARM = "SelfHarm" + """The harm category for Text - SelfHarm.""" SEXUAL = "Sexual" + """The harm category for Text - Sexual.""" VIOLENCE = "Violence" + """The harm category for Text - Violence.""" diff --git a/sdk/contentsafety/azure-ai-contentsafety/azure/ai/contentsafety/models/_models.py b/sdk/contentsafety/azure-ai-contentsafety/azure/ai/contentsafety/models/_models.py index cf0403b1cd4c..83e88f0b42b5 100644 --- a/sdk/contentsafety/azure-ai-contentsafety/azure/ai/contentsafety/models/_models.py +++ b/sdk/contentsafety/azure-ai-contentsafety/azure/ai/contentsafety/models/_models.py @@ -1,90 +1,87 @@ # coding=utf-8 -# pylint: disable=too-many-lines # -------------------------------------------------------------------------- # Copyright (c) Microsoft Corporation. All rights reserved. # Licensed under the MIT License. See License.txt in the project root for license information. # Code generated by Microsoft (R) Python Code Generator. # Changes may cause incorrect behavior and will be lost if the code is regenerated. # -------------------------------------------------------------------------- +# pylint: disable=useless-super-delegation -from typing import Any, List, Mapping, Optional, TYPE_CHECKING, Union, overload +import datetime +from typing import Any, Mapping, Optional, TYPE_CHECKING, Union, overload -from .. import _model_base -from .._model_base import rest_field +from azure.core.exceptions import ODataV4Format + +from .._utils.model_base import Model as _Model, rest_field if TYPE_CHECKING: - # pylint: disable=unused-import,ungrouped-imports from .. import models as _models -class AddOrUpdateTextBlocklistItemsOptions(_model_base.Model): +class AddOrUpdateTextBlocklistItemsOptions(_Model): """The request to add blocklistItems to a text blocklist. - All required parameters must be populated in order to send to server. - :ivar blocklist_items: Array of blocklistItems to add. Required. :vartype blocklist_items: list[~azure.ai.contentsafety.models.TextBlocklistItem] """ - blocklist_items: List["_models.TextBlocklistItem"] = rest_field(name="blocklistItems") + blocklist_items: list["_models.TextBlocklistItem"] = rest_field( + name="blocklistItems", visibility=["read", "create", "update", "delete", "query"] + ) """Array of blocklistItems to add. Required.""" @overload def __init__( self, *, - blocklist_items: List["_models.TextBlocklistItem"], - ): - ... + blocklist_items: list["_models.TextBlocklistItem"], + ) -> None: ... @overload - def __init__(self, mapping: Mapping[str, Any]): + def __init__(self, mapping: Mapping[str, Any]) -> None: """ :param mapping: raw JSON to initialize the model. :type mapping: Mapping[str, Any] """ - def __init__(self, *args: Any, **kwargs: Any) -> None: # pylint: disable=useless-super-delegation + def __init__(self, *args: Any, **kwargs: Any) -> None: super().__init__(*args, **kwargs) -class AddOrUpdateTextBlocklistItemsResult(_model_base.Model): +class AddOrUpdateTextBlocklistItemsResult(_Model): """The response of adding blocklistItems to the text blocklist. - All required parameters must be populated in order to send to server. - :ivar blocklist_items: Array of blocklistItems have been added. Required. :vartype blocklist_items: list[~azure.ai.contentsafety.models.TextBlocklistItem] """ - blocklist_items: List["_models.TextBlocklistItem"] = rest_field(name="blocklistItems") + blocklist_items: list["_models.TextBlocklistItem"] = rest_field( + name="blocklistItems", visibility=["read", "create", "update", "delete", "query"] + ) """Array of blocklistItems have been added. Required.""" @overload def __init__( self, *, - blocklist_items: List["_models.TextBlocklistItem"], - ): - ... + blocklist_items: list["_models.TextBlocklistItem"], + ) -> None: ... @overload - def __init__(self, mapping: Mapping[str, Any]): + def __init__(self, mapping: Mapping[str, Any]) -> None: """ :param mapping: raw JSON to initialize the model. :type mapping: Mapping[str, Any] """ - def __init__(self, *args: Any, **kwargs: Any) -> None: # pylint: disable=useless-super-delegation + def __init__(self, *args: Any, **kwargs: Any) -> None: super().__init__(*args, **kwargs) -class AnalyzeImageOptions(_model_base.Model): +class AnalyzeImageOptions(_Model): """The image analysis request. - All required parameters must be populated in order to send to server. - - :ivar image: The image needs to be analyzed. Required. + :ivar image: The image to be analyzed. Required. :vartype image: ~azure.ai.contentsafety.models.ImageData :ivar categories: The categories will be analyzed. If they are not assigned, a default set of analysis results for the categories will be returned. @@ -94,12 +91,16 @@ class AnalyzeImageOptions(_model_base.Model): :vartype output_type: str or ~azure.ai.contentsafety.models.AnalyzeImageOutputType """ - image: "_models.ImageData" = rest_field() - """The image needs to be analyzed. Required.""" - categories: Optional[List[Union[str, "_models.ImageCategory"]]] = rest_field() + image: "_models.ImageData" = rest_field(visibility=["read", "create", "update", "delete", "query"]) + """The image to be analyzed. Required.""" + categories: Optional[list[Union[str, "_models.ImageCategory"]]] = rest_field( + visibility=["read", "create", "update", "delete", "query"] + ) """The categories will be analyzed. If they are not assigned, a default set of analysis results for the categories will be returned.""" - output_type: Optional[Union[str, "_models.AnalyzeImageOutputType"]] = rest_field(name="outputType") + output_type: Optional[Union[str, "_models.AnalyzeImageOutputType"]] = rest_field( + name="outputType", visibility=["read", "create", "update", "delete", "query"] + ) """This refers to the type of image analysis output. If no value is assigned, the default value will be \"FourSeverityLevels\". \"FourSeverityLevels\"""" @@ -108,60 +109,56 @@ def __init__( self, *, image: "_models.ImageData", - categories: Optional[List[Union[str, "_models.ImageCategory"]]] = None, + categories: Optional[list[Union[str, "_models.ImageCategory"]]] = None, output_type: Optional[Union[str, "_models.AnalyzeImageOutputType"]] = None, - ): - ... + ) -> None: ... @overload - def __init__(self, mapping: Mapping[str, Any]): + def __init__(self, mapping: Mapping[str, Any]) -> None: """ :param mapping: raw JSON to initialize the model. :type mapping: Mapping[str, Any] """ - def __init__(self, *args: Any, **kwargs: Any) -> None: # pylint: disable=useless-super-delegation + def __init__(self, *args: Any, **kwargs: Any) -> None: super().__init__(*args, **kwargs) -class AnalyzeImageResult(_model_base.Model): +class AnalyzeImageResult(_Model): """The image analysis response. - All required parameters must be populated in order to send to server. - :ivar categories_analysis: Analysis result for categories. Required. :vartype categories_analysis: list[~azure.ai.contentsafety.models.ImageCategoriesAnalysis] """ - categories_analysis: List["_models.ImageCategoriesAnalysis"] = rest_field(name="categoriesAnalysis") + categories_analysis: list["_models.ImageCategoriesAnalysis"] = rest_field( + name="categoriesAnalysis", visibility=["read", "create", "update", "delete", "query"] + ) """Analysis result for categories. Required.""" @overload def __init__( self, *, - categories_analysis: List["_models.ImageCategoriesAnalysis"], - ): - ... + categories_analysis: list["_models.ImageCategoriesAnalysis"], + ) -> None: ... @overload - def __init__(self, mapping: Mapping[str, Any]): + def __init__(self, mapping: Mapping[str, Any]) -> None: """ :param mapping: raw JSON to initialize the model. :type mapping: Mapping[str, Any] """ - def __init__(self, *args: Any, **kwargs: Any) -> None: # pylint: disable=useless-super-delegation + def __init__(self, *args: Any, **kwargs: Any) -> None: super().__init__(*args, **kwargs) -class AnalyzeTextOptions(_model_base.Model): +class AnalyzeTextOptions(_Model): """The text analysis request. - All required parameters must be populated in order to send to server. - - :ivar text: The text needs to be analyzed. We support a maximum of 10k Unicode characters - (Unicode code points) in the text of one request. Required. + :ivar text: The text to be analyzed. We support a maximum of 10k Unicode characters (Unicode + code points) in the text of one request. Required. :vartype text: str :ivar categories: The categories will be analyzed. If they are not assigned, a default set of analysis results for the categories will be returned. @@ -178,19 +175,27 @@ class AnalyzeTextOptions(_model_base.Model): :vartype output_type: str or ~azure.ai.contentsafety.models.AnalyzeTextOutputType """ - text: str = rest_field() - """The text needs to be analyzed. We support a maximum of 10k Unicode characters (Unicode code - points) in the text of one request. Required.""" - categories: Optional[List[Union[str, "_models.TextCategory"]]] = rest_field() + text: str = rest_field(visibility=["read", "create", "update", "delete", "query"]) + """The text to be analyzed. We support a maximum of 10k Unicode characters (Unicode code points) + in the text of one request. Required.""" + categories: Optional[list[Union[str, "_models.TextCategory"]]] = rest_field( + visibility=["read", "create", "update", "delete", "query"] + ) """The categories will be analyzed. If they are not assigned, a default set of analysis results for the categories will be returned.""" - blocklist_names: Optional[List[str]] = rest_field(name="blocklistNames") + blocklist_names: Optional[list[str]] = rest_field( + name="blocklistNames", visibility=["read", "create", "update", "delete", "query"] + ) """The names of blocklists.""" - halt_on_blocklist_hit: Optional[bool] = rest_field(name="haltOnBlocklistHit") + halt_on_blocklist_hit: Optional[bool] = rest_field( + name="haltOnBlocklistHit", visibility=["read", "create", "update", "delete", "query"] + ) """When set to true, further analyses of harmful content will not be performed in cases where blocklists are hit. When set to false, all analyses of harmful content will be performed, whether or not blocklists are hit.""" - output_type: Optional[Union[str, "_models.AnalyzeTextOutputType"]] = rest_field(name="outputType") + output_type: Optional[Union[str, "_models.AnalyzeTextOutputType"]] = rest_field( + name="outputType", visibility=["read", "create", "update", "delete", "query"] + ) """This refers to the type of text analysis output. If no value is assigned, the default value will be \"FourSeverityLevels\". Known values are: \"FourSeverityLevels\" and \"EightSeverityLevels\".""" @@ -200,64 +205,268 @@ def __init__( self, *, text: str, - categories: Optional[List[Union[str, "_models.TextCategory"]]] = None, - blocklist_names: Optional[List[str]] = None, + categories: Optional[list[Union[str, "_models.TextCategory"]]] = None, + blocklist_names: Optional[list[str]] = None, halt_on_blocklist_hit: Optional[bool] = None, output_type: Optional[Union[str, "_models.AnalyzeTextOutputType"]] = None, - ): - ... + ) -> None: ... @overload - def __init__(self, mapping: Mapping[str, Any]): + def __init__(self, mapping: Mapping[str, Any]) -> None: """ :param mapping: raw JSON to initialize the model. :type mapping: Mapping[str, Any] """ - def __init__(self, *args: Any, **kwargs: Any) -> None: # pylint: disable=useless-super-delegation + def __init__(self, *args: Any, **kwargs: Any) -> None: super().__init__(*args, **kwargs) -class AnalyzeTextResult(_model_base.Model): +class AnalyzeTextResult(_Model): """The text analysis response. - All required parameters must be populated in order to send to server. - :ivar blocklists_match: The blocklist match details. :vartype blocklists_match: list[~azure.ai.contentsafety.models.TextBlocklistMatch] :ivar categories_analysis: Analysis result for categories. Required. :vartype categories_analysis: list[~azure.ai.contentsafety.models.TextCategoriesAnalysis] """ - blocklists_match: Optional[List["_models.TextBlocklistMatch"]] = rest_field(name="blocklistsMatch") + blocklists_match: Optional[list["_models.TextBlocklistMatch"]] = rest_field( + name="blocklistsMatch", visibility=["read", "create", "update", "delete", "query"] + ) """The blocklist match details.""" - categories_analysis: List["_models.TextCategoriesAnalysis"] = rest_field(name="categoriesAnalysis") + categories_analysis: list["_models.TextCategoriesAnalysis"] = rest_field( + name="categoriesAnalysis", visibility=["read", "create", "update", "delete", "query"] + ) """Analysis result for categories. Required.""" @overload def __init__( self, *, - categories_analysis: List["_models.TextCategoriesAnalysis"], - blocklists_match: Optional[List["_models.TextBlocklistMatch"]] = None, - ): - ... + categories_analysis: list["_models.TextCategoriesAnalysis"], + blocklists_match: Optional[list["_models.TextBlocklistMatch"]] = None, + ) -> None: ... @overload - def __init__(self, mapping: Mapping[str, Any]): + def __init__(self, mapping: Mapping[str, Any]) -> None: """ :param mapping: raw JSON to initialize the model. :type mapping: Mapping[str, Any] """ - def __init__(self, *args: Any, **kwargs: Any) -> None: # pylint: disable=useless-super-delegation + def __init__(self, *args: Any, **kwargs: Any) -> None: super().__init__(*args, **kwargs) -class ImageCategoriesAnalysis(_model_base.Model): - """Image analysis result. +class DetectedProvenance(_Model): + """A Microsoft-issued provenance signal indicating the media was created or modified using AI. + + :ivar type: Detected provenance record type. Known values are: "C2PA" and "Watermark". + :vartype type: str or ~azure.ai.contentsafety.models.DetectedProvenanceType + :ivar provider: Identifier of the Microsoft provider that generated the content. + :vartype provider: str + :ivar model_name: Identifier of the generating AI model when available. + :vartype model_name: str + :ivar timestamp: Generation timestamp recorded in the provenance signal. + :vartype timestamp: ~datetime.datetime + """ + + type: Optional[Union[str, "_models.DetectedProvenanceType"]] = rest_field( + visibility=["read", "create", "update", "delete", "query"] + ) + """Detected provenance record type. Known values are: \"C2PA\" and \"Watermark\".""" + provider: Optional[str] = rest_field(visibility=["read", "create", "update", "delete", "query"]) + """Identifier of the Microsoft provider that generated the content.""" + model_name: Optional[str] = rest_field(name="modelName", visibility=["read", "create", "update", "delete", "query"]) + """Identifier of the generating AI model when available.""" + timestamp: Optional[datetime.datetime] = rest_field( + visibility=["read", "create", "update", "delete", "query"], format="rfc3339" + ) + """Generation timestamp recorded in the provenance signal.""" + + @overload + def __init__( + self, + *, + type: Optional[Union[str, "_models.DetectedProvenanceType"]] = None, + provider: Optional[str] = None, + model_name: Optional[str] = None, + timestamp: Optional[datetime.datetime] = None, + ) -> None: ... + + @overload + def __init__(self, mapping: Mapping[str, Any]) -> None: + """ + :param mapping: raw JSON to initialize the model. + :type mapping: Mapping[str, Any] + """ + + def __init__(self, *args: Any, **kwargs: Any) -> None: + super().__init__(*args, **kwargs) + + +class DetectProvenanceOptions(_Model): + """Input describing the media to inspect using Content Provenance Detection. + + :ivar content: Source content to inspect. Required. + :vartype content: ~azure.ai.contentsafety.models.ProvenanceContent + """ + + content: "_models.ProvenanceContent" = rest_field(visibility=["read", "create", "update", "delete", "query"]) + """Source content to inspect. Required.""" + + @overload + def __init__( + self, + *, + content: "_models.ProvenanceContent", + ) -> None: ... + + @overload + def __init__(self, mapping: Mapping[str, Any]) -> None: + """ + :param mapping: raw JSON to initialize the model. + :type mapping: Mapping[str, Any] + """ + + def __init__(self, *args: Any, **kwargs: Any) -> None: + super().__init__(*args, **kwargs) + + +class DetectProvenanceResult(_Model): + """Result of a Content Provenance Detection operation. + + :ivar outcome: Top-level outcome of the Content Provenance Detection operation. Required. Known + values are: "NoProvenanceDetected" and "ProvenanceDetected". + :vartype outcome: str or ~azure.ai.contentsafety.models.DetectOutcome + :ivar results: Detected provenance signals. Empty or omitted when ``outcome`` is + ``NoProvenanceDetected``. + :vartype results: list[~azure.ai.contentsafety.models.DetectedProvenance] + """ + + outcome: Union[str, "_models.DetectOutcome"] = rest_field( + visibility=["read", "create", "update", "delete", "query"] + ) + """Top-level outcome of the Content Provenance Detection operation. Required. Known values are: + \"NoProvenanceDetected\" and \"ProvenanceDetected\".""" + results: Optional[list["_models.DetectedProvenance"]] = rest_field( + visibility=["read", "create", "update", "delete", "query"] + ) + """Detected provenance signals. Empty or omitted when ``outcome`` is ``NoProvenanceDetected``.""" + + @overload + def __init__( + self, + *, + outcome: Union[str, "_models.DetectOutcome"], + results: Optional[list["_models.DetectedProvenance"]] = None, + ) -> None: ... + + @overload + def __init__(self, mapping: Mapping[str, Any]) -> None: + """ + :param mapping: raw JSON to initialize the model. + :type mapping: Mapping[str, Any] + """ + + def __init__(self, *args: Any, **kwargs: Any) -> None: + super().__init__(*args, **kwargs) + + +class DetectTextProtectedMaterialOptions(_Model): + """The request of detecting potential protected material present in the given text. + + :ivar text: The text to be analyzed, which may contain protected material. The characters will + be counted in Unicode code points. Required. + :vartype text: str + """ + + text: str = rest_field(visibility=["read", "create", "update", "delete", "query"]) + """The text to be analyzed, which may contain protected material. The characters will be counted + in Unicode code points. Required.""" + + @overload + def __init__( + self, + *, + text: str, + ) -> None: ... + + @overload + def __init__(self, mapping: Mapping[str, Any]) -> None: + """ + :param mapping: raw JSON to initialize the model. + :type mapping: Mapping[str, Any] + """ + + def __init__(self, *args: Any, **kwargs: Any) -> None: + super().__init__(*args, **kwargs) + + +class DetectTextProtectedMaterialResult(_Model): + """The combined detection results of potential protected material. + + :ivar protected_material_analysis: Analysis result for the given text. Required. + :vartype protected_material_analysis: + ~azure.ai.contentsafety.models.TextProtectedMaterialAnalysisResult + """ + + protected_material_analysis: "_models.TextProtectedMaterialAnalysisResult" = rest_field( + name="protectedMaterialAnalysis", visibility=["read", "create", "update", "delete", "query"] + ) + """Analysis result for the given text. Required.""" + + @overload + def __init__( + self, + *, + protected_material_analysis: "_models.TextProtectedMaterialAnalysisResult", + ) -> None: ... + + @overload + def __init__(self, mapping: Mapping[str, Any]) -> None: + """ + :param mapping: raw JSON to initialize the model. + :type mapping: Mapping[str, Any] + """ + + def __init__(self, *args: Any, **kwargs: Any) -> None: + super().__init__(*args, **kwargs) + + +class DocumentInjectionAnalysisResult(_Model): + """The individual analysis result of potential injection attacks in the given documents. + + :ivar attack_detected: Whether a potential injection attack is detected or not. Required. + :vartype attack_detected: bool + """ + + attack_detected: bool = rest_field( + name="attackDetected", visibility=["read", "create", "update", "delete", "query"] + ) + """Whether a potential injection attack is detected or not. Required.""" + + @overload + def __init__( + self, + *, + attack_detected: bool, + ) -> None: ... + + @overload + def __init__(self, mapping: Mapping[str, Any]) -> None: + """ + :param mapping: raw JSON to initialize the model. + :type mapping: Mapping[str, Any] + """ + + def __init__(self, *args: Any, **kwargs: Any) -> None: + super().__init__(*args, **kwargs) - All required parameters must be populated in order to send to server. + +class ImageCategoriesAnalysis(_Model): + """Image analysis result. :ivar category: The image analysis category. Required. Known values are: "Hate", "SelfHarm", "Sexual", and "Violence". @@ -268,10 +477,12 @@ class ImageCategoriesAnalysis(_model_base.Model): :vartype severity: int """ - category: Union[str, "_models.ImageCategory"] = rest_field() + category: Union[str, "_models.ImageCategory"] = rest_field( + visibility=["read", "create", "update", "delete", "query"] + ) """The image analysis category. Required. Known values are: \"Hate\", \"SelfHarm\", \"Sexual\", and \"Violence\".""" - severity: Optional[int] = rest_field() + severity: Optional[int] = rest_field(visibility=["read", "create", "update", "delete", "query"]) """The value increases with the severity of the input content. The value of this field is determined by the output type specified in the request. The output type could be ‘FourSeverityLevels’, and the output value can be 0, 2, 4, 6.""" @@ -282,21 +493,20 @@ def __init__( *, category: Union[str, "_models.ImageCategory"], severity: Optional[int] = None, - ): - ... + ) -> None: ... @overload - def __init__(self, mapping: Mapping[str, Any]): + def __init__(self, mapping: Mapping[str, Any]) -> None: """ :param mapping: raw JSON to initialize the model. :type mapping: Mapping[str, Any] """ - def __init__(self, *args: Any, **kwargs: Any) -> None: # pylint: disable=useless-super-delegation + def __init__(self, *args: Any, **kwargs: Any) -> None: super().__init__(*args, **kwargs) -class ImageData(_model_base.Model): +class ImageData(_Model): """The image can be either base64 encoded bytes or a blob URL. You can choose only one of these options. If both are provided, the request will be refused. The maximum image size is 2048 x 2048 pixels and should not exceed 4 MB, while the minimum image size is 50 x 50 pixels. @@ -307,9 +517,9 @@ class ImageData(_model_base.Model): :vartype blob_url: str """ - content: Optional[bytes] = rest_field(format="base64") + content: Optional[bytes] = rest_field(visibility=["read", "create", "update", "delete", "query"], format="base64") """The Base64 encoding of the image.""" - blob_url: Optional[str] = rest_field(name="blobUrl") + blob_url: Optional[str] = rest_field(name="blobUrl", visibility=["read", "create", "update", "delete", "query"]) """The blob url of the image.""" @overload @@ -318,55 +528,219 @@ def __init__( *, content: Optional[bytes] = None, blob_url: Optional[str] = None, - ): - ... + ) -> None: ... @overload - def __init__(self, mapping: Mapping[str, Any]): + def __init__(self, mapping: Mapping[str, Any]) -> None: """ :param mapping: raw JSON to initialize the model. :type mapping: Mapping[str, Any] """ - def __init__(self, *args: Any, **kwargs: Any) -> None: # pylint: disable=useless-super-delegation + def __init__(self, *args: Any, **kwargs: Any) -> None: super().__init__(*args, **kwargs) -class RemoveTextBlocklistItemsOptions(_model_base.Model): - """The request to remove blocklistItems from a text blocklist. +class ProvenanceContent(_Model): + """Source content descriptor for a Content Provenance Detection operation. + + :ivar uri: Blob URI of the media to inspect. Media up to 100 MB is supported. Supported + formats: image (JPEG, PNG, GIF, WebP), audio (MP3, WAV), and video (MP4). Required. + :vartype uri: str + """ + + uri: str = rest_field(visibility=["read", "create", "update", "delete", "query"]) + """Blob URI of the media to inspect. Media up to 100 MB is supported. Supported formats: image + (JPEG, PNG, GIF, WebP), audio (MP3, WAV), and video (MP4). Required.""" + + @overload + def __init__( + self, + *, + uri: str, + ) -> None: ... + + @overload + def __init__(self, mapping: Mapping[str, Any]) -> None: + """ + :param mapping: raw JSON to initialize the model. + :type mapping: Mapping[str, Any] + """ + + def __init__(self, *args: Any, **kwargs: Any) -> None: + super().__init__(*args, **kwargs) + + +class ProvenanceDetectOperation(_Model): + """Status and result of an asynchronous Content Provenance Detection operation. + + :ivar id: The unique ID of the operation. Required. + :vartype id: str + :ivar status: The status of the operation. Required. Known values are: "NotStarted", "Running", + "Succeeded", "Failed", and "Canceled". + :vartype status: str or ~azure.ai.contentsafety.models.OperationState + :ivar error: Error object that describes the error when status is "Failed". + :vartype error: ~azure.core.ODataV4Format + :ivar result: The result of the operation. + :vartype result: ~azure.ai.contentsafety.models.DetectProvenanceResult + :ivar kind: Kind of Content Provenance Detection operation. Required. "Detect" + :vartype kind: str or ~azure.ai.contentsafety.models.ProvenanceOperationKind + :ivar created_at: Date and time (UTC) when the operation was created. + :vartype created_at: ~datetime.datetime + :ivar last_updated_at: Date and time (UTC) when the status was last updated. + :vartype last_updated_at: ~datetime.datetime + """ + + id: str = rest_field(visibility=["read", "create", "update", "delete", "query"]) + """The unique ID of the operation. Required.""" + status: Union[str, "_models.OperationState"] = rest_field( + visibility=["read", "create", "update", "delete", "query"] + ) + """The status of the operation. Required. Known values are: \"NotStarted\", \"Running\", + \"Succeeded\", \"Failed\", and \"Canceled\".""" + error: Optional[ODataV4Format] = rest_field(visibility=["read", "create", "update", "delete", "query"]) + """Error object that describes the error when status is \"Failed\".""" + result: Optional["_models.DetectProvenanceResult"] = rest_field( + visibility=["read", "create", "update", "delete", "query"] + ) + """The result of the operation.""" + kind: Union[str, "_models.ProvenanceOperationKind"] = rest_field(visibility=["read"]) + """Kind of Content Provenance Detection operation. Required. \"Detect\"""" + created_at: Optional[datetime.datetime] = rest_field(name="createdAt", visibility=["read"], format="rfc3339") + """Date and time (UTC) when the operation was created.""" + last_updated_at: Optional[datetime.datetime] = rest_field( + name="lastUpdatedAt", visibility=["read"], format="rfc3339" + ) + """Date and time (UTC) when the status was last updated.""" + + @overload + def __init__( + self, + *, + id: str, # pylint: disable=redefined-builtin + status: Union[str, "_models.OperationState"], + error: Optional[ODataV4Format] = None, + result: Optional["_models.DetectProvenanceResult"] = None, + ) -> None: ... + + @overload + def __init__(self, mapping: Mapping[str, Any]) -> None: + """ + :param mapping: raw JSON to initialize the model. + :type mapping: Mapping[str, Any] + """ + + def __init__(self, *args: Any, **kwargs: Any) -> None: + super().__init__(*args, **kwargs) - All required parameters must be populated in order to send to server. + +class RemoveTextBlocklistItemsOptions(_Model): + """The request to remove blocklistItems from a text blocklist. :ivar blocklist_item_ids: Array of blocklistItemIds to remove. Required. :vartype blocklist_item_ids: list[str] """ - blocklist_item_ids: List[str] = rest_field(name="blocklistItemIds") + blocklist_item_ids: list[str] = rest_field( + name="blocklistItemIds", visibility=["read", "create", "update", "delete", "query"] + ) """Array of blocklistItemIds to remove. Required.""" @overload def __init__( self, *, - blocklist_item_ids: List[str], - ): - ... + blocklist_item_ids: list[str], + ) -> None: ... @overload - def __init__(self, mapping: Mapping[str, Any]): + def __init__(self, mapping: Mapping[str, Any]) -> None: """ :param mapping: raw JSON to initialize the model. :type mapping: Mapping[str, Any] """ - def __init__(self, *args: Any, **kwargs: Any) -> None: # pylint: disable=useless-super-delegation + def __init__(self, *args: Any, **kwargs: Any) -> None: super().__init__(*args, **kwargs) -class TextBlocklist(_model_base.Model): - """Text Blocklist. +class ShieldPromptOptions(_Model): + """The request of analyzing potential direct or indirect injection attacks. + + :ivar user_prompt: The user prompt to be analyzed, which may contain direct injection attacks. + :vartype user_prompt: str + :ivar documents: The documents to be analyzed, which may contain direct or indirect injection + attacks. + :vartype documents: list[str] + """ - All required parameters must be populated in order to send to server. + user_prompt: Optional[str] = rest_field( + name="userPrompt", visibility=["read", "create", "update", "delete", "query"] + ) + """The user prompt to be analyzed, which may contain direct injection attacks.""" + documents: Optional[list[str]] = rest_field(visibility=["read", "create", "update", "delete", "query"]) + """The documents to be analyzed, which may contain direct or indirect injection attacks.""" + + @overload + def __init__( + self, + *, + user_prompt: Optional[str] = None, + documents: Optional[list[str]] = None, + ) -> None: ... + + @overload + def __init__(self, mapping: Mapping[str, Any]) -> None: + """ + :param mapping: raw JSON to initialize the model. + :type mapping: Mapping[str, Any] + """ + + def __init__(self, *args: Any, **kwargs: Any) -> None: + super().__init__(*args, **kwargs) + + +class ShieldPromptResult(_Model): + """The combined analysis results of potential direct or indirect injection attacks. + + :ivar user_prompt_analysis: Direct injection attacks analysis result for the given user prompt. + :vartype user_prompt_analysis: ~azure.ai.contentsafety.models.UserPromptInjectionAnalysisResult + :ivar documents_analysis: Direct and indirect injection attacks analysis result for the given + documents. + :vartype documents_analysis: + list[~azure.ai.contentsafety.models.DocumentInjectionAnalysisResult] + """ + + user_prompt_analysis: Optional["_models.UserPromptInjectionAnalysisResult"] = rest_field( + name="userPromptAnalysis", visibility=["read", "create", "update", "delete", "query"] + ) + """Direct injection attacks analysis result for the given user prompt.""" + documents_analysis: Optional[list["_models.DocumentInjectionAnalysisResult"]] = rest_field( + name="documentsAnalysis", visibility=["read", "create", "update", "delete", "query"] + ) + """Direct and indirect injection attacks analysis result for the given documents.""" + + @overload + def __init__( + self, + *, + user_prompt_analysis: Optional["_models.UserPromptInjectionAnalysisResult"] = None, + documents_analysis: Optional[list["_models.DocumentInjectionAnalysisResult"]] = None, + ) -> None: ... + + @overload + def __init__(self, mapping: Mapping[str, Any]) -> None: + """ + :param mapping: raw JSON to initialize the model. + :type mapping: Mapping[str, Any] + """ + + def __init__(self, *args: Any, **kwargs: Any) -> None: + super().__init__(*args, **kwargs) + + +class TextBlocklist(_Model): + """Text Blocklist. :ivar blocklist_name: Text blocklist name. Required. :vartype blocklist_name: str @@ -376,7 +750,7 @@ class TextBlocklist(_model_base.Model): blocklist_name: str = rest_field(name="blocklistName", visibility=["read", "create", "query"]) """Text blocklist name. Required.""" - description: Optional[str] = rest_field() + description: Optional[str] = rest_field(visibility=["read", "create", "update", "delete", "query"]) """Text blocklist description.""" @overload @@ -385,42 +759,42 @@ def __init__( *, blocklist_name: str, description: Optional[str] = None, - ): - ... + ) -> None: ... @overload - def __init__(self, mapping: Mapping[str, Any]): + def __init__(self, mapping: Mapping[str, Any]) -> None: """ :param mapping: raw JSON to initialize the model. :type mapping: Mapping[str, Any] """ - def __init__(self, *args: Any, **kwargs: Any) -> None: # pylint: disable=useless-super-delegation + def __init__(self, *args: Any, **kwargs: Any) -> None: super().__init__(*args, **kwargs) -class TextBlocklistItem(_model_base.Model): +class TextBlocklistItem(_Model): """Item in a TextBlocklist. - Readonly variables are only populated by the server, and will be ignored when sending a request. - - All required parameters must be populated in order to send to server. - :ivar blocklist_item_id: The service will generate a BlocklistItemId, which will be a UUID. Required. :vartype blocklist_item_id: str :ivar description: BlocklistItem description. :vartype description: str - :ivar text: BlocklistItem content. Required. + :ivar text: BlocklistItem content. The length is counted using Unicode code point. Required. :vartype text: str + :ivar is_regex: An optional properties indicating whether this item is to be matched as a + regular expression. + :vartype is_regex: bool """ blocklist_item_id: str = rest_field(name="blocklistItemId", visibility=["read"]) """The service will generate a BlocklistItemId, which will be a UUID. Required.""" - description: Optional[str] = rest_field() + description: Optional[str] = rest_field(visibility=["read", "create", "update", "delete", "query"]) """BlocklistItem description.""" - text: str = rest_field() - """BlocklistItem content. Required.""" + text: str = rest_field(visibility=["read", "create", "update", "delete", "query"]) + """BlocklistItem content. The length is counted using Unicode code point. Required.""" + is_regex: Optional[bool] = rest_field(name="isRegex", visibility=["read", "create", "update", "delete", "query"]) + """An optional properties indicating whether this item is to be matched as a regular expression.""" @overload def __init__( @@ -428,25 +802,23 @@ def __init__( *, text: str, description: Optional[str] = None, - ): - ... + is_regex: Optional[bool] = None, + ) -> None: ... @overload - def __init__(self, mapping: Mapping[str, Any]): + def __init__(self, mapping: Mapping[str, Any]) -> None: """ :param mapping: raw JSON to initialize the model. :type mapping: Mapping[str, Any] """ - def __init__(self, *args: Any, **kwargs: Any) -> None: # pylint: disable=useless-super-delegation + def __init__(self, *args: Any, **kwargs: Any) -> None: super().__init__(*args, **kwargs) -class TextBlocklistMatch(_model_base.Model): +class TextBlocklistMatch(_Model): """The result of blocklist match. - All required parameters must be populated in order to send to server. - :ivar blocklist_name: The name of the matched blocklist. Required. :vartype blocklist_name: str :ivar blocklist_item_id: The ID of the matched item. Required. @@ -455,11 +827,15 @@ class TextBlocklistMatch(_model_base.Model): :vartype blocklist_item_text: str """ - blocklist_name: str = rest_field(name="blocklistName") + blocklist_name: str = rest_field(name="blocklistName", visibility=["read", "create", "update", "delete", "query"]) """The name of the matched blocklist. Required.""" - blocklist_item_id: str = rest_field(name="blocklistItemId") + blocklist_item_id: str = rest_field( + name="blocklistItemId", visibility=["read", "create", "update", "delete", "query"] + ) """The ID of the matched item. Required.""" - blocklist_item_text: str = rest_field(name="blocklistItemText") + blocklist_item_text: str = rest_field( + name="blocklistItemText", visibility=["read", "create", "update", "delete", "query"] + ) """The content of the matched item. Required.""" @overload @@ -469,25 +845,22 @@ def __init__( blocklist_name: str, blocklist_item_id: str, blocklist_item_text: str, - ): - ... + ) -> None: ... @overload - def __init__(self, mapping: Mapping[str, Any]): + def __init__(self, mapping: Mapping[str, Any]) -> None: """ :param mapping: raw JSON to initialize the model. :type mapping: Mapping[str, Any] """ - def __init__(self, *args: Any, **kwargs: Any) -> None: # pylint: disable=useless-super-delegation + def __init__(self, *args: Any, **kwargs: Any) -> None: super().__init__(*args, **kwargs) -class TextCategoriesAnalysis(_model_base.Model): +class TextCategoriesAnalysis(_Model): """Text analysis result. - All required parameters must be populated in order to send to server. - :ivar category: The text analysis category. Required. Known values are: "Hate", "SelfHarm", "Sexual", and "Violence". :vartype category: str or ~azure.ai.contentsafety.models.TextCategory @@ -498,10 +871,12 @@ class TextCategoriesAnalysis(_model_base.Model): :vartype severity: int """ - category: Union[str, "_models.TextCategory"] = rest_field() + category: Union[str, "_models.TextCategory"] = rest_field( + visibility=["read", "create", "update", "delete", "query"] + ) """The text analysis category. Required. Known values are: \"Hate\", \"SelfHarm\", \"Sexual\", and \"Violence\".""" - severity: Optional[int] = rest_field() + severity: Optional[int] = rest_field(visibility=["read", "create", "update", "delete", "query"]) """The value increases with the severity of the input content. The value of this field is determined by the output type specified in the request. The output type could be ‘FourSeverityLevels’ or ‘EightSeverity Levels’, and the output value can be 0, 2, 4, 6 or 0, 1, @@ -513,15 +888,72 @@ def __init__( *, category: Union[str, "_models.TextCategory"], severity: Optional[int] = None, - ): - ... + ) -> None: ... + + @overload + def __init__(self, mapping: Mapping[str, Any]) -> None: + """ + :param mapping: raw JSON to initialize the model. + :type mapping: Mapping[str, Any] + """ + + def __init__(self, *args: Any, **kwargs: Any) -> None: + super().__init__(*args, **kwargs) + + +class TextProtectedMaterialAnalysisResult(_Model): + """The individual detection result of potential protected material. + + :ivar detected: Whether potential protected material is detected or not. Required. + :vartype detected: bool + """ + + detected: bool = rest_field(visibility=["read", "create", "update", "delete", "query"]) + """Whether potential protected material is detected or not. Required.""" + + @overload + def __init__( + self, + *, + detected: bool, + ) -> None: ... + + @overload + def __init__(self, mapping: Mapping[str, Any]) -> None: + """ + :param mapping: raw JSON to initialize the model. + :type mapping: Mapping[str, Any] + """ + + def __init__(self, *args: Any, **kwargs: Any) -> None: + super().__init__(*args, **kwargs) + + +class UserPromptInjectionAnalysisResult(_Model): + """The individual analysis result of potential injection attacks in the given user prompt. + + :ivar attack_detected: Whether a potential injection attack is detected or not. Required. + :vartype attack_detected: bool + """ + + attack_detected: bool = rest_field( + name="attackDetected", visibility=["read", "create", "update", "delete", "query"] + ) + """Whether a potential injection attack is detected or not. Required.""" + + @overload + def __init__( + self, + *, + attack_detected: bool, + ) -> None: ... @overload - def __init__(self, mapping: Mapping[str, Any]): + def __init__(self, mapping: Mapping[str, Any]) -> None: """ :param mapping: raw JSON to initialize the model. :type mapping: Mapping[str, Any] """ - def __init__(self, *args: Any, **kwargs: Any) -> None: # pylint: disable=useless-super-delegation + def __init__(self, *args: Any, **kwargs: Any) -> None: super().__init__(*args, **kwargs) diff --git a/sdk/contentsafety/azure-ai-contentsafety/azure/ai/contentsafety/models/_patch.py b/sdk/contentsafety/azure-ai-contentsafety/azure/ai/contentsafety/models/_patch.py index f7dd32510333..87676c65a8f0 100644 --- a/sdk/contentsafety/azure-ai-contentsafety/azure/ai/contentsafety/models/_patch.py +++ b/sdk/contentsafety/azure-ai-contentsafety/azure/ai/contentsafety/models/_patch.py @@ -1,14 +1,15 @@ -# ------------------------------------ -# Copyright (c) Microsoft Corporation. -# Licensed under the MIT License. -# ------------------------------------ +# coding=utf-8 +# -------------------------------------------------------------------------- +# Copyright (c) Microsoft Corporation. All rights reserved. +# Licensed under the MIT License. See License.txt in the project root for license information. +# -------------------------------------------------------------------------- """Customize generated code here. Follow our quickstart for examples: https://aka.ms/azsdk/python/dpcodegen/python/customize """ -from typing import List -__all__: List[str] = [] # Add all objects you want publicly available to users at this package level + +__all__: list[str] = [] # Add all objects you want publicly available to users at this package level def patch_sdk(): diff --git a/sdk/contentsafety/azure-ai-contentsafety/azure/ai/contentsafety/types.py b/sdk/contentsafety/azure-ai-contentsafety/azure/ai/contentsafety/types.py new file mode 100644 index 000000000000..1ab0529c725d --- /dev/null +++ b/sdk/contentsafety/azure-ai-contentsafety/azure/ai/contentsafety/types.py @@ -0,0 +1,207 @@ +# coding=utf-8 +# -------------------------------------------------------------------------- +# Copyright (c) Microsoft Corporation. All rights reserved. +# Licensed under the MIT License. See License.txt in the project root for license information. +# Code generated by Microsoft (R) Python Code Generator. +# Changes may cause incorrect behavior and will be lost if the code is regenerated. +# -------------------------------------------------------------------------- + +from typing import TYPE_CHECKING, Union +from typing_extensions import Required, TypedDict + +if TYPE_CHECKING: + from .models import AnalyzeImageOutputType, AnalyzeTextOutputType, ImageCategory, TextCategory + + +class AddOrUpdateTextBlocklistItemsOptions(TypedDict, total=False): + """The request to add blocklistItems to a text blocklist. + + :ivar blocklist_items: Array of blocklistItems to add. Required. + :vartype blocklist_items: list["TextBlocklistItem"] + """ + + blocklistItems: Required[list["TextBlocklistItem"]] + """Array of blocklistItems to add. Required.""" + + +class AnalyzeImageOptions(TypedDict, total=False): + """The image analysis request. + + :ivar image: The image to be analyzed. Required. + :vartype image: "ImageData" + :ivar categories: The categories will be analyzed. If they are not assigned, a default set of + analysis results for the categories will be returned. + :vartype categories: list[Union[str, "ImageCategory"]] + :ivar output_type: This refers to the type of image analysis output. If no value is assigned, + the default value will be "FourSeverityLevels". "FourSeverityLevels" + :vartype output_type: Union[str, "AnalyzeImageOutputType"] + """ + + image: Required["ImageData"] + """The image to be analyzed. Required.""" + categories: list[Union[str, "ImageCategory"]] + """The categories will be analyzed. If they are not assigned, a default set of analysis results + for the categories will be returned.""" + outputType: Union[str, "AnalyzeImageOutputType"] + """This refers to the type of image analysis output. If no value is assigned, the default value + will be \"FourSeverityLevels\". \"FourSeverityLevels\"""" + + +class AnalyzeTextOptions(TypedDict, total=False): + """The text analysis request. + + :ivar text: The text to be analyzed. We support a maximum of 10k Unicode characters (Unicode + code points) in the text of one request. Required. + :vartype text: str + :ivar categories: The categories will be analyzed. If they are not assigned, a default set of + analysis results for the categories will be returned. + :vartype categories: list[Union[str, "TextCategory"]] + :ivar blocklist_names: The names of blocklists. + :vartype blocklist_names: list[str] + :ivar halt_on_blocklist_hit: When set to true, further analyses of harmful content will not be + performed in cases where blocklists are hit. When set to false, all analyses of harmful content + will be performed, whether or not blocklists are hit. + :vartype halt_on_blocklist_hit: bool + :ivar output_type: This refers to the type of text analysis output. If no value is assigned, + the default value will be "FourSeverityLevels". Known values are: "FourSeverityLevels" and + "EightSeverityLevels". + :vartype output_type: Union[str, "AnalyzeTextOutputType"] + """ + + text: Required[str] + """The text to be analyzed. We support a maximum of 10k Unicode characters (Unicode code points) + in the text of one request. Required.""" + categories: list[Union[str, "TextCategory"]] + """The categories will be analyzed. If they are not assigned, a default set of analysis results + for the categories will be returned.""" + blocklistNames: list[str] + """The names of blocklists.""" + haltOnBlocklistHit: bool + """When set to true, further analyses of harmful content will not be performed in cases where + blocklists are hit. When set to false, all analyses of harmful content will be performed, + whether or not blocklists are hit.""" + outputType: Union[str, "AnalyzeTextOutputType"] + """This refers to the type of text analysis output. If no value is assigned, the default value + will be \"FourSeverityLevels\". Known values are: \"FourSeverityLevels\" and + \"EightSeverityLevels\".""" + + +class DetectProvenanceOptions(TypedDict, total=False): + """Input describing the media to inspect using Content Provenance Detection. + + :ivar content: Source content to inspect. Required. + :vartype content: "ProvenanceContent" + """ + + content: Required["ProvenanceContent"] + """Source content to inspect. Required.""" + + +class DetectTextProtectedMaterialOptions(TypedDict, total=False): + """The request of detecting potential protected material present in the given text. + + :ivar text: The text to be analyzed, which may contain protected material. The characters will + be counted in Unicode code points. Required. + :vartype text: str + """ + + text: Required[str] + """The text to be analyzed, which may contain protected material. The characters will be counted + in Unicode code points. Required.""" + + +class ImageData(TypedDict, total=False): + """The image can be either base64 encoded bytes or a blob URL. You can choose only one of these + options. If both are provided, the request will be refused. The maximum image size is 2048 x + 2048 pixels and should not exceed 4 MB, while the minimum image size is 50 x 50 pixels. + + :ivar content: The Base64 encoding of the image. + :vartype content: str + :ivar blob_url: The blob url of the image. + :vartype blob_url: str + """ + + content: str + """The Base64 encoding of the image.""" + blobUrl: str + """The blob url of the image.""" + + +class ProvenanceContent(TypedDict, total=False): + """Source content descriptor for a Content Provenance Detection operation. + + :ivar uri: Blob URI of the media to inspect. Media up to 100 MB is supported. Supported + formats: image (JPEG, PNG, GIF, WebP), audio (MP3, WAV), and video (MP4). Required. + :vartype uri: str + """ + + uri: Required[str] + """Blob URI of the media to inspect. Media up to 100 MB is supported. Supported formats: image + (JPEG, PNG, GIF, WebP), audio (MP3, WAV), and video (MP4). Required.""" + + +class RemoveTextBlocklistItemsOptions(TypedDict, total=False): + """The request to remove blocklistItems from a text blocklist. + + :ivar blocklist_item_ids: Array of blocklistItemIds to remove. Required. + :vartype blocklist_item_ids: list[str] + """ + + blocklistItemIds: Required[list[str]] + """Array of blocklistItemIds to remove. Required.""" + + +class ShieldPromptOptions(TypedDict, total=False): + """The request of analyzing potential direct or indirect injection attacks. + + :ivar user_prompt: The user prompt to be analyzed, which may contain direct injection attacks. + :vartype user_prompt: str + :ivar documents: The documents to be analyzed, which may contain direct or indirect injection + attacks. + :vartype documents: list[str] + """ + + userPrompt: str + """The user prompt to be analyzed, which may contain direct injection attacks.""" + documents: list[str] + """The documents to be analyzed, which may contain direct or indirect injection attacks.""" + + +class TextBlocklist(TypedDict, total=False): + """Text Blocklist. + + :ivar blocklist_name: Text blocklist name. Required. + :vartype blocklist_name: str + :ivar description: Text blocklist description. + :vartype description: str + """ + + blocklistName: Required[str] + """Text blocklist name. Required.""" + description: str + """Text blocklist description.""" + + +class TextBlocklistItem(TypedDict, total=False): + """Item in a TextBlocklist. + + :ivar blocklist_item_id: The service will generate a BlocklistItemId, which will be a UUID. + Required. + :vartype blocklist_item_id: str + :ivar description: BlocklistItem description. + :vartype description: str + :ivar text: BlocklistItem content. The length is counted using Unicode code point. Required. + :vartype text: str + :ivar is_regex: An optional properties indicating whether this item is to be matched as a + regular expression. + :vartype is_regex: bool + """ + + blocklistItemId: Required[str] + """The service will generate a BlocklistItemId, which will be a UUID. Required.""" + description: str + """BlocklistItem description.""" + text: Required[str] + """BlocklistItem content. The length is counted using Unicode code point. Required.""" + isRegex: bool + """An optional properties indicating whether this item is to be matched as a regular expression.""" diff --git a/sdk/contentsafety/azure-ai-contentsafety/generated_samples/add_or_update_blocklist_items.py b/sdk/contentsafety/azure-ai-contentsafety/generated_samples/add_or_update_blocklist_items.py new file mode 100644 index 000000000000..fc18330b2113 --- /dev/null +++ b/sdk/contentsafety/azure-ai-contentsafety/generated_samples/add_or_update_blocklist_items.py @@ -0,0 +1,34 @@ +# coding=utf-8 +# -------------------------------------------------------------------------- +# Copyright (c) Microsoft Corporation. All rights reserved. +# Licensed under the MIT License. See License.txt in the project root for license information. +# Code generated by Microsoft (R) Python Code Generator. +# Changes may cause incorrect behavior and will be lost if the code is regenerated. +# -------------------------------------------------------------------------- + +from azure.ai.contentsafety import BlocklistClient + +""" +# PREREQUISITES + pip install azure-ai-contentsafety +# USAGE + python add_or_update_blocklist_items.py +""" + + +def main(): + client = BlocklistClient( + endpoint="ENDPOINT", + credential="CREDENTIAL", + ) + + response = client.add_or_update_blocklist_items( + blocklist_name="TestBlocklist", + options={"blocklistItems": [{"blocklistItemId": "str", "text": "str", "description": "str", "isRegex": bool}]}, + ) + print(response) + + +# x-ms-original-file: 2026-07-01-preview/AddOrUpdateBlocklistItems.json +if __name__ == "__main__": + main() diff --git a/sdk/contentsafety/azure-ai-contentsafety/generated_samples/analyze_image.py b/sdk/contentsafety/azure-ai-contentsafety/generated_samples/analyze_image.py new file mode 100644 index 000000000000..a2e498f66ed3 --- /dev/null +++ b/sdk/contentsafety/azure-ai-contentsafety/generated_samples/analyze_image.py @@ -0,0 +1,37 @@ +# coding=utf-8 +# -------------------------------------------------------------------------- +# Copyright (c) Microsoft Corporation. All rights reserved. +# Licensed under the MIT License. See License.txt in the project root for license information. +# Code generated by Microsoft (R) Python Code Generator. +# Changes may cause incorrect behavior and will be lost if the code is regenerated. +# -------------------------------------------------------------------------- + +from azure.ai.contentsafety import ContentSafetyClient + +""" +# PREREQUISITES + pip install azure-ai-contentsafety +# USAGE + python analyze_image.py +""" + + +def main(): + client = ContentSafetyClient( + endpoint="ENDPOINT", + credential="CREDENTIAL", + ) + + response = client.analyze_image( + options={ + "image": {"blobUrl": "str", "content": bytes("bytes", encoding="utf-8")}, + "categories": ["str"], + "outputType": "str", + }, + ) + print(response) + + +# x-ms-original-file: 2026-07-01-preview/AnalyzeImage.json +if __name__ == "__main__": + main() diff --git a/sdk/contentsafety/azure-ai-contentsafety/generated_samples/analyze_text.py b/sdk/contentsafety/azure-ai-contentsafety/generated_samples/analyze_text.py new file mode 100644 index 000000000000..ee8d969566ef --- /dev/null +++ b/sdk/contentsafety/azure-ai-contentsafety/generated_samples/analyze_text.py @@ -0,0 +1,39 @@ +# coding=utf-8 +# -------------------------------------------------------------------------- +# Copyright (c) Microsoft Corporation. All rights reserved. +# Licensed under the MIT License. See License.txt in the project root for license information. +# Code generated by Microsoft (R) Python Code Generator. +# Changes may cause incorrect behavior and will be lost if the code is regenerated. +# -------------------------------------------------------------------------- + +from azure.ai.contentsafety import ContentSafetyClient + +""" +# PREREQUISITES + pip install azure-ai-contentsafety +# USAGE + python analyze_text.py +""" + + +def main(): + client = ContentSafetyClient( + endpoint="ENDPOINT", + credential="CREDENTIAL", + ) + + response = client.analyze_text( + options={ + "text": "str", + "blocklistNames": ["str"], + "categories": ["str"], + "haltOnBlocklistHit": bool, + "outputType": "str", + }, + ) + print(response) + + +# x-ms-original-file: 2026-07-01-preview/AnalyzeText.json +if __name__ == "__main__": + main() diff --git a/sdk/contentsafety/azure-ai-contentsafety/generated_samples/create_or_update_text_blocklist.py b/sdk/contentsafety/azure-ai-contentsafety/generated_samples/create_or_update_text_blocklist.py new file mode 100644 index 000000000000..4e92c10c1c42 --- /dev/null +++ b/sdk/contentsafety/azure-ai-contentsafety/generated_samples/create_or_update_text_blocklist.py @@ -0,0 +1,34 @@ +# coding=utf-8 +# -------------------------------------------------------------------------- +# Copyright (c) Microsoft Corporation. All rights reserved. +# Licensed under the MIT License. See License.txt in the project root for license information. +# Code generated by Microsoft (R) Python Code Generator. +# Changes may cause incorrect behavior and will be lost if the code is regenerated. +# -------------------------------------------------------------------------- + +from azure.ai.contentsafety import BlocklistClient + +""" +# PREREQUISITES + pip install azure-ai-contentsafety +# USAGE + python create_or_update_text_blocklist.py +""" + + +def main(): + client = BlocklistClient( + endpoint="ENDPOINT", + credential="CREDENTIAL", + ) + + response = client.create_or_update_text_blocklist( + blocklist_name="TestBlocklist", + options={"blocklistName": "str", "description": "str"}, + ) + print(response) + + +# x-ms-original-file: 2026-07-01-preview/CreateOrUpdateTextBlocklist.json +if __name__ == "__main__": + main() diff --git a/sdk/contentsafety/azure-ai-contentsafety/generated_samples/delete_text_blocklist.py b/sdk/contentsafety/azure-ai-contentsafety/generated_samples/delete_text_blocklist.py new file mode 100644 index 000000000000..f250c526932e --- /dev/null +++ b/sdk/contentsafety/azure-ai-contentsafety/generated_samples/delete_text_blocklist.py @@ -0,0 +1,32 @@ +# coding=utf-8 +# -------------------------------------------------------------------------- +# Copyright (c) Microsoft Corporation. All rights reserved. +# Licensed under the MIT License. See License.txt in the project root for license information. +# Code generated by Microsoft (R) Python Code Generator. +# Changes may cause incorrect behavior and will be lost if the code is regenerated. +# -------------------------------------------------------------------------- + +from azure.ai.contentsafety import BlocklistClient + +""" +# PREREQUISITES + pip install azure-ai-contentsafety +# USAGE + python delete_text_blocklist.py +""" + + +def main(): + client = BlocklistClient( + endpoint="ENDPOINT", + credential="CREDENTIAL", + ) + + client.delete_text_blocklist( + blocklist_name="TestBlocklist", + ) + + +# x-ms-original-file: 2026-07-01-preview/DeleteTextBlocklist.json +if __name__ == "__main__": + main() diff --git a/sdk/contentsafety/azure-ai-contentsafety/generated_samples/detect_text_protected_material.py b/sdk/contentsafety/azure-ai-contentsafety/generated_samples/detect_text_protected_material.py new file mode 100644 index 000000000000..2ba61f910f12 --- /dev/null +++ b/sdk/contentsafety/azure-ai-contentsafety/generated_samples/detect_text_protected_material.py @@ -0,0 +1,33 @@ +# coding=utf-8 +# -------------------------------------------------------------------------- +# Copyright (c) Microsoft Corporation. All rights reserved. +# Licensed under the MIT License. See License.txt in the project root for license information. +# Code generated by Microsoft (R) Python Code Generator. +# Changes may cause incorrect behavior and will be lost if the code is regenerated. +# -------------------------------------------------------------------------- + +from azure.ai.contentsafety import ContentSafetyClient + +""" +# PREREQUISITES + pip install azure-ai-contentsafety +# USAGE + python detect_text_protected_material.py +""" + + +def main(): + client = ContentSafetyClient( + endpoint="ENDPOINT", + credential="CREDENTIAL", + ) + + response = client.detect_text_protected_material( + options={"text": "str"}, + ) + print(response) + + +# x-ms-original-file: 2026-07-01-preview/DetectTextProtectedMaterial.json +if __name__ == "__main__": + main() diff --git a/sdk/contentsafety/azure-ai-contentsafety/generated_samples/get_text_blocklist.py b/sdk/contentsafety/azure-ai-contentsafety/generated_samples/get_text_blocklist.py new file mode 100644 index 000000000000..e0417621b2fb --- /dev/null +++ b/sdk/contentsafety/azure-ai-contentsafety/generated_samples/get_text_blocklist.py @@ -0,0 +1,33 @@ +# coding=utf-8 +# -------------------------------------------------------------------------- +# Copyright (c) Microsoft Corporation. All rights reserved. +# Licensed under the MIT License. See License.txt in the project root for license information. +# Code generated by Microsoft (R) Python Code Generator. +# Changes may cause incorrect behavior and will be lost if the code is regenerated. +# -------------------------------------------------------------------------- + +from azure.ai.contentsafety import BlocklistClient + +""" +# PREREQUISITES + pip install azure-ai-contentsafety +# USAGE + python get_text_blocklist.py +""" + + +def main(): + client = BlocklistClient( + endpoint="ENDPOINT", + credential="CREDENTIAL", + ) + + response = client.get_text_blocklist( + blocklist_name="TestBlocklist", + ) + print(response) + + +# x-ms-original-file: 2026-07-01-preview/GetTextBlocklist.json +if __name__ == "__main__": + main() diff --git a/sdk/contentsafety/azure-ai-contentsafety/generated_samples/get_text_blocklist_item.py b/sdk/contentsafety/azure-ai-contentsafety/generated_samples/get_text_blocklist_item.py new file mode 100644 index 000000000000..b347c6a50662 --- /dev/null +++ b/sdk/contentsafety/azure-ai-contentsafety/generated_samples/get_text_blocklist_item.py @@ -0,0 +1,34 @@ +# coding=utf-8 +# -------------------------------------------------------------------------- +# Copyright (c) Microsoft Corporation. All rights reserved. +# Licensed under the MIT License. See License.txt in the project root for license information. +# Code generated by Microsoft (R) Python Code Generator. +# Changes may cause incorrect behavior and will be lost if the code is regenerated. +# -------------------------------------------------------------------------- + +from azure.ai.contentsafety import BlocklistClient + +""" +# PREREQUISITES + pip install azure-ai-contentsafety +# USAGE + python get_text_blocklist_item.py +""" + + +def main(): + client = BlocklistClient( + endpoint="ENDPOINT", + credential="CREDENTIAL", + ) + + response = client.get_text_blocklist_item( + blocklist_name="TestBlocklist", + blocklist_item_id="9511969e-f1e3-4604-9127-05ee16c509ec", + ) + print(response) + + +# x-ms-original-file: 2026-07-01-preview/GetTextBlocklistItem.json +if __name__ == "__main__": + main() diff --git a/sdk/contentsafety/azure-ai-contentsafety/generated_samples/list_text_blocklist_items.py b/sdk/contentsafety/azure-ai-contentsafety/generated_samples/list_text_blocklist_items.py new file mode 100644 index 000000000000..d50c8f10d513 --- /dev/null +++ b/sdk/contentsafety/azure-ai-contentsafety/generated_samples/list_text_blocklist_items.py @@ -0,0 +1,34 @@ +# coding=utf-8 +# -------------------------------------------------------------------------- +# Copyright (c) Microsoft Corporation. All rights reserved. +# Licensed under the MIT License. See License.txt in the project root for license information. +# Code generated by Microsoft (R) Python Code Generator. +# Changes may cause incorrect behavior and will be lost if the code is regenerated. +# -------------------------------------------------------------------------- + +from azure.ai.contentsafety import BlocklistClient + +""" +# PREREQUISITES + pip install azure-ai-contentsafety +# USAGE + python list_text_blocklist_items.py +""" + + +def main(): + client = BlocklistClient( + endpoint="ENDPOINT", + credential="CREDENTIAL", + ) + + response = client.list_text_blocklist_items( + blocklist_name="TestBlocklist", + ) + for item in response: + print(item) + + +# x-ms-original-file: 2026-07-01-preview/ListTextBlocklistItems.json +if __name__ == "__main__": + main() diff --git a/sdk/contentsafety/azure-ai-contentsafety/generated_samples/list_text_blocklists.py b/sdk/contentsafety/azure-ai-contentsafety/generated_samples/list_text_blocklists.py new file mode 100644 index 000000000000..3961a1726596 --- /dev/null +++ b/sdk/contentsafety/azure-ai-contentsafety/generated_samples/list_text_blocklists.py @@ -0,0 +1,32 @@ +# coding=utf-8 +# -------------------------------------------------------------------------- +# Copyright (c) Microsoft Corporation. All rights reserved. +# Licensed under the MIT License. See License.txt in the project root for license information. +# Code generated by Microsoft (R) Python Code Generator. +# Changes may cause incorrect behavior and will be lost if the code is regenerated. +# -------------------------------------------------------------------------- + +from azure.ai.contentsafety import BlocklistClient + +""" +# PREREQUISITES + pip install azure-ai-contentsafety +# USAGE + python list_text_blocklists.py +""" + + +def main(): + client = BlocklistClient( + endpoint="ENDPOINT", + credential="CREDENTIAL", + ) + + response = client.list_text_blocklists() + for item in response: + print(item) + + +# x-ms-original-file: 2026-07-01-preview/ListTextBlocklists.json +if __name__ == "__main__": + main() diff --git a/sdk/contentsafety/azure-ai-contentsafety/generated_samples/provenance_detect.py b/sdk/contentsafety/azure-ai-contentsafety/generated_samples/provenance_detect.py new file mode 100644 index 000000000000..75cde4a50c54 --- /dev/null +++ b/sdk/contentsafety/azure-ai-contentsafety/generated_samples/provenance_detect.py @@ -0,0 +1,33 @@ +# coding=utf-8 +# -------------------------------------------------------------------------- +# Copyright (c) Microsoft Corporation. All rights reserved. +# Licensed under the MIT License. See License.txt in the project root for license information. +# Code generated by Microsoft (R) Python Code Generator. +# Changes may cause incorrect behavior and will be lost if the code is regenerated. +# -------------------------------------------------------------------------- + +from azure.ai.contentsafety import ContentProvenanceClient + +""" +# PREREQUISITES + pip install azure-ai-contentsafety +# USAGE + python provenance_detect.py +""" + + +def main(): + client = ContentProvenanceClient( + endpoint="ENDPOINT", + credential="CREDENTIAL", + ) + + response = client.begin_detect( + options={"content": {"uri": "https://contoso.blob.core.windows.net/inputs/sample.jpg"}}, + ).result() + print(response) + + +# x-ms-original-file: 2026-07-01-preview/ProvenanceDetect.json +if __name__ == "__main__": + main() diff --git a/sdk/contentsafety/azure-ai-contentsafety/generated_samples/provenance_get_operation_status.py b/sdk/contentsafety/azure-ai-contentsafety/generated_samples/provenance_get_operation_status.py new file mode 100644 index 000000000000..a12a8e5337aa --- /dev/null +++ b/sdk/contentsafety/azure-ai-contentsafety/generated_samples/provenance_get_operation_status.py @@ -0,0 +1,33 @@ +# coding=utf-8 +# -------------------------------------------------------------------------- +# Copyright (c) Microsoft Corporation. All rights reserved. +# Licensed under the MIT License. See License.txt in the project root for license information. +# Code generated by Microsoft (R) Python Code Generator. +# Changes may cause incorrect behavior and will be lost if the code is regenerated. +# -------------------------------------------------------------------------- + +from azure.ai.contentsafety import ContentProvenanceClient + +""" +# PREREQUISITES + pip install azure-ai-contentsafety +# USAGE + python provenance_get_operation_status.py +""" + + +def main(): + client = ContentProvenanceClient( + endpoint="ENDPOINT", + credential="CREDENTIAL", + ) + + response = client.get_operation_status( + operation_id="3fa85f64-5717-4562-b3fc-2c963f66afa6", + ) + print(response) + + +# x-ms-original-file: 2026-07-01-preview/ProvenanceGetOperationStatus.json +if __name__ == "__main__": + main() diff --git a/sdk/contentsafety/azure-ai-contentsafety/generated_samples/remove_blocklist_items.py b/sdk/contentsafety/azure-ai-contentsafety/generated_samples/remove_blocklist_items.py new file mode 100644 index 000000000000..f98e73ad2fbd --- /dev/null +++ b/sdk/contentsafety/azure-ai-contentsafety/generated_samples/remove_blocklist_items.py @@ -0,0 +1,33 @@ +# coding=utf-8 +# -------------------------------------------------------------------------- +# Copyright (c) Microsoft Corporation. All rights reserved. +# Licensed under the MIT License. See License.txt in the project root for license information. +# Code generated by Microsoft (R) Python Code Generator. +# Changes may cause incorrect behavior and will be lost if the code is regenerated. +# -------------------------------------------------------------------------- + +from azure.ai.contentsafety import BlocklistClient + +""" +# PREREQUISITES + pip install azure-ai-contentsafety +# USAGE + python remove_blocklist_items.py +""" + + +def main(): + client = BlocklistClient( + endpoint="ENDPOINT", + credential="CREDENTIAL", + ) + + client.remove_blocklist_items( + blocklist_name="TestBlocklist", + options={"blocklistItemIds": ["str"]}, + ) + + +# x-ms-original-file: 2026-07-01-preview/RemoveBlocklistItems.json +if __name__ == "__main__": + main() diff --git a/sdk/contentsafety/azure-ai-contentsafety/generated_samples/shield_prompt.py b/sdk/contentsafety/azure-ai-contentsafety/generated_samples/shield_prompt.py new file mode 100644 index 000000000000..77a8275e573b --- /dev/null +++ b/sdk/contentsafety/azure-ai-contentsafety/generated_samples/shield_prompt.py @@ -0,0 +1,33 @@ +# coding=utf-8 +# -------------------------------------------------------------------------- +# Copyright (c) Microsoft Corporation. All rights reserved. +# Licensed under the MIT License. See License.txt in the project root for license information. +# Code generated by Microsoft (R) Python Code Generator. +# Changes may cause incorrect behavior and will be lost if the code is regenerated. +# -------------------------------------------------------------------------- + +from azure.ai.contentsafety import ContentSafetyClient + +""" +# PREREQUISITES + pip install azure-ai-contentsafety +# USAGE + python shield_prompt.py +""" + + +def main(): + client = ContentSafetyClient( + endpoint="ENDPOINT", + credential="CREDENTIAL", + ) + + response = client.shield_prompt( + options={"documents": ["str"], "userPrompt": "str"}, + ) + print(response) + + +# x-ms-original-file: 2026-07-01-preview/ShieldPrompt.json +if __name__ == "__main__": + main() diff --git a/sdk/contentsafety/azure-ai-contentsafety/generated_tests/conftest.py b/sdk/contentsafety/azure-ai-contentsafety/generated_tests/conftest.py new file mode 100644 index 000000000000..3d0c9132f78e --- /dev/null +++ b/sdk/contentsafety/azure-ai-contentsafety/generated_tests/conftest.py @@ -0,0 +1,59 @@ +# coding=utf-8 +# -------------------------------------------------------------------------- +# Copyright (c) Microsoft Corporation. All rights reserved. +# Licensed under the MIT License. See License.txt in the project root for license information. +# Code generated by Microsoft (R) Python Code Generator. +# Changes may cause incorrect behavior and will be lost if the code is regenerated. +# -------------------------------------------------------------------------- +import os +import pytest +from dotenv import load_dotenv +from devtools_testutils import ( + test_proxy, + add_general_regex_sanitizer, + add_body_key_sanitizer, + add_header_regex_sanitizer, +) + +load_dotenv() + + +# For security, please avoid record sensitive identity information in recordings +@pytest.fixture(scope="session", autouse=True) +def add_sanitizers(test_proxy): + contentsafety_subscription_id = os.environ.get( + "CONTENTSAFETY_SUBSCRIPTION_ID", "00000000-0000-0000-0000-000000000000" + ) + contentsafety_tenant_id = os.environ.get("CONTENTSAFETY_TENANT_ID", "00000000-0000-0000-0000-000000000000") + contentsafety_client_id = os.environ.get("CONTENTSAFETY_CLIENT_ID", "00000000-0000-0000-0000-000000000000") + contentsafety_client_secret = os.environ.get("CONTENTSAFETY_CLIENT_SECRET", "00000000-0000-0000-0000-000000000000") + add_general_regex_sanitizer(regex=contentsafety_subscription_id, value="00000000-0000-0000-0000-000000000000") + add_general_regex_sanitizer(regex=contentsafety_tenant_id, value="00000000-0000-0000-0000-000000000000") + add_general_regex_sanitizer(regex=contentsafety_client_id, value="00000000-0000-0000-0000-000000000000") + add_general_regex_sanitizer(regex=contentsafety_client_secret, value="00000000-0000-0000-0000-000000000000") + + contentprovenance_subscription_id = os.environ.get( + "CONTENTPROVENANCE_SUBSCRIPTION_ID", "00000000-0000-0000-0000-000000000000" + ) + contentprovenance_tenant_id = os.environ.get("CONTENTPROVENANCE_TENANT_ID", "00000000-0000-0000-0000-000000000000") + contentprovenance_client_id = os.environ.get("CONTENTPROVENANCE_CLIENT_ID", "00000000-0000-0000-0000-000000000000") + contentprovenance_client_secret = os.environ.get( + "CONTENTPROVENANCE_CLIENT_SECRET", "00000000-0000-0000-0000-000000000000" + ) + add_general_regex_sanitizer(regex=contentprovenance_subscription_id, value="00000000-0000-0000-0000-000000000000") + add_general_regex_sanitizer(regex=contentprovenance_tenant_id, value="00000000-0000-0000-0000-000000000000") + add_general_regex_sanitizer(regex=contentprovenance_client_id, value="00000000-0000-0000-0000-000000000000") + add_general_regex_sanitizer(regex=contentprovenance_client_secret, value="00000000-0000-0000-0000-000000000000") + + blocklist_subscription_id = os.environ.get("BLOCKLIST_SUBSCRIPTION_ID", "00000000-0000-0000-0000-000000000000") + blocklist_tenant_id = os.environ.get("BLOCKLIST_TENANT_ID", "00000000-0000-0000-0000-000000000000") + blocklist_client_id = os.environ.get("BLOCKLIST_CLIENT_ID", "00000000-0000-0000-0000-000000000000") + blocklist_client_secret = os.environ.get("BLOCKLIST_CLIENT_SECRET", "00000000-0000-0000-0000-000000000000") + add_general_regex_sanitizer(regex=blocklist_subscription_id, value="00000000-0000-0000-0000-000000000000") + add_general_regex_sanitizer(regex=blocklist_tenant_id, value="00000000-0000-0000-0000-000000000000") + add_general_regex_sanitizer(regex=blocklist_client_id, value="00000000-0000-0000-0000-000000000000") + add_general_regex_sanitizer(regex=blocklist_client_secret, value="00000000-0000-0000-0000-000000000000") + + add_header_regex_sanitizer(key="Set-Cookie", value="[set-cookie;]") + add_header_regex_sanitizer(key="Cookie", value="cookie;") + add_body_key_sanitizer(json_path="$..access_token", value="access_token") diff --git a/sdk/contentsafety/azure-ai-contentsafety/generated_tests/test_blocklist.py b/sdk/contentsafety/azure-ai-contentsafety/generated_tests/test_blocklist.py new file mode 100644 index 000000000000..83deae7cb51a --- /dev/null +++ b/sdk/contentsafety/azure-ai-contentsafety/generated_tests/test_blocklist.py @@ -0,0 +1,105 @@ +# coding=utf-8 +# -------------------------------------------------------------------------- +# Copyright (c) Microsoft Corporation. All rights reserved. +# Licensed under the MIT License. See License.txt in the project root for license information. +# Code generated by Microsoft (R) Python Code Generator. +# Changes may cause incorrect behavior and will be lost if the code is regenerated. +# -------------------------------------------------------------------------- +import pytest +from devtools_testutils import recorded_by_proxy +from testpreparer import BlocklistClientTestBase, BlocklistPreparer + + +@pytest.mark.skip("you may need to update the auto-generated test case before run it") +class TestBlocklist(BlocklistClientTestBase): + @BlocklistPreparer() + @recorded_by_proxy + def test_add_or_update_blocklist_items(self, blocklist_endpoint): + client = self.create_client(endpoint=blocklist_endpoint) + response = client.add_or_update_blocklist_items( + blocklist_name="str", + options={ + "blocklistItems": [{"blocklistItemId": "str", "text": "str", "description": "str", "isRegex": bool}] + }, + ) + + # please add some check logic here by yourself + # ... + + @BlocklistPreparer() + @recorded_by_proxy + def test_create_or_update_text_blocklist(self, blocklist_endpoint): + client = self.create_client(endpoint=blocklist_endpoint) + response = client.create_or_update_text_blocklist( + blocklist_name="str", + options={"blocklistName": "str", "description": "str"}, + ) + + # please add some check logic here by yourself + # ... + + @BlocklistPreparer() + @recorded_by_proxy + def test_delete_text_blocklist(self, blocklist_endpoint): + client = self.create_client(endpoint=blocklist_endpoint) + response = client.delete_text_blocklist( + blocklist_name="str", + ) + + # please add some check logic here by yourself + # ... + + @BlocklistPreparer() + @recorded_by_proxy + def test_get_text_blocklist(self, blocklist_endpoint): + client = self.create_client(endpoint=blocklist_endpoint) + response = client.get_text_blocklist( + blocklist_name="str", + ) + + # please add some check logic here by yourself + # ... + + @BlocklistPreparer() + @recorded_by_proxy + def test_get_text_blocklist_item(self, blocklist_endpoint): + client = self.create_client(endpoint=blocklist_endpoint) + response = client.get_text_blocklist_item( + blocklist_name="str", + blocklist_item_id="str", + ) + + # please add some check logic here by yourself + # ... + + @BlocklistPreparer() + @recorded_by_proxy + def test_list_text_blocklist_items(self, blocklist_endpoint): + client = self.create_client(endpoint=blocklist_endpoint) + response = client.list_text_blocklist_items( + blocklist_name="str", + ) + result = [r for r in response] + # please add some check logic here by yourself + # ... + + @BlocklistPreparer() + @recorded_by_proxy + def test_list_text_blocklists(self, blocklist_endpoint): + client = self.create_client(endpoint=blocklist_endpoint) + response = client.list_text_blocklists() + result = [r for r in response] + # please add some check logic here by yourself + # ... + + @BlocklistPreparer() + @recorded_by_proxy + def test_remove_blocklist_items(self, blocklist_endpoint): + client = self.create_client(endpoint=blocklist_endpoint) + response = client.remove_blocklist_items( + blocklist_name="str", + options={"blocklistItemIds": ["str"]}, + ) + + # please add some check logic here by yourself + # ... diff --git a/sdk/contentsafety/azure-ai-contentsafety/generated_tests/test_blocklist_async.py b/sdk/contentsafety/azure-ai-contentsafety/generated_tests/test_blocklist_async.py new file mode 100644 index 000000000000..c38446aafb5c --- /dev/null +++ b/sdk/contentsafety/azure-ai-contentsafety/generated_tests/test_blocklist_async.py @@ -0,0 +1,106 @@ +# coding=utf-8 +# -------------------------------------------------------------------------- +# Copyright (c) Microsoft Corporation. All rights reserved. +# Licensed under the MIT License. See License.txt in the project root for license information. +# Code generated by Microsoft (R) Python Code Generator. +# Changes may cause incorrect behavior and will be lost if the code is regenerated. +# -------------------------------------------------------------------------- +import pytest +from devtools_testutils.aio import recorded_by_proxy_async +from testpreparer import BlocklistPreparer +from testpreparer_async import BlocklistClientTestBaseAsync + + +@pytest.mark.skip("you may need to update the auto-generated test case before run it") +class TestBlocklistAsync(BlocklistClientTestBaseAsync): + @BlocklistPreparer() + @recorded_by_proxy_async + async def test_add_or_update_blocklist_items(self, blocklist_endpoint): + client = self.create_async_client(endpoint=blocklist_endpoint) + response = await client.add_or_update_blocklist_items( + blocklist_name="str", + options={ + "blocklistItems": [{"blocklistItemId": "str", "text": "str", "description": "str", "isRegex": bool}] + }, + ) + + # please add some check logic here by yourself + # ... + + @BlocklistPreparer() + @recorded_by_proxy_async + async def test_create_or_update_text_blocklist(self, blocklist_endpoint): + client = self.create_async_client(endpoint=blocklist_endpoint) + response = await client.create_or_update_text_blocklist( + blocklist_name="str", + options={"blocklistName": "str", "description": "str"}, + ) + + # please add some check logic here by yourself + # ... + + @BlocklistPreparer() + @recorded_by_proxy_async + async def test_delete_text_blocklist(self, blocklist_endpoint): + client = self.create_async_client(endpoint=blocklist_endpoint) + response = await client.delete_text_blocklist( + blocklist_name="str", + ) + + # please add some check logic here by yourself + # ... + + @BlocklistPreparer() + @recorded_by_proxy_async + async def test_get_text_blocklist(self, blocklist_endpoint): + client = self.create_async_client(endpoint=blocklist_endpoint) + response = await client.get_text_blocklist( + blocklist_name="str", + ) + + # please add some check logic here by yourself + # ... + + @BlocklistPreparer() + @recorded_by_proxy_async + async def test_get_text_blocklist_item(self, blocklist_endpoint): + client = self.create_async_client(endpoint=blocklist_endpoint) + response = await client.get_text_blocklist_item( + blocklist_name="str", + blocklist_item_id="str", + ) + + # please add some check logic here by yourself + # ... + + @BlocklistPreparer() + @recorded_by_proxy_async + async def test_list_text_blocklist_items(self, blocklist_endpoint): + client = self.create_async_client(endpoint=blocklist_endpoint) + response = client.list_text_blocklist_items( + blocklist_name="str", + ) + result = [r async for r in response] + # please add some check logic here by yourself + # ... + + @BlocklistPreparer() + @recorded_by_proxy_async + async def test_list_text_blocklists(self, blocklist_endpoint): + client = self.create_async_client(endpoint=blocklist_endpoint) + response = client.list_text_blocklists() + result = [r async for r in response] + # please add some check logic here by yourself + # ... + + @BlocklistPreparer() + @recorded_by_proxy_async + async def test_remove_blocklist_items(self, blocklist_endpoint): + client = self.create_async_client(endpoint=blocklist_endpoint) + response = await client.remove_blocklist_items( + blocklist_name="str", + options={"blocklistItemIds": ["str"]}, + ) + + # please add some check logic here by yourself + # ... diff --git a/sdk/contentsafety/azure-ai-contentsafety/generated_tests/test_content_provenance.py b/sdk/contentsafety/azure-ai-contentsafety/generated_tests/test_content_provenance.py new file mode 100644 index 000000000000..1372eab73801 --- /dev/null +++ b/sdk/contentsafety/azure-ai-contentsafety/generated_tests/test_content_provenance.py @@ -0,0 +1,35 @@ +# coding=utf-8 +# -------------------------------------------------------------------------- +# Copyright (c) Microsoft Corporation. All rights reserved. +# Licensed under the MIT License. See License.txt in the project root for license information. +# Code generated by Microsoft (R) Python Code Generator. +# Changes may cause incorrect behavior and will be lost if the code is regenerated. +# -------------------------------------------------------------------------- +import pytest +from devtools_testutils import recorded_by_proxy +from testpreparer import ContentProvenanceClientTestBase, ContentProvenancePreparer + + +@pytest.mark.skip("you may need to update the auto-generated test case before run it") +class TestContentProvenance(ContentProvenanceClientTestBase): + @ContentProvenancePreparer() + @recorded_by_proxy + def test_begin_detect(self, contentprovenance_endpoint): + client = self.create_client(endpoint=contentprovenance_endpoint) + response = client.begin_detect( + options={"content": {"uri": "str"}}, + ).result() # call '.result()' to poll until service return final result + + # please add some check logic here by yourself + # ... + + @ContentProvenancePreparer() + @recorded_by_proxy + def test_get_operation_status(self, contentprovenance_endpoint): + client = self.create_client(endpoint=contentprovenance_endpoint) + response = client.get_operation_status( + operation_id="str", + ) + + # please add some check logic here by yourself + # ... diff --git a/sdk/contentsafety/azure-ai-contentsafety/generated_tests/test_content_provenance_async.py b/sdk/contentsafety/azure-ai-contentsafety/generated_tests/test_content_provenance_async.py new file mode 100644 index 000000000000..276e641635ab --- /dev/null +++ b/sdk/contentsafety/azure-ai-contentsafety/generated_tests/test_content_provenance_async.py @@ -0,0 +1,38 @@ +# coding=utf-8 +# -------------------------------------------------------------------------- +# Copyright (c) Microsoft Corporation. All rights reserved. +# Licensed under the MIT License. See License.txt in the project root for license information. +# Code generated by Microsoft (R) Python Code Generator. +# Changes may cause incorrect behavior and will be lost if the code is regenerated. +# -------------------------------------------------------------------------- +import pytest +from devtools_testutils.aio import recorded_by_proxy_async +from testpreparer import ContentProvenancePreparer +from testpreparer_async import ContentProvenanceClientTestBaseAsync + + +@pytest.mark.skip("you may need to update the auto-generated test case before run it") +class TestContentProvenanceAsync(ContentProvenanceClientTestBaseAsync): + @ContentProvenancePreparer() + @recorded_by_proxy_async + async def test_begin_detect(self, contentprovenance_endpoint): + client = self.create_async_client(endpoint=contentprovenance_endpoint) + response = await ( + await client.begin_detect( + options={"content": {"uri": "str"}}, + ) + ).result() # call '.result()' to poll until service return final result + + # please add some check logic here by yourself + # ... + + @ContentProvenancePreparer() + @recorded_by_proxy_async + async def test_get_operation_status(self, contentprovenance_endpoint): + client = self.create_async_client(endpoint=contentprovenance_endpoint) + response = await client.get_operation_status( + operation_id="str", + ) + + # please add some check logic here by yourself + # ... diff --git a/sdk/contentsafety/azure-ai-contentsafety/generated_tests/test_content_safety.py b/sdk/contentsafety/azure-ai-contentsafety/generated_tests/test_content_safety.py new file mode 100644 index 000000000000..836055fee94b --- /dev/null +++ b/sdk/contentsafety/azure-ai-contentsafety/generated_tests/test_content_safety.py @@ -0,0 +1,67 @@ +# coding=utf-8 +# -------------------------------------------------------------------------- +# Copyright (c) Microsoft Corporation. All rights reserved. +# Licensed under the MIT License. See License.txt in the project root for license information. +# Code generated by Microsoft (R) Python Code Generator. +# Changes may cause incorrect behavior and will be lost if the code is regenerated. +# -------------------------------------------------------------------------- +import pytest +from devtools_testutils import recorded_by_proxy +from testpreparer import ContentSafetyClientTestBase, ContentSafetyPreparer + + +@pytest.mark.skip("you may need to update the auto-generated test case before run it") +class TestContentSafety(ContentSafetyClientTestBase): + @ContentSafetyPreparer() + @recorded_by_proxy + def test_analyze_image(self, contentsafety_endpoint): + client = self.create_client(endpoint=contentsafety_endpoint) + response = client.analyze_image( + options={ + "image": {"blobUrl": "str", "content": bytes("bytes", encoding="utf-8")}, + "categories": ["str"], + "outputType": "str", + }, + ) + + # please add some check logic here by yourself + # ... + + @ContentSafetyPreparer() + @recorded_by_proxy + def test_analyze_text(self, contentsafety_endpoint): + client = self.create_client(endpoint=contentsafety_endpoint) + response = client.analyze_text( + options={ + "text": "str", + "blocklistNames": ["str"], + "categories": ["str"], + "haltOnBlocklistHit": bool, + "outputType": "str", + }, + ) + + # please add some check logic here by yourself + # ... + + @ContentSafetyPreparer() + @recorded_by_proxy + def test_detect_text_protected_material(self, contentsafety_endpoint): + client = self.create_client(endpoint=contentsafety_endpoint) + response = client.detect_text_protected_material( + options={"text": "str"}, + ) + + # please add some check logic here by yourself + # ... + + @ContentSafetyPreparer() + @recorded_by_proxy + def test_shield_prompt(self, contentsafety_endpoint): + client = self.create_client(endpoint=contentsafety_endpoint) + response = client.shield_prompt( + options={"documents": ["str"], "userPrompt": "str"}, + ) + + # please add some check logic here by yourself + # ... diff --git a/sdk/contentsafety/azure-ai-contentsafety/generated_tests/test_content_safety_async.py b/sdk/contentsafety/azure-ai-contentsafety/generated_tests/test_content_safety_async.py new file mode 100644 index 000000000000..9b32af356342 --- /dev/null +++ b/sdk/contentsafety/azure-ai-contentsafety/generated_tests/test_content_safety_async.py @@ -0,0 +1,68 @@ +# coding=utf-8 +# -------------------------------------------------------------------------- +# Copyright (c) Microsoft Corporation. All rights reserved. +# Licensed under the MIT License. See License.txt in the project root for license information. +# Code generated by Microsoft (R) Python Code Generator. +# Changes may cause incorrect behavior and will be lost if the code is regenerated. +# -------------------------------------------------------------------------- +import pytest +from devtools_testutils.aio import recorded_by_proxy_async +from testpreparer import ContentSafetyPreparer +from testpreparer_async import ContentSafetyClientTestBaseAsync + + +@pytest.mark.skip("you may need to update the auto-generated test case before run it") +class TestContentSafetyAsync(ContentSafetyClientTestBaseAsync): + @ContentSafetyPreparer() + @recorded_by_proxy_async + async def test_analyze_image(self, contentsafety_endpoint): + client = self.create_async_client(endpoint=contentsafety_endpoint) + response = await client.analyze_image( + options={ + "image": {"blobUrl": "str", "content": bytes("bytes", encoding="utf-8")}, + "categories": ["str"], + "outputType": "str", + }, + ) + + # please add some check logic here by yourself + # ... + + @ContentSafetyPreparer() + @recorded_by_proxy_async + async def test_analyze_text(self, contentsafety_endpoint): + client = self.create_async_client(endpoint=contentsafety_endpoint) + response = await client.analyze_text( + options={ + "text": "str", + "blocklistNames": ["str"], + "categories": ["str"], + "haltOnBlocklistHit": bool, + "outputType": "str", + }, + ) + + # please add some check logic here by yourself + # ... + + @ContentSafetyPreparer() + @recorded_by_proxy_async + async def test_detect_text_protected_material(self, contentsafety_endpoint): + client = self.create_async_client(endpoint=contentsafety_endpoint) + response = await client.detect_text_protected_material( + options={"text": "str"}, + ) + + # please add some check logic here by yourself + # ... + + @ContentSafetyPreparer() + @recorded_by_proxy_async + async def test_shield_prompt(self, contentsafety_endpoint): + client = self.create_async_client(endpoint=contentsafety_endpoint) + response = await client.shield_prompt( + options={"documents": ["str"], "userPrompt": "str"}, + ) + + # please add some check logic here by yourself + # ... diff --git a/sdk/contentsafety/azure-ai-contentsafety/generated_tests/testpreparer.py b/sdk/contentsafety/azure-ai-contentsafety/generated_tests/testpreparer.py new file mode 100644 index 000000000000..b72b1b050d4a --- /dev/null +++ b/sdk/contentsafety/azure-ai-contentsafety/generated_tests/testpreparer.py @@ -0,0 +1,58 @@ +# coding=utf-8 +# -------------------------------------------------------------------------- +# Copyright (c) Microsoft Corporation. All rights reserved. +# Licensed under the MIT License. See License.txt in the project root for license information. +# Code generated by Microsoft (R) Python Code Generator. +# Changes may cause incorrect behavior and will be lost if the code is regenerated. +# -------------------------------------------------------------------------- +from azure.ai.contentsafety import BlocklistClient, ContentProvenanceClient, ContentSafetyClient +from devtools_testutils import AzureRecordedTestCase, PowerShellPreparer +import functools + + +class ContentSafetyClientTestBase(AzureRecordedTestCase): + + def create_client(self, endpoint): + credential = self.get_credential(ContentSafetyClient) + return self.create_client_from_credential( + ContentSafetyClient, + credential=credential, + endpoint=endpoint, + ) + + +ContentSafetyPreparer = functools.partial( + PowerShellPreparer, "contentsafety", contentsafety_endpoint="https://fake_contentsafety_endpoint.com" +) + + +class ContentProvenanceClientTestBase(AzureRecordedTestCase): + + def create_client(self, endpoint): + credential = self.get_credential(ContentProvenanceClient) + return self.create_client_from_credential( + ContentProvenanceClient, + credential=credential, + endpoint=endpoint, + ) + + +ContentProvenancePreparer = functools.partial( + PowerShellPreparer, "contentprovenance", contentprovenance_endpoint="https://fake_contentprovenance_endpoint.com" +) + + +class BlocklistClientTestBase(AzureRecordedTestCase): + + def create_client(self, endpoint): + credential = self.get_credential(BlocklistClient) + return self.create_client_from_credential( + BlocklistClient, + credential=credential, + endpoint=endpoint, + ) + + +BlocklistPreparer = functools.partial( + PowerShellPreparer, "blocklist", blocklist_endpoint="https://fake_blocklist_endpoint.com" +) diff --git a/sdk/contentsafety/azure-ai-contentsafety/generated_tests/testpreparer_async.py b/sdk/contentsafety/azure-ai-contentsafety/generated_tests/testpreparer_async.py new file mode 100644 index 000000000000..959cb3eba1c6 --- /dev/null +++ b/sdk/contentsafety/azure-ai-contentsafety/generated_tests/testpreparer_async.py @@ -0,0 +1,42 @@ +# coding=utf-8 +# -------------------------------------------------------------------------- +# Copyright (c) Microsoft Corporation. All rights reserved. +# Licensed under the MIT License. See License.txt in the project root for license information. +# Code generated by Microsoft (R) Python Code Generator. +# Changes may cause incorrect behavior and will be lost if the code is regenerated. +# -------------------------------------------------------------------------- +from azure.ai.contentsafety.aio import BlocklistClient, ContentProvenanceClient, ContentSafetyClient +from devtools_testutils import AzureRecordedTestCase + + +class ContentSafetyClientTestBaseAsync(AzureRecordedTestCase): + + def create_async_client(self, endpoint): + credential = self.get_credential(ContentSafetyClient, is_async=True) + return self.create_client_from_credential( + ContentSafetyClient, + credential=credential, + endpoint=endpoint, + ) + + +class ContentProvenanceClientTestBaseAsync(AzureRecordedTestCase): + + def create_async_client(self, endpoint): + credential = self.get_credential(ContentProvenanceClient, is_async=True) + return self.create_client_from_credential( + ContentProvenanceClient, + credential=credential, + endpoint=endpoint, + ) + + +class BlocklistClientTestBaseAsync(AzureRecordedTestCase): + + def create_async_client(self, endpoint): + credential = self.get_credential(BlocklistClient, is_async=True) + return self.create_client_from_credential( + BlocklistClient, + credential=credential, + endpoint=endpoint, + ) diff --git a/sdk/contentsafety/azure-ai-contentsafety/pyproject.toml b/sdk/contentsafety/azure-ai-contentsafety/pyproject.toml index 0504960bccae..594513e6cc24 100644 --- a/sdk/contentsafety/azure-ai-contentsafety/pyproject.toml +++ b/sdk/contentsafety/azure-ai-contentsafety/pyproject.toml @@ -1,2 +1,74 @@ +[build-system] +requires = [ + "setuptools>=77.0.3", + "wheel", +] +build-backend = "setuptools.build_meta" + +[project] +name = "azure-ai-contentsafety" +authors = [ + { name = "Microsoft Corporation", email = "azpysdkhelp@microsoft.com" }, +] +description = "Microsoft Corporation Azure AI Content Safety Client Library for Python" +license = "MIT" +classifiers = [ + "Development Status :: 5 - Production/Stable", + "Programming Language :: Python", + "Programming Language :: Python :: 3 :: Only", + "Programming Language :: Python :: 3", + "Programming Language :: Python :: 3.10", + "Programming Language :: Python :: 3.11", + "Programming Language :: Python :: 3.12", + "Programming Language :: Python :: 3.13", + "Programming Language :: Python :: 3.14", +] +requires-python = ">=3.10" +keywords = [ + "azure", + "azure sdk", +] +dependencies = [ + "isodate>=0.6.1", + "azure-core>=1.37.0", + "typing-extensions>=4.6.0", +] +dynamic = [ + "version", + "readme", +] + +[project.urls] +repository = "https://github.com/Azure/azure-sdk-for-python" + +[tool.setuptools.dynamic.version] +attr = "azure.ai.contentsafety._version.VERSION" + +[tool.setuptools.dynamic.readme] +file = [ + "README.md", + "CHANGELOG.md", +] +content-type = "text/markdown" + +[tool.setuptools.packages.find] +exclude = [ + "tests*", + "generated_tests*", + "samples*", + "generated_samples*", + "doc*", + "azure", + "azure.ai", +] + +[tool.setuptools.package-data] +pytyped = [ + "py.typed", +] + [tool.azure-sdk-conda] in_bundle = false + +[packaging] +auto_update = false diff --git a/sdk/contentsafety/azure-ai-contentsafety/samples/sample_manage_blocklist.py b/sdk/contentsafety/azure-ai-contentsafety/samples/sample_manage_blocklist.py index e147048ca500..29b2236fbe9c 100644 --- a/sdk/contentsafety/azure-ai-contentsafety/samples/sample_manage_blocklist.py +++ b/sdk/contentsafety/azure-ai-contentsafety/samples/sample_manage_blocklist.py @@ -1,3 +1,4 @@ +# pylint: disable=line-too-long,useless-suppression # coding: utf-8 # ------------------------------------------------------------------------- diff --git a/sdk/contentsafety/azure-ai-contentsafety/sdk_packaging.toml b/sdk/contentsafety/azure-ai-contentsafety/sdk_packaging.toml deleted file mode 100644 index 901bc8ccbfa6..000000000000 --- a/sdk/contentsafety/azure-ai-contentsafety/sdk_packaging.toml +++ /dev/null @@ -1,2 +0,0 @@ -[packaging] -auto_update = false diff --git a/sdk/contentsafety/azure-ai-contentsafety/setup.py b/sdk/contentsafety/azure-ai-contentsafety/setup.py deleted file mode 100644 index b4e939ee2c66..000000000000 --- a/sdk/contentsafety/azure-ai-contentsafety/setup.py +++ /dev/null @@ -1,71 +0,0 @@ -# coding=utf-8 -# -------------------------------------------------------------------------- -# Copyright (c) Microsoft Corporation. All rights reserved. -# Licensed under the MIT License. See License.txt in the project root for license information. -# Code generated by Microsoft (R) Python Code Generator. -# Changes may cause incorrect behavior and will be lost if the code is regenerated. -# -------------------------------------------------------------------------- -# coding: utf-8 - -import os -import re -from setuptools import setup, find_packages - - -PACKAGE_NAME = "azure-ai-contentsafety" -PACKAGE_PPRINT_NAME = "Azure AI Content Safety" - -# a-b-c => a/b/c -package_folder_path = PACKAGE_NAME.replace("-", "/") - -# Version extraction inspired from 'requests' -with open(os.path.join(package_folder_path, "_version.py"), "r") as fd: - version = re.search(r'^VERSION\s*=\s*[\'"]([^\'"]*)[\'"]', fd.read(), re.MULTILINE).group(1) - -if not version: - raise RuntimeError("Cannot find version information") - - -setup( - name=PACKAGE_NAME, - version=version, - description="Microsoft {} Client Library for Python".format(PACKAGE_PPRINT_NAME), - long_description=open("README.md", "r").read(), - long_description_content_type="text/markdown", - license="MIT License", - author="Microsoft Corporation", - author_email="azpysdkhelp@microsoft.com", - url="https://github.com/Azure/azure-sdk-for-python/tree/main/sdk", - keywords="azure, azure sdk", - classifiers=[ - "Development Status :: 5 - Production/Stable", - "Programming Language :: Python", - "Programming Language :: Python :: 3 :: Only", - "Programming Language :: Python :: 3", - "Programming Language :: Python :: 3.7", - "Programming Language :: Python :: 3.8", - "Programming Language :: Python :: 3.9", - "Programming Language :: Python :: 3.10", - "Programming Language :: Python :: 3.11", - "License :: OSI Approved :: MIT License", - ], - zip_safe=False, - packages=find_packages( - exclude=[ - "tests", - # Exclude packages that will be covered by PEP420 or nspkg - "azure", - "azure.ai", - ] - ), - include_package_data=True, - package_data={ - "azure.ai.contentsafety": ["py.typed"], - }, - install_requires=[ - "isodate<1.0.0,>=0.6.1", - "azure-core<2.0.0,>=1.28.0", - "typing-extensions>=4.3.0; python_version<'3.8.0'", - ], - python_requires=">=3.7", -) diff --git a/sdk/contentsafety/azure-ai-contentsafety/tests/conftest.py b/sdk/contentsafety/azure-ai-contentsafety/tests/conftest.py index eabe5360b66b..1ca14ff35bdf 100644 --- a/sdk/contentsafety/azure-ai-contentsafety/tests/conftest.py +++ b/sdk/contentsafety/azure-ai-contentsafety/tests/conftest.py @@ -9,6 +9,7 @@ from devtools_testutils import test_proxy, add_general_string_sanitizer import os + # autouse=True will trigger this fixture on each pytest run, even if it's not explicitly used by a test method @pytest.fixture(scope="session", autouse=True) def start_proxy(test_proxy): diff --git a/sdk/contentsafety/azure-ai-contentsafety/tsp-location.yaml b/sdk/contentsafety/azure-ai-contentsafety/tsp-location.yaml index 6b117195f5d3..b389cf40271e 100644 --- a/sdk/contentsafety/azure-ai-contentsafety/tsp-location.yaml +++ b/sdk/contentsafety/azure-ai-contentsafety/tsp-location.yaml @@ -1,4 +1,4 @@ directory: specification/cognitiveservices/ContentSafety -commit: fb39d9813934567c594ca253efff7c5c01a474e8 +commit: 829ccecea7e9c1609881104b9a8d0f8cb65ce644 repo: Azure/azure-rest-api-specs -additionalDirectories: [] \ No newline at end of file +additionalDirectories: From 9943ad443667889e5aa4a1fda38fa2675ee3226b Mon Sep 17 00:00:00 2001 From: Connor Wood Date: Thu, 30 Jul 2026 23:22:01 -0700 Subject: [PATCH 02/16] Add CHANGELOG entry for azure-ai-contentsafety 1.1.0b1 --- sdk/contentsafety/azure-ai-contentsafety/CHANGELOG.md | 9 ++++++++- 1 file changed, 8 insertions(+), 1 deletion(-) diff --git a/sdk/contentsafety/azure-ai-contentsafety/CHANGELOG.md b/sdk/contentsafety/azure-ai-contentsafety/CHANGELOG.md index 492429f33536..b9bc0c605b0e 100644 --- a/sdk/contentsafety/azure-ai-contentsafety/CHANGELOG.md +++ b/sdk/contentsafety/azure-ai-contentsafety/CHANGELOG.md @@ -2,7 +2,14 @@ ## 1.1.0b1 (2026-07-30) -skip changelog generation for data-plane package and please add changelog manually. +### Features Added + +- Added support for the `2026-07-01-preview` API version. +- Added `ContentProvenanceClient`, which detects whether media was generated or modified by an AI system: + - `begin_detect` starts a long-running provenance detection operation. + - `get_operation_status` returns the status and result of a detection operation. +- Added models `DetectProvenanceOptions`, `DetectProvenanceResult`, `DetectedProvenance`, `ProvenanceContent`, and `ProvenanceDetectOperation`. +- Added enums `DetectedProvenanceType` and `ProvenanceOperationKind`. ## 1.0.0 (2023-12-15) From b3d34943a751f53f5eb5a7fbcae1448f3267dff3 Mon Sep 17 00:00:00 2001 From: Connor Wood Date: Thu, 30 Jul 2026 23:22:33 -0700 Subject: [PATCH 03/16] Ignore generated model_base.py for azure-ai-contentsafety in cspell --- .vscode/cspell.json | 1 + 1 file changed, 1 insertion(+) diff --git a/.vscode/cspell.json b/.vscode/cspell.json index 3fcf1df73f71..2f229ac49d06 100644 --- a/.vscode/cspell.json +++ b/.vscode/cspell.json @@ -129,6 +129,7 @@ "eng/tools/azure-sdk-tools/setup.py", "sdk/webpubsub/azure-messaging-webpubsubclient/azure/messaging/webpubsubclient/_serialization.py", "sdk/webpubsub/azure-messaging-webpubsubclient/azure/messaging/webpubsubclient/_model_base.py", + "sdk/contentsafety/azure-ai-contentsafety/azure/ai/contentsafety/_utils/model_base.py", "eng/tools/azure-sdk-tools/tests/test_servicemetadata.py", "conda/conda-recipes/azure-ai-ml/meta.yaml", "conda/conda-recipes/azure-eventhub/meta.yaml", From c38be936fe9977a894990e84d6c5bc4edfed729a Mon Sep 17 00:00:00 2001 From: Connor Wood Date: Thu, 30 Jul 2026 23:22:47 -0700 Subject: [PATCH 04/16] Remove generated test_blocklist.py (duplicate module name with tests/test_blocklist.py) --- .../generated_tests/test_blocklist.py | 105 ------------------ 1 file changed, 105 deletions(-) delete mode 100644 sdk/contentsafety/azure-ai-contentsafety/generated_tests/test_blocklist.py diff --git a/sdk/contentsafety/azure-ai-contentsafety/generated_tests/test_blocklist.py b/sdk/contentsafety/azure-ai-contentsafety/generated_tests/test_blocklist.py deleted file mode 100644 index 83deae7cb51a..000000000000 --- a/sdk/contentsafety/azure-ai-contentsafety/generated_tests/test_blocklist.py +++ /dev/null @@ -1,105 +0,0 @@ -# coding=utf-8 -# -------------------------------------------------------------------------- -# Copyright (c) Microsoft Corporation. All rights reserved. -# Licensed under the MIT License. See License.txt in the project root for license information. -# Code generated by Microsoft (R) Python Code Generator. -# Changes may cause incorrect behavior and will be lost if the code is regenerated. -# -------------------------------------------------------------------------- -import pytest -from devtools_testutils import recorded_by_proxy -from testpreparer import BlocklistClientTestBase, BlocklistPreparer - - -@pytest.mark.skip("you may need to update the auto-generated test case before run it") -class TestBlocklist(BlocklistClientTestBase): - @BlocklistPreparer() - @recorded_by_proxy - def test_add_or_update_blocklist_items(self, blocklist_endpoint): - client = self.create_client(endpoint=blocklist_endpoint) - response = client.add_or_update_blocklist_items( - blocklist_name="str", - options={ - "blocklistItems": [{"blocklistItemId": "str", "text": "str", "description": "str", "isRegex": bool}] - }, - ) - - # please add some check logic here by yourself - # ... - - @BlocklistPreparer() - @recorded_by_proxy - def test_create_or_update_text_blocklist(self, blocklist_endpoint): - client = self.create_client(endpoint=blocklist_endpoint) - response = client.create_or_update_text_blocklist( - blocklist_name="str", - options={"blocklistName": "str", "description": "str"}, - ) - - # please add some check logic here by yourself - # ... - - @BlocklistPreparer() - @recorded_by_proxy - def test_delete_text_blocklist(self, blocklist_endpoint): - client = self.create_client(endpoint=blocklist_endpoint) - response = client.delete_text_blocklist( - blocklist_name="str", - ) - - # please add some check logic here by yourself - # ... - - @BlocklistPreparer() - @recorded_by_proxy - def test_get_text_blocklist(self, blocklist_endpoint): - client = self.create_client(endpoint=blocklist_endpoint) - response = client.get_text_blocklist( - blocklist_name="str", - ) - - # please add some check logic here by yourself - # ... - - @BlocklistPreparer() - @recorded_by_proxy - def test_get_text_blocklist_item(self, blocklist_endpoint): - client = self.create_client(endpoint=blocklist_endpoint) - response = client.get_text_blocklist_item( - blocklist_name="str", - blocklist_item_id="str", - ) - - # please add some check logic here by yourself - # ... - - @BlocklistPreparer() - @recorded_by_proxy - def test_list_text_blocklist_items(self, blocklist_endpoint): - client = self.create_client(endpoint=blocklist_endpoint) - response = client.list_text_blocklist_items( - blocklist_name="str", - ) - result = [r for r in response] - # please add some check logic here by yourself - # ... - - @BlocklistPreparer() - @recorded_by_proxy - def test_list_text_blocklists(self, blocklist_endpoint): - client = self.create_client(endpoint=blocklist_endpoint) - response = client.list_text_blocklists() - result = [r for r in response] - # please add some check logic here by yourself - # ... - - @BlocklistPreparer() - @recorded_by_proxy - def test_remove_blocklist_items(self, blocklist_endpoint): - client = self.create_client(endpoint=blocklist_endpoint) - response = client.remove_blocklist_items( - blocklist_name="str", - options={"blocklistItemIds": ["str"]}, - ) - - # please add some check logic here by yourself - # ... From 4e50462cf9873615670227f5905dffe3a2c73118 Mon Sep 17 00:00:00 2001 From: Connor Wood Date: Thu, 30 Jul 2026 23:22:49 -0700 Subject: [PATCH 05/16] Remove generated test_content_safety.py (duplicate module name with tests/test_content_safety.py) --- .../generated_tests/test_content_safety.py | 67 ------------------- 1 file changed, 67 deletions(-) delete mode 100644 sdk/contentsafety/azure-ai-contentsafety/generated_tests/test_content_safety.py diff --git a/sdk/contentsafety/azure-ai-contentsafety/generated_tests/test_content_safety.py b/sdk/contentsafety/azure-ai-contentsafety/generated_tests/test_content_safety.py deleted file mode 100644 index 836055fee94b..000000000000 --- a/sdk/contentsafety/azure-ai-contentsafety/generated_tests/test_content_safety.py +++ /dev/null @@ -1,67 +0,0 @@ -# coding=utf-8 -# -------------------------------------------------------------------------- -# Copyright (c) Microsoft Corporation. All rights reserved. -# Licensed under the MIT License. See License.txt in the project root for license information. -# Code generated by Microsoft (R) Python Code Generator. -# Changes may cause incorrect behavior and will be lost if the code is regenerated. -# -------------------------------------------------------------------------- -import pytest -from devtools_testutils import recorded_by_proxy -from testpreparer import ContentSafetyClientTestBase, ContentSafetyPreparer - - -@pytest.mark.skip("you may need to update the auto-generated test case before run it") -class TestContentSafety(ContentSafetyClientTestBase): - @ContentSafetyPreparer() - @recorded_by_proxy - def test_analyze_image(self, contentsafety_endpoint): - client = self.create_client(endpoint=contentsafety_endpoint) - response = client.analyze_image( - options={ - "image": {"blobUrl": "str", "content": bytes("bytes", encoding="utf-8")}, - "categories": ["str"], - "outputType": "str", - }, - ) - - # please add some check logic here by yourself - # ... - - @ContentSafetyPreparer() - @recorded_by_proxy - def test_analyze_text(self, contentsafety_endpoint): - client = self.create_client(endpoint=contentsafety_endpoint) - response = client.analyze_text( - options={ - "text": "str", - "blocklistNames": ["str"], - "categories": ["str"], - "haltOnBlocklistHit": bool, - "outputType": "str", - }, - ) - - # please add some check logic here by yourself - # ... - - @ContentSafetyPreparer() - @recorded_by_proxy - def test_detect_text_protected_material(self, contentsafety_endpoint): - client = self.create_client(endpoint=contentsafety_endpoint) - response = client.detect_text_protected_material( - options={"text": "str"}, - ) - - # please add some check logic here by yourself - # ... - - @ContentSafetyPreparer() - @recorded_by_proxy - def test_shield_prompt(self, contentsafety_endpoint): - client = self.create_client(endpoint=contentsafety_endpoint) - response = client.shield_prompt( - options={"documents": ["str"], "userPrompt": "str"}, - ) - - # please add some check logic here by yourself - # ... From d61b096d74a20c5308853e0ac80f1455c90ade66 Mon Sep 17 00:00:00 2001 From: Connor Wood Date: Fri, 31 Jul 2026 08:49:21 -0700 Subject: [PATCH 06/16] Document shield_prompt, protected material detection and Python 3.10 minimum in CHANGELOG --- sdk/contentsafety/azure-ai-contentsafety/CHANGELOG.md | 6 ++++++ 1 file changed, 6 insertions(+) diff --git a/sdk/contentsafety/azure-ai-contentsafety/CHANGELOG.md b/sdk/contentsafety/azure-ai-contentsafety/CHANGELOG.md index b9bc0c605b0e..2ade1b629006 100644 --- a/sdk/contentsafety/azure-ai-contentsafety/CHANGELOG.md +++ b/sdk/contentsafety/azure-ai-contentsafety/CHANGELOG.md @@ -10,6 +10,12 @@ - `get_operation_status` returns the status and result of a detection operation. - Added models `DetectProvenanceOptions`, `DetectProvenanceResult`, `DetectedProvenance`, `ProvenanceContent`, and `ProvenanceDetectOperation`. - Added enums `DetectedProvenanceType` and `ProvenanceOperationKind`. +- Added `shield_prompt` for shielding prompts from direct and indirect injection attacks. +- Added `detect_text_protected_material` for detecting protected material in text. + +### Other Changes + +- The minimum supported Python version is now 3.10 (previously 3.7). ## 1.0.0 (2023-12-15) From 803ea583bbdaec82243eb81ad000537929c46a5b Mon Sep 17 00:00:00 2001 From: azure-sdk Date: Mon, 3 Aug 2026 21:02:14 +0000 Subject: [PATCH 07/16] Configurations: 'specification/cognitiveservices/ContentSafety/tspconfig.yaml', SDK Release Type: beta, and CommitSHA: '926fc28f53c318fe3cf68eb8be1ea38e658c0879' in SpecRepo: 'https://github.com/Azure/azure-rest-api-specs' Pipeline run: https://dev.azure.com/azure-sdk/internal/_build/results?buildId=6652880 Refer to https://eng.ms/docs/products/azure-developer-experience/develop/sdk-release/sdk-release-prerequisites to prepare for SDK release. --- .../azure-ai-contentsafety/CHANGELOG.md | 17 +-- .../azure-ai-contentsafety/_metadata.json | 2 +- .../apiview-properties.json | 2 +- .../contentsafety/_operations/_operations.py | 4 +- .../generated_tests/test_blocklist.py | 105 ++++++++++++++++++ .../generated_tests/test_content_safety.py | 67 +++++++++++ .../azure-ai-contentsafety/pyproject.toml | 39 +++---- .../azure-ai-contentsafety/tsp-location.yaml | 2 +- 8 files changed, 195 insertions(+), 43 deletions(-) create mode 100644 sdk/contentsafety/azure-ai-contentsafety/generated_tests/test_blocklist.py create mode 100644 sdk/contentsafety/azure-ai-contentsafety/generated_tests/test_content_safety.py diff --git a/sdk/contentsafety/azure-ai-contentsafety/CHANGELOG.md b/sdk/contentsafety/azure-ai-contentsafety/CHANGELOG.md index 2ade1b629006..d7eddf14e89f 100644 --- a/sdk/contentsafety/azure-ai-contentsafety/CHANGELOG.md +++ b/sdk/contentsafety/azure-ai-contentsafety/CHANGELOG.md @@ -1,21 +1,8 @@ # Release History -## 1.1.0b1 (2026-07-30) +## 1.1.0b1 (2026-08-03) -### Features Added - -- Added support for the `2026-07-01-preview` API version. -- Added `ContentProvenanceClient`, which detects whether media was generated or modified by an AI system: - - `begin_detect` starts a long-running provenance detection operation. - - `get_operation_status` returns the status and result of a detection operation. -- Added models `DetectProvenanceOptions`, `DetectProvenanceResult`, `DetectedProvenance`, `ProvenanceContent`, and `ProvenanceDetectOperation`. -- Added enums `DetectedProvenanceType` and `ProvenanceOperationKind`. -- Added `shield_prompt` for shielding prompts from direct and indirect injection attacks. -- Added `detect_text_protected_material` for detecting protected material in text. - -### Other Changes - -- The minimum supported Python version is now 3.10 (previously 3.7). +skip changelog generation for data-plane package and please add changelog manually. ## 1.0.0 (2023-12-15) diff --git a/sdk/contentsafety/azure-ai-contentsafety/_metadata.json b/sdk/contentsafety/azure-ai-contentsafety/_metadata.json index b5f9a9ff4c8b..8218a528f94d 100644 --- a/sdk/contentsafety/azure-ai-contentsafety/_metadata.json +++ b/sdk/contentsafety/azure-ai-contentsafety/_metadata.json @@ -3,7 +3,7 @@ "apiVersions": { "ContentSafety": "2026-07-01-preview" }, - "commit": "829ccecea7e9c1609881104b9a8d0f8cb65ce644", + "commit": "926fc28f53c318fe3cf68eb8be1ea38e658c0879", "repository_url": "https://github.com/Azure/azure-rest-api-specs", "typespec_src": "specification/cognitiveservices/ContentSafety", "emitterVersion": "0.63.3", diff --git a/sdk/contentsafety/azure-ai-contentsafety/apiview-properties.json b/sdk/contentsafety/azure-ai-contentsafety/apiview-properties.json index 0d503a5f4d85..d365c78bbb2a 100644 --- a/sdk/contentsafety/azure-ai-contentsafety/apiview-properties.json +++ b/sdk/contentsafety/azure-ai-contentsafety/apiview-properties.json @@ -63,5 +63,5 @@ "azure.ai.contentsafety.BlocklistClient.remove_blocklist_items": "Customizations.BlocklistClient.removeBlocklistItems", "azure.ai.contentsafety.aio.BlocklistClient.remove_blocklist_items": "Customizations.BlocklistClient.removeBlocklistItems" }, - "CrossLanguageVersion": "b51bf37f4d86" + "CrossLanguageVersion": "ea7c2c2d91e8" } \ No newline at end of file diff --git a/sdk/contentsafety/azure-ai-contentsafety/azure/ai/contentsafety/_operations/_operations.py b/sdk/contentsafety/azure-ai-contentsafety/azure/ai/contentsafety/_operations/_operations.py index 8c9cf373a9df..0e696ba89616 100644 --- a/sdk/contentsafety/azure-ai-contentsafety/azure/ai/contentsafety/_operations/_operations.py +++ b/sdk/contentsafety/azure-ai-contentsafety/azure/ai/contentsafety/_operations/_operations.py @@ -148,7 +148,7 @@ def build_content_provenance_detect_request(**kwargs: Any) -> HttpRequest: accept = _headers.pop("Accept", "application/json") # Construct URL - _url = ":detect" + _url = "/provenance:detect" # Construct parameters _params["api-version"] = _SERIALIZER.query("api_version", api_version, "str") @@ -171,7 +171,7 @@ def build_content_provenance_get_operation_status_request( # pylint: disable=na accept = _headers.pop("Accept", "application/json") # Construct URL - _url = "/operations/{operationId}" + _url = "/provenance/operations/{operationId}" path_format_arguments = { "operationId": _SERIALIZER.url("operation_id", operation_id, "str"), } diff --git a/sdk/contentsafety/azure-ai-contentsafety/generated_tests/test_blocklist.py b/sdk/contentsafety/azure-ai-contentsafety/generated_tests/test_blocklist.py new file mode 100644 index 000000000000..83deae7cb51a --- /dev/null +++ b/sdk/contentsafety/azure-ai-contentsafety/generated_tests/test_blocklist.py @@ -0,0 +1,105 @@ +# coding=utf-8 +# -------------------------------------------------------------------------- +# Copyright (c) Microsoft Corporation. All rights reserved. +# Licensed under the MIT License. See License.txt in the project root for license information. +# Code generated by Microsoft (R) Python Code Generator. +# Changes may cause incorrect behavior and will be lost if the code is regenerated. +# -------------------------------------------------------------------------- +import pytest +from devtools_testutils import recorded_by_proxy +from testpreparer import BlocklistClientTestBase, BlocklistPreparer + + +@pytest.mark.skip("you may need to update the auto-generated test case before run it") +class TestBlocklist(BlocklistClientTestBase): + @BlocklistPreparer() + @recorded_by_proxy + def test_add_or_update_blocklist_items(self, blocklist_endpoint): + client = self.create_client(endpoint=blocklist_endpoint) + response = client.add_or_update_blocklist_items( + blocklist_name="str", + options={ + "blocklistItems": [{"blocklistItemId": "str", "text": "str", "description": "str", "isRegex": bool}] + }, + ) + + # please add some check logic here by yourself + # ... + + @BlocklistPreparer() + @recorded_by_proxy + def test_create_or_update_text_blocklist(self, blocklist_endpoint): + client = self.create_client(endpoint=blocklist_endpoint) + response = client.create_or_update_text_blocklist( + blocklist_name="str", + options={"blocklistName": "str", "description": "str"}, + ) + + # please add some check logic here by yourself + # ... + + @BlocklistPreparer() + @recorded_by_proxy + def test_delete_text_blocklist(self, blocklist_endpoint): + client = self.create_client(endpoint=blocklist_endpoint) + response = client.delete_text_blocklist( + blocklist_name="str", + ) + + # please add some check logic here by yourself + # ... + + @BlocklistPreparer() + @recorded_by_proxy + def test_get_text_blocklist(self, blocklist_endpoint): + client = self.create_client(endpoint=blocklist_endpoint) + response = client.get_text_blocklist( + blocklist_name="str", + ) + + # please add some check logic here by yourself + # ... + + @BlocklistPreparer() + @recorded_by_proxy + def test_get_text_blocklist_item(self, blocklist_endpoint): + client = self.create_client(endpoint=blocklist_endpoint) + response = client.get_text_blocklist_item( + blocklist_name="str", + blocklist_item_id="str", + ) + + # please add some check logic here by yourself + # ... + + @BlocklistPreparer() + @recorded_by_proxy + def test_list_text_blocklist_items(self, blocklist_endpoint): + client = self.create_client(endpoint=blocklist_endpoint) + response = client.list_text_blocklist_items( + blocklist_name="str", + ) + result = [r for r in response] + # please add some check logic here by yourself + # ... + + @BlocklistPreparer() + @recorded_by_proxy + def test_list_text_blocklists(self, blocklist_endpoint): + client = self.create_client(endpoint=blocklist_endpoint) + response = client.list_text_blocklists() + result = [r for r in response] + # please add some check logic here by yourself + # ... + + @BlocklistPreparer() + @recorded_by_proxy + def test_remove_blocklist_items(self, blocklist_endpoint): + client = self.create_client(endpoint=blocklist_endpoint) + response = client.remove_blocklist_items( + blocklist_name="str", + options={"blocklistItemIds": ["str"]}, + ) + + # please add some check logic here by yourself + # ... diff --git a/sdk/contentsafety/azure-ai-contentsafety/generated_tests/test_content_safety.py b/sdk/contentsafety/azure-ai-contentsafety/generated_tests/test_content_safety.py new file mode 100644 index 000000000000..836055fee94b --- /dev/null +++ b/sdk/contentsafety/azure-ai-contentsafety/generated_tests/test_content_safety.py @@ -0,0 +1,67 @@ +# coding=utf-8 +# -------------------------------------------------------------------------- +# Copyright (c) Microsoft Corporation. All rights reserved. +# Licensed under the MIT License. See License.txt in the project root for license information. +# Code generated by Microsoft (R) Python Code Generator. +# Changes may cause incorrect behavior and will be lost if the code is regenerated. +# -------------------------------------------------------------------------- +import pytest +from devtools_testutils import recorded_by_proxy +from testpreparer import ContentSafetyClientTestBase, ContentSafetyPreparer + + +@pytest.mark.skip("you may need to update the auto-generated test case before run it") +class TestContentSafety(ContentSafetyClientTestBase): + @ContentSafetyPreparer() + @recorded_by_proxy + def test_analyze_image(self, contentsafety_endpoint): + client = self.create_client(endpoint=contentsafety_endpoint) + response = client.analyze_image( + options={ + "image": {"blobUrl": "str", "content": bytes("bytes", encoding="utf-8")}, + "categories": ["str"], + "outputType": "str", + }, + ) + + # please add some check logic here by yourself + # ... + + @ContentSafetyPreparer() + @recorded_by_proxy + def test_analyze_text(self, contentsafety_endpoint): + client = self.create_client(endpoint=contentsafety_endpoint) + response = client.analyze_text( + options={ + "text": "str", + "blocklistNames": ["str"], + "categories": ["str"], + "haltOnBlocklistHit": bool, + "outputType": "str", + }, + ) + + # please add some check logic here by yourself + # ... + + @ContentSafetyPreparer() + @recorded_by_proxy + def test_detect_text_protected_material(self, contentsafety_endpoint): + client = self.create_client(endpoint=contentsafety_endpoint) + response = client.detect_text_protected_material( + options={"text": "str"}, + ) + + # please add some check logic here by yourself + # ... + + @ContentSafetyPreparer() + @recorded_by_proxy + def test_shield_prompt(self, contentsafety_endpoint): + client = self.create_client(endpoint=contentsafety_endpoint) + response = client.shield_prompt( + options={"documents": ["str"], "userPrompt": "str"}, + ) + + # please add some check logic here by yourself + # ... diff --git a/sdk/contentsafety/azure-ai-contentsafety/pyproject.toml b/sdk/contentsafety/azure-ai-contentsafety/pyproject.toml index 594513e6cc24..f737e920c348 100644 --- a/sdk/contentsafety/azure-ai-contentsafety/pyproject.toml +++ b/sdk/contentsafety/azure-ai-contentsafety/pyproject.toml @@ -1,14 +1,18 @@ +# -------------------------------------------------------------------------- +# Copyright (c) Microsoft Corporation. All rights reserved. +# Licensed under the MIT License. See License.txt in the project root for license information. +# Code generated by Microsoft (R) Python Code Generator. +# Changes may cause incorrect behavior and will be lost if the code is regenerated. +# -------------------------------------------------------------------------- + [build-system] -requires = [ - "setuptools>=77.0.3", - "wheel", -] +requires = ["setuptools>=77.0.3", "wheel"] build-backend = "setuptools.build_meta" [project] name = "azure-ai-contentsafety" authors = [ - { name = "Microsoft Corporation", email = "azpysdkhelp@microsoft.com" }, + { name = "Microsoft Corporation", email = "azpysdkhelp@microsoft.com" }, ] description = "Microsoft Corporation Azure AI Content Safety Client Library for Python" license = "MIT" @@ -24,32 +28,23 @@ classifiers = [ "Programming Language :: Python :: 3.14", ] requires-python = ">=3.10" -keywords = [ - "azure", - "azure sdk", -] +keywords = ["azure", "azure sdk"] + dependencies = [ "isodate>=0.6.1", "azure-core>=1.37.0", "typing-extensions>=4.6.0", ] dynamic = [ - "version", - "readme", +"version", "readme" ] [project.urls] repository = "https://github.com/Azure/azure-sdk-for-python" -[tool.setuptools.dynamic.version] -attr = "azure.ai.contentsafety._version.VERSION" - -[tool.setuptools.dynamic.readme] -file = [ - "README.md", - "CHANGELOG.md", -] -content-type = "text/markdown" +[tool.setuptools.dynamic] +version = {attr = "azure.ai.contentsafety._version.VERSION"} +readme = {file = ["README.md", "CHANGELOG.md"], content-type = "text/markdown"} [tool.setuptools.packages.find] exclude = [ @@ -63,9 +58,7 @@ exclude = [ ] [tool.setuptools.package-data] -pytyped = [ - "py.typed", -] +pytyped = ["py.typed"] [tool.azure-sdk-conda] in_bundle = false diff --git a/sdk/contentsafety/azure-ai-contentsafety/tsp-location.yaml b/sdk/contentsafety/azure-ai-contentsafety/tsp-location.yaml index b389cf40271e..d092da2dadae 100644 --- a/sdk/contentsafety/azure-ai-contentsafety/tsp-location.yaml +++ b/sdk/contentsafety/azure-ai-contentsafety/tsp-location.yaml @@ -1,4 +1,4 @@ directory: specification/cognitiveservices/ContentSafety -commit: 829ccecea7e9c1609881104b9a8d0f8cb65ce644 +commit: 926fc28f53c318fe3cf68eb8be1ea38e658c0879 repo: Azure/azure-rest-api-specs additionalDirectories: From dca973efbc9a9fda07cd2ed00134c38441247161 Mon Sep 17 00:00:00 2001 From: Connor Wood Date: Tue, 4 Aug 2026 09:37:09 -0700 Subject: [PATCH 08/16] Restore CHANGELOG entry for azure-ai-contentsafety 1.1.0b1 --- .../azure-ai-contentsafety/CHANGELOG.md | 15 ++++++++++++++- 1 file changed, 14 insertions(+), 1 deletion(-) diff --git a/sdk/contentsafety/azure-ai-contentsafety/CHANGELOG.md b/sdk/contentsafety/azure-ai-contentsafety/CHANGELOG.md index d7eddf14e89f..95eaaf77dd9d 100644 --- a/sdk/contentsafety/azure-ai-contentsafety/CHANGELOG.md +++ b/sdk/contentsafety/azure-ai-contentsafety/CHANGELOG.md @@ -2,7 +2,20 @@ ## 1.1.0b1 (2026-08-03) -skip changelog generation for data-plane package and please add changelog manually. +### Features Added + +- Added support for the `2026-07-01-preview` API version. +- Added `ContentProvenanceClient`, which detects whether media was generated or modified by an AI system: + - `begin_detect` starts a long-running provenance detection operation. + - `get_operation_status` returns the status and result of a detection operation. +- Added models `DetectProvenanceOptions`, `DetectProvenanceResult`, `DetectedProvenance`, `ProvenanceContent`, and `ProvenanceDetectOperation`. +- Added enums `DetectedProvenanceType` and `ProvenanceOperationKind`. +- Added `shield_prompt` for shielding prompts from direct and indirect injection attacks. +- Added `detect_text_protected_material` for detecting protected material in text. + +### Other Changes + +- The minimum supported Python version is now 3.10 (previously 3.7). ## 1.0.0 (2023-12-15) From 6b3d4eaad1c28abaa9bc08bcbc3bdf6dcbab4ca5 Mon Sep 17 00:00:00 2001 From: Connor Wood Date: Tue, 4 Aug 2026 09:37:24 -0700 Subject: [PATCH 09/16] Remove generated test_blocklist.py (duplicate module name with tests/test_blocklist.py) --- .../generated_tests/test_blocklist.py | 105 ------------------ 1 file changed, 105 deletions(-) delete mode 100644 sdk/contentsafety/azure-ai-contentsafety/generated_tests/test_blocklist.py diff --git a/sdk/contentsafety/azure-ai-contentsafety/generated_tests/test_blocklist.py b/sdk/contentsafety/azure-ai-contentsafety/generated_tests/test_blocklist.py deleted file mode 100644 index 83deae7cb51a..000000000000 --- a/sdk/contentsafety/azure-ai-contentsafety/generated_tests/test_blocklist.py +++ /dev/null @@ -1,105 +0,0 @@ -# coding=utf-8 -# -------------------------------------------------------------------------- -# Copyright (c) Microsoft Corporation. All rights reserved. -# Licensed under the MIT License. See License.txt in the project root for license information. -# Code generated by Microsoft (R) Python Code Generator. -# Changes may cause incorrect behavior and will be lost if the code is regenerated. -# -------------------------------------------------------------------------- -import pytest -from devtools_testutils import recorded_by_proxy -from testpreparer import BlocklistClientTestBase, BlocklistPreparer - - -@pytest.mark.skip("you may need to update the auto-generated test case before run it") -class TestBlocklist(BlocklistClientTestBase): - @BlocklistPreparer() - @recorded_by_proxy - def test_add_or_update_blocklist_items(self, blocklist_endpoint): - client = self.create_client(endpoint=blocklist_endpoint) - response = client.add_or_update_blocklist_items( - blocklist_name="str", - options={ - "blocklistItems": [{"blocklistItemId": "str", "text": "str", "description": "str", "isRegex": bool}] - }, - ) - - # please add some check logic here by yourself - # ... - - @BlocklistPreparer() - @recorded_by_proxy - def test_create_or_update_text_blocklist(self, blocklist_endpoint): - client = self.create_client(endpoint=blocklist_endpoint) - response = client.create_or_update_text_blocklist( - blocklist_name="str", - options={"blocklistName": "str", "description": "str"}, - ) - - # please add some check logic here by yourself - # ... - - @BlocklistPreparer() - @recorded_by_proxy - def test_delete_text_blocklist(self, blocklist_endpoint): - client = self.create_client(endpoint=blocklist_endpoint) - response = client.delete_text_blocklist( - blocklist_name="str", - ) - - # please add some check logic here by yourself - # ... - - @BlocklistPreparer() - @recorded_by_proxy - def test_get_text_blocklist(self, blocklist_endpoint): - client = self.create_client(endpoint=blocklist_endpoint) - response = client.get_text_blocklist( - blocklist_name="str", - ) - - # please add some check logic here by yourself - # ... - - @BlocklistPreparer() - @recorded_by_proxy - def test_get_text_blocklist_item(self, blocklist_endpoint): - client = self.create_client(endpoint=blocklist_endpoint) - response = client.get_text_blocklist_item( - blocklist_name="str", - blocklist_item_id="str", - ) - - # please add some check logic here by yourself - # ... - - @BlocklistPreparer() - @recorded_by_proxy - def test_list_text_blocklist_items(self, blocklist_endpoint): - client = self.create_client(endpoint=blocklist_endpoint) - response = client.list_text_blocklist_items( - blocklist_name="str", - ) - result = [r for r in response] - # please add some check logic here by yourself - # ... - - @BlocklistPreparer() - @recorded_by_proxy - def test_list_text_blocklists(self, blocklist_endpoint): - client = self.create_client(endpoint=blocklist_endpoint) - response = client.list_text_blocklists() - result = [r for r in response] - # please add some check logic here by yourself - # ... - - @BlocklistPreparer() - @recorded_by_proxy - def test_remove_blocklist_items(self, blocklist_endpoint): - client = self.create_client(endpoint=blocklist_endpoint) - response = client.remove_blocklist_items( - blocklist_name="str", - options={"blocklistItemIds": ["str"]}, - ) - - # please add some check logic here by yourself - # ... From 3c1f4a515c5d881ea6b5783778bb86ef50a5cbc2 Mon Sep 17 00:00:00 2001 From: Connor Wood Date: Tue, 4 Aug 2026 09:37:26 -0700 Subject: [PATCH 10/16] Remove generated test_content_safety.py (duplicate module name with tests/test_content_safety.py) --- .../generated_tests/test_content_safety.py | 67 ------------------- 1 file changed, 67 deletions(-) delete mode 100644 sdk/contentsafety/azure-ai-contentsafety/generated_tests/test_content_safety.py diff --git a/sdk/contentsafety/azure-ai-contentsafety/generated_tests/test_content_safety.py b/sdk/contentsafety/azure-ai-contentsafety/generated_tests/test_content_safety.py deleted file mode 100644 index 836055fee94b..000000000000 --- a/sdk/contentsafety/azure-ai-contentsafety/generated_tests/test_content_safety.py +++ /dev/null @@ -1,67 +0,0 @@ -# coding=utf-8 -# -------------------------------------------------------------------------- -# Copyright (c) Microsoft Corporation. All rights reserved. -# Licensed under the MIT License. See License.txt in the project root for license information. -# Code generated by Microsoft (R) Python Code Generator. -# Changes may cause incorrect behavior and will be lost if the code is regenerated. -# -------------------------------------------------------------------------- -import pytest -from devtools_testutils import recorded_by_proxy -from testpreparer import ContentSafetyClientTestBase, ContentSafetyPreparer - - -@pytest.mark.skip("you may need to update the auto-generated test case before run it") -class TestContentSafety(ContentSafetyClientTestBase): - @ContentSafetyPreparer() - @recorded_by_proxy - def test_analyze_image(self, contentsafety_endpoint): - client = self.create_client(endpoint=contentsafety_endpoint) - response = client.analyze_image( - options={ - "image": {"blobUrl": "str", "content": bytes("bytes", encoding="utf-8")}, - "categories": ["str"], - "outputType": "str", - }, - ) - - # please add some check logic here by yourself - # ... - - @ContentSafetyPreparer() - @recorded_by_proxy - def test_analyze_text(self, contentsafety_endpoint): - client = self.create_client(endpoint=contentsafety_endpoint) - response = client.analyze_text( - options={ - "text": "str", - "blocklistNames": ["str"], - "categories": ["str"], - "haltOnBlocklistHit": bool, - "outputType": "str", - }, - ) - - # please add some check logic here by yourself - # ... - - @ContentSafetyPreparer() - @recorded_by_proxy - def test_detect_text_protected_material(self, contentsafety_endpoint): - client = self.create_client(endpoint=contentsafety_endpoint) - response = client.detect_text_protected_material( - options={"text": "str"}, - ) - - # please add some check logic here by yourself - # ... - - @ContentSafetyPreparer() - @recorded_by_proxy - def test_shield_prompt(self, contentsafety_endpoint): - client = self.create_client(endpoint=contentsafety_endpoint) - response = client.shield_prompt( - options={"documents": ["str"], "userPrompt": "str"}, - ) - - # please add some check logic here by yourself - # ... From e70b8787cce4b2f6b190c16a2ed051a044d6152c Mon Sep 17 00:00:00 2001 From: Connor Wood Date: Tue, 4 Aug 2026 10:58:21 -0700 Subject: [PATCH 11/16] Update test recordings for api-version 2026-07-01-preview --- sdk/contentsafety/azure-ai-contentsafety/assets.json | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/sdk/contentsafety/azure-ai-contentsafety/assets.json b/sdk/contentsafety/azure-ai-contentsafety/assets.json index bd1c40b21587..14e036aec3ed 100644 --- a/sdk/contentsafety/azure-ai-contentsafety/assets.json +++ b/sdk/contentsafety/azure-ai-contentsafety/assets.json @@ -2,5 +2,5 @@ "AssetsRepo": "Azure/azure-sdk-assets", "AssetsRepoPrefixPath": "python", "TagPrefix": "python/contentsafety/azure-ai-contentsafety", - "Tag": "python/contentsafety/azure-ai-contentsafety_e87cb3fa17" + "Tag": "python/contentsafety/azure-ai-contentsafety_1e14393cf8" } From 77d709aef9bed938120050738842409f811ae203 Mon Sep 17 00:00:00 2001 From: Connor Wood Date: Wed, 5 Aug 2026 09:13:40 -0700 Subject: [PATCH 12/16] Update entra id credential test recording for api-version 2026-07-01-preview --- sdk/contentsafety/azure-ai-contentsafety/assets.json | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/sdk/contentsafety/azure-ai-contentsafety/assets.json b/sdk/contentsafety/azure-ai-contentsafety/assets.json index 14e036aec3ed..2ae32705ba19 100644 --- a/sdk/contentsafety/azure-ai-contentsafety/assets.json +++ b/sdk/contentsafety/azure-ai-contentsafety/assets.json @@ -2,5 +2,5 @@ "AssetsRepo": "Azure/azure-sdk-assets", "AssetsRepoPrefixPath": "python", "TagPrefix": "python/contentsafety/azure-ai-contentsafety", - "Tag": "python/contentsafety/azure-ai-contentsafety_1e14393cf8" + "Tag": "python/contentsafety/azure-ai-contentsafety_5c8aec198f" } From 0cd732aef22ec79342a3d39e7d2482ce0264c975 Mon Sep 17 00:00:00 2001 From: Connor Wood Date: Wed, 5 Aug 2026 12:15:12 -0700 Subject: [PATCH 13/16] Set development status classifier to Beta verifysdist failed: azure-ai-contentsafety has version 1.1.0b1 and is a beta release, but has development status 'Development Status :: 5 - Production/Stable'. Expected 'Development Status :: 4 - Beta' ONLY. --- sdk/contentsafety/azure-ai-contentsafety/pyproject.toml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/sdk/contentsafety/azure-ai-contentsafety/pyproject.toml b/sdk/contentsafety/azure-ai-contentsafety/pyproject.toml index f737e920c348..2d875aca2abe 100644 --- a/sdk/contentsafety/azure-ai-contentsafety/pyproject.toml +++ b/sdk/contentsafety/azure-ai-contentsafety/pyproject.toml @@ -17,7 +17,7 @@ authors = [ description = "Microsoft Corporation Azure AI Content Safety Client Library for Python" license = "MIT" classifiers = [ - "Development Status :: 5 - Production/Stable", + "Development Status :: 4 - Beta", "Programming Language :: Python", "Programming Language :: Python :: 3 :: Only", "Programming Language :: Python :: 3", From 7f724ba36ddb0eefc1892e7d3d89948d8fc223f9 Mon Sep 17 00:00:00 2001 From: Connor Wood Date: Wed, 5 Aug 2026 15:02:26 -0700 Subject: [PATCH 14/16] Add Content Provenance detection tests Covers both outcomes against the live service: signed media (C2PA + watermark) asserting ProvenanceDetected with a populated results array, and unsigned media asserting NoProvenanceDetected. Provenance had no executing test coverage in any language. The media are blob SAS URIs, so conftest replaces each one wholesale with a placeholder; the recordings contain neither the SAS nor the storage account name. --- .../azure-ai-contentsafety/assets.json | 2 +- .../azure-ai-contentsafety/tests/conftest.py | 18 ++++++- .../azure-ai-contentsafety/tests/test_case.py | 9 +++- .../tests/test_content_provenance.py | 50 +++++++++++++++++++ 4 files changed, 76 insertions(+), 3 deletions(-) create mode 100644 sdk/contentsafety/azure-ai-contentsafety/tests/test_content_provenance.py diff --git a/sdk/contentsafety/azure-ai-contentsafety/assets.json b/sdk/contentsafety/azure-ai-contentsafety/assets.json index 2ae32705ba19..164ff96b5d5a 100644 --- a/sdk/contentsafety/azure-ai-contentsafety/assets.json +++ b/sdk/contentsafety/azure-ai-contentsafety/assets.json @@ -2,5 +2,5 @@ "AssetsRepo": "Azure/azure-sdk-assets", "AssetsRepoPrefixPath": "python", "TagPrefix": "python/contentsafety/azure-ai-contentsafety", - "Tag": "python/contentsafety/azure-ai-contentsafety_5c8aec198f" + "Tag": "python/contentsafety/azure-ai-contentsafety_1c8c81705a" } diff --git a/sdk/contentsafety/azure-ai-contentsafety/tests/conftest.py b/sdk/contentsafety/azure-ai-contentsafety/tests/conftest.py index 1ca14ff35bdf..c9a5cbc0bf4f 100644 --- a/sdk/contentsafety/azure-ai-contentsafety/tests/conftest.py +++ b/sdk/contentsafety/azure-ai-contentsafety/tests/conftest.py @@ -6,8 +6,10 @@ # -------------------------------------------------------------------------- import pytest -from devtools_testutils import test_proxy, add_general_string_sanitizer +from devtools_testutils import test_proxy, add_general_string_sanitizer, add_general_regex_sanitizer import os +import re +from urllib.parse import urlparse # autouse=True will trigger this fixture on each pytest run, even if it's not explicitly used by a test method @@ -32,3 +34,17 @@ def add_sanitizers(test_proxy): add_general_string_sanitizer(target=content_safety_client_id, value="00000000000000000000000000000000") add_general_string_sanitizer(target=content_safety_client_secret, value="00000000000000000000000000000000") add_general_string_sanitizer(target=content_safety_tenant_id, value="00000000000000000000000000000000") + + # Provenance media are blob SAS URIs. Replace each one wholesale with the placeholder the + # preparer supplies in playback, so neither the SAS nor the storage account is recorded. + media_placeholders = { + "CONTENT_SAFETY_SIGNED_MEDIA_URI": "https://fake_storage.blob.core.windows.net/provenance-test/signed.png", + "CONTENT_SAFETY_UNSIGNED_MEDIA_URI": "https://fake_storage.blob.core.windows.net/provenance-test/unsigned.png", + } + for env_name, placeholder in media_placeholders.items(): + media_uri = os.environ.get(env_name) + if not media_uri: + continue + parsed = urlparse(media_uri) + add_general_regex_sanitizer(regex=rf"https://[^\"\s]*{re.escape(parsed.path)}[^\"\s]*", value=placeholder) + add_general_string_sanitizer(target=parsed.netloc.split(".")[0], value="fake_storage") diff --git a/sdk/contentsafety/azure-ai-contentsafety/tests/test_case.py b/sdk/contentsafety/azure-ai-contentsafety/tests/test_case.py index 6f06cc5503ad..ec38113e1cde 100644 --- a/sdk/contentsafety/azure-ai-contentsafety/tests/test_case.py +++ b/sdk/contentsafety/azure-ai-contentsafety/tests/test_case.py @@ -8,7 +8,7 @@ from azure.core.credentials import AzureKeyCredential from devtools_testutils import AzureRecordedTestCase, is_live, FakeTokenCredential, EnvironmentVariableLoader -from azure.ai.contentsafety import ContentSafetyClient, BlocklistClient +from azure.ai.contentsafety import ContentSafetyClient, BlocklistClient, ContentProvenanceClient class ContentSafetyTest(AzureRecordedTestCase): @@ -18,6 +18,9 @@ def create_content_safety_client_from_key(self, endpoint, key): def create_blocklist_client_from_key(self, endpoint, key): return self._create_client_from_key(BlocklistClient, endpoint, key) + def create_content_provenance_client_from_key(self, endpoint, key): + return self._create_client_from_key(ContentProvenanceClient, endpoint, key) + def create_content_safety_client_from_entra_id(self, endpoint): return self._create_client_from_entra_id(ContentSafetyClient, endpoint) @@ -43,4 +46,8 @@ def _create_client_from_entra_id(self, client_class, endpoint): content_safety_client_id="00000000000000000000000000000000", content_safety_client_secret="00000000000000000000000000000000", content_safety_tenant_id="00000000000000000000000000000000", + # Blob SAS URIs for provenance detection. The real values carry a SAS token, so they are + # sanitized to these placeholders in recordings. + content_safety_signed_media_uri="https://fake_storage.blob.core.windows.net/provenance-test/signed.png", + content_safety_unsigned_media_uri="https://fake_storage.blob.core.windows.net/provenance-test/unsigned.png", ) diff --git a/sdk/contentsafety/azure-ai-contentsafety/tests/test_content_provenance.py b/sdk/contentsafety/azure-ai-contentsafety/tests/test_content_provenance.py new file mode 100644 index 000000000000..7d17a4e01e8f --- /dev/null +++ b/sdk/contentsafety/azure-ai-contentsafety/tests/test_content_provenance.py @@ -0,0 +1,50 @@ +# coding=utf-8 +# ------------------------------------ +# Copyright (c) Microsoft Corporation. +# Licensed under the MIT License. +# ------------------------------------ + +from devtools_testutils import recorded_by_proxy + +from azure.ai.contentsafety.models import ( + DetectOutcome, + DetectProvenanceOptions, + DetectedProvenanceType, + ProvenanceContent, +) +from test_case import ContentSafetyTest, ContentSafetyPreparer + + +class TestContentProvenanceCase(ContentSafetyTest): + @ContentSafetyPreparer() + @recorded_by_proxy + def test_detect_provenance_detected( + self, content_safety_endpoint, content_safety_key, content_safety_signed_media_uri + ): + client = self.create_content_provenance_client_from_key(content_safety_endpoint, content_safety_key) + + result = client.begin_detect( + DetectProvenanceOptions(content=ProvenanceContent(uri=content_safety_signed_media_uri)) + ).result() + + assert result.outcome == DetectOutcome.PROVENANCE_DETECTED + assert result.results + detected_types = {detected.type for detected in result.results} + assert detected_types <= {DetectedProvenanceType.C2_PA, DetectedProvenanceType.WATERMARK} + for detected in result.results: + assert detected.provider + assert detected.model_name + + @ContentSafetyPreparer() + @recorded_by_proxy + def test_detect_provenance_not_detected( + self, content_safety_endpoint, content_safety_key, content_safety_unsigned_media_uri + ): + client = self.create_content_provenance_client_from_key(content_safety_endpoint, content_safety_key) + + result = client.begin_detect( + DetectProvenanceOptions(content=ProvenanceContent(uri=content_safety_unsigned_media_uri)) + ).result() + + assert result.outcome == DetectOutcome.NO_PROVENANCE_DETECTED + assert not result.results From c57c560e160f3eb49f1623929725d7e998df6950 Mon Sep 17 00:00:00 2001 From: Connor Wood Date: Mon, 10 Aug 2026 11:44:02 -0700 Subject: [PATCH 15/16] Rename the provenance test module to avoid a pytest collision tests/test_content_provenance.py shared a module name with the generated stub generated_tests/test_content_provenance.py. With no __init__.py, pytest reported 'import file mismatch' and failed collection across every test job. --- sdk/contentsafety/azure-ai-contentsafety/assets.json | 2 +- .../tests/{test_content_provenance.py => test_provenance.py} | 0 2 files changed, 1 insertion(+), 1 deletion(-) rename sdk/contentsafety/azure-ai-contentsafety/tests/{test_content_provenance.py => test_provenance.py} (100%) diff --git a/sdk/contentsafety/azure-ai-contentsafety/assets.json b/sdk/contentsafety/azure-ai-contentsafety/assets.json index 164ff96b5d5a..344f26c0042c 100644 --- a/sdk/contentsafety/azure-ai-contentsafety/assets.json +++ b/sdk/contentsafety/azure-ai-contentsafety/assets.json @@ -2,5 +2,5 @@ "AssetsRepo": "Azure/azure-sdk-assets", "AssetsRepoPrefixPath": "python", "TagPrefix": "python/contentsafety/azure-ai-contentsafety", - "Tag": "python/contentsafety/azure-ai-contentsafety_1c8c81705a" + "Tag": "python/contentsafety/azure-ai-contentsafety_91c6969269" } diff --git a/sdk/contentsafety/azure-ai-contentsafety/tests/test_content_provenance.py b/sdk/contentsafety/azure-ai-contentsafety/tests/test_provenance.py similarity index 100% rename from sdk/contentsafety/azure-ai-contentsafety/tests/test_content_provenance.py rename to sdk/contentsafety/azure-ai-contentsafety/tests/test_provenance.py From a4f3f6f46330cad604e5228399185a0d28a71e91 Mon Sep 17 00:00:00 2001 From: Connor Wood Date: Mon, 10 Aug 2026 12:47:46 -0700 Subject: [PATCH 16/16] Bump api.md parserVersion to 0.3.31 --- sdk/contentsafety/azure-ai-contentsafety/api.metadata.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/sdk/contentsafety/azure-ai-contentsafety/api.metadata.yml b/sdk/contentsafety/azure-ai-contentsafety/api.metadata.yml index fbbc447e5b14..92028eba16f7 100644 --- a/sdk/contentsafety/azure-ai-contentsafety/api.metadata.yml +++ b/sdk/contentsafety/azure-ai-contentsafety/api.metadata.yml @@ -1,3 +1,3 @@ apiMdSha256: 04f0f979de1fd4dad50f631b6bd0ba453b8bce4f12769ab558e9900324d4afb8 -parserVersion: 0.3.30 +parserVersion: 0.3.31 pythonVersion: 3.13.14