1. Packages
  2. Azure Native
  3. API Docs
  4. customerinsights
  5. getPrediction
This is the latest version of Azure Native. Use the Azure Native v1 docs if using the v1 version of this package.
Azure Native v2.34.0 published on Thursday, Mar 28, 2024 by Pulumi

azure-native.customerinsights.getPrediction

Explore with Pulumi AI

azure-native logo
This is the latest version of Azure Native. Use the Azure Native v1 docs if using the v1 version of this package.
Azure Native v2.34.0 published on Thursday, Mar 28, 2024 by Pulumi

    Gets a Prediction in the hub. Azure REST API version: 2017-04-26.

    Using getPrediction

    Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

    function getPrediction(args: GetPredictionArgs, opts?: InvokeOptions): Promise<GetPredictionResult>
    function getPredictionOutput(args: GetPredictionOutputArgs, opts?: InvokeOptions): Output<GetPredictionResult>
    def get_prediction(hub_name: Optional[str] = None,
                       prediction_name: Optional[str] = None,
                       resource_group_name: Optional[str] = None,
                       opts: Optional[InvokeOptions] = None) -> GetPredictionResult
    def get_prediction_output(hub_name: Optional[pulumi.Input[str]] = None,
                       prediction_name: Optional[pulumi.Input[str]] = None,
                       resource_group_name: Optional[pulumi.Input[str]] = None,
                       opts: Optional[InvokeOptions] = None) -> Output[GetPredictionResult]
    func LookupPrediction(ctx *Context, args *LookupPredictionArgs, opts ...InvokeOption) (*LookupPredictionResult, error)
    func LookupPredictionOutput(ctx *Context, args *LookupPredictionOutputArgs, opts ...InvokeOption) LookupPredictionResultOutput

    > Note: This function is named LookupPrediction in the Go SDK.

    public static class GetPrediction 
    {
        public static Task<GetPredictionResult> InvokeAsync(GetPredictionArgs args, InvokeOptions? opts = null)
        public static Output<GetPredictionResult> Invoke(GetPredictionInvokeArgs args, InvokeOptions? opts = null)
    }
    public static CompletableFuture<GetPredictionResult> getPrediction(GetPredictionArgs args, InvokeOptions options)
    // Output-based functions aren't available in Java yet
    
    fn::invoke:
      function: azure-native:customerinsights:getPrediction
      arguments:
        # arguments dictionary

    The following arguments are supported:

    HubName string
    The name of the hub.
    PredictionName string
    The name of the Prediction.
    ResourceGroupName string
    The name of the resource group.
    HubName string
    The name of the hub.
    PredictionName string
    The name of the Prediction.
    ResourceGroupName string
    The name of the resource group.
    hubName String
    The name of the hub.
    predictionName String
    The name of the Prediction.
    resourceGroupName String
    The name of the resource group.
    hubName string
    The name of the hub.
    predictionName string
    The name of the Prediction.
    resourceGroupName string
    The name of the resource group.
    hub_name str
    The name of the hub.
    prediction_name str
    The name of the Prediction.
    resource_group_name str
    The name of the resource group.
    hubName String
    The name of the hub.
    predictionName String
    The name of the Prediction.
    resourceGroupName String
    The name of the resource group.

    getPrediction Result

    The following output properties are available:

    AutoAnalyze bool
    Whether do auto analyze.
    Id string
    Resource ID.
    Mappings Pulumi.AzureNative.CustomerInsights.Outputs.PredictionResponseMappings
    Definition of the link mapping of prediction.
    Name string
    Resource name.
    NegativeOutcomeExpression string
    Negative outcome expression.
    PositiveOutcomeExpression string
    Positive outcome expression.
    PrimaryProfileType string
    Primary profile type.
    ProvisioningState string
    Provisioning state.
    ScopeExpression string
    Scope expression.
    ScoreLabel string
    Score label.
    SystemGeneratedEntities Pulumi.AzureNative.CustomerInsights.Outputs.PredictionResponseSystemGeneratedEntities
    System generated entities.
    TenantId string
    The hub name.
    Type string
    Resource type.
    Description Dictionary<string, string>
    Description of the prediction.
    DisplayName Dictionary<string, string>
    Display name of the prediction.
    Grades List<Pulumi.AzureNative.CustomerInsights.Outputs.PredictionResponseGrades>
    The prediction grades.
    InvolvedInteractionTypes List<string>
    Interaction types involved in the prediction.
    InvolvedKpiTypes List<string>
    KPI types involved in the prediction.
    InvolvedRelationships List<string>
    Relationships involved in the prediction.
    PredictionName string
    Name of the prediction.
    AutoAnalyze bool
    Whether do auto analyze.
    Id string
    Resource ID.
    Mappings PredictionResponseMappings
    Definition of the link mapping of prediction.
    Name string
    Resource name.
    NegativeOutcomeExpression string
    Negative outcome expression.
    PositiveOutcomeExpression string
    Positive outcome expression.
    PrimaryProfileType string
    Primary profile type.
    ProvisioningState string
    Provisioning state.
    ScopeExpression string
    Scope expression.
    ScoreLabel string
    Score label.
    SystemGeneratedEntities PredictionResponseSystemGeneratedEntities
    System generated entities.
    TenantId string
    The hub name.
    Type string
    Resource type.
    Description map[string]string
    Description of the prediction.
    DisplayName map[string]string
    Display name of the prediction.
    Grades []PredictionResponseGrades
    The prediction grades.
    InvolvedInteractionTypes []string
    Interaction types involved in the prediction.
    InvolvedKpiTypes []string
    KPI types involved in the prediction.
    InvolvedRelationships []string
    Relationships involved in the prediction.
    PredictionName string
    Name of the prediction.
    autoAnalyze Boolean
    Whether do auto analyze.
    id String
    Resource ID.
    mappings PredictionResponseMappings
    Definition of the link mapping of prediction.
    name String
    Resource name.
    negativeOutcomeExpression String
    Negative outcome expression.
    positiveOutcomeExpression String
    Positive outcome expression.
    primaryProfileType String
    Primary profile type.
    provisioningState String
    Provisioning state.
    scopeExpression String
    Scope expression.
    scoreLabel String
    Score label.
    systemGeneratedEntities PredictionResponseSystemGeneratedEntities
    System generated entities.
    tenantId String
    The hub name.
    type String
    Resource type.
    description Map<String,String>
    Description of the prediction.
    displayName Map<String,String>
    Display name of the prediction.
    grades List<PredictionResponseGrades>
    The prediction grades.
    involvedInteractionTypes List<String>
    Interaction types involved in the prediction.
    involvedKpiTypes List<String>
    KPI types involved in the prediction.
    involvedRelationships List<String>
    Relationships involved in the prediction.
    predictionName String
    Name of the prediction.
    autoAnalyze boolean
    Whether do auto analyze.
    id string
    Resource ID.
    mappings PredictionResponseMappings
    Definition of the link mapping of prediction.
    name string
    Resource name.
    negativeOutcomeExpression string
    Negative outcome expression.
    positiveOutcomeExpression string
    Positive outcome expression.
    primaryProfileType string
    Primary profile type.
    provisioningState string
    Provisioning state.
    scopeExpression string
    Scope expression.
    scoreLabel string
    Score label.
    systemGeneratedEntities PredictionResponseSystemGeneratedEntities
    System generated entities.
    tenantId string
    The hub name.
    type string
    Resource type.
    description {[key: string]: string}
    Description of the prediction.
    displayName {[key: string]: string}
    Display name of the prediction.
    grades PredictionResponseGrades[]
    The prediction grades.
    involvedInteractionTypes string[]
    Interaction types involved in the prediction.
    involvedKpiTypes string[]
    KPI types involved in the prediction.
    involvedRelationships string[]
    Relationships involved in the prediction.
    predictionName string
    Name of the prediction.
    auto_analyze bool
    Whether do auto analyze.
    id str
    Resource ID.
    mappings PredictionResponseMappings
    Definition of the link mapping of prediction.
    name str
    Resource name.
    negative_outcome_expression str
    Negative outcome expression.
    positive_outcome_expression str
    Positive outcome expression.
    primary_profile_type str
    Primary profile type.
    provisioning_state str
    Provisioning state.
    scope_expression str
    Scope expression.
    score_label str
    Score label.
    system_generated_entities PredictionResponseSystemGeneratedEntities
    System generated entities.
    tenant_id str
    The hub name.
    type str
    Resource type.
    description Mapping[str, str]
    Description of the prediction.
    display_name Mapping[str, str]
    Display name of the prediction.
    grades Sequence[PredictionResponseGrades]
    The prediction grades.
    involved_interaction_types Sequence[str]
    Interaction types involved in the prediction.
    involved_kpi_types Sequence[str]
    KPI types involved in the prediction.
    involved_relationships Sequence[str]
    Relationships involved in the prediction.
    prediction_name str
    Name of the prediction.
    autoAnalyze Boolean
    Whether do auto analyze.
    id String
    Resource ID.
    mappings Property Map
    Definition of the link mapping of prediction.
    name String
    Resource name.
    negativeOutcomeExpression String
    Negative outcome expression.
    positiveOutcomeExpression String
    Positive outcome expression.
    primaryProfileType String
    Primary profile type.
    provisioningState String
    Provisioning state.
    scopeExpression String
    Scope expression.
    scoreLabel String
    Score label.
    systemGeneratedEntities Property Map
    System generated entities.
    tenantId String
    The hub name.
    type String
    Resource type.
    description Map<String>
    Description of the prediction.
    displayName Map<String>
    Display name of the prediction.
    grades List<Property Map>
    The prediction grades.
    involvedInteractionTypes List<String>
    Interaction types involved in the prediction.
    involvedKpiTypes List<String>
    KPI types involved in the prediction.
    involvedRelationships List<String>
    Relationships involved in the prediction.
    predictionName String
    Name of the prediction.

    Supporting Types

    PredictionResponseGrades

    GradeName string
    Name of the grade.
    MaxScoreThreshold int
    Maximum score threshold.
    MinScoreThreshold int
    Minimum score threshold.
    GradeName string
    Name of the grade.
    MaxScoreThreshold int
    Maximum score threshold.
    MinScoreThreshold int
    Minimum score threshold.
    gradeName String
    Name of the grade.
    maxScoreThreshold Integer
    Maximum score threshold.
    minScoreThreshold Integer
    Minimum score threshold.
    gradeName string
    Name of the grade.
    maxScoreThreshold number
    Maximum score threshold.
    minScoreThreshold number
    Minimum score threshold.
    grade_name str
    Name of the grade.
    max_score_threshold int
    Maximum score threshold.
    min_score_threshold int
    Minimum score threshold.
    gradeName String
    Name of the grade.
    maxScoreThreshold Number
    Maximum score threshold.
    minScoreThreshold Number
    Minimum score threshold.

    PredictionResponseMappings

    Grade string
    The grade of the link mapping.
    Reason string
    The reason of the link mapping.
    Score string
    The score of the link mapping.
    Grade string
    The grade of the link mapping.
    Reason string
    The reason of the link mapping.
    Score string
    The score of the link mapping.
    grade String
    The grade of the link mapping.
    reason String
    The reason of the link mapping.
    score String
    The score of the link mapping.
    grade string
    The grade of the link mapping.
    reason string
    The reason of the link mapping.
    score string
    The score of the link mapping.
    grade str
    The grade of the link mapping.
    reason str
    The reason of the link mapping.
    score str
    The score of the link mapping.
    grade String
    The grade of the link mapping.
    reason String
    The reason of the link mapping.
    score String
    The score of the link mapping.

    PredictionResponseSystemGeneratedEntities

    GeneratedInteractionTypes List<string>
    Generated interaction types.
    GeneratedKpis Dictionary<string, string>
    Generated KPIs.
    GeneratedLinks List<string>
    Generated links.
    GeneratedInteractionTypes []string
    Generated interaction types.
    GeneratedKpis map[string]string
    Generated KPIs.
    GeneratedLinks []string
    Generated links.
    generatedInteractionTypes List<String>
    Generated interaction types.
    generatedKpis Map<String,String>
    Generated KPIs.
    generatedLinks List<String>
    Generated links.
    generatedInteractionTypes string[]
    Generated interaction types.
    generatedKpis {[key: string]: string}
    Generated KPIs.
    generatedLinks string[]
    Generated links.
    generated_interaction_types Sequence[str]
    Generated interaction types.
    generated_kpis Mapping[str, str]
    Generated KPIs.
    generated_links Sequence[str]
    Generated links.
    generatedInteractionTypes List<String>
    Generated interaction types.
    generatedKpis Map<String>
    Generated KPIs.
    generatedLinks List<String>
    Generated links.

    Package Details

    Repository
    Azure Native pulumi/pulumi-azure-native
    License
    Apache-2.0
    azure-native logo
    This is the latest version of Azure Native. Use the Azure Native v1 docs if using the v1 version of this package.
    Azure Native v2.34.0 published on Thursday, Mar 28, 2024 by Pulumi