SageMaker / Client / get_search_suggestions

get_search_suggestions#

SageMaker.Client.get_search_suggestions(**kwargs)#

An auto-complete API for the search functionality in the SageMaker console. It returns suggestions of possible matches for the property name to use in Search queries. Provides suggestions for HyperParameters, Tags, and Metrics.

See also: AWS API Documentation

Request Syntax

response = client.get_search_suggestions(
    Resource='TrainingJob'|'Experiment'|'ExperimentTrial'|'ExperimentTrialComponent'|'Endpoint'|'ModelPackage'|'ModelPackageGroup'|'Pipeline'|'PipelineExecution'|'FeatureGroup'|'Project'|'FeatureMetadata'|'HyperParameterTuningJob'|'ModelCard'|'Model',
    SuggestionQuery={
        'PropertyNameQuery': {
            'PropertyNameHint': 'string'
        }
    }
)
Parameters:

  • Resource (string) –

    [REQUIRED]

    The name of the SageMaker resource to search for.

  • SuggestionQuery (dict) –

    Limits the property names that are included in the response.

    • PropertyNameQuery (dict) –

      Defines a property name hint. Only property names that begin with the specified hint are included in the response.

      • PropertyNameHint (string) – [REQUIRED]

        Text that begins a property’s name.

Return type:

dict

Returns:

Response Syntax

{
    'PropertyNameSuggestions': [
        {
            'PropertyName': 'string'
        },
    ]
}

Response Structure

  • (dict) –

    • PropertyNameSuggestions (list) –

      A list of property names for a Resource that match a SuggestionQuery.

      • (dict) –

        A property name returned from a GetSearchSuggestions call that specifies a value in the PropertyNameQuery field.

        • PropertyName (string) –

          A suggested property name based on what you entered in the search textbox in the SageMaker console.