Oracle Cloud Infrastructure

v0.5.0 published on Monday, Sep 12, 2022 by Pulumi

getModel

This data source provides details about a specific Model resource in Oracle Cloud Infrastructure Data Science service.

Gets the specified model’s information.

Example Usage

using System.Collections.Generic;
using Pulumi;
using Oci = Pulumi.Oci;

return await Deployment.RunAsync(() => 
{
    var testModel = Oci.DataScience.GetModel.Invoke(new()
    {
        ModelId = oci_datascience_model.Test_model.Id,
    });

});
package main

import (
	"github.com/pulumi/pulumi-oci/sdk/go/oci/DataScience"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := DataScience.GetModel(ctx, &datascience.GetModelArgs{
			ModelId: oci_datascience_model.Test_model.Id,
		}, nil)
		if err != nil {
			return err
		}
		return nil
	})
}
package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.oci.DataScience.DataScienceFunctions;
import com.pulumi.oci.AiVision.inputs.GetModelArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;

public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }

    public static void stack(Context ctx) {
        final var testModel = DataScienceFunctions.getModel(GetModelArgs.builder()
            .modelId(oci_datascience_model.test_model().id())
            .build());

    }
}
import pulumi
import pulumi_oci as oci

test_model = oci.DataScience.get_model(model_id=oci_datascience_model["test_model"]["id"])
import * as pulumi from "@pulumi/pulumi";
import * as oci from "@pulumi/oci";

const testModel = oci.DataScience.getModel({
    modelId: oci_datascience_model.test_model.id,
});
variables:
  testModel:
    Fn::Invoke:
      Function: oci:DataScience:getModel
      Arguments:
        modelId: ${oci_datascience_model.test_model.id}

Using getModel

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 getModel(args: GetModelArgs, opts?: InvokeOptions): Promise<GetModelResult>
function getModelOutput(args: GetModelOutputArgs, opts?: InvokeOptions): Output<GetModelResult>
def get_model(model_id: Optional[str] = None,
              opts: Optional[InvokeOptions] = None) -> GetModelResult
def get_model_output(model_id: Optional[pulumi.Input[str]] = None,
              opts: Optional[InvokeOptions] = None) -> Output[GetModelResult]
func GetModel(ctx *Context, args *GetModelArgs, opts ...InvokeOption) (*GetModelResult, error)
func GetModelOutput(ctx *Context, args *GetModelOutputArgs, opts ...InvokeOption) GetModelResultOutput

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

public static class GetModel 
{
    public static Task<GetModelResult> InvokeAsync(GetModelArgs args, InvokeOptions? opts = null)
    public static Output<GetModelResult> Invoke(GetModelInvokeArgs args, InvokeOptions? opts = null)
}
public static CompletableFuture<GetModelResult> getModel(GetModelArgs args, InvokeOptions options)
// Output-based functions aren't available in Java yet
Fn::Invoke:
  Function: oci:DataScience/getModel:getModel
  Arguments:
    # Arguments dictionary

The following arguments are supported:

ModelId string

The OCID of the model.

ModelId string

The OCID of the model.

modelId String

The OCID of the model.

modelId string

The OCID of the model.

model_id str

The OCID of the model.

modelId String

The OCID of the model.

getModel Result

The following output properties are available:

ArtifactContentDisposition string
ArtifactContentLength string
ArtifactContentMd5 string
ArtifactLastModified string
CompartmentId string

The OCID of the model's compartment.

CreatedBy string

The OCID of the user who created the model.

CustomMetadataLists List<GetModelCustomMetadataList>

An array of custom metadata details for the model.

DefinedMetadataLists List<GetModelDefinedMetadataList>

An array of defined metadata details for the model.

DefinedTags Dictionary<string, object>

Defined tags for this resource. Each key is predefined and scoped to a namespace. See Resource Tags. Example: {"Operations.CostCenter": "42"}

Description string

