diff --git a/DO_OPENAPI_COMMIT_SHA.txt b/DO_OPENAPI_COMMIT_SHA.txt index 55e0e421..e08b1c1a 100644 --- a/DO_OPENAPI_COMMIT_SHA.txt +++ b/DO_OPENAPI_COMMIT_SHA.txt @@ -1 +1 @@ -6fd6c99 +3512e76 diff --git a/src/pydo/aio/operations/_operations.py b/src/pydo/aio/operations/_operations.py index bc566554..788135ba 100644 --- a/src/pydo/aio/operations/_operations.py +++ b/src/pydo/aio/operations/_operations.py @@ -283,6 +283,7 @@ build_genai_delete_knowledge_base_data_source_request, build_genai_delete_knowledge_base_request, build_genai_delete_model_api_key_request, + build_genai_delete_model_evaluation_run_request, build_genai_delete_model_router_request, build_genai_delete_openai_api_key_request, build_genai_delete_scheduled_indexing_request, @@ -305,6 +306,7 @@ build_genai_get_indexing_job_request, build_genai_get_knowledge_base_request, build_genai_get_model_catalog_card_request, + build_genai_get_model_evaluation_preset_request, build_genai_get_model_evaluation_run_request, build_genai_get_model_evaluation_run_results_download_url_request, build_genai_get_model_router_request, @@ -334,6 +336,7 @@ build_genai_list_model_api_keys_request, build_genai_list_model_catalog_request, build_genai_list_model_evaluation_metrics_request, + build_genai_list_model_evaluation_presets_request, build_genai_list_model_evaluation_runs_request, build_genai_list_model_router_presets_request, build_genai_list_model_router_task_presets_request, @@ -4228,6 +4231,13 @@ async def list( } ], "ingress": { + "custom_error_page_url": "str", # Optional. + Optional HTTPS URL of a custom error page to display when the app + is unreachable. The page is shown in a full-viewport iframe. The + target must allow framing: avoid ``X-Frame-Options: DENY`` and a + restrictive ``Content-Security-Policy`` ``frame-ancestors`` that + blocks the platform. If omitted, the default platform error page + is used. "rules": [ { "component": { @@ -5781,6 +5791,14 @@ async def list( } ], "ingress": { + "custom_error_page_url": "str", # + Optional. Optional HTTPS URL of a custom error page to + display when the app is unreachable. The page is shown in a + full-viewport iframe. The target must allow framing: avoid + ``X-Frame-Options: DENY`` and a restrictive + ``Content-Security-Policy`` ``frame-ancestors`` that blocks + the platform. If omitted, the default platform error page is + used. "rules": [ { "component": { @@ -7485,6 +7503,14 @@ async def list( } ], "ingress": { + "custom_error_page_url": "str", # + Optional. Optional HTTPS URL of a custom error page to + display when the app is unreachable. The page is shown in a + full-viewport iframe. The target must allow framing: avoid + ``X-Frame-Options: DENY`` and a restrictive + ``Content-Security-Policy`` ``frame-ancestors`` that blocks + the platform. If omitted, the default platform error page is + used. "rules": [ { "component": { @@ -9127,6 +9153,14 @@ async def list( } ], "ingress": { + "custom_error_page_url": "str", # + Optional. Optional HTTPS URL of a custom error page to + display when the app is unreachable. The page is shown in a + full-viewport iframe. The target must allow framing: avoid + ``X-Frame-Options: DENY`` and a restrictive + ``Content-Security-Policy`` ``frame-ancestors`` that blocks + the platform. If omitted, the default platform error page is + used. "rules": [ { "component": { @@ -10760,6 +10794,14 @@ async def list( } ], "ingress": { + "custom_error_page_url": "str", # + Optional. Optional HTTPS URL of a custom error page to + display when the app is unreachable. The page is shown in a + full-viewport iframe. The target must allow framing: avoid + ``X-Frame-Options: DENY`` and a restrictive + ``Content-Security-Policy`` ``frame-ancestors`` that blocks + the platform. If omitted, the default platform error page is + used. "rules": [ { "component": { @@ -12362,6 +12404,12 @@ async def create( } ], "ingress": { + "custom_error_page_url": "str", # Optional. Optional HTTPS + URL of a custom error page to display when the app is unreachable. The + page is shown in a full-viewport iframe. The target must allow framing: + avoid ``X-Frame-Options: DENY`` and a restrictive + ``Content-Security-Policy`` ``frame-ancestors`` that blocks the platform. + If omitted, the default platform error page is used. "rules": [ { "component": { @@ -13656,6 +13704,12 @@ async def create( } ], "ingress": { + "custom_error_page_url": "str", # Optional. Optional + HTTPS URL of a custom error page to display when the app is + unreachable. The page is shown in a full-viewport iframe. The target + must allow framing: avoid ``X-Frame-Options: DENY`` and a restrictive + ``Content-Security-Policy`` ``frame-ancestors`` that blocks the + platform. If omitted, the default platform error page is used. "rules": [ { "component": { @@ -15121,6 +15175,13 @@ async def create( } ], "ingress": { + "custom_error_page_url": "str", # Optional. + Optional HTTPS URL of a custom error page to display when the app + is unreachable. The page is shown in a full-viewport iframe. The + target must allow framing: avoid ``X-Frame-Options: DENY`` and a + restrictive ``Content-Security-Policy`` ``frame-ancestors`` that + blocks the platform. If omitted, the default platform error page + is used. "rules": [ { "component": { @@ -16742,6 +16803,13 @@ async def create( } ], "ingress": { + "custom_error_page_url": "str", # Optional. + Optional HTTPS URL of a custom error page to display when the app + is unreachable. The page is shown in a full-viewport iframe. The + target must allow framing: avoid ``X-Frame-Options: DENY`` and a + restrictive ``Content-Security-Policy`` ``frame-ancestors`` that + blocks the platform. If omitted, the default platform error page + is used. "rules": [ { "component": { @@ -18302,6 +18370,13 @@ async def create( } ], "ingress": { + "custom_error_page_url": "str", # Optional. + Optional HTTPS URL of a custom error page to display when the app + is unreachable. The page is shown in a full-viewport iframe. The + target must allow framing: avoid ``X-Frame-Options: DENY`` and a + restrictive ``Content-Security-Policy`` ``frame-ancestors`` that + blocks the platform. If omitted, the default platform error page + is used. "rules": [ { "component": { @@ -19854,6 +19929,13 @@ async def create( } ], "ingress": { + "custom_error_page_url": "str", # Optional. + Optional HTTPS URL of a custom error page to display when the app + is unreachable. The page is shown in a full-viewport iframe. The + target must allow framing: avoid ``X-Frame-Options: DENY`` and a + restrictive ``Content-Security-Policy`` ``frame-ancestors`` that + blocks the platform. If omitted, the default platform error page + is used. "rules": [ { "component": { @@ -21342,6 +21424,12 @@ async def create( } ], "ingress": { + "custom_error_page_url": "str", # Optional. Optional + HTTPS URL of a custom error page to display when the app is + unreachable. The page is shown in a full-viewport iframe. The target + must allow framing: avoid ``X-Frame-Options: DENY`` and a restrictive + ``Content-Security-Policy`` ``frame-ancestors`` that blocks the + platform. If omitted, the default platform error page is used. "rules": [ { "component": { @@ -22807,6 +22895,13 @@ async def create( } ], "ingress": { + "custom_error_page_url": "str", # Optional. + Optional HTTPS URL of a custom error page to display when the app + is unreachable. The page is shown in a full-viewport iframe. The + target must allow framing: avoid ``X-Frame-Options: DENY`` and a + restrictive ``Content-Security-Policy`` ``frame-ancestors`` that + blocks the platform. If omitted, the default platform error page + is used. "rules": [ { "component": { @@ -24428,6 +24523,13 @@ async def create( } ], "ingress": { + "custom_error_page_url": "str", # Optional. + Optional HTTPS URL of a custom error page to display when the app + is unreachable. The page is shown in a full-viewport iframe. The + target must allow framing: avoid ``X-Frame-Options: DENY`` and a + restrictive ``Content-Security-Policy`` ``frame-ancestors`` that + blocks the platform. If omitted, the default platform error page + is used. "rules": [ { "component": { @@ -25988,6 +26090,13 @@ async def create( } ], "ingress": { + "custom_error_page_url": "str", # Optional. + Optional HTTPS URL of a custom error page to display when the app + is unreachable. The page is shown in a full-viewport iframe. The + target must allow framing: avoid ``X-Frame-Options: DENY`` and a + restrictive ``Content-Security-Policy`` ``frame-ancestors`` that + blocks the platform. If omitted, the default platform error page + is used. "rules": [ { "component": { @@ -27540,6 +27649,13 @@ async def create( } ], "ingress": { + "custom_error_page_url": "str", # Optional. + Optional HTTPS URL of a custom error page to display when the app + is unreachable. The page is shown in a full-viewport iframe. The + target must allow framing: avoid ``X-Frame-Options: DENY`` and a + restrictive ``Content-Security-Policy`` ``frame-ancestors`` that + blocks the platform. If omitted, the default platform error page + is used. "rules": [ { "component": { @@ -29011,6 +29127,12 @@ async def create(self, body: Union[JSON, IO[bytes]], **kwargs: Any) -> JSON: } ], "ingress": { + "custom_error_page_url": "str", # Optional. Optional HTTPS + URL of a custom error page to display when the app is unreachable. The + page is shown in a full-viewport iframe. The target must allow framing: + avoid ``X-Frame-Options: DENY`` and a restrictive + ``Content-Security-Policy`` ``frame-ancestors`` that blocks the platform. + If omitted, the default platform error page is used. "rules": [ { "component": { @@ -30305,6 +30427,12 @@ async def create(self, body: Union[JSON, IO[bytes]], **kwargs: Any) -> JSON: } ], "ingress": { + "custom_error_page_url": "str", # Optional. Optional + HTTPS URL of a custom error page to display when the app is + unreachable. The page is shown in a full-viewport iframe. The target + must allow framing: avoid ``X-Frame-Options: DENY`` and a restrictive + ``Content-Security-Policy`` ``frame-ancestors`` that blocks the + platform. If omitted, the default platform error page is used. "rules": [ { "component": { @@ -31770,6 +31898,13 @@ async def create(self, body: Union[JSON, IO[bytes]], **kwargs: Any) -> JSON: } ], "ingress": { + "custom_error_page_url": "str", # Optional. + Optional HTTPS URL of a custom error page to display when the app + is unreachable. The page is shown in a full-viewport iframe. The + target must allow framing: avoid ``X-Frame-Options: DENY`` and a + restrictive ``Content-Security-Policy`` ``frame-ancestors`` that + blocks the platform. If omitted, the default platform error page + is used. "rules": [ { "component": { @@ -33391,6 +33526,13 @@ async def create(self, body: Union[JSON, IO[bytes]], **kwargs: Any) -> JSON: } ], "ingress": { + "custom_error_page_url": "str", # Optional. + Optional HTTPS URL of a custom error page to display when the app + is unreachable. The page is shown in a full-viewport iframe. The + target must allow framing: avoid ``X-Frame-Options: DENY`` and a + restrictive ``Content-Security-Policy`` ``frame-ancestors`` that + blocks the platform. If omitted, the default platform error page + is used. "rules": [ { "component": { @@ -34951,6 +35093,13 @@ async def create(self, body: Union[JSON, IO[bytes]], **kwargs: Any) -> JSON: } ], "ingress": { + "custom_error_page_url": "str", # Optional. + Optional HTTPS URL of a custom error page to display when the app + is unreachable. The page is shown in a full-viewport iframe. The + target must allow framing: avoid ``X-Frame-Options: DENY`` and a + restrictive ``Content-Security-Policy`` ``frame-ancestors`` that + blocks the platform. If omitted, the default platform error page + is used. "rules": [ { "component": { @@ -36503,6 +36652,13 @@ async def create(self, body: Union[JSON, IO[bytes]], **kwargs: Any) -> JSON: } ], "ingress": { + "custom_error_page_url": "str", # Optional. + Optional HTTPS URL of a custom error page to display when the app + is unreachable. The page is shown in a full-viewport iframe. The + target must allow framing: avoid ``X-Frame-Options: DENY`` and a + restrictive ``Content-Security-Policy`` ``frame-ancestors`` that + blocks the platform. If omitted, the default platform error page + is used. "rules": [ { "component": { @@ -38173,6 +38329,12 @@ async def get(self, id: str, *, name: Optional[str] = None, **kwargs: Any) -> JS } ], "ingress": { + "custom_error_page_url": "str", # Optional. Optional + HTTPS URL of a custom error page to display when the app is + unreachable. The page is shown in a full-viewport iframe. The target + must allow framing: avoid ``X-Frame-Options: DENY`` and a restrictive + ``Content-Security-Policy`` ``frame-ancestors`` that blocks the + platform. If omitted, the default platform error page is used. "rules": [ { "component": { @@ -39638,6 +39800,13 @@ async def get(self, id: str, *, name: Optional[str] = None, **kwargs: Any) -> JS } ], "ingress": { + "custom_error_page_url": "str", # Optional. + Optional HTTPS URL of a custom error page to display when the app + is unreachable. The page is shown in a full-viewport iframe. The + target must allow framing: avoid ``X-Frame-Options: DENY`` and a + restrictive ``Content-Security-Policy`` ``frame-ancestors`` that + blocks the platform. If omitted, the default platform error page + is used. "rules": [ { "component": { @@ -41259,6 +41428,13 @@ async def get(self, id: str, *, name: Optional[str] = None, **kwargs: Any) -> JS } ], "ingress": { + "custom_error_page_url": "str", # Optional. + Optional HTTPS URL of a custom error page to display when the app + is unreachable. The page is shown in a full-viewport iframe. The + target must allow framing: avoid ``X-Frame-Options: DENY`` and a + restrictive ``Content-Security-Policy`` ``frame-ancestors`` that + blocks the platform. If omitted, the default platform error page + is used. "rules": [ { "component": { @@ -42819,6 +42995,13 @@ async def get(self, id: str, *, name: Optional[str] = None, **kwargs: Any) -> JS } ], "ingress": { + "custom_error_page_url": "str", # Optional. + Optional HTTPS URL of a custom error page to display when the app + is unreachable. The page is shown in a full-viewport iframe. The + target must allow framing: avoid ``X-Frame-Options: DENY`` and a + restrictive ``Content-Security-Policy`` ``frame-ancestors`` that + blocks the platform. If omitted, the default platform error page + is used. "rules": [ { "component": { @@ -44371,6 +44554,13 @@ async def get(self, id: str, *, name: Optional[str] = None, **kwargs: Any) -> JS } ], "ingress": { + "custom_error_page_url": "str", # Optional. + Optional HTTPS URL of a custom error page to display when the app + is unreachable. The page is shown in a full-viewport iframe. The + target must allow framing: avoid ``X-Frame-Options: DENY`` and a + restrictive ``Content-Security-Policy`` ``frame-ancestors`` that + blocks the platform. If omitted, the default platform error page + is used. "rules": [ { "component": { @@ -45943,6 +46133,12 @@ async def update( } ], "ingress": { + "custom_error_page_url": "str", # Optional. Optional HTTPS + URL of a custom error page to display when the app is unreachable. The + page is shown in a full-viewport iframe. The target must allow framing: + avoid ``X-Frame-Options: DENY`` and a restrictive + ``Content-Security-Policy`` ``frame-ancestors`` that blocks the platform. + If omitted, the default platform error page is used. "rules": [ { "component": { @@ -47239,6 +47435,12 @@ async def update( } ], "ingress": { + "custom_error_page_url": "str", # Optional. Optional + HTTPS URL of a custom error page to display when the app is + unreachable. The page is shown in a full-viewport iframe. The target + must allow framing: avoid ``X-Frame-Options: DENY`` and a restrictive + ``Content-Security-Policy`` ``frame-ancestors`` that blocks the + platform. If omitted, the default platform error page is used. "rules": [ { "component": { @@ -48704,6 +48906,13 @@ async def update( } ], "ingress": { + "custom_error_page_url": "str", # Optional. + Optional HTTPS URL of a custom error page to display when the app + is unreachable. The page is shown in a full-viewport iframe. The + target must allow framing: avoid ``X-Frame-Options: DENY`` and a + restrictive ``Content-Security-Policy`` ``frame-ancestors`` that + blocks the platform. If omitted, the default platform error page + is used. "rules": [ { "component": { @@ -50325,6 +50534,13 @@ async def update( } ], "ingress": { + "custom_error_page_url": "str", # Optional. + Optional HTTPS URL of a custom error page to display when the app + is unreachable. The page is shown in a full-viewport iframe. The + target must allow framing: avoid ``X-Frame-Options: DENY`` and a + restrictive ``Content-Security-Policy`` ``frame-ancestors`` that + blocks the platform. If omitted, the default platform error page + is used. "rules": [ { "component": { @@ -51885,6 +52101,13 @@ async def update( } ], "ingress": { + "custom_error_page_url": "str", # Optional. + Optional HTTPS URL of a custom error page to display when the app + is unreachable. The page is shown in a full-viewport iframe. The + target must allow framing: avoid ``X-Frame-Options: DENY`` and a + restrictive ``Content-Security-Policy`` ``frame-ancestors`` that + blocks the platform. If omitted, the default platform error page + is used. "rules": [ { "component": { @@ -53437,6 +53660,13 @@ async def update( } ], "ingress": { + "custom_error_page_url": "str", # Optional. + Optional HTTPS URL of a custom error page to display when the app + is unreachable. The page is shown in a full-viewport iframe. The + target must allow framing: avoid ``X-Frame-Options: DENY`` and a + restrictive ``Content-Security-Policy`` ``frame-ancestors`` that + blocks the platform. If omitted, the default platform error page + is used. "rules": [ { "component": { @@ -54943,6 +55173,12 @@ async def update( } ], "ingress": { + "custom_error_page_url": "str", # Optional. Optional + HTTPS URL of a custom error page to display when the app is + unreachable. The page is shown in a full-viewport iframe. The target + must allow framing: avoid ``X-Frame-Options: DENY`` and a restrictive + ``Content-Security-Policy`` ``frame-ancestors`` that blocks the + platform. If omitted, the default platform error page is used. "rules": [ { "component": { @@ -56408,6 +56644,13 @@ async def update( } ], "ingress": { + "custom_error_page_url": "str", # Optional. + Optional HTTPS URL of a custom error page to display when the app + is unreachable. The page is shown in a full-viewport iframe. The + target must allow framing: avoid ``X-Frame-Options: DENY`` and a + restrictive ``Content-Security-Policy`` ``frame-ancestors`` that + blocks the platform. If omitted, the default platform error page + is used. "rules": [ { "component": { @@ -58029,6 +58272,13 @@ async def update( } ], "ingress": { + "custom_error_page_url": "str", # Optional. + Optional HTTPS URL of a custom error page to display when the app + is unreachable. The page is shown in a full-viewport iframe. The + target must allow framing: avoid ``X-Frame-Options: DENY`` and a + restrictive ``Content-Security-Policy`` ``frame-ancestors`` that + blocks the platform. If omitted, the default platform error page + is used. "rules": [ { "component": { @@ -59589,6 +59839,13 @@ async def update( } ], "ingress": { + "custom_error_page_url": "str", # Optional. + Optional HTTPS URL of a custom error page to display when the app + is unreachable. The page is shown in a full-viewport iframe. The + target must allow framing: avoid ``X-Frame-Options: DENY`` and a + restrictive ``Content-Security-Policy`` ``frame-ancestors`` that + blocks the platform. If omitted, the default platform error page + is used. "rules": [ { "component": { @@ -61141,6 +61398,13 @@ async def update( } ], "ingress": { + "custom_error_page_url": "str", # Optional. + Optional HTTPS URL of a custom error page to display when the app + is unreachable. The page is shown in a full-viewport iframe. The + target must allow framing: avoid ``X-Frame-Options: DENY`` and a + restrictive ``Content-Security-Policy`` ``frame-ancestors`` that + blocks the platform. If omitted, the default platform error page + is used. "rules": [ { "component": { @@ -62627,6 +62891,12 @@ async def update( } ], "ingress": { + "custom_error_page_url": "str", # Optional. Optional HTTPS + URL of a custom error page to display when the app is unreachable. The + page is shown in a full-viewport iframe. The target must allow framing: + avoid ``X-Frame-Options: DENY`` and a restrictive + ``Content-Security-Policy`` ``frame-ancestors`` that blocks the platform. + If omitted, the default platform error page is used. "rules": [ { "component": { @@ -63923,6 +64193,12 @@ async def update( } ], "ingress": { + "custom_error_page_url": "str", # Optional. Optional + HTTPS URL of a custom error page to display when the app is + unreachable. The page is shown in a full-viewport iframe. The target + must allow framing: avoid ``X-Frame-Options: DENY`` and a restrictive + ``Content-Security-Policy`` ``frame-ancestors`` that blocks the + platform. If omitted, the default platform error page is used. "rules": [ { "component": { @@ -65388,6 +65664,13 @@ async def update( } ], "ingress": { + "custom_error_page_url": "str", # Optional. + Optional HTTPS URL of a custom error page to display when the app + is unreachable. The page is shown in a full-viewport iframe. The + target must allow framing: avoid ``X-Frame-Options: DENY`` and a + restrictive ``Content-Security-Policy`` ``frame-ancestors`` that + blocks the platform. If omitted, the default platform error page + is used. "rules": [ { "component": { @@ -67009,6 +67292,13 @@ async def update( } ], "ingress": { + "custom_error_page_url": "str", # Optional. + Optional HTTPS URL of a custom error page to display when the app + is unreachable. The page is shown in a full-viewport iframe. The + target must allow framing: avoid ``X-Frame-Options: DENY`` and a + restrictive ``Content-Security-Policy`` ``frame-ancestors`` that + blocks the platform. If omitted, the default platform error page + is used. "rules": [ { "component": { @@ -68569,6 +68859,13 @@ async def update( } ], "ingress": { + "custom_error_page_url": "str", # Optional. + Optional HTTPS URL of a custom error page to display when the app + is unreachable. The page is shown in a full-viewport iframe. The + target must allow framing: avoid ``X-Frame-Options: DENY`` and a + restrictive ``Content-Security-Policy`` ``frame-ancestors`` that + blocks the platform. If omitted, the default platform error page + is used. "rules": [ { "component": { @@ -70121,6 +70418,13 @@ async def update( } ], "ingress": { + "custom_error_page_url": "str", # Optional. + Optional HTTPS URL of a custom error page to display when the app + is unreachable. The page is shown in a full-viewport iframe. The + target must allow framing: avoid ``X-Frame-Options: DENY`` and a + restrictive ``Content-Security-Policy`` ``frame-ancestors`` that + blocks the platform. If omitted, the default platform error page + is used. "rules": [ { "component": { @@ -71827,6 +72131,12 @@ async def restart( } ], "ingress": { + "custom_error_page_url": "str", # Optional. Optional + HTTPS URL of a custom error page to display when the app is + unreachable. The page is shown in a full-viewport iframe. The target + must allow framing: avoid ``X-Frame-Options: DENY`` and a restrictive + ``Content-Security-Policy`` ``frame-ancestors`` that blocks the + platform. If omitted, the default platform error page is used. "rules": [ { "component": { @@ -73334,6 +73644,12 @@ async def restart( } ], "ingress": { + "custom_error_page_url": "str", # Optional. Optional + HTTPS URL of a custom error page to display when the app is + unreachable. The page is shown in a full-viewport iframe. The target + must allow framing: avoid ``X-Frame-Options: DENY`` and a restrictive + ``Content-Security-Policy`` ``frame-ancestors`` that blocks the + platform. If omitted, the default platform error page is used. "rules": [ { "component": { @@ -74841,6 +75157,12 @@ async def restart( } ], "ingress": { + "custom_error_page_url": "str", # Optional. Optional + HTTPS URL of a custom error page to display when the app is + unreachable. The page is shown in a full-viewport iframe. The target + must allow framing: avoid ``X-Frame-Options: DENY`` and a restrictive + ``Content-Security-Policy`` ``frame-ancestors`` that blocks the + platform. If omitted, the default platform error page is used. "rules": [ { "component": { @@ -76882,6 +77204,13 @@ async def list_deployments( } ], "ingress": { + "custom_error_page_url": "str", # Optional. + Optional HTTPS URL of a custom error page to display when the app + is unreachable. The page is shown in a full-viewport iframe. The + target must allow framing: avoid ``X-Frame-Options: DENY`` and a + restrictive ``Content-Security-Policy`` ``frame-ancestors`` that + blocks the platform. If omitted, the default platform error page + is used. "rules": [ { "component": { @@ -78547,6 +78876,12 @@ async def create_deployment( } ], "ingress": { + "custom_error_page_url": "str", # Optional. Optional + HTTPS URL of a custom error page to display when the app is + unreachable. The page is shown in a full-viewport iframe. The target + must allow framing: avoid ``X-Frame-Options: DENY`` and a restrictive + ``Content-Security-Policy`` ``frame-ancestors`` that blocks the + platform. If omitted, the default platform error page is used. "rules": [ { "component": { @@ -80055,6 +80390,12 @@ async def create_deployment( } ], "ingress": { + "custom_error_page_url": "str", # Optional. Optional + HTTPS URL of a custom error page to display when the app is + unreachable. The page is shown in a full-viewport iframe. The target + must allow framing: avoid ``X-Frame-Options: DENY`` and a restrictive + ``Content-Security-Policy`` ``frame-ancestors`` that blocks the + platform. If omitted, the default platform error page is used. "rules": [ { "component": { @@ -81561,6 +81902,12 @@ async def create_deployment( } ], "ingress": { + "custom_error_page_url": "str", # Optional. Optional + HTTPS URL of a custom error page to display when the app is + unreachable. The page is shown in a full-viewport iframe. The target + must allow framing: avoid ``X-Frame-Options: DENY`` and a restrictive + ``Content-Security-Policy`` ``frame-ancestors`` that blocks the + platform. If omitted, the default platform error page is used. "rules": [ { "component": { @@ -83151,6 +83498,12 @@ async def get_deployment( } ], "ingress": { + "custom_error_page_url": "str", # Optional. Optional + HTTPS URL of a custom error page to display when the app is + unreachable. The page is shown in a full-viewport iframe. The target + must allow framing: avoid ``X-Frame-Options: DENY`` and a restrictive + ``Content-Security-Policy`` ``frame-ancestors`` that blocks the + platform. If omitted, the default platform error page is used. "rules": [ { "component": { @@ -84728,6 +85081,12 @@ async def cancel_deployment( } ], "ingress": { + "custom_error_page_url": "str", # Optional. Optional + HTTPS URL of a custom error page to display when the app is + unreachable. The page is shown in a full-viewport iframe. The target + must allow framing: avoid ``X-Frame-Options: DENY`` and a restrictive + ``Content-Security-Policy`` ``frame-ancestors`` that blocks the + platform. If omitted, the default platform error page is used. "rules": [ { "component": { @@ -87608,6 +87967,14 @@ async def list_events( } ], "ingress": { + "custom_error_page_url": "str", # + Optional. Optional HTTPS URL of a custom error page to + display when the app is unreachable. The page is shown in a + full-viewport iframe. The target must allow framing: avoid + ``X-Frame-Options: DENY`` and a restrictive + ``Content-Security-Policy`` ``frame-ancestors`` that blocks + the platform. If omitted, the default platform error page is + used. "rules": [ { "component": { @@ -89363,6 +89730,13 @@ async def get_event(self, app_id: str, event_id: str, **kwargs: Any) -> JSON: } ], "ingress": { + "custom_error_page_url": "str", # Optional. + Optional HTTPS URL of a custom error page to display when the app + is unreachable. The page is shown in a full-viewport iframe. The + target must allow framing: avoid ``X-Frame-Options: DENY`` and a + restrictive ``Content-Security-Policy`` ``frame-ancestors`` that + blocks the platform. If omitted, the default platform error page + is used. "rules": [ { "component": { @@ -91054,6 +91428,13 @@ async def cancel_event(self, app_id: str, event_id: str, **kwargs: Any) -> JSON: } ], "ingress": { + "custom_error_page_url": "str", # Optional. + Optional HTTPS URL of a custom error page to display when the app + is unreachable. The page is shown in a full-viewport iframe. The + target must allow framing: avoid ``X-Frame-Options: DENY`` and a + restrictive ``Content-Security-Policy`` ``frame-ancestors`` that + blocks the platform. If omitted, the default platform error page + is used. "rules": [ { "component": { @@ -93086,6 +93467,12 @@ async def validate_app_spec( } ], "ingress": { + "custom_error_page_url": "str", # Optional. Optional HTTPS + URL of a custom error page to display when the app is unreachable. The + page is shown in a full-viewport iframe. The target must allow framing: + avoid ``X-Frame-Options: DENY`` and a restrictive + ``Content-Security-Policy`` ``frame-ancestors`` that blocks the platform. + If omitted, the default platform error page is used. "rules": [ { "component": { @@ -94382,6 +94769,12 @@ async def validate_app_spec( } ], "ingress": { + "custom_error_page_url": "str", # Optional. Optional HTTPS + URL of a custom error page to display when the app is unreachable. The + page is shown in a full-viewport iframe. The target must allow framing: + avoid ``X-Frame-Options: DENY`` and a restrictive + ``Content-Security-Policy`` ``frame-ancestors`` that blocks the platform. + If omitted, the default platform error page is used. "rules": [ { "component": { @@ -95700,6 +96093,12 @@ async def validate_app_spec( } ], "ingress": { + "custom_error_page_url": "str", # Optional. Optional HTTPS + URL of a custom error page to display when the app is unreachable. The + page is shown in a full-viewport iframe. The target must allow framing: + avoid ``X-Frame-Options: DENY`` and a restrictive + ``Content-Security-Policy`` ``frame-ancestors`` that blocks the platform. + If omitted, the default platform error page is used. "rules": [ { "component": { @@ -97001,6 +97400,12 @@ async def validate_app_spec( } ], "ingress": { + "custom_error_page_url": "str", # Optional. Optional HTTPS + URL of a custom error page to display when the app is unreachable. The + page is shown in a full-viewport iframe. The target must allow framing: + avoid ``X-Frame-Options: DENY`` and a restrictive + ``Content-Security-Policy`` ``frame-ancestors`` that blocks the platform. + If omitted, the default platform error page is used. "rules": [ { "component": { @@ -98297,6 +98702,12 @@ async def validate_app_spec( } ], "ingress": { + "custom_error_page_url": "str", # Optional. Optional HTTPS + URL of a custom error page to display when the app is unreachable. The + page is shown in a full-viewport iframe. The target must allow framing: + avoid ``X-Frame-Options: DENY`` and a restrictive + ``Content-Security-Policy`` ``frame-ancestors`` that blocks the platform. + If omitted, the default platform error page is used. "rules": [ { "component": { @@ -100416,6 +100827,12 @@ async def create_rollback( } ], "ingress": { + "custom_error_page_url": "str", # Optional. Optional + HTTPS URL of a custom error page to display when the app is + unreachable. The page is shown in a full-viewport iframe. The target + must allow framing: avoid ``X-Frame-Options: DENY`` and a restrictive + ``Content-Security-Policy`` ``frame-ancestors`` that blocks the + platform. If omitted, the default platform error page is used. "rules": [ { "component": { @@ -101932,6 +102349,12 @@ async def create_rollback( } ], "ingress": { + "custom_error_page_url": "str", # Optional. Optional + HTTPS URL of a custom error page to display when the app is + unreachable. The page is shown in a full-viewport iframe. The target + must allow framing: avoid ``X-Frame-Options: DENY`` and a restrictive + ``Content-Security-Policy`` ``frame-ancestors`` that blocks the + platform. If omitted, the default platform error page is used. "rules": [ { "component": { @@ -103451,6 +103874,12 @@ async def create_rollback( } ], "ingress": { + "custom_error_page_url": "str", # Optional. Optional + HTTPS URL of a custom error page to display when the app is + unreachable. The page is shown in a full-viewport iframe. The target + must allow framing: avoid ``X-Frame-Options: DENY`` and a restrictive + ``Content-Security-Policy`` ``frame-ancestors`` that blocks the + platform. If omitted, the default platform error page is used. "rules": [ { "component": { @@ -105565,6 +105994,12 @@ async def revert_rollback(self, app_id: str, **kwargs: Any) -> JSON: } ], "ingress": { + "custom_error_page_url": "str", # Optional. Optional + HTTPS URL of a custom error page to display when the app is + unreachable. The page is shown in a full-viewport iframe. The target + must allow framing: avoid ``X-Frame-Options: DENY`` and a restrictive + ``Content-Security-Policy`` ``frame-ancestors`` that blocks the + platform. If omitted, the default platform error page is used. "rules": [ { "component": { @@ -149364,9 +149799,12 @@ async def list_clusters( "updated_at": "2020-02-20 00:00:00", # Optional. A time value given in ISO8601 combined date and time format that represents when the Kubernetes cluster was last updated. - "vpc_uuid": "str" # Optional. A string specifying the UUID + "vpc_uuid": "str", # Optional. A string specifying the UUID of the VPC to which the Kubernetes cluster is assigned.:code:`
`:code:`
`Requires ``vpc:read`` scope. + "worker_subnet_uuid": "str" # Optional. The UUID of the VPC + subnet worker nodes are attached to. When unset, the default subnet for + the VPC is used.:code:`
`:code:`
`Requires ``vpc:read`` scope. } ], "links": { @@ -149662,9 +150100,13 @@ async def create_cluster( "updated_at": "2020-02-20 00:00:00", # Optional. A time value given in ISO8601 combined date and time format that represents when the Kubernetes cluster was last updated. - "vpc_uuid": "str" # Optional. A string specifying the UUID of the VPC to + "vpc_uuid": "str", # Optional. A string specifying the UUID of the VPC to which the Kubernetes cluster is assigned.:code:`
`:code:`
`Requires ``vpc:read`` scope. + "worker_subnet_uuid": "str" # Optional. The UUID of the VPC subnet to attach + worker nodes to. When omitted on create, the default subnet for the VPC is used. + This value cannot be changed after the cluster is created. ``vpc_uuid`` must + also be set. :code:`
`:code:`
`Requires ``vpc:read`` scope. } # response body for status code(s): 201 @@ -149874,9 +150316,14 @@ async def create_cluster( "updated_at": "2020-02-20 00:00:00", # Optional. A time value given in ISO8601 combined date and time format that represents when the Kubernetes cluster was last updated. - "vpc_uuid": "str" # Optional. A string specifying the UUID of the + "vpc_uuid": "str", # Optional. A string specifying the UUID of the VPC to which the Kubernetes cluster is assigned.:code:`
`:code:`
`Requires ``vpc:read`` scope. + "worker_subnet_uuid": "str" # Optional. The UUID of the VPC subnet + to attach worker nodes to. When omitted on create, the default subnet for the + VPC is used. This value cannot be changed after the cluster is created. + ``vpc_uuid`` must also be set. :code:`
`:code:`
`Requires ``vpc:read`` + scope. } } """ @@ -150117,9 +150564,14 @@ async def create_cluster( "updated_at": "2020-02-20 00:00:00", # Optional. A time value given in ISO8601 combined date and time format that represents when the Kubernetes cluster was last updated. - "vpc_uuid": "str" # Optional. A string specifying the UUID of the + "vpc_uuid": "str", # Optional. A string specifying the UUID of the VPC to which the Kubernetes cluster is assigned.:code:`
`:code:`
`Requires ``vpc:read`` scope. + "worker_subnet_uuid": "str" # Optional. The UUID of the VPC subnet + to attach worker nodes to. When omitted on create, the default subnet for the + VPC is used. This value cannot be changed after the cluster is created. + ``vpc_uuid`` must also be set. :code:`
`:code:`
`Requires ``vpc:read`` + scope. } } """ @@ -150345,9 +150797,13 @@ async def create_cluster(self, body: Union[JSON, IO[bytes]], **kwargs: Any) -> J "updated_at": "2020-02-20 00:00:00", # Optional. A time value given in ISO8601 combined date and time format that represents when the Kubernetes cluster was last updated. - "vpc_uuid": "str" # Optional. A string specifying the UUID of the VPC to + "vpc_uuid": "str", # Optional. A string specifying the UUID of the VPC to which the Kubernetes cluster is assigned.:code:`
`:code:`
`Requires ``vpc:read`` scope. + "worker_subnet_uuid": "str" # Optional. The UUID of the VPC subnet to attach + worker nodes to. When omitted on create, the default subnet for the VPC is used. + This value cannot be changed after the cluster is created. ``vpc_uuid`` must + also be set. :code:`
`:code:`
`Requires ``vpc:read`` scope. } # response body for status code(s): 201 @@ -150557,9 +151013,14 @@ async def create_cluster(self, body: Union[JSON, IO[bytes]], **kwargs: Any) -> J "updated_at": "2020-02-20 00:00:00", # Optional. A time value given in ISO8601 combined date and time format that represents when the Kubernetes cluster was last updated. - "vpc_uuid": "str" # Optional. A string specifying the UUID of the + "vpc_uuid": "str", # Optional. A string specifying the UUID of the VPC to which the Kubernetes cluster is assigned.:code:`
`:code:`
`Requires ``vpc:read`` scope. + "worker_subnet_uuid": "str" # Optional. The UUID of the VPC subnet + to attach worker nodes to. When omitted on create, the default subnet for the + VPC is used. This value cannot be changed after the cluster is created. + ``vpc_uuid`` must also be set. :code:`
`:code:`
`Requires ``vpc:read`` + scope. } } """ @@ -150863,9 +151324,12 @@ async def get_cluster(self, cluster_id: str, **kwargs: Any) -> JSON: "updated_at": "2020-02-20 00:00:00", # Optional. A time value given in ISO8601 combined date and time format that represents when the Kubernetes cluster was last updated. - "vpc_uuid": "str" # Optional. A string specifying the UUID of the + "vpc_uuid": "str", # Optional. A string specifying the UUID of the VPC to which the Kubernetes cluster is assigned.:code:`
`:code:`
`Requires ``vpc:read`` scope. + "worker_subnet_uuid": "str" # Optional. The UUID of the VPC subnet + worker nodes are attached to. When unset, the default subnet for the VPC is + used.:code:`
`:code:`
`Requires ``vpc:read`` scope. } } # response body for status code(s): 404 @@ -151288,9 +151752,14 @@ async def update_cluster( "updated_at": "2020-02-20 00:00:00", # Optional. A time value given in ISO8601 combined date and time format that represents when the Kubernetes cluster was last updated. - "vpc_uuid": "str" # Optional. A string specifying the UUID of the + "vpc_uuid": "str", # Optional. A string specifying the UUID of the VPC to which the Kubernetes cluster is assigned.:code:`
`:code:`
`Requires ``vpc:read`` scope. + "worker_subnet_uuid": "str" # Optional. The UUID of the VPC subnet + to attach worker nodes to. When omitted on create, the default subnet for the + VPC is used. This value cannot be changed after the cluster is created. + ``vpc_uuid`` must also be set. :code:`
`:code:`
`Requires ``vpc:read`` + scope. } } # response body for status code(s): 404 @@ -151543,9 +152012,14 @@ async def update_cluster( "updated_at": "2020-02-20 00:00:00", # Optional. A time value given in ISO8601 combined date and time format that represents when the Kubernetes cluster was last updated. - "vpc_uuid": "str" # Optional. A string specifying the UUID of the + "vpc_uuid": "str", # Optional. A string specifying the UUID of the VPC to which the Kubernetes cluster is assigned.:code:`
`:code:`
`Requires ``vpc:read`` scope. + "worker_subnet_uuid": "str" # Optional. The UUID of the VPC subnet + to attach worker nodes to. When omitted on create, the default subnet for the + VPC is used. This value cannot be changed after the cluster is created. + ``vpc_uuid`` must also be set. :code:`
`:code:`
`Requires ``vpc:read`` + scope. } } # response body for status code(s): 404 @@ -151883,9 +152357,14 @@ async def update_cluster( "updated_at": "2020-02-20 00:00:00", # Optional. A time value given in ISO8601 combined date and time format that represents when the Kubernetes cluster was last updated. - "vpc_uuid": "str" # Optional. A string specifying the UUID of the + "vpc_uuid": "str", # Optional. A string specifying the UUID of the VPC to which the Kubernetes cluster is assigned.:code:`
`:code:`
`Requires ``vpc:read`` scope. + "worker_subnet_uuid": "str" # Optional. The UUID of the VPC subnet + to attach worker nodes to. When omitted on create, the default subnet for the + VPC is used. This value cannot be changed after the cluster is created. + ``vpc_uuid`` must also be set. :code:`
`:code:`
`Requires ``vpc:read`` + scope. } } # response body for status code(s): 404 @@ -250377,6 +250856,367 @@ async def list_model_evaluation_metrics(self, **kwargs: Any) -> JSON: return cast(JSON, deserialized) # type: ignore + @distributed_trace_async + async def list_model_evaluation_presets(self, **kwargs: Any) -> JSON: + # pylint: disable=line-too-long + """List Model Evaluation Presets. + + To list all saved model evaluation presets, send a GET request to + ``/v2/genai/model_evaluation_presets``. + + :return: JSON object + :rtype: JSON + :raises ~azure.core.exceptions.HttpResponseError: + + Example: + .. code-block:: python + + # response body for status code(s): 200 + response == { + "presets": [ + { + "created_at": "2020-02-20 00:00:00", # Optional. Timestamp + when the preset was created. + "dataset_name": "str", # Optional. List of explicitly saved + evaluation presets (reusable configs). + "dataset_uuid": "str", # Optional. Dataset used for + evaluation. + "eval_preset_uuid": "str", # Optional. UUID of the + evaluation preset. + "judge_model_name": "str", # Optional. List of explicitly + saved evaluation presets (reusable configs). + "judge_model_uuid": "str", # Optional. Judge model used to + score responses. + "metrics": [ + { + "category": "METRIC_CATEGORY_UNSPECIFIED", # + Optional. Default value is "METRIC_CATEGORY_UNSPECIFIED". Known + values are: "METRIC_CATEGORY_UNSPECIFIED", + "METRIC_CATEGORY_CORRECTNESS", "METRIC_CATEGORY_USER_OUTCOMES", + "METRIC_CATEGORY_SAFETY_AND_SECURITY", + "METRIC_CATEGORY_CONTEXT_QUALITY", and + "METRIC_CATEGORY_MODEL_FIT". + "description": "str", # Optional. Metrics + selected for this preset. + "evaluation_scope": + "EVALUATION_SCOPE_UNSPECIFIED", # Optional. Default value is + "EVALUATION_SCOPE_UNSPECIFIED". Scope that determines whether a + metric belongs to agent evaluation or model evaluation. For + backwards compatibility, UNSPECIFIED defaults to agent metrics + only in list operations. Known values are: + "EVALUATION_SCOPE_UNSPECIFIED", "EVALUATION_SCOPE_AGENT", and + "EVALUATION_SCOPE_MODEL". + "inverted": bool, # Optional. If true, the + metric is inverted, meaning that a lower value is better. + "is_metric_goal": bool, # Optional. Metrics + selected for this preset. + "metric_name": "str", # Optional. Metrics + selected for this preset. + "metric_rank": 0, # Optional. Metrics + selected for this preset. + "metric_type": "METRIC_TYPE_UNSPECIFIED", # + Optional. Default value is "METRIC_TYPE_UNSPECIFIED". Known + values are: "METRIC_TYPE_UNSPECIFIED", + "METRIC_TYPE_GENERAL_QUALITY", "METRIC_TYPE_RAG_AND_TOOL", + "METRIC_TYPE_MODEL_QUALITY", and "METRIC_TYPE_MODEL_SAFETY". + "metric_uuid": "str", # Optional. Metrics + selected for this preset. + "metric_value_type": + "METRIC_VALUE_TYPE_UNSPECIFIED", # Optional. Default value is + "METRIC_VALUE_TYPE_UNSPECIFIED". Known values are: + "METRIC_VALUE_TYPE_UNSPECIFIED", "METRIC_VALUE_TYPE_NUMBER", + "METRIC_VALUE_TYPE_STRING", and "METRIC_VALUE_TYPE_PERCENTAGE". + "range_max": 0.0, # Optional. The maximum + value for the metric. + "range_min": 0.0 # Optional. The minimum + value for the metric. + } + ], + "name": "str", # Optional. Name of the evaluation preset. + "star_metric": { + "metric_uuid": "str", # Optional. List of explicitly + saved evaluation presets (reusable configs). + "name": "str", # Optional. List of explicitly saved + evaluation presets (reusable configs). + "success_threshold": 0.0, # Optional. The success + threshold for the star metric. This is a value that the metric must + reach to be considered successful. + "success_threshold_pct": 0 # Optional. The success + threshold for the star metric. This is a percentage value between 0 + and 100. + } + } + ] + } + # response body for status code(s): 404 + response == { + "id": "str", # A short identifier corresponding to the HTTP status code + returned. For example, the ID for a response returning a 404 status code would + be "not_found.". Required. + "message": "str", # A message providing additional information about the + error, including details to help resolve it when possible. Required. + "request_id": "str" # Optional. Optionally, some endpoints may include a + request ID that should be provided when reporting bugs or opening support + tickets to help identify the issue. + } + """ + error_map: MutableMapping[int, Type[HttpResponseError]] = { + 404: ResourceNotFoundError, + 409: ResourceExistsError, + 304: ResourceNotModifiedError, + 401: cast( + Type[HttpResponseError], + lambda response: ClientAuthenticationError(response=response), + ), + 429: HttpResponseError, + 500: HttpResponseError, + } + error_map.update(kwargs.pop("error_map", {}) or {}) + + _headers = kwargs.pop("headers", {}) or {} + _params = kwargs.pop("params", {}) or {} + + cls: ClsType[JSON] = kwargs.pop("cls", None) + + _request = build_genai_list_model_evaluation_presets_request( + headers=_headers, + params=_params, + ) + _request.url = self._client.format_url(_request.url) + + _stream = False + pipeline_response: PipelineResponse = ( + await self._client._pipeline.run( # pylint: disable=protected-access + _request, stream=_stream, **kwargs + ) + ) + + response = pipeline_response.http_response + + if response.status_code not in [200, 404]: + 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) # type: ignore + raise HttpResponseError(response=response) + + response_headers = {} + if response.status_code == 200: + response_headers["ratelimit-limit"] = self._deserialize( + "int", response.headers.get("ratelimit-limit") + ) + response_headers["ratelimit-remaining"] = self._deserialize( + "int", response.headers.get("ratelimit-remaining") + ) + response_headers["ratelimit-reset"] = self._deserialize( + "int", response.headers.get("ratelimit-reset") + ) + + if response.content: + deserialized = response.json() + else: + deserialized = None + + if response.status_code == 404: + response_headers["ratelimit-limit"] = self._deserialize( + "int", response.headers.get("ratelimit-limit") + ) + response_headers["ratelimit-remaining"] = self._deserialize( + "int", response.headers.get("ratelimit-remaining") + ) + response_headers["ratelimit-reset"] = self._deserialize( + "int", response.headers.get("ratelimit-reset") + ) + + if response.content: + deserialized = response.json() + else: + deserialized = None + + if cls: + return cls(pipeline_response, cast(JSON, deserialized), response_headers) # type: ignore + + return cast(JSON, deserialized) # type: ignore + + @distributed_trace_async + async def get_model_evaluation_preset( + self, eval_preset_uuid: str, **kwargs: Any + ) -> JSON: + # pylint: disable=line-too-long + """Retrieve Model Evaluation Preset. + + To retrieve a saved model evaluation preset, send a GET request to + ``/v2/genai/model_evaluation_presets/{eval_preset_uuid}``. + + :param eval_preset_uuid: UUID of the evaluation preset. Required. + :type eval_preset_uuid: str + :return: JSON object + :rtype: JSON + :raises ~azure.core.exceptions.HttpResponseError: + + Example: + .. code-block:: python + + # response body for status code(s): 200 + response == { + "preset": { + "created_at": "2020-02-20 00:00:00", # Optional. Timestamp when the + preset was created. + "dataset_name": "str", # Optional. Model Evaluation Preset - a + saved, reusable configuration for model evaluation runs. + "dataset_uuid": "str", # Optional. Dataset used for evaluation. + "eval_preset_uuid": "str", # Optional. UUID of the evaluation + preset. + "judge_model_name": "str", # Optional. Model Evaluation Preset - a + saved, reusable configuration for model evaluation runs. + "judge_model_uuid": "str", # Optional. Judge model used to score + responses. + "metrics": [ + { + "category": "METRIC_CATEGORY_UNSPECIFIED", # + Optional. Default value is "METRIC_CATEGORY_UNSPECIFIED". Known + values are: "METRIC_CATEGORY_UNSPECIFIED", + "METRIC_CATEGORY_CORRECTNESS", "METRIC_CATEGORY_USER_OUTCOMES", + "METRIC_CATEGORY_SAFETY_AND_SECURITY", + "METRIC_CATEGORY_CONTEXT_QUALITY", and "METRIC_CATEGORY_MODEL_FIT". + "description": "str", # Optional. Metrics selected + for this preset. + "evaluation_scope": "EVALUATION_SCOPE_UNSPECIFIED", + # Optional. Default value is "EVALUATION_SCOPE_UNSPECIFIED". Scope + that determines whether a metric belongs to agent evaluation or model + evaluation. For backwards compatibility, UNSPECIFIED defaults to + agent metrics only in list operations. Known values are: + "EVALUATION_SCOPE_UNSPECIFIED", "EVALUATION_SCOPE_AGENT", and + "EVALUATION_SCOPE_MODEL". + "inverted": bool, # Optional. If true, the metric is + inverted, meaning that a lower value is better. + "is_metric_goal": bool, # Optional. Metrics selected + for this preset. + "metric_name": "str", # Optional. Metrics selected + for this preset. + "metric_rank": 0, # Optional. Metrics selected for + this preset. + "metric_type": "METRIC_TYPE_UNSPECIFIED", # + Optional. Default value is "METRIC_TYPE_UNSPECIFIED". Known values + are: "METRIC_TYPE_UNSPECIFIED", "METRIC_TYPE_GENERAL_QUALITY", + "METRIC_TYPE_RAG_AND_TOOL", "METRIC_TYPE_MODEL_QUALITY", and + "METRIC_TYPE_MODEL_SAFETY". + "metric_uuid": "str", # Optional. Metrics selected + for this preset. + "metric_value_type": "METRIC_VALUE_TYPE_UNSPECIFIED", + # Optional. Default value is "METRIC_VALUE_TYPE_UNSPECIFIED". Known + values are: "METRIC_VALUE_TYPE_UNSPECIFIED", + "METRIC_VALUE_TYPE_NUMBER", "METRIC_VALUE_TYPE_STRING", and + "METRIC_VALUE_TYPE_PERCENTAGE". + "range_max": 0.0, # Optional. The maximum value for + the metric. + "range_min": 0.0 # Optional. The minimum value for + the metric. + } + ], + "name": "str", # Optional. Name of the evaluation preset. + "star_metric": { + "metric_uuid": "str", # Optional. Model Evaluation Preset - + a saved, reusable configuration for model evaluation runs. + "name": "str", # Optional. Model Evaluation Preset - a + saved, reusable configuration for model evaluation runs. + "success_threshold": 0.0, # Optional. The success threshold + for the star metric. This is a value that the metric must reach to be + considered successful. + "success_threshold_pct": 0 # Optional. The success threshold + for the star metric. This is a percentage value between 0 and 100. + } + } + } + # response body for status code(s): 404 + response == { + "id": "str", # A short identifier corresponding to the HTTP status code + returned. For example, the ID for a response returning a 404 status code would + be "not_found.". Required. + "message": "str", # A message providing additional information about the + error, including details to help resolve it when possible. Required. + "request_id": "str" # Optional. Optionally, some endpoints may include a + request ID that should be provided when reporting bugs or opening support + tickets to help identify the issue. + } + """ + error_map: MutableMapping[int, Type[HttpResponseError]] = { + 404: ResourceNotFoundError, + 409: ResourceExistsError, + 304: ResourceNotModifiedError, + 401: cast( + Type[HttpResponseError], + lambda response: ClientAuthenticationError(response=response), + ), + 429: HttpResponseError, + 500: HttpResponseError, + } + error_map.update(kwargs.pop("error_map", {}) or {}) + + _headers = kwargs.pop("headers", {}) or {} + _params = kwargs.pop("params", {}) or {} + + cls: ClsType[JSON] = kwargs.pop("cls", None) + + _request = build_genai_get_model_evaluation_preset_request( + eval_preset_uuid=eval_preset_uuid, + headers=_headers, + params=_params, + ) + _request.url = self._client.format_url(_request.url) + + _stream = False + pipeline_response: PipelineResponse = ( + await self._client._pipeline.run( # pylint: disable=protected-access + _request, stream=_stream, **kwargs + ) + ) + + response = pipeline_response.http_response + + if response.status_code not in [200, 404]: + 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) # type: ignore + raise HttpResponseError(response=response) + + response_headers = {} + if response.status_code == 200: + response_headers["ratelimit-limit"] = self._deserialize( + "int", response.headers.get("ratelimit-limit") + ) + response_headers["ratelimit-remaining"] = self._deserialize( + "int", response.headers.get("ratelimit-remaining") + ) + response_headers["ratelimit-reset"] = self._deserialize( + "int", response.headers.get("ratelimit-reset") + ) + + if response.content: + deserialized = response.json() + else: + deserialized = None + + if response.status_code == 404: + response_headers["ratelimit-limit"] = self._deserialize( + "int", response.headers.get("ratelimit-limit") + ) + response_headers["ratelimit-remaining"] = self._deserialize( + "int", response.headers.get("ratelimit-remaining") + ) + response_headers["ratelimit-reset"] = self._deserialize( + "int", response.headers.get("ratelimit-reset") + ) + + if response.content: + deserialized = response.json() + else: + deserialized = None + + if cls: + return cls(pipeline_response, cast(JSON, deserialized), response_headers) # type: ignore + + return cast(JSON, deserialized) # type: ignore + @distributed_trace_async async def list_model_evaluation_runs( self, @@ -251307,6 +252147,132 @@ async def get_model_evaluation_run( return cast(JSON, deserialized) # type: ignore + @distributed_trace_async + async def delete_model_evaluation_run( + self, eval_run_uuid: str, **kwargs: Any + ) -> JSON: + # pylint: disable=line-too-long + """Delete Model Evaluation Run. + + To delete a model evaluation run, send a DELETE request to + ``/v2/gen-ai/model_evaluation_runs/{eval_run_uuid}``. The run must be in a terminal status (\\ + ``successful``\\ , ``partially_successful``\\ , ``failed``\\ , or ``cancelled``\\ ). For runs + still in progress, either wait for the run to finish or cancel it, then retry the delete once + the run reaches a terminal status. + + :param eval_run_uuid: UUID of the model evaluation run to delete. The run must be in a terminal + status (\\ ``successful``\\ , ``partially_successful``\\ , ``failed``\\ , or ``cancelled``\\ + ). + For runs still in progress, either wait for the run to finish or cancel + it, then retry the delete. Required. + :type eval_run_uuid: str + :return: JSON object + :rtype: JSON + :raises ~azure.core.exceptions.HttpResponseError: + + Example: + .. code-block:: python + + # response body for status code(s): 200 + response == { + "error": "str", # Optional. Error message if deletion failed. + "status": "DELETE_MODEL_EVALUATION_RUN_STATUS_UNSPECIFIED" # Optional. + Default value is "DELETE_MODEL_EVALUATION_RUN_STATUS_UNSPECIFIED". Status of + delete operation. Known values are: + "DELETE_MODEL_EVALUATION_RUN_STATUS_UNSPECIFIED", + "DELETE_MODEL_EVALUATION_RUN_STATUS_SUCCESS", and + "DELETE_MODEL_EVALUATION_RUN_STATUS_FAIL". + } + # response body for status code(s): 404 + response == { + "id": "str", # A short identifier corresponding to the HTTP status code + returned. For example, the ID for a response returning a 404 status code would + be "not_found.". Required. + "message": "str", # A message providing additional information about the + error, including details to help resolve it when possible. Required. + "request_id": "str" # Optional. Optionally, some endpoints may include a + request ID that should be provided when reporting bugs or opening support + tickets to help identify the issue. + } + """ + error_map: MutableMapping[int, Type[HttpResponseError]] = { + 404: ResourceNotFoundError, + 409: ResourceExistsError, + 304: ResourceNotModifiedError, + 401: cast( + Type[HttpResponseError], + lambda response: ClientAuthenticationError(response=response), + ), + 429: HttpResponseError, + 500: HttpResponseError, + } + error_map.update(kwargs.pop("error_map", {}) or {}) + + _headers = kwargs.pop("headers", {}) or {} + _params = kwargs.pop("params", {}) or {} + + cls: ClsType[JSON] = kwargs.pop("cls", None) + + _request = build_genai_delete_model_evaluation_run_request( + eval_run_uuid=eval_run_uuid, + headers=_headers, + params=_params, + ) + _request.url = self._client.format_url(_request.url) + + _stream = False + pipeline_response: PipelineResponse = ( + await self._client._pipeline.run( # pylint: disable=protected-access + _request, stream=_stream, **kwargs + ) + ) + + response = pipeline_response.http_response + + if response.status_code not in [200, 404]: + 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) # type: ignore + raise HttpResponseError(response=response) + + response_headers = {} + if response.status_code == 200: + response_headers["ratelimit-limit"] = self._deserialize( + "int", response.headers.get("ratelimit-limit") + ) + response_headers["ratelimit-remaining"] = self._deserialize( + "int", response.headers.get("ratelimit-remaining") + ) + response_headers["ratelimit-reset"] = self._deserialize( + "int", response.headers.get("ratelimit-reset") + ) + + if response.content: + deserialized = response.json() + else: + deserialized = None + + if response.status_code == 404: + response_headers["ratelimit-limit"] = self._deserialize( + "int", response.headers.get("ratelimit-limit") + ) + response_headers["ratelimit-remaining"] = self._deserialize( + "int", response.headers.get("ratelimit-remaining") + ) + response_headers["ratelimit-reset"] = self._deserialize( + "int", response.headers.get("ratelimit-reset") + ) + + if response.content: + deserialized = response.json() + else: + deserialized = None + + if cls: + return cls(pipeline_response, cast(JSON, deserialized), response_headers) # type: ignore + + return cast(JSON, deserialized) # type: ignore + @distributed_trace_async async def get_model_evaluation_run_results_download_url( # pylint: disable=name-too-long self, eval_run_uuid: str, **kwargs: Any diff --git a/src/pydo/operations/_operations.py b/src/pydo/operations/_operations.py index a1e4ce56..ad4e4762 100644 --- a/src/pydo/operations/_operations.py +++ b/src/pydo/operations/_operations.py @@ -14298,6 +14298,45 @@ def build_genai_list_model_evaluation_metrics_request( return HttpRequest(method="GET", url=_url, headers=_headers, **kwargs) +def build_genai_list_model_evaluation_presets_request( + **kwargs: Any, +) -> HttpRequest: # pylint: disable=name-too-long + _headers = case_insensitive_dict(kwargs.pop("headers", {}) or {}) + + accept = _headers.pop("Accept", "application/json") + + # Construct URL + _url = "/v2/gen-ai/model_evaluation_presets" + + # Construct headers + _headers["Accept"] = _SERIALIZER.header("accept", accept, "str") + + return HttpRequest(method="GET", url=_url, headers=_headers, **kwargs) + + +def build_genai_get_model_evaluation_preset_request( # pylint: disable=name-too-long + eval_preset_uuid: str, **kwargs: Any +) -> HttpRequest: + _headers = case_insensitive_dict(kwargs.pop("headers", {}) or {}) + + accept = _headers.pop("Accept", "application/json") + + # Construct URL + _url = "/v2/gen-ai/model_evaluation_presets/{eval_preset_uuid}" + path_format_arguments = { + "eval_preset_uuid": _SERIALIZER.url( + "eval_preset_uuid", eval_preset_uuid, "str" + ), + } + + _url: str = _url.format(**path_format_arguments) # type: ignore + + # Construct headers + _headers["Accept"] = _SERIALIZER.header("accept", accept, "str") + + return HttpRequest(method="GET", url=_url, headers=_headers, **kwargs) + + def build_genai_list_model_evaluation_runs_request( # pylint: disable=name-too-long *, eval_preset_uuid: Optional[str] = None, @@ -14391,6 +14430,27 @@ def build_genai_get_model_evaluation_run_request( # pylint: disable=name-too-lo ) +def build_genai_delete_model_evaluation_run_request( # pylint: disable=name-too-long + eval_run_uuid: str, **kwargs: Any +) -> HttpRequest: + _headers = case_insensitive_dict(kwargs.pop("headers", {}) or {}) + + accept = _headers.pop("Accept", "application/json") + + # Construct URL + _url = "/v2/gen-ai/model_evaluation_runs/{eval_run_uuid}" + path_format_arguments = { + "eval_run_uuid": _SERIALIZER.url("eval_run_uuid", eval_run_uuid, "str"), + } + + _url: str = _url.format(**path_format_arguments) # type: ignore + + # Construct headers + _headers["Accept"] = _SERIALIZER.header("accept", accept, "str") + + return HttpRequest(method="DELETE", url=_url, headers=_headers, **kwargs) + + def build_genai_get_model_evaluation_run_results_download_url_request( # pylint: disable=name-too-long eval_run_uuid: str, **kwargs: Any ) -> HttpRequest: @@ -19156,6 +19216,13 @@ def list( } ], "ingress": { + "custom_error_page_url": "str", # Optional. + Optional HTTPS URL of a custom error page to display when the app + is unreachable. The page is shown in a full-viewport iframe. The + target must allow framing: avoid ``X-Frame-Options: DENY`` and a + restrictive ``Content-Security-Policy`` ``frame-ancestors`` that + blocks the platform. If omitted, the default platform error page + is used. "rules": [ { "component": { @@ -20709,6 +20776,14 @@ def list( } ], "ingress": { + "custom_error_page_url": "str", # + Optional. Optional HTTPS URL of a custom error page to + display when the app is unreachable. The page is shown in a + full-viewport iframe. The target must allow framing: avoid + ``X-Frame-Options: DENY`` and a restrictive + ``Content-Security-Policy`` ``frame-ancestors`` that blocks + the platform. If omitted, the default platform error page is + used. "rules": [ { "component": { @@ -22413,6 +22488,14 @@ def list( } ], "ingress": { + "custom_error_page_url": "str", # + Optional. Optional HTTPS URL of a custom error page to + display when the app is unreachable. The page is shown in a + full-viewport iframe. The target must allow framing: avoid + ``X-Frame-Options: DENY`` and a restrictive + ``Content-Security-Policy`` ``frame-ancestors`` that blocks + the platform. If omitted, the default platform error page is + used. "rules": [ { "component": { @@ -24055,6 +24138,14 @@ def list( } ], "ingress": { + "custom_error_page_url": "str", # + Optional. Optional HTTPS URL of a custom error page to + display when the app is unreachable. The page is shown in a + full-viewport iframe. The target must allow framing: avoid + ``X-Frame-Options: DENY`` and a restrictive + ``Content-Security-Policy`` ``frame-ancestors`` that blocks + the platform. If omitted, the default platform error page is + used. "rules": [ { "component": { @@ -25688,6 +25779,14 @@ def list( } ], "ingress": { + "custom_error_page_url": "str", # + Optional. Optional HTTPS URL of a custom error page to + display when the app is unreachable. The page is shown in a + full-viewport iframe. The target must allow framing: avoid + ``X-Frame-Options: DENY`` and a restrictive + ``Content-Security-Policy`` ``frame-ancestors`` that blocks + the platform. If omitted, the default platform error page is + used. "rules": [ { "component": { @@ -27290,6 +27389,12 @@ def create( } ], "ingress": { + "custom_error_page_url": "str", # Optional. Optional HTTPS + URL of a custom error page to display when the app is unreachable. The + page is shown in a full-viewport iframe. The target must allow framing: + avoid ``X-Frame-Options: DENY`` and a restrictive + ``Content-Security-Policy`` ``frame-ancestors`` that blocks the platform. + If omitted, the default platform error page is used. "rules": [ { "component": { @@ -28584,6 +28689,12 @@ def create( } ], "ingress": { + "custom_error_page_url": "str", # Optional. Optional + HTTPS URL of a custom error page to display when the app is + unreachable. The page is shown in a full-viewport iframe. The target + must allow framing: avoid ``X-Frame-Options: DENY`` and a restrictive + ``Content-Security-Policy`` ``frame-ancestors`` that blocks the + platform. If omitted, the default platform error page is used. "rules": [ { "component": { @@ -30049,6 +30160,13 @@ def create( } ], "ingress": { + "custom_error_page_url": "str", # Optional. + Optional HTTPS URL of a custom error page to display when the app + is unreachable. The page is shown in a full-viewport iframe. The + target must allow framing: avoid ``X-Frame-Options: DENY`` and a + restrictive ``Content-Security-Policy`` ``frame-ancestors`` that + blocks the platform. If omitted, the default platform error page + is used. "rules": [ { "component": { @@ -31670,6 +31788,13 @@ def create( } ], "ingress": { + "custom_error_page_url": "str", # Optional. + Optional HTTPS URL of a custom error page to display when the app + is unreachable. The page is shown in a full-viewport iframe. The + target must allow framing: avoid ``X-Frame-Options: DENY`` and a + restrictive ``Content-Security-Policy`` ``frame-ancestors`` that + blocks the platform. If omitted, the default platform error page + is used. "rules": [ { "component": { @@ -33230,6 +33355,13 @@ def create( } ], "ingress": { + "custom_error_page_url": "str", # Optional. + Optional HTTPS URL of a custom error page to display when the app + is unreachable. The page is shown in a full-viewport iframe. The + target must allow framing: avoid ``X-Frame-Options: DENY`` and a + restrictive ``Content-Security-Policy`` ``frame-ancestors`` that + blocks the platform. If omitted, the default platform error page + is used. "rules": [ { "component": { @@ -34782,6 +34914,13 @@ def create( } ], "ingress": { + "custom_error_page_url": "str", # Optional. + Optional HTTPS URL of a custom error page to display when the app + is unreachable. The page is shown in a full-viewport iframe. The + target must allow framing: avoid ``X-Frame-Options: DENY`` and a + restrictive ``Content-Security-Policy`` ``frame-ancestors`` that + blocks the platform. If omitted, the default platform error page + is used. "rules": [ { "component": { @@ -36270,6 +36409,12 @@ def create( } ], "ingress": { + "custom_error_page_url": "str", # Optional. Optional + HTTPS URL of a custom error page to display when the app is + unreachable. The page is shown in a full-viewport iframe. The target + must allow framing: avoid ``X-Frame-Options: DENY`` and a restrictive + ``Content-Security-Policy`` ``frame-ancestors`` that blocks the + platform. If omitted, the default platform error page is used. "rules": [ { "component": { @@ -37735,6 +37880,13 @@ def create( } ], "ingress": { + "custom_error_page_url": "str", # Optional. + Optional HTTPS URL of a custom error page to display when the app + is unreachable. The page is shown in a full-viewport iframe. The + target must allow framing: avoid ``X-Frame-Options: DENY`` and a + restrictive ``Content-Security-Policy`` ``frame-ancestors`` that + blocks the platform. If omitted, the default platform error page + is used. "rules": [ { "component": { @@ -39356,6 +39508,13 @@ def create( } ], "ingress": { + "custom_error_page_url": "str", # Optional. + Optional HTTPS URL of a custom error page to display when the app + is unreachable. The page is shown in a full-viewport iframe. The + target must allow framing: avoid ``X-Frame-Options: DENY`` and a + restrictive ``Content-Security-Policy`` ``frame-ancestors`` that + blocks the platform. If omitted, the default platform error page + is used. "rules": [ { "component": { @@ -40916,6 +41075,13 @@ def create( } ], "ingress": { + "custom_error_page_url": "str", # Optional. + Optional HTTPS URL of a custom error page to display when the app + is unreachable. The page is shown in a full-viewport iframe. The + target must allow framing: avoid ``X-Frame-Options: DENY`` and a + restrictive ``Content-Security-Policy`` ``frame-ancestors`` that + blocks the platform. If omitted, the default platform error page + is used. "rules": [ { "component": { @@ -42468,6 +42634,13 @@ def create( } ], "ingress": { + "custom_error_page_url": "str", # Optional. + Optional HTTPS URL of a custom error page to display when the app + is unreachable. The page is shown in a full-viewport iframe. The + target must allow framing: avoid ``X-Frame-Options: DENY`` and a + restrictive ``Content-Security-Policy`` ``frame-ancestors`` that + blocks the platform. If omitted, the default platform error page + is used. "rules": [ { "component": { @@ -43939,6 +44112,12 @@ def create(self, body: Union[JSON, IO[bytes]], **kwargs: Any) -> JSON: } ], "ingress": { + "custom_error_page_url": "str", # Optional. Optional HTTPS + URL of a custom error page to display when the app is unreachable. The + page is shown in a full-viewport iframe. The target must allow framing: + avoid ``X-Frame-Options: DENY`` and a restrictive + ``Content-Security-Policy`` ``frame-ancestors`` that blocks the platform. + If omitted, the default platform error page is used. "rules": [ { "component": { @@ -45233,6 +45412,12 @@ def create(self, body: Union[JSON, IO[bytes]], **kwargs: Any) -> JSON: } ], "ingress": { + "custom_error_page_url": "str", # Optional. Optional + HTTPS URL of a custom error page to display when the app is + unreachable. The page is shown in a full-viewport iframe. The target + must allow framing: avoid ``X-Frame-Options: DENY`` and a restrictive + ``Content-Security-Policy`` ``frame-ancestors`` that blocks the + platform. If omitted, the default platform error page is used. "rules": [ { "component": { @@ -46698,6 +46883,13 @@ def create(self, body: Union[JSON, IO[bytes]], **kwargs: Any) -> JSON: } ], "ingress": { + "custom_error_page_url": "str", # Optional. + Optional HTTPS URL of a custom error page to display when the app + is unreachable. The page is shown in a full-viewport iframe. The + target must allow framing: avoid ``X-Frame-Options: DENY`` and a + restrictive ``Content-Security-Policy`` ``frame-ancestors`` that + blocks the platform. If omitted, the default platform error page + is used. "rules": [ { "component": { @@ -48319,6 +48511,13 @@ def create(self, body: Union[JSON, IO[bytes]], **kwargs: Any) -> JSON: } ], "ingress": { + "custom_error_page_url": "str", # Optional. + Optional HTTPS URL of a custom error page to display when the app + is unreachable. The page is shown in a full-viewport iframe. The + target must allow framing: avoid ``X-Frame-Options: DENY`` and a + restrictive ``Content-Security-Policy`` ``frame-ancestors`` that + blocks the platform. If omitted, the default platform error page + is used. "rules": [ { "component": { @@ -49879,6 +50078,13 @@ def create(self, body: Union[JSON, IO[bytes]], **kwargs: Any) -> JSON: } ], "ingress": { + "custom_error_page_url": "str", # Optional. + Optional HTTPS URL of a custom error page to display when the app + is unreachable. The page is shown in a full-viewport iframe. The + target must allow framing: avoid ``X-Frame-Options: DENY`` and a + restrictive ``Content-Security-Policy`` ``frame-ancestors`` that + blocks the platform. If omitted, the default platform error page + is used. "rules": [ { "component": { @@ -51431,6 +51637,13 @@ def create(self, body: Union[JSON, IO[bytes]], **kwargs: Any) -> JSON: } ], "ingress": { + "custom_error_page_url": "str", # Optional. + Optional HTTPS URL of a custom error page to display when the app + is unreachable. The page is shown in a full-viewport iframe. The + target must allow framing: avoid ``X-Frame-Options: DENY`` and a + restrictive ``Content-Security-Policy`` ``frame-ancestors`` that + blocks the platform. If omitted, the default platform error page + is used. "rules": [ { "component": { @@ -53101,6 +53314,12 @@ def get(self, id: str, *, name: Optional[str] = None, **kwargs: Any) -> JSON: } ], "ingress": { + "custom_error_page_url": "str", # Optional. Optional + HTTPS URL of a custom error page to display when the app is + unreachable. The page is shown in a full-viewport iframe. The target + must allow framing: avoid ``X-Frame-Options: DENY`` and a restrictive + ``Content-Security-Policy`` ``frame-ancestors`` that blocks the + platform. If omitted, the default platform error page is used. "rules": [ { "component": { @@ -54566,6 +54785,13 @@ def get(self, id: str, *, name: Optional[str] = None, **kwargs: Any) -> JSON: } ], "ingress": { + "custom_error_page_url": "str", # Optional. + Optional HTTPS URL of a custom error page to display when the app + is unreachable. The page is shown in a full-viewport iframe. The + target must allow framing: avoid ``X-Frame-Options: DENY`` and a + restrictive ``Content-Security-Policy`` ``frame-ancestors`` that + blocks the platform. If omitted, the default platform error page + is used. "rules": [ { "component": { @@ -56187,6 +56413,13 @@ def get(self, id: str, *, name: Optional[str] = None, **kwargs: Any) -> JSON: } ], "ingress": { + "custom_error_page_url": "str", # Optional. + Optional HTTPS URL of a custom error page to display when the app + is unreachable. The page is shown in a full-viewport iframe. The + target must allow framing: avoid ``X-Frame-Options: DENY`` and a + restrictive ``Content-Security-Policy`` ``frame-ancestors`` that + blocks the platform. If omitted, the default platform error page + is used. "rules": [ { "component": { @@ -57747,6 +57980,13 @@ def get(self, id: str, *, name: Optional[str] = None, **kwargs: Any) -> JSON: } ], "ingress": { + "custom_error_page_url": "str", # Optional. + Optional HTTPS URL of a custom error page to display when the app + is unreachable. The page is shown in a full-viewport iframe. The + target must allow framing: avoid ``X-Frame-Options: DENY`` and a + restrictive ``Content-Security-Policy`` ``frame-ancestors`` that + blocks the platform. If omitted, the default platform error page + is used. "rules": [ { "component": { @@ -59299,6 +59539,13 @@ def get(self, id: str, *, name: Optional[str] = None, **kwargs: Any) -> JSON: } ], "ingress": { + "custom_error_page_url": "str", # Optional. + Optional HTTPS URL of a custom error page to display when the app + is unreachable. The page is shown in a full-viewport iframe. The + target must allow framing: avoid ``X-Frame-Options: DENY`` and a + restrictive ``Content-Security-Policy`` ``frame-ancestors`` that + blocks the platform. If omitted, the default platform error page + is used. "rules": [ { "component": { @@ -60871,6 +61118,12 @@ def update( } ], "ingress": { + "custom_error_page_url": "str", # Optional. Optional HTTPS + URL of a custom error page to display when the app is unreachable. The + page is shown in a full-viewport iframe. The target must allow framing: + avoid ``X-Frame-Options: DENY`` and a restrictive + ``Content-Security-Policy`` ``frame-ancestors`` that blocks the platform. + If omitted, the default platform error page is used. "rules": [ { "component": { @@ -62167,6 +62420,12 @@ def update( } ], "ingress": { + "custom_error_page_url": "str", # Optional. Optional + HTTPS URL of a custom error page to display when the app is + unreachable. The page is shown in a full-viewport iframe. The target + must allow framing: avoid ``X-Frame-Options: DENY`` and a restrictive + ``Content-Security-Policy`` ``frame-ancestors`` that blocks the + platform. If omitted, the default platform error page is used. "rules": [ { "component": { @@ -63632,6 +63891,13 @@ def update( } ], "ingress": { + "custom_error_page_url": "str", # Optional. + Optional HTTPS URL of a custom error page to display when the app + is unreachable. The page is shown in a full-viewport iframe. The + target must allow framing: avoid ``X-Frame-Options: DENY`` and a + restrictive ``Content-Security-Policy`` ``frame-ancestors`` that + blocks the platform. If omitted, the default platform error page + is used. "rules": [ { "component": { @@ -65253,6 +65519,13 @@ def update( } ], "ingress": { + "custom_error_page_url": "str", # Optional. + Optional HTTPS URL of a custom error page to display when the app + is unreachable. The page is shown in a full-viewport iframe. The + target must allow framing: avoid ``X-Frame-Options: DENY`` and a + restrictive ``Content-Security-Policy`` ``frame-ancestors`` that + blocks the platform. If omitted, the default platform error page + is used. "rules": [ { "component": { @@ -66813,6 +67086,13 @@ def update( } ], "ingress": { + "custom_error_page_url": "str", # Optional. + Optional HTTPS URL of a custom error page to display when the app + is unreachable. The page is shown in a full-viewport iframe. The + target must allow framing: avoid ``X-Frame-Options: DENY`` and a + restrictive ``Content-Security-Policy`` ``frame-ancestors`` that + blocks the platform. If omitted, the default platform error page + is used. "rules": [ { "component": { @@ -68365,6 +68645,13 @@ def update( } ], "ingress": { + "custom_error_page_url": "str", # Optional. + Optional HTTPS URL of a custom error page to display when the app + is unreachable. The page is shown in a full-viewport iframe. The + target must allow framing: avoid ``X-Frame-Options: DENY`` and a + restrictive ``Content-Security-Policy`` ``frame-ancestors`` that + blocks the platform. If omitted, the default platform error page + is used. "rules": [ { "component": { @@ -69871,6 +70158,12 @@ def update( } ], "ingress": { + "custom_error_page_url": "str", # Optional. Optional + HTTPS URL of a custom error page to display when the app is + unreachable. The page is shown in a full-viewport iframe. The target + must allow framing: avoid ``X-Frame-Options: DENY`` and a restrictive + ``Content-Security-Policy`` ``frame-ancestors`` that blocks the + platform. If omitted, the default platform error page is used. "rules": [ { "component": { @@ -71336,6 +71629,13 @@ def update( } ], "ingress": { + "custom_error_page_url": "str", # Optional. + Optional HTTPS URL of a custom error page to display when the app + is unreachable. The page is shown in a full-viewport iframe. The + target must allow framing: avoid ``X-Frame-Options: DENY`` and a + restrictive ``Content-Security-Policy`` ``frame-ancestors`` that + blocks the platform. If omitted, the default platform error page + is used. "rules": [ { "component": { @@ -72957,6 +73257,13 @@ def update( } ], "ingress": { + "custom_error_page_url": "str", # Optional. + Optional HTTPS URL of a custom error page to display when the app + is unreachable. The page is shown in a full-viewport iframe. The + target must allow framing: avoid ``X-Frame-Options: DENY`` and a + restrictive ``Content-Security-Policy`` ``frame-ancestors`` that + blocks the platform. If omitted, the default platform error page + is used. "rules": [ { "component": { @@ -74517,6 +74824,13 @@ def update( } ], "ingress": { + "custom_error_page_url": "str", # Optional. + Optional HTTPS URL of a custom error page to display when the app + is unreachable. The page is shown in a full-viewport iframe. The + target must allow framing: avoid ``X-Frame-Options: DENY`` and a + restrictive ``Content-Security-Policy`` ``frame-ancestors`` that + blocks the platform. If omitted, the default platform error page + is used. "rules": [ { "component": { @@ -76069,6 +76383,13 @@ def update( } ], "ingress": { + "custom_error_page_url": "str", # Optional. + Optional HTTPS URL of a custom error page to display when the app + is unreachable. The page is shown in a full-viewport iframe. The + target must allow framing: avoid ``X-Frame-Options: DENY`` and a + restrictive ``Content-Security-Policy`` ``frame-ancestors`` that + blocks the platform. If omitted, the default platform error page + is used. "rules": [ { "component": { @@ -77553,6 +77874,12 @@ def update(self, id: str, body: Union[JSON, IO[bytes]], **kwargs: Any) -> JSON: } ], "ingress": { + "custom_error_page_url": "str", # Optional. Optional HTTPS + URL of a custom error page to display when the app is unreachable. The + page is shown in a full-viewport iframe. The target must allow framing: + avoid ``X-Frame-Options: DENY`` and a restrictive + ``Content-Security-Policy`` ``frame-ancestors`` that blocks the platform. + If omitted, the default platform error page is used. "rules": [ { "component": { @@ -78849,6 +79176,12 @@ def update(self, id: str, body: Union[JSON, IO[bytes]], **kwargs: Any) -> JSON: } ], "ingress": { + "custom_error_page_url": "str", # Optional. Optional + HTTPS URL of a custom error page to display when the app is + unreachable. The page is shown in a full-viewport iframe. The target + must allow framing: avoid ``X-Frame-Options: DENY`` and a restrictive + ``Content-Security-Policy`` ``frame-ancestors`` that blocks the + platform. If omitted, the default platform error page is used. "rules": [ { "component": { @@ -80314,6 +80647,13 @@ def update(self, id: str, body: Union[JSON, IO[bytes]], **kwargs: Any) -> JSON: } ], "ingress": { + "custom_error_page_url": "str", # Optional. + Optional HTTPS URL of a custom error page to display when the app + is unreachable. The page is shown in a full-viewport iframe. The + target must allow framing: avoid ``X-Frame-Options: DENY`` and a + restrictive ``Content-Security-Policy`` ``frame-ancestors`` that + blocks the platform. If omitted, the default platform error page + is used. "rules": [ { "component": { @@ -81935,6 +82275,13 @@ def update(self, id: str, body: Union[JSON, IO[bytes]], **kwargs: Any) -> JSON: } ], "ingress": { + "custom_error_page_url": "str", # Optional. + Optional HTTPS URL of a custom error page to display when the app + is unreachable. The page is shown in a full-viewport iframe. The + target must allow framing: avoid ``X-Frame-Options: DENY`` and a + restrictive ``Content-Security-Policy`` ``frame-ancestors`` that + blocks the platform. If omitted, the default platform error page + is used. "rules": [ { "component": { @@ -83495,6 +83842,13 @@ def update(self, id: str, body: Union[JSON, IO[bytes]], **kwargs: Any) -> JSON: } ], "ingress": { + "custom_error_page_url": "str", # Optional. + Optional HTTPS URL of a custom error page to display when the app + is unreachable. The page is shown in a full-viewport iframe. The + target must allow framing: avoid ``X-Frame-Options: DENY`` and a + restrictive ``Content-Security-Policy`` ``frame-ancestors`` that + blocks the platform. If omitted, the default platform error page + is used. "rules": [ { "component": { @@ -85047,6 +85401,13 @@ def update(self, id: str, body: Union[JSON, IO[bytes]], **kwargs: Any) -> JSON: } ], "ingress": { + "custom_error_page_url": "str", # Optional. + Optional HTTPS URL of a custom error page to display when the app + is unreachable. The page is shown in a full-viewport iframe. The + target must allow framing: avoid ``X-Frame-Options: DENY`` and a + restrictive ``Content-Security-Policy`` ``frame-ancestors`` that + blocks the platform. If omitted, the default platform error page + is used. "rules": [ { "component": { @@ -86753,6 +87114,12 @@ def restart( } ], "ingress": { + "custom_error_page_url": "str", # Optional. Optional + HTTPS URL of a custom error page to display when the app is + unreachable. The page is shown in a full-viewport iframe. The target + must allow framing: avoid ``X-Frame-Options: DENY`` and a restrictive + ``Content-Security-Policy`` ``frame-ancestors`` that blocks the + platform. If omitted, the default platform error page is used. "rules": [ { "component": { @@ -88260,6 +88627,12 @@ def restart( } ], "ingress": { + "custom_error_page_url": "str", # Optional. Optional + HTTPS URL of a custom error page to display when the app is + unreachable. The page is shown in a full-viewport iframe. The target + must allow framing: avoid ``X-Frame-Options: DENY`` and a restrictive + ``Content-Security-Policy`` ``frame-ancestors`` that blocks the + platform. If omitted, the default platform error page is used. "rules": [ { "component": { @@ -89767,6 +90140,12 @@ def restart( } ], "ingress": { + "custom_error_page_url": "str", # Optional. Optional + HTTPS URL of a custom error page to display when the app is + unreachable. The page is shown in a full-viewport iframe. The target + must allow framing: avoid ``X-Frame-Options: DENY`` and a restrictive + ``Content-Security-Policy`` ``frame-ancestors`` that blocks the + platform. If omitted, the default platform error page is used. "rules": [ { "component": { @@ -91808,6 +92187,13 @@ def list_deployments( } ], "ingress": { + "custom_error_page_url": "str", # Optional. + Optional HTTPS URL of a custom error page to display when the app + is unreachable. The page is shown in a full-viewport iframe. The + target must allow framing: avoid ``X-Frame-Options: DENY`` and a + restrictive ``Content-Security-Policy`` ``frame-ancestors`` that + blocks the platform. If omitted, the default platform error page + is used. "rules": [ { "component": { @@ -93473,6 +93859,12 @@ def create_deployment( } ], "ingress": { + "custom_error_page_url": "str", # Optional. Optional + HTTPS URL of a custom error page to display when the app is + unreachable. The page is shown in a full-viewport iframe. The target + must allow framing: avoid ``X-Frame-Options: DENY`` and a restrictive + ``Content-Security-Policy`` ``frame-ancestors`` that blocks the + platform. If omitted, the default platform error page is used. "rules": [ { "component": { @@ -94981,6 +95373,12 @@ def create_deployment( } ], "ingress": { + "custom_error_page_url": "str", # Optional. Optional + HTTPS URL of a custom error page to display when the app is + unreachable. The page is shown in a full-viewport iframe. The target + must allow framing: avoid ``X-Frame-Options: DENY`` and a restrictive + ``Content-Security-Policy`` ``frame-ancestors`` that blocks the + platform. If omitted, the default platform error page is used. "rules": [ { "component": { @@ -96487,6 +96885,12 @@ def create_deployment( } ], "ingress": { + "custom_error_page_url": "str", # Optional. Optional + HTTPS URL of a custom error page to display when the app is + unreachable. The page is shown in a full-viewport iframe. The target + must allow framing: avoid ``X-Frame-Options: DENY`` and a restrictive + ``Content-Security-Policy`` ``frame-ancestors`` that blocks the + platform. If omitted, the default platform error page is used. "rules": [ { "component": { @@ -98075,6 +98479,12 @@ def get_deployment(self, app_id: str, deployment_id: str, **kwargs: Any) -> JSON } ], "ingress": { + "custom_error_page_url": "str", # Optional. Optional + HTTPS URL of a custom error page to display when the app is + unreachable. The page is shown in a full-viewport iframe. The target + must allow framing: avoid ``X-Frame-Options: DENY`` and a restrictive + ``Content-Security-Policy`` ``frame-ancestors`` that blocks the + platform. If omitted, the default platform error page is used. "rules": [ { "component": { @@ -99650,6 +100060,12 @@ def cancel_deployment(self, app_id: str, deployment_id: str, **kwargs: Any) -> J } ], "ingress": { + "custom_error_page_url": "str", # Optional. Optional + HTTPS URL of a custom error page to display when the app is + unreachable. The page is shown in a full-viewport iframe. The target + must allow framing: avoid ``X-Frame-Options: DENY`` and a restrictive + ``Content-Security-Policy`` ``frame-ancestors`` that blocks the + platform. If omitted, the default platform error page is used. "rules": [ { "component": { @@ -102530,6 +102946,14 @@ def list_events( } ], "ingress": { + "custom_error_page_url": "str", # + Optional. Optional HTTPS URL of a custom error page to + display when the app is unreachable. The page is shown in a + full-viewport iframe. The target must allow framing: avoid + ``X-Frame-Options: DENY`` and a restrictive + ``Content-Security-Policy`` ``frame-ancestors`` that blocks + the platform. If omitted, the default platform error page is + used. "rules": [ { "component": { @@ -104285,6 +104709,13 @@ def get_event(self, app_id: str, event_id: str, **kwargs: Any) -> JSON: } ], "ingress": { + "custom_error_page_url": "str", # Optional. + Optional HTTPS URL of a custom error page to display when the app + is unreachable. The page is shown in a full-viewport iframe. The + target must allow framing: avoid ``X-Frame-Options: DENY`` and a + restrictive ``Content-Security-Policy`` ``frame-ancestors`` that + blocks the platform. If omitted, the default platform error page + is used. "rules": [ { "component": { @@ -105976,6 +106407,13 @@ def cancel_event(self, app_id: str, event_id: str, **kwargs: Any) -> JSON: } ], "ingress": { + "custom_error_page_url": "str", # Optional. + Optional HTTPS URL of a custom error page to display when the app + is unreachable. The page is shown in a full-viewport iframe. The + target must allow framing: avoid ``X-Frame-Options: DENY`` and a + restrictive ``Content-Security-Policy`` ``frame-ancestors`` that + blocks the platform. If omitted, the default platform error page + is used. "rules": [ { "component": { @@ -108008,6 +108446,12 @@ def validate_app_spec( } ], "ingress": { + "custom_error_page_url": "str", # Optional. Optional HTTPS + URL of a custom error page to display when the app is unreachable. The + page is shown in a full-viewport iframe. The target must allow framing: + avoid ``X-Frame-Options: DENY`` and a restrictive + ``Content-Security-Policy`` ``frame-ancestors`` that blocks the platform. + If omitted, the default platform error page is used. "rules": [ { "component": { @@ -109304,6 +109748,12 @@ def validate_app_spec( } ], "ingress": { + "custom_error_page_url": "str", # Optional. Optional HTTPS + URL of a custom error page to display when the app is unreachable. The + page is shown in a full-viewport iframe. The target must allow framing: + avoid ``X-Frame-Options: DENY`` and a restrictive + ``Content-Security-Policy`` ``frame-ancestors`` that blocks the platform. + If omitted, the default platform error page is used. "rules": [ { "component": { @@ -110622,6 +111072,12 @@ def validate_app_spec( } ], "ingress": { + "custom_error_page_url": "str", # Optional. Optional HTTPS + URL of a custom error page to display when the app is unreachable. The + page is shown in a full-viewport iframe. The target must allow framing: + avoid ``X-Frame-Options: DENY`` and a restrictive + ``Content-Security-Policy`` ``frame-ancestors`` that blocks the platform. + If omitted, the default platform error page is used. "rules": [ { "component": { @@ -111921,6 +112377,12 @@ def validate_app_spec(self, body: Union[JSON, IO[bytes]], **kwargs: Any) -> JSON } ], "ingress": { + "custom_error_page_url": "str", # Optional. Optional HTTPS + URL of a custom error page to display when the app is unreachable. The + page is shown in a full-viewport iframe. The target must allow framing: + avoid ``X-Frame-Options: DENY`` and a restrictive + ``Content-Security-Policy`` ``frame-ancestors`` that blocks the platform. + If omitted, the default platform error page is used. "rules": [ { "component": { @@ -113217,6 +113679,12 @@ def validate_app_spec(self, body: Union[JSON, IO[bytes]], **kwargs: Any) -> JSON } ], "ingress": { + "custom_error_page_url": "str", # Optional. Optional HTTPS + URL of a custom error page to display when the app is unreachable. The + page is shown in a full-viewport iframe. The target must allow framing: + avoid ``X-Frame-Options: DENY`` and a restrictive + ``Content-Security-Policy`` ``frame-ancestors`` that blocks the platform. + If omitted, the default platform error page is used. "rules": [ { "component": { @@ -115336,6 +115804,12 @@ def create_rollback( } ], "ingress": { + "custom_error_page_url": "str", # Optional. Optional + HTTPS URL of a custom error page to display when the app is + unreachable. The page is shown in a full-viewport iframe. The target + must allow framing: avoid ``X-Frame-Options: DENY`` and a restrictive + ``Content-Security-Policy`` ``frame-ancestors`` that blocks the + platform. If omitted, the default platform error page is used. "rules": [ { "component": { @@ -116852,6 +117326,12 @@ def create_rollback( } ], "ingress": { + "custom_error_page_url": "str", # Optional. Optional + HTTPS URL of a custom error page to display when the app is + unreachable. The page is shown in a full-viewport iframe. The target + must allow framing: avoid ``X-Frame-Options: DENY`` and a restrictive + ``Content-Security-Policy`` ``frame-ancestors`` that blocks the + platform. If omitted, the default platform error page is used. "rules": [ { "component": { @@ -118371,6 +118851,12 @@ def create_rollback( } ], "ingress": { + "custom_error_page_url": "str", # Optional. Optional + HTTPS URL of a custom error page to display when the app is + unreachable. The page is shown in a full-viewport iframe. The target + must allow framing: avoid ``X-Frame-Options: DENY`` and a restrictive + ``Content-Security-Policy`` ``frame-ancestors`` that blocks the + platform. If omitted, the default platform error page is used. "rules": [ { "component": { @@ -120485,6 +120971,12 @@ def revert_rollback(self, app_id: str, **kwargs: Any) -> JSON: } ], "ingress": { + "custom_error_page_url": "str", # Optional. Optional + HTTPS URL of a custom error page to display when the app is + unreachable. The page is shown in a full-viewport iframe. The target + must allow framing: avoid ``X-Frame-Options: DENY`` and a restrictive + ``Content-Security-Policy`` ``frame-ancestors`` that blocks the + platform. If omitted, the default platform error page is used. "rules": [ { "component": { @@ -164258,9 +164750,12 @@ def list_clusters( "updated_at": "2020-02-20 00:00:00", # Optional. A time value given in ISO8601 combined date and time format that represents when the Kubernetes cluster was last updated. - "vpc_uuid": "str" # Optional. A string specifying the UUID + "vpc_uuid": "str", # Optional. A string specifying the UUID of the VPC to which the Kubernetes cluster is assigned.:code:`
`:code:`
`Requires ``vpc:read`` scope. + "worker_subnet_uuid": "str" # Optional. The UUID of the VPC + subnet worker nodes are attached to. When unset, the default subnet for + the VPC is used.:code:`
`:code:`
`Requires ``vpc:read`` scope. } ], "links": { @@ -164556,9 +165051,13 @@ def create_cluster( "updated_at": "2020-02-20 00:00:00", # Optional. A time value given in ISO8601 combined date and time format that represents when the Kubernetes cluster was last updated. - "vpc_uuid": "str" # Optional. A string specifying the UUID of the VPC to + "vpc_uuid": "str", # Optional. A string specifying the UUID of the VPC to which the Kubernetes cluster is assigned.:code:`
`:code:`
`Requires ``vpc:read`` scope. + "worker_subnet_uuid": "str" # Optional. The UUID of the VPC subnet to attach + worker nodes to. When omitted on create, the default subnet for the VPC is used. + This value cannot be changed after the cluster is created. ``vpc_uuid`` must + also be set. :code:`
`:code:`
`Requires ``vpc:read`` scope. } # response body for status code(s): 201 @@ -164768,9 +165267,14 @@ def create_cluster( "updated_at": "2020-02-20 00:00:00", # Optional. A time value given in ISO8601 combined date and time format that represents when the Kubernetes cluster was last updated. - "vpc_uuid": "str" # Optional. A string specifying the UUID of the + "vpc_uuid": "str", # Optional. A string specifying the UUID of the VPC to which the Kubernetes cluster is assigned.:code:`
`:code:`
`Requires ``vpc:read`` scope. + "worker_subnet_uuid": "str" # Optional. The UUID of the VPC subnet + to attach worker nodes to. When omitted on create, the default subnet for the + VPC is used. This value cannot be changed after the cluster is created. + ``vpc_uuid`` must also be set. :code:`
`:code:`
`Requires ``vpc:read`` + scope. } } """ @@ -165011,9 +165515,14 @@ def create_cluster( "updated_at": "2020-02-20 00:00:00", # Optional. A time value given in ISO8601 combined date and time format that represents when the Kubernetes cluster was last updated. - "vpc_uuid": "str" # Optional. A string specifying the UUID of the + "vpc_uuid": "str", # Optional. A string specifying the UUID of the VPC to which the Kubernetes cluster is assigned.:code:`
`:code:`
`Requires ``vpc:read`` scope. + "worker_subnet_uuid": "str" # Optional. The UUID of the VPC subnet + to attach worker nodes to. When omitted on create, the default subnet for the + VPC is used. This value cannot be changed after the cluster is created. + ``vpc_uuid`` must also be set. :code:`
`:code:`
`Requires ``vpc:read`` + scope. } } """ @@ -165239,9 +165748,13 @@ def create_cluster(self, body: Union[JSON, IO[bytes]], **kwargs: Any) -> JSON: "updated_at": "2020-02-20 00:00:00", # Optional. A time value given in ISO8601 combined date and time format that represents when the Kubernetes cluster was last updated. - "vpc_uuid": "str" # Optional. A string specifying the UUID of the VPC to + "vpc_uuid": "str", # Optional. A string specifying the UUID of the VPC to which the Kubernetes cluster is assigned.:code:`
`:code:`
`Requires ``vpc:read`` scope. + "worker_subnet_uuid": "str" # Optional. The UUID of the VPC subnet to attach + worker nodes to. When omitted on create, the default subnet for the VPC is used. + This value cannot be changed after the cluster is created. ``vpc_uuid`` must + also be set. :code:`
`:code:`
`Requires ``vpc:read`` scope. } # response body for status code(s): 201 @@ -165451,9 +165964,14 @@ def create_cluster(self, body: Union[JSON, IO[bytes]], **kwargs: Any) -> JSON: "updated_at": "2020-02-20 00:00:00", # Optional. A time value given in ISO8601 combined date and time format that represents when the Kubernetes cluster was last updated. - "vpc_uuid": "str" # Optional. A string specifying the UUID of the + "vpc_uuid": "str", # Optional. A string specifying the UUID of the VPC to which the Kubernetes cluster is assigned.:code:`
`:code:`
`Requires ``vpc:read`` scope. + "worker_subnet_uuid": "str" # Optional. The UUID of the VPC subnet + to attach worker nodes to. When omitted on create, the default subnet for the + VPC is used. This value cannot be changed after the cluster is created. + ``vpc_uuid`` must also be set. :code:`
`:code:`
`Requires ``vpc:read`` + scope. } } """ @@ -165757,9 +166275,12 @@ def get_cluster(self, cluster_id: str, **kwargs: Any) -> JSON: "updated_at": "2020-02-20 00:00:00", # Optional. A time value given in ISO8601 combined date and time format that represents when the Kubernetes cluster was last updated. - "vpc_uuid": "str" # Optional. A string specifying the UUID of the + "vpc_uuid": "str", # Optional. A string specifying the UUID of the VPC to which the Kubernetes cluster is assigned.:code:`
`:code:`
`Requires ``vpc:read`` scope. + "worker_subnet_uuid": "str" # Optional. The UUID of the VPC subnet + worker nodes are attached to. When unset, the default subnet for the VPC is + used.:code:`
`:code:`
`Requires ``vpc:read`` scope. } } # response body for status code(s): 404 @@ -166182,9 +166703,14 @@ def update_cluster( "updated_at": "2020-02-20 00:00:00", # Optional. A time value given in ISO8601 combined date and time format that represents when the Kubernetes cluster was last updated. - "vpc_uuid": "str" # Optional. A string specifying the UUID of the + "vpc_uuid": "str", # Optional. A string specifying the UUID of the VPC to which the Kubernetes cluster is assigned.:code:`
`:code:`
`Requires ``vpc:read`` scope. + "worker_subnet_uuid": "str" # Optional. The UUID of the VPC subnet + to attach worker nodes to. When omitted on create, the default subnet for the + VPC is used. This value cannot be changed after the cluster is created. + ``vpc_uuid`` must also be set. :code:`
`:code:`
`Requires ``vpc:read`` + scope. } } # response body for status code(s): 404 @@ -166437,9 +166963,14 @@ def update_cluster( "updated_at": "2020-02-20 00:00:00", # Optional. A time value given in ISO8601 combined date and time format that represents when the Kubernetes cluster was last updated. - "vpc_uuid": "str" # Optional. A string specifying the UUID of the + "vpc_uuid": "str", # Optional. A string specifying the UUID of the VPC to which the Kubernetes cluster is assigned.:code:`
`:code:`
`Requires ``vpc:read`` scope. + "worker_subnet_uuid": "str" # Optional. The UUID of the VPC subnet + to attach worker nodes to. When omitted on create, the default subnet for the + VPC is used. This value cannot be changed after the cluster is created. + ``vpc_uuid`` must also be set. :code:`
`:code:`
`Requires ``vpc:read`` + scope. } } # response body for status code(s): 404 @@ -166777,9 +167308,14 @@ def update_cluster( "updated_at": "2020-02-20 00:00:00", # Optional. A time value given in ISO8601 combined date and time format that represents when the Kubernetes cluster was last updated. - "vpc_uuid": "str" # Optional. A string specifying the UUID of the + "vpc_uuid": "str", # Optional. A string specifying the UUID of the VPC to which the Kubernetes cluster is assigned.:code:`
`:code:`
`Requires ``vpc:read`` scope. + "worker_subnet_uuid": "str" # Optional. The UUID of the VPC subnet + to attach worker nodes to. When omitted on create, the default subnet for the + VPC is used. This value cannot be changed after the cluster is created. + ``vpc_uuid`` must also be set. :code:`
`:code:`
`Requires ``vpc:read`` + scope. } } # response body for status code(s): 404 @@ -265245,6 +265781,365 @@ def list_model_evaluation_metrics(self, **kwargs: Any) -> JSON: return cast(JSON, deserialized) # type: ignore + @distributed_trace + def list_model_evaluation_presets(self, **kwargs: Any) -> JSON: + # pylint: disable=line-too-long + """List Model Evaluation Presets. + + To list all saved model evaluation presets, send a GET request to + ``/v2/genai/model_evaluation_presets``. + + :return: JSON object + :rtype: JSON + :raises ~azure.core.exceptions.HttpResponseError: + + Example: + .. code-block:: python + + # response body for status code(s): 200 + response == { + "presets": [ + { + "created_at": "2020-02-20 00:00:00", # Optional. Timestamp + when the preset was created. + "dataset_name": "str", # Optional. List of explicitly saved + evaluation presets (reusable configs). + "dataset_uuid": "str", # Optional. Dataset used for + evaluation. + "eval_preset_uuid": "str", # Optional. UUID of the + evaluation preset. + "judge_model_name": "str", # Optional. List of explicitly + saved evaluation presets (reusable configs). + "judge_model_uuid": "str", # Optional. Judge model used to + score responses. + "metrics": [ + { + "category": "METRIC_CATEGORY_UNSPECIFIED", # + Optional. Default value is "METRIC_CATEGORY_UNSPECIFIED". Known + values are: "METRIC_CATEGORY_UNSPECIFIED", + "METRIC_CATEGORY_CORRECTNESS", "METRIC_CATEGORY_USER_OUTCOMES", + "METRIC_CATEGORY_SAFETY_AND_SECURITY", + "METRIC_CATEGORY_CONTEXT_QUALITY", and + "METRIC_CATEGORY_MODEL_FIT". + "description": "str", # Optional. Metrics + selected for this preset. + "evaluation_scope": + "EVALUATION_SCOPE_UNSPECIFIED", # Optional. Default value is + "EVALUATION_SCOPE_UNSPECIFIED". Scope that determines whether a + metric belongs to agent evaluation or model evaluation. For + backwards compatibility, UNSPECIFIED defaults to agent metrics + only in list operations. Known values are: + "EVALUATION_SCOPE_UNSPECIFIED", "EVALUATION_SCOPE_AGENT", and + "EVALUATION_SCOPE_MODEL". + "inverted": bool, # Optional. If true, the + metric is inverted, meaning that a lower value is better. + "is_metric_goal": bool, # Optional. Metrics + selected for this preset. + "metric_name": "str", # Optional. Metrics + selected for this preset. + "metric_rank": 0, # Optional. Metrics + selected for this preset. + "metric_type": "METRIC_TYPE_UNSPECIFIED", # + Optional. Default value is "METRIC_TYPE_UNSPECIFIED". Known + values are: "METRIC_TYPE_UNSPECIFIED", + "METRIC_TYPE_GENERAL_QUALITY", "METRIC_TYPE_RAG_AND_TOOL", + "METRIC_TYPE_MODEL_QUALITY", and "METRIC_TYPE_MODEL_SAFETY". + "metric_uuid": "str", # Optional. Metrics + selected for this preset. + "metric_value_type": + "METRIC_VALUE_TYPE_UNSPECIFIED", # Optional. Default value is + "METRIC_VALUE_TYPE_UNSPECIFIED". Known values are: + "METRIC_VALUE_TYPE_UNSPECIFIED", "METRIC_VALUE_TYPE_NUMBER", + "METRIC_VALUE_TYPE_STRING", and "METRIC_VALUE_TYPE_PERCENTAGE". + "range_max": 0.0, # Optional. The maximum + value for the metric. + "range_min": 0.0 # Optional. The minimum + value for the metric. + } + ], + "name": "str", # Optional. Name of the evaluation preset. + "star_metric": { + "metric_uuid": "str", # Optional. List of explicitly + saved evaluation presets (reusable configs). + "name": "str", # Optional. List of explicitly saved + evaluation presets (reusable configs). + "success_threshold": 0.0, # Optional. The success + threshold for the star metric. This is a value that the metric must + reach to be considered successful. + "success_threshold_pct": 0 # Optional. The success + threshold for the star metric. This is a percentage value between 0 + and 100. + } + } + ] + } + # response body for status code(s): 404 + response == { + "id": "str", # A short identifier corresponding to the HTTP status code + returned. For example, the ID for a response returning a 404 status code would + be "not_found.". Required. + "message": "str", # A message providing additional information about the + error, including details to help resolve it when possible. Required. + "request_id": "str" # Optional. Optionally, some endpoints may include a + request ID that should be provided when reporting bugs or opening support + tickets to help identify the issue. + } + """ + error_map: MutableMapping[int, Type[HttpResponseError]] = { + 404: ResourceNotFoundError, + 409: ResourceExistsError, + 304: ResourceNotModifiedError, + 401: cast( + Type[HttpResponseError], + lambda response: ClientAuthenticationError(response=response), + ), + 429: HttpResponseError, + 500: HttpResponseError, + } + error_map.update(kwargs.pop("error_map", {}) or {}) + + _headers = kwargs.pop("headers", {}) or {} + _params = kwargs.pop("params", {}) or {} + + cls: ClsType[JSON] = kwargs.pop("cls", None) + + _request = build_genai_list_model_evaluation_presets_request( + headers=_headers, + params=_params, + ) + _request.url = self._client.format_url(_request.url) + + _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, 404]: + 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) # type: ignore + raise HttpResponseError(response=response) + + response_headers = {} + if response.status_code == 200: + response_headers["ratelimit-limit"] = self._deserialize( + "int", response.headers.get("ratelimit-limit") + ) + response_headers["ratelimit-remaining"] = self._deserialize( + "int", response.headers.get("ratelimit-remaining") + ) + response_headers["ratelimit-reset"] = self._deserialize( + "int", response.headers.get("ratelimit-reset") + ) + + if response.content: + deserialized = response.json() + else: + deserialized = None + + if response.status_code == 404: + response_headers["ratelimit-limit"] = self._deserialize( + "int", response.headers.get("ratelimit-limit") + ) + response_headers["ratelimit-remaining"] = self._deserialize( + "int", response.headers.get("ratelimit-remaining") + ) + response_headers["ratelimit-reset"] = self._deserialize( + "int", response.headers.get("ratelimit-reset") + ) + + if response.content: + deserialized = response.json() + else: + deserialized = None + + if cls: + return cls(pipeline_response, cast(JSON, deserialized), response_headers) # type: ignore + + return cast(JSON, deserialized) # type: ignore + + @distributed_trace + def get_model_evaluation_preset(self, eval_preset_uuid: str, **kwargs: Any) -> JSON: + # pylint: disable=line-too-long + """Retrieve Model Evaluation Preset. + + To retrieve a saved model evaluation preset, send a GET request to + ``/v2/genai/model_evaluation_presets/{eval_preset_uuid}``. + + :param eval_preset_uuid: UUID of the evaluation preset. Required. + :type eval_preset_uuid: str + :return: JSON object + :rtype: JSON + :raises ~azure.core.exceptions.HttpResponseError: + + Example: + .. code-block:: python + + # response body for status code(s): 200 + response == { + "preset": { + "created_at": "2020-02-20 00:00:00", # Optional. Timestamp when the + preset was created. + "dataset_name": "str", # Optional. Model Evaluation Preset - a + saved, reusable configuration for model evaluation runs. + "dataset_uuid": "str", # Optional. Dataset used for evaluation. + "eval_preset_uuid": "str", # Optional. UUID of the evaluation + preset. + "judge_model_name": "str", # Optional. Model Evaluation Preset - a + saved, reusable configuration for model evaluation runs. + "judge_model_uuid": "str", # Optional. Judge model used to score + responses. + "metrics": [ + { + "category": "METRIC_CATEGORY_UNSPECIFIED", # + Optional. Default value is "METRIC_CATEGORY_UNSPECIFIED". Known + values are: "METRIC_CATEGORY_UNSPECIFIED", + "METRIC_CATEGORY_CORRECTNESS", "METRIC_CATEGORY_USER_OUTCOMES", + "METRIC_CATEGORY_SAFETY_AND_SECURITY", + "METRIC_CATEGORY_CONTEXT_QUALITY", and "METRIC_CATEGORY_MODEL_FIT". + "description": "str", # Optional. Metrics selected + for this preset. + "evaluation_scope": "EVALUATION_SCOPE_UNSPECIFIED", + # Optional. Default value is "EVALUATION_SCOPE_UNSPECIFIED". Scope + that determines whether a metric belongs to agent evaluation or model + evaluation. For backwards compatibility, UNSPECIFIED defaults to + agent metrics only in list operations. Known values are: + "EVALUATION_SCOPE_UNSPECIFIED", "EVALUATION_SCOPE_AGENT", and + "EVALUATION_SCOPE_MODEL". + "inverted": bool, # Optional. If true, the metric is + inverted, meaning that a lower value is better. + "is_metric_goal": bool, # Optional. Metrics selected + for this preset. + "metric_name": "str", # Optional. Metrics selected + for this preset. + "metric_rank": 0, # Optional. Metrics selected for + this preset. + "metric_type": "METRIC_TYPE_UNSPECIFIED", # + Optional. Default value is "METRIC_TYPE_UNSPECIFIED". Known values + are: "METRIC_TYPE_UNSPECIFIED", "METRIC_TYPE_GENERAL_QUALITY", + "METRIC_TYPE_RAG_AND_TOOL", "METRIC_TYPE_MODEL_QUALITY", and + "METRIC_TYPE_MODEL_SAFETY". + "metric_uuid": "str", # Optional. Metrics selected + for this preset. + "metric_value_type": "METRIC_VALUE_TYPE_UNSPECIFIED", + # Optional. Default value is "METRIC_VALUE_TYPE_UNSPECIFIED". Known + values are: "METRIC_VALUE_TYPE_UNSPECIFIED", + "METRIC_VALUE_TYPE_NUMBER", "METRIC_VALUE_TYPE_STRING", and + "METRIC_VALUE_TYPE_PERCENTAGE". + "range_max": 0.0, # Optional. The maximum value for + the metric. + "range_min": 0.0 # Optional. The minimum value for + the metric. + } + ], + "name": "str", # Optional. Name of the evaluation preset. + "star_metric": { + "metric_uuid": "str", # Optional. Model Evaluation Preset - + a saved, reusable configuration for model evaluation runs. + "name": "str", # Optional. Model Evaluation Preset - a + saved, reusable configuration for model evaluation runs. + "success_threshold": 0.0, # Optional. The success threshold + for the star metric. This is a value that the metric must reach to be + considered successful. + "success_threshold_pct": 0 # Optional. The success threshold + for the star metric. This is a percentage value between 0 and 100. + } + } + } + # response body for status code(s): 404 + response == { + "id": "str", # A short identifier corresponding to the HTTP status code + returned. For example, the ID for a response returning a 404 status code would + be "not_found.". Required. + "message": "str", # A message providing additional information about the + error, including details to help resolve it when possible. Required. + "request_id": "str" # Optional. Optionally, some endpoints may include a + request ID that should be provided when reporting bugs or opening support + tickets to help identify the issue. + } + """ + error_map: MutableMapping[int, Type[HttpResponseError]] = { + 404: ResourceNotFoundError, + 409: ResourceExistsError, + 304: ResourceNotModifiedError, + 401: cast( + Type[HttpResponseError], + lambda response: ClientAuthenticationError(response=response), + ), + 429: HttpResponseError, + 500: HttpResponseError, + } + error_map.update(kwargs.pop("error_map", {}) or {}) + + _headers = kwargs.pop("headers", {}) or {} + _params = kwargs.pop("params", {}) or {} + + cls: ClsType[JSON] = kwargs.pop("cls", None) + + _request = build_genai_get_model_evaluation_preset_request( + eval_preset_uuid=eval_preset_uuid, + headers=_headers, + params=_params, + ) + _request.url = self._client.format_url(_request.url) + + _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, 404]: + 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) # type: ignore + raise HttpResponseError(response=response) + + response_headers = {} + if response.status_code == 200: + response_headers["ratelimit-limit"] = self._deserialize( + "int", response.headers.get("ratelimit-limit") + ) + response_headers["ratelimit-remaining"] = self._deserialize( + "int", response.headers.get("ratelimit-remaining") + ) + response_headers["ratelimit-reset"] = self._deserialize( + "int", response.headers.get("ratelimit-reset") + ) + + if response.content: + deserialized = response.json() + else: + deserialized = None + + if response.status_code == 404: + response_headers["ratelimit-limit"] = self._deserialize( + "int", response.headers.get("ratelimit-limit") + ) + response_headers["ratelimit-remaining"] = self._deserialize( + "int", response.headers.get("ratelimit-remaining") + ) + response_headers["ratelimit-reset"] = self._deserialize( + "int", response.headers.get("ratelimit-reset") + ) + + if response.content: + deserialized = response.json() + else: + deserialized = None + + if cls: + return cls(pipeline_response, cast(JSON, deserialized), response_headers) # type: ignore + + return cast(JSON, deserialized) # type: ignore + @distributed_trace def list_model_evaluation_runs( self, @@ -266175,6 +267070,130 @@ def get_model_evaluation_run( return cast(JSON, deserialized) # type: ignore + @distributed_trace + def delete_model_evaluation_run(self, eval_run_uuid: str, **kwargs: Any) -> JSON: + # pylint: disable=line-too-long + """Delete Model Evaluation Run. + + To delete a model evaluation run, send a DELETE request to + ``/v2/gen-ai/model_evaluation_runs/{eval_run_uuid}``. The run must be in a terminal status (\\ + ``successful``\\ , ``partially_successful``\\ , ``failed``\\ , or ``cancelled``\\ ). For runs + still in progress, either wait for the run to finish or cancel it, then retry the delete once + the run reaches a terminal status. + + :param eval_run_uuid: UUID of the model evaluation run to delete. The run must be in a terminal + status (\\ ``successful``\\ , ``partially_successful``\\ , ``failed``\\ , or ``cancelled``\\ + ). + For runs still in progress, either wait for the run to finish or cancel + it, then retry the delete. Required. + :type eval_run_uuid: str + :return: JSON object + :rtype: JSON + :raises ~azure.core.exceptions.HttpResponseError: + + Example: + .. code-block:: python + + # response body for status code(s): 200 + response == { + "error": "str", # Optional. Error message if deletion failed. + "status": "DELETE_MODEL_EVALUATION_RUN_STATUS_UNSPECIFIED" # Optional. + Default value is "DELETE_MODEL_EVALUATION_RUN_STATUS_UNSPECIFIED". Status of + delete operation. Known values are: + "DELETE_MODEL_EVALUATION_RUN_STATUS_UNSPECIFIED", + "DELETE_MODEL_EVALUATION_RUN_STATUS_SUCCESS", and + "DELETE_MODEL_EVALUATION_RUN_STATUS_FAIL". + } + # response body for status code(s): 404 + response == { + "id": "str", # A short identifier corresponding to the HTTP status code + returned. For example, the ID for a response returning a 404 status code would + be "not_found.". Required. + "message": "str", # A message providing additional information about the + error, including details to help resolve it when possible. Required. + "request_id": "str" # Optional. Optionally, some endpoints may include a + request ID that should be provided when reporting bugs or opening support + tickets to help identify the issue. + } + """ + error_map: MutableMapping[int, Type[HttpResponseError]] = { + 404: ResourceNotFoundError, + 409: ResourceExistsError, + 304: ResourceNotModifiedError, + 401: cast( + Type[HttpResponseError], + lambda response: ClientAuthenticationError(response=response), + ), + 429: HttpResponseError, + 500: HttpResponseError, + } + error_map.update(kwargs.pop("error_map", {}) or {}) + + _headers = kwargs.pop("headers", {}) or {} + _params = kwargs.pop("params", {}) or {} + + cls: ClsType[JSON] = kwargs.pop("cls", None) + + _request = build_genai_delete_model_evaluation_run_request( + eval_run_uuid=eval_run_uuid, + headers=_headers, + params=_params, + ) + _request.url = self._client.format_url(_request.url) + + _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, 404]: + 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) # type: ignore + raise HttpResponseError(response=response) + + response_headers = {} + if response.status_code == 200: + response_headers["ratelimit-limit"] = self._deserialize( + "int", response.headers.get("ratelimit-limit") + ) + response_headers["ratelimit-remaining"] = self._deserialize( + "int", response.headers.get("ratelimit-remaining") + ) + response_headers["ratelimit-reset"] = self._deserialize( + "int", response.headers.get("ratelimit-reset") + ) + + if response.content: + deserialized = response.json() + else: + deserialized = None + + if response.status_code == 404: + response_headers["ratelimit-limit"] = self._deserialize( + "int", response.headers.get("ratelimit-limit") + ) + response_headers["ratelimit-remaining"] = self._deserialize( + "int", response.headers.get("ratelimit-remaining") + ) + response_headers["ratelimit-reset"] = self._deserialize( + "int", response.headers.get("ratelimit-reset") + ) + + if response.content: + deserialized = response.json() + else: + deserialized = None + + if cls: + return cls(pipeline_response, cast(JSON, deserialized), response_headers) # type: ignore + + return cast(JSON, deserialized) # type: ignore + @distributed_trace def get_model_evaluation_run_results_download_url( # pylint: disable=name-too-long self, eval_run_uuid: str, **kwargs: Any