Skip to main content

aip_sdk.suggestions

Dataset quality-check suggestion SDK helpers.

aip_sdk.suggestions.CheckSuggestionResponse​

aip_sdk.suggestions.CheckSuggestionResponse

Quality-check suggestion response for a dataset.

aip_sdk.suggestions.CheckSuggestionResponse.model_config​

aip_sdk.suggestions.CheckSuggestionResponse.model_config = ConfigDict(extra='allow')

No docstring is defined in the source.

aip_sdk.suggestions.CheckSuggestionResponse.source_family​

aip_sdk.suggestions.CheckSuggestionResponse.source_family: str | None = None

No docstring is defined in the source.

aip_sdk.suggestions.CheckSuggestionResponse.suggestions​

aip_sdk.suggestions.CheckSuggestionResponse.suggestions: list[MetricSuggestion] = []

No docstring is defined in the source.

aip_sdk.suggestions.CheckSuggestionResponse.warnings​

aip_sdk.suggestions.CheckSuggestionResponse.warnings: list[str] = []

No docstring is defined in the source.

aip_sdk.suggestions.MetricSuggestion​

aip_sdk.suggestions.MetricSuggestion

Single quality-check metric suggestion returned by the API.

aip_sdk.suggestions.MetricSuggestion.metric​

aip_sdk.suggestions.MetricSuggestion.metric: str = Field(min_length=1)

No docstring is defined in the source.

aip_sdk.suggestions.MetricSuggestion.model_config​

aip_sdk.suggestions.MetricSuggestion.model_config = ConfigDict(extra='allow')

No docstring is defined in the source.

aip_sdk.suggestions.MetricSuggestion.rank​

aip_sdk.suggestions.MetricSuggestion.rank: int = Field(ge=1)

No docstring is defined in the source.

aip_sdk.suggestions.MetricSuggestion.reason​

aip_sdk.suggestions.MetricSuggestion.reason: str = Field(min_length=1)

No docstring is defined in the source.

aip_sdk.suggestions.MetricSuggestion.rule_id​

aip_sdk.suggestions.MetricSuggestion.rule_id: str = Field(min_length=1)

No docstring is defined in the source.

aip_sdk.suggestions.check_suggestions​

aip_sdk.suggestions.check_suggestions(dataset_id: str, *, client: APIClient | None = None) -> CheckSuggestionResponse

Return ranked quality-check suggestions for a dataset.

Parameters

  • dataset_id str: Dataset ID to evaluate.
  • client APIClient | None: Optional API client.

Returns