A short description of the model.

DisplayName string

A user-friendly display name for the resource. It does not have to be unique and can be modified. Avoid entering confidential information.

EmptyModel bool
FreeformTags Dictionary<string, object>

Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. See Resource Tags. Example: {"Department": "Finance"}

Id string

The OCID of the model.

InputSchema string

Input schema file content in String format

ModelArtifact string
ModelId string
OutputSchema string

Output schema file content in String format

ProjectId string

The OCID of the project associated with the model.

State string

The state of the model.

TimeCreated string

The date and time the resource was created in the timestamp format defined by RFC3339. Example: 2019-08-25T21:10:29.41Z

ArtifactContentDisposition string
ArtifactContentLength string
ArtifactContentMd5 string
ArtifactLastModified string
CompartmentId string

The OCID of the model's compartment.

CreatedBy string

The OCID of the user who created the model.

CustomMetadataLists []GetModelCustomMetadataList

An array of custom metadata details for the model.

DefinedMetadataLists []GetModelDefinedMetadataList

An array of defined metadata details for the model.

DefinedTags map[string]interface{}

Defined tags for this resource. Each key is predefined and scoped to a namespace. See Resource Tags. Example: {"Operations.CostCenter": "42"}

Description string

A short description of the model.

DisplayName string

A user-friendly display name for the resource. It does not have to be unique and can be modified. Avoid entering confidential information.

EmptyModel bool
FreeformTags map[string]interface{}

Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. See Resource Tags. Example: {"Department": "Finance"}

Id string

The OCID of the model.

InputSchema string

Input schema file content in String format

ModelArtifact string
ModelId string
OutputSchema string

Output schema file content in String format

ProjectId string

The OCID of the project associated with the model.

State string

The state of the model.

TimeCreated string

The date and time the resource was created in the timestamp format defined by RFC3339. Example: 2019-08-25T21:10:29.41Z

artifactContentDisposition String
artifactContentLength String
artifactContentMd5 String
artifactLastModified String
compartmentId String

The OCID of the model's compartment.

createdBy String

The OCID of the user who created the model.

customMetadataLists List<GetModelCustomMetadataList>

An array of custom metadata details for the model.

definedMetadataLists List<GetModelDefinedMetadataList>

An array of defined metadata details for the model.

definedTags Map<String,Object>

Defined tags for this resource. Each key is predefined and scoped to a namespace. See Resource Tags. Example: {"Operations.CostCenter": "42"}

description String

A short description of the model.

displayName String

A user-friendly display name for the resource. It does not have to be unique and can be modified. Avoid entering confidential information.

emptyModel Boolean
freeformTags Map<String,Object>

Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. See Resource Tags. Example: {"Department": "Finance"}

id String

The OCID of the model.

inputSchema String

Input schema file content in String format

modelArtifact String
modelId String
outputSchema String

Output schema file content in String format

projectId String

The OCID of the project associated with the model.

state String

The state of the model.

timeCreated String

The date and time the resource was created in the timestamp format defined by RFC3339. Example: 2019-08-25T21:10:29.41Z

artifactContentDisposition string
artifactContentLength string
artifactContentMd5 string
artifactLastModified string
compartmentId string

The OCID of the model's compartment.

createdBy string

The OCID of the user who created the model.

customMetadataLists GetModelCustomMetadataList[]

An array of custom metadata details for the model.

definedMetadataLists GetModelDefinedMetadataList[]

An array of defined metadata details for the model.

definedTags {[key: string]: any}

Defined tags for this resource. Each key is predefined and scoped to a namespace. See Resource Tags. Example: {"Operations.CostCenter": "42"}

description string

A short description of the model.

displayName string

A user-friendly display name for the resource. It does not have to be unique and can be modified. Avoid entering confidential information.

emptyModel boolean
freeformTags {[key: string]: any}

Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. See Resource Tags. Example: {"Department": "Finance"}

id string

The OCID of the model.

