Skip to main content

aip_sdk.test_packages

Test-package recommendation SDK helpers.

aip_sdk.test_packages.RecommendationEntry​

aip_sdk.test_packages.RecommendationEntry

Single metric entry inside a test-package recommendation.

aip_sdk.test_packages.RecommendationEntry.metric_id​

aip_sdk.test_packages.RecommendationEntry.metric_id: str = Field(min_length=1, max_length=128)

No docstring is defined in the source.

aip_sdk.test_packages.RecommendationEntry.model_config​

aip_sdk.test_packages.RecommendationEntry.model_config = ConfigDict(extra='allow')

No docstring is defined in the source.

aip_sdk.test_packages.RecommendationEntry.reason​

aip_sdk.test_packages.RecommendationEntry.reason: str = Field(min_length=1)

No docstring is defined in the source.

aip_sdk.test_packages.RecommendationEntry.weight​

aip_sdk.test_packages.RecommendationEntry.weight: float = Field(ge=0)

No docstring is defined in the source.

aip_sdk.test_packages.RecommendationInput​

aip_sdk.test_packages.RecommendationInput = RecommendationEntry | dict[str, Any]

No docstring is defined in the source.

aip_sdk.test_packages.TestPackageRecommendation​

aip_sdk.test_packages.TestPackageRecommendation

Workspace-scoped curated test-package recommendation.

aip_sdk.test_packages.TestPackageRecommendation.created_at​

aip_sdk.test_packages.TestPackageRecommendation.created_at: datetime | None = None

No docstring is defined in the source.

aip_sdk.test_packages.TestPackageRecommendation.id​

aip_sdk.test_packages.TestPackageRecommendation.id: str

No docstring is defined in the source.

aip_sdk.test_packages.TestPackageRecommendation.model_config​

aip_sdk.test_packages.TestPackageRecommendation.model_config = ConfigDict(extra='allow')

No docstring is defined in the source.

aip_sdk.test_packages.TestPackageRecommendation.name​

aip_sdk.test_packages.TestPackageRecommendation.name: str

No docstring is defined in the source.

aip_sdk.test_packages.TestPackageRecommendation.recommendations​

aip_sdk.test_packages.TestPackageRecommendation.recommendations: list[RecommendationEntry]

No docstring is defined in the source.

aip_sdk.test_packages.TestPackageRecommendation.schema_family​

aip_sdk.test_packages.TestPackageRecommendation.schema_family: str

No docstring is defined in the source.

aip_sdk.test_packages.TestPackageRecommendation.updated_at​

aip_sdk.test_packages.TestPackageRecommendation.updated_at: datetime | None = None

No docstring is defined in the source.

aip_sdk.test_packages.TestPackageRecommendation.version​

aip_sdk.test_packages.TestPackageRecommendation.version: str

No docstring is defined in the source.

aip_sdk.test_packages.TestPackageRecommendation.workspace_id​

aip_sdk.test_packages.TestPackageRecommendation.workspace_id: str

No docstring is defined in the source.

aip_sdk.test_packages.create_recommendation​

aip_sdk.test_packages.create_recommendation(*, workspace_id: str, name: str, version: str, schema_family: str, recommendations: Iterable[RecommendationInput], client: APIClient | None = None) -> TestPackageRecommendation

Create a workspace-scoped test-package recommendation.

aip_sdk.test_packages.delete_recommendation​

aip_sdk.test_packages.delete_recommendation(recommendation_id: str, *, client: APIClient | None = None) -> None

Delete a test-package recommendation.

aip_sdk.test_packages.get_recommendation​

aip_sdk.test_packages.get_recommendation(recommendation_id: str, *, client: APIClient | None = None) -> TestPackageRecommendation

Return a single test-package recommendation.

aip_sdk.test_packages.list_recommendations​

aip_sdk.test_packages.list_recommendations(*, schema_family: str | None = None, client: APIClient | None = None) -> list[TestPackageRecommendation]

List tenant-scoped test-package recommendations.

aip_sdk.test_packages.update_recommendation​

aip_sdk.test_packages.update_recommendation(recommendation_id: str, *, name: str, version: str, schema_family: str, recommendations: Iterable[RecommendationInput], client: APIClient | None = None) -> TestPackageRecommendation

Replace a test-package recommendation's editable fields.