inputSchema string

Input schema file content in String format

modelArtifact string
modelId string
outputSchema string

Output schema file content in String format

projectId string

The OCID of the project associated with the model.

state string

The state of the model.

timeCreated string

The date and time the resource was created in the timestamp format defined by RFC3339. Example: 2019-08-25T21:10:29.41Z

artifact_content_disposition str
artifact_content_length str
artifact_content_md5 str
artifact_last_modified str
compartment_id str

The OCID of the model's compartment.

created_by str

The OCID of the user who created the model.

custom_metadata_lists GetModelCustomMetadataList]

An array of custom metadata details for the model.

defined_metadata_lists GetModelDefinedMetadataList]

An array of defined metadata details for the model.

defined_tags Mapping[str, Any]

Defined tags for this resource. Each key is predefined and scoped to a namespace. See Resource Tags. Example: {"Operations.CostCenter": "42"}

description str

A short description of the model.

display_name str

A user-friendly display name for the resource. It does not have to be unique and can be modified. Avoid entering confidential information.

empty_model bool
freeform_tags Mapping[str, Any]

Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. See Resource Tags. Example: {"Department": "Finance"}

id str

The OCID of the model.

input_schema str

Input schema file content in String format

model_artifact str
model_id str
output_schema str

Output schema file content in String format

project_id str

The OCID of the project associated with the model.

state str

The state of the model.

time_created str

The date and time the resource was created in the timestamp format defined by RFC3339. Example: 2019-08-25T21:10:29.41Z

artifactContentDisposition String
artifactContentLength String
artifactContentMd5 String
artifactLastModified String
compartmentId String

The OCID of the model's compartment.

createdBy String

The OCID of the user who created the model.

customMetadataLists List<Property Map>

An array of custom metadata details for the model.

definedMetadataLists List<Property Map>

An array of defined metadata details for the model.

definedTags Map<Any>

Defined tags for this resource. Each key is predefined and scoped to a namespace. See Resource Tags. Example: {"Operations.CostCenter": "42"}

description String

A short description of the model.

displayName String

A user-friendly display name for the resource. It does not have to be unique and can be modified. Avoid entering confidential information.

emptyModel Boolean
freeformTags Map<Any>

Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. See Resource Tags. Example: {"Department": "Finance"}

id String

The OCID of the model.

inputSchema String

Input schema file content in String format

modelArtifact String
modelId String
outputSchema String

Output schema file content in String format

projectId String

The OCID of the project associated with the model.

state String

The state of the model.

timeCreated String

The date and time the resource was created in the timestamp format defined by RFC3339. Example: 2019-08-25T21:10:29.41Z

Supporting Types

GetModelCustomMetadataList

Category string

Category of model metadata which should be null for defined metadata.For custom metadata is should be one of the following values "Performance,Training Profile,Training and Validation Datasets,Training Environment,other".

Description string

A short description of the model.

Key string

Key of the model Metadata. The key can either be user defined or Oracle Cloud Infrastructure defined. List of Oracle Cloud Infrastructure defined keys:

  • useCaseType
  • libraryName
  • libraryVersion
  • estimatorClass
  • hyperParameters
  • testartifactresults
Value string

Allowed values for useCaseType: binary_classification, regression, multinomial_classification, clustering, recommender, dimensionality_reduction/representation, time_series_forecasting, anomaly_detection, topic_modeling, ner, sentiment_analysis, image_classification, object_localization, other

Category string

Category of model metadata which should be null for defined metadata.For custom metadata is should be one of the following values "Performance,Training Profile,Training and Validation Datasets,Training Environment,other".

Description string

A short description of the model.

Key string

Key of the model Metadata. The key can either be user defined or Oracle Cloud Infrastructure defined. List of Oracle Cloud Infrastructure defined keys:

  • useCaseType
  • libraryName
  • libraryVersion
  • estimatorClass
  • hyperParameters
  • testartifactresults
Value string

Allowed values for useCaseType: binary_classification, regression, multinomial_classification, clustering, recommender, dimensionality_reduction/representation, time_series_forecasting, anomaly_detection, topic_modeling, ner, sentiment_analysis, image_classification, object_localization, other

category String

Category of model metadata which should be null for defined metadata.For custom metadata is should be one of the following values "Performance,Training Profile,Training and Validation Datasets,Training Environment,other".

description String

A short description of the model.

key String

Key of the model Metadata. The key can either be user defined or Oracle Cloud Infrastructure defined. List of Oracle Cloud Infrastructure defined keys:

  • useCaseType
  • libraryName
  • libraryVersion
  • estimatorClass
  • hyperParameters
  • testartifactresults
value String

Allowed values for useCaseType: binary_classification, regression, multinomial_classification, clustering, recommender, dimensionality_reduction/representation, time_series_forecasting, anomaly_detection, topic_modeling, ner, sentiment_analysis, image_classification, object_localization, other

category string

Category of model metadata which should be null for defined metadata.For custom metadata is should be one of the following values "Performance,Training Profile,Training and Validation Datasets,Training Environment,other".

description string

A short description of the model.

key string

Key of the model Metadata. The key can either be user defined or Oracle Cloud Infrastructure defined. List of Oracle Cloud Infrastructure defined keys:

  • useCaseType
  • libraryName
  • libraryVersion
  • estimatorClass
  • hyperParameters
  • testartifactresults
value string

Allowed values for useCaseType: binary_classification, regression, multinomial_classification, clustering, recommender, dimensionality_reduction/representation, time_series_forecasting, anomaly_detection, topic_modeling, ner, sentiment_analysis, image_classification, object_localization, other

category str

Category of model metadata which should be null for defined metadata.For custom metadata is should be one of the following values "Performance,Training Profile,Training and Validation Datasets,Training Environment,other".

description str

A short description of the model.

key str

Key of the model Metadata. The key can either be user defined or Oracle Cloud Infrastructure defined. List of Oracle Cloud Infrastructure defined keys:

  • useCaseType
  • libraryName
  • libraryVersion
  • estimatorClass
  • hyperParameters
  • testartifactresults
value str

Allowed values for useCaseType: binary_classification, regression, multinomial_classification, clustering, recommender, dimensionality_reduction/representation, time_series_forecasting, anomaly_detection, topic_modeling, ner, sentiment_analysis, image_classification, object_localization, other

category String

Category of model metadata which should be null for defined metadata.For custom metadata is should be one of the following values "Performance,Training Profile,Training and Validation Datasets,Training Environment,other".

description String

A short description of the model.

key String

Key of the model Metadata. The key can either be user defined or Oracle Cloud Infrastructure defined. List of Oracle Cloud Infrastructure defined keys:

  • useCaseType
  • libraryName
  • libraryVersion
  • estimatorClass
  • hyperParameters
  • testartifactresults
value String

Allowed values for useCaseType: binary_classification, regression, multinomial_classification, clustering, recommender, dimensionality_reduction/representation, time_series_forecasting, anomaly_detection, topic_modeling, ner, sentiment_analysis, image_classification, object_localization, other

GetModelDefinedMetadataList

Category string

Category of model metadata which should be null for defined metadata.For custom metadata is should be one of the following values "Performance,Training Profile,Training and Validation Datasets,Training Environment,other".

Description string

A short description of the model.

Key string

Key of the model Metadata. The key can either be user defined or Oracle Cloud Infrastructure defined. List of Oracle Cloud Infrastructure defined keys:

  • useCaseType
  • libraryName
  • libraryVersion
  • estimatorClass
  • hyperParameters
  • testartifactresults
Value string

Allowed values for useCaseType: binary_classification, regression, multinomial_classification, clustering, recommender, dimensionality_reduction/representation, time_series_forecasting, anomaly_detection, topic_modeling, ner, sentiment_analysis, image_classification, object_localization, other

Category string

Category of model metadata which should be null for defined metadata.For custom metadata is should be one of the following values "Performance,Training Profile,Training and Validation Datasets,Training Environment,other".

Description string

A short description of the model.

Key string

Key of the model Metadata. The key can either be user defined or Oracle Cloud Infrastructure defined. List of Oracle Cloud Infrastructure defined keys:

  • useCaseType
  • libraryName
  • libraryVersion
  • estimatorClass
  • hyperParameters
  • testartifactresults
Value string

Allowed values for useCaseType: binary_classification, regression, multinomial_classification, clustering, recommender, dimensionality_reduction/representation, time_series_forecasting, anomaly_detection, topic_modeling, ner, sentiment_analysis, image_classification, object_localization, other

category String

Category of model metadata which should be null for defined metadata.For custom metadata is should be one of the following values "Performance,Training Profile,Training and Validation Datasets,Training Environment,other".

description String

A short description of the model.

key String

Key of the model Metadata. The key can either be user defined or Oracle Cloud Infrastructure defined. List of Oracle Cloud Infrastructure defined keys:

  • useCaseType
  • libraryName
  • libraryVersion
  • estimatorClass
  • hyperParameters
  • testartifactresults
value String

Allowed values for useCaseType: binary_classification, regression, multinomial_classification, clustering, recommender, dimensionality_reduction/representation, time_series_forecasting, anomaly_detection, topic_modeling, ner, sentiment_analysis, image_classification, object_localization, other

category string

Category of model metadata which should be null for defined metadata.For custom metadata is should be one of the following values "Performance,Training Profile,Training and Validation Datasets,Training Environment,other".

description string

A short description of the model.

key string

Key of the model Metadata. The key can either be user defined or Oracle Cloud Infrastructure defined. List of Oracle Cloud Infrastructure defined keys:

  • useCaseType
  • libraryName
  • libraryVersion
  • estimatorClass
  • hyperParameters
  • testartifactresults
value string

Allowed values for useCaseType: binary_classification, regression, multinomial_classification, clustering, recommender, dimensionality_reduction/representation, time_series_forecasting, anomaly_detection, topic_modeling, ner, sentiment_analysis, image_classification, object_localization, other

category str

Category of model metadata which should be null for defined metadata.For custom metadata is should be one of the following values "Performance,Training Profile,Training and Validation Datasets,Training Environment,other".

description str

A short description of the model.

key str

Key of the model Metadata. The key can either be user defined or Oracle Cloud Infrastructure defined. List of Oracle Cloud Infrastructure defined keys:

  • useCaseType
  • libraryName
  • libraryVersion
  • estimatorClass
  • hyperParameters
  • testartifactresults
value str

Allowed values for useCaseType: binary_classification, regression, multinomial_classification, clustering, recommender, dimensionality_reduction/representation, time_series_forecasting, anomaly_detection, topic_modeling, ner, sentiment_analysis, image_classification, object_localization, other

category String

Category of model metadata which should be null for defined metadata.For custom metadata is should be one of the following values "Performance,Training Profile,Training and Validation Datasets,Training Environment,other".

description String

A short description of the model.

key String

Key of the model Metadata. The key can either be user defined or Oracle Cloud Infrastructure defined. List of Oracle Cloud Infrastructure defined keys:

  • useCaseType
  • libraryName
  • libraryVersion
  • estimatorClass
  • hyperParameters
  • testartifactresults
value String

Allowed values for useCaseType: binary_classification, regression, multinomial_classification, clustering, recommender, dimensionality_reduction/representation, time_series_forecasting, anomaly_detection, topic_modeling, ner, sentiment_analysis, image_classification, object_localization, other

Package Details

Repository
https://github.com/pulumi/pulumi-oci
License
Apache-2.0
Notes

This Pulumi package is based on the oci Terraform Provider.