Oracle Cloud Infrastructure v2.11.0, Sep 19 24

Oracle Cloud Infrastructure v2.11.0 published on Thursday, Sep 19, 2024 by Pulumi

oci.DataScience.getModels

Explore with Pulumi AI

Oracle Cloud Infrastructure v2.11.0 published on Thursday, Sep 19, 2024 by Pulumi

Example Usage

import * as pulumi from "@pulumi/pulumi";
import * as oci from "@pulumi/oci";

const testModels = oci.DataScience.getModels({
    compartmentId: compartmentId,
    createdBy: modelCreatedBy,
    displayName: modelDisplayName,
    id: modelId,
    modelVersionSetName: testModelVersionSet.name,
    projectId: testProject.id,
    state: modelState,
});

import pulumi
import pulumi_oci as oci

test_models = oci.DataScience.get_models(compartment_id=compartment_id,
    created_by=model_created_by,
    display_name=model_display_name,
    id=model_id,
    model_version_set_name=test_model_version_set["name"],
    project_id=test_project["id"],
    state=model_state)

package main

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

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := DataScience.GetModels(ctx, &datascience.GetModelsArgs{
			CompartmentId:       compartmentId,
			CreatedBy:           pulumi.StringRef(modelCreatedBy),
			DisplayName:         pulumi.StringRef(modelDisplayName),
			Id:                  pulumi.StringRef(modelId),
			ModelVersionSetName: testModelVersionSet.Name,
			ProjectId:           pulumi.StringRef(testProject.Id),
			State:               pulumi.StringRef(modelState),
		}, nil)
		if err != nil {
			return err
		}
		return nil
	})
}

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

return await Deployment.RunAsync(() => 
{
    var testModels = Oci.DataScience.GetModels.Invoke(new()
    {
        CompartmentId = compartmentId,
        CreatedBy = modelCreatedBy,
        DisplayName = modelDisplayName,
        Id = modelId,
        ModelVersionSetName = testModelVersionSet.Name,
        ProjectId = testProject.Id,
        State = modelState,
    });

});

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.DataScience.inputs.GetModelsArgs;
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 testModels = DataScienceFunctions.getModels(GetModelsArgs.builder()
            .compartmentId(compartmentId)
            .createdBy(modelCreatedBy)
            .displayName(modelDisplayName)
            .id(modelId)
            .modelVersionSetName(testModelVersionSet.name())
            .projectId(testProject.id())
            .state(modelState)
            .build());

    }
}

variables:
  testModels:
    fn::invoke:
      Function: oci:DataScience:getModels
      Arguments:
        compartmentId: ${compartmentId}
        createdBy: ${modelCreatedBy}
        displayName: ${modelDisplayName}
        id: ${modelId}
        modelVersionSetName: ${testModelVersionSet.name}
        projectId: ${testProject.id}
        state: ${modelState}

Using getModels

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 getModels(args: GetModelsArgs, opts?: InvokeOptions): Promise<GetModelsResult>
function getModelsOutput(args: GetModelsOutputArgs, opts?: InvokeOptions): Output<GetModelsResult>

def get_models(compartment_id: Optional[str] = None,
               created_by: Optional[str] = None,
               display_name: Optional[str] = None,
               filters: Optional[Sequence[_datascience.GetModelsFilter]] = None,
               id: Optional[str] = None,
               model_version_set_name: Optional[str] = None,
               project_id: Optional[str] = None,
               state: Optional[str] = None,
               version_label: Optional[str] = None,
               opts: Optional[InvokeOptions] = None) -> GetModelsResult
def get_models_output(compartment_id: Optional[pulumi.Input[str]] = None,
               created_by: Optional[pulumi.Input[str]] = None,
               display_name: Optional[pulumi.Input[str]] = None,
               filters: Optional[pulumi.Input[Sequence[pulumi.Input[_datascience.GetModelsFilterArgs]]]] = None,
               id: Optional[pulumi.Input[str]] = None,
               model_version_set_name: Optional[pulumi.Input[str]] = None,
               project_id: Optional[pulumi.Input[str]] = None,
               state: Optional[pulumi.Input[str]] = None,
               version_label: Optional[pulumi.Input[str]] = None,
               opts: Optional[InvokeOptions] = None) -> Output[GetModelsResult]

func GetModels(ctx *Context, args *GetModelsArgs, opts ...InvokeOption) (*GetModelsResult, error)
func GetModelsOutput(ctx *Context, args *GetModelsOutputArgs, opts ...InvokeOption) GetModelsResultOutput

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

public static class GetModels 
{
    public static Task<GetModelsResult> InvokeAsync(GetModelsArgs args, InvokeOptions? opts = null)
    public static Output<GetModelsResult> Invoke(GetModelsInvokeArgs args, InvokeOptions? opts = null)
}

public static CompletableFuture<GetModelsResult> getModels(GetModelsArgs args, InvokeOptions options)
// Output-based functions aren't available in Java yet

fn::invoke:
  function: oci:DataScience/getModels:getModels
  arguments:
    # arguments dictionary

The following arguments are supported:

CompartmentId string: Filter results by the OCID of the compartment.
ModelVersionSetName string
VersionLabel string
CreatedBy string: Filter results by the OCID of the user who created the resource.
DisplayName string: Filter results by its user-friendly name.
Filters List<GetModelsFilter>
Id string: Filter results by OCID. Must be an OCID of the correct type for the resource type.
ProjectId string: Filter results by the OCID of the project.
State string: Filter results by the specified lifecycle state. Must be a valid state for the resource type.

CompartmentId string: Filter results by the OCID of the compartment.
ModelVersionSetName string
VersionLabel string
CreatedBy string: Filter results by the OCID of the user who created the resource.
DisplayName string: Filter results by its user-friendly name.
Filters []GetModelsFilter
Id string: Filter results by OCID. Must be an OCID of the correct type for the resource type.
ProjectId string: Filter results by the OCID of the project.
State string: Filter results by the specified lifecycle state. Must be a valid state for the resource type.

compartmentId String: Filter results by the OCID of the compartment.
modelVersionSetName String
versionLabel String
createdBy String: Filter results by the OCID of the user who created the resource.
displayName String: Filter results by its user-friendly name.
filters List<GetModelsFilter>
id String: Filter results by OCID. Must be an OCID of the correct type for the resource type.
projectId String: Filter results by the OCID of the project.
state String: Filter results by the specified lifecycle state. Must be a valid state for the resource type.

compartmentId string: Filter results by the OCID of the compartment.
modelVersionSetName string
versionLabel string
createdBy string: Filter results by the OCID of the user who created the resource.
displayName string: Filter results by its user-friendly name.
filters GetModelsFilter[]
id string: Filter results by OCID. Must be an OCID of the correct type for the resource type.
projectId string: Filter results by the OCID of the project.
state string: Filter results by the specified lifecycle state. Must be a valid state for the resource type.

compartment_id str: Filter results by the OCID of the compartment.
model_version_set_name str
version_label str
created_by str: Filter results by the OCID of the user who created the resource.
display_name str: Filter results by its user-friendly name.
filters Sequence[datascience.GetModelsFilter]
id str: Filter results by OCID. Must be an OCID of the correct type for the resource type.
project_id str: Filter results by the OCID of the project.
state str: Filter results by the specified lifecycle state. Must be a valid state for the resource type.

compartmentId String: Filter results by the OCID of the compartment.
modelVersionSetName String
versionLabel String
createdBy String: Filter results by the OCID of the user who created the resource.
displayName String: Filter results by its user-friendly name.
filters List<Property Map>
id String: Filter results by OCID. Must be an OCID of the correct type for the resource type.
projectId String: Filter results by the OCID of the project.
state String: Filter results by the specified lifecycle state. Must be a valid state for the resource type.

getModels Result

The following output properties are available:

CompartmentId string: The OCID of the model's compartment.
ModelVersionSetName string
Models List<GetModelsModel>: The list of models.
VersionLabel string
CreatedBy string: The OCID of the user who created 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.
Filters List<GetModelsFilter>
Id string: The OCID of the model.
ProjectId string: The OCID of the project associated with the model.
State string: The state of the model.

CompartmentId string: The OCID of the model's compartment.
ModelVersionSetName string
Models []GetModelsModel: The list of models.
VersionLabel string
CreatedBy string: The OCID of the user who created 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.
Filters []GetModelsFilter
Id string: The OCID of the model.
ProjectId string: The OCID of the project associated with the model.
State string: The state of the model.

compartmentId String: The OCID of the model's compartment.
modelVersionSetName String
models List<GetModelsModel>: The list of models.
versionLabel String
createdBy String: The OCID of the user who created 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.
filters List<GetModelsFilter>
id String: The OCID of the model.
projectId String: The OCID of the project associated with the model.
state String: The state of the model.

compartmentId string: The OCID of the model's compartment.
modelVersionSetName string
models GetModelsModel[]: The list of models.
versionLabel string
createdBy string: The OCID of the user who created 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.
filters GetModelsFilter[]
id string: The OCID of the model.
projectId string: The OCID of the project associated with the model.
state string: The state of the model.

compartment_id str: The OCID of the model's compartment.
model_version_set_name str
models Sequence[datascience.GetModelsModel]: The list of models.
version_label str
created_by str: The OCID of the user who created 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.
filters Sequence[datascience.GetModelsFilter]
id str: The OCID of the model.
project_id str: The OCID of the project associated with the model.
state str: The state of the model.

compartmentId String: The OCID of the model's compartment.
modelVersionSetName String
models List<Property Map>: The list of models.
versionLabel String
createdBy String: The OCID of the user who created 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.
filters List<Property Map>
id String: The OCID of the model.
projectId String: The OCID of the project associated with the model.
state String: The state of the model.

Supporting Types

GetModelsFilter

Name string
Values List<string>
Regex bool

Name string
Values []string
Regex bool

name String
values List<String>
regex Boolean

name string
values string[]
regex boolean

name str
values Sequence[str]
regex bool

name String
values List<String>
regex Boolean

GetModelsModel

ArtifactContentDisposition string
ArtifactContentLength string
ArtifactContentMd5 string
ArtifactLastModified string
CompartmentId string: Filter results by the OCID of the compartment.
CreatedBy string: Filter results by the OCID of the user who created the resource.
CustomMetadataLists List<GetModelsModelCustomMetadataList>: An array of custom metadata details for the model.
DefinedMetadataLists List<GetModelsModelDefinedMetadataList>: An array of defined metadata details for the model.
DefinedTags Dictionary<string, string>: 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: Filter results by its user-friendly name.
EmptyModel bool
FreeformTags Dictionary<string, string>: 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: Filter results by OCID. Must be an OCID of the correct type for the resource type.
InputSchema string: Input schema file content in String format
ModelArtifact string
OutputSchema string: Output schema file content in String format
ProjectId string: Filter results by the OCID of the project.
State string: Filter results by the specified lifecycle state. Must be a valid state for the resource type.
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: Filter results by the OCID of the compartment.
CreatedBy string: Filter results by the OCID of the user who created the resource.
CustomMetadataLists []GetModelsModelCustomMetadataList: An array of custom metadata details for the model.
DefinedMetadataLists []GetModelsModelDefinedMetadataList: An array of defined metadata details for the model.
DefinedTags map[string]string: 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: Filter results by its user-friendly name.
EmptyModel bool
FreeformTags map[string]string: 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: Filter results by OCID. Must be an OCID of the correct type for the resource type.
InputSchema string: Input schema file content in String format
ModelArtifact string
OutputSchema string: Output schema file content in String format
ProjectId string: Filter results by the OCID of the project.
State string: Filter results by the specified lifecycle state. Must be a valid state for the resource type.
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: Filter results by the OCID of the compartment.
createdBy String: Filter results by the OCID of the user who created the resource.
customMetadataLists List<GetModelsModelCustomMetadataList>: An array of custom metadata details for the model.
definedMetadataLists List<GetModelsModelDefinedMetadataList>: An array of defined metadata details for the model.
definedTags Map<String,String>: 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: Filter results by its user-friendly name.
emptyModel Boolean
freeformTags Map<String,String>: 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: Filter results by OCID. Must be an OCID of the correct type for the resource type.
inputSchema String: Input schema file content in String format
modelArtifact String
outputSchema String: Output schema file content in String format
projectId String: Filter results by the OCID of the project.
state String: Filter results by the specified lifecycle state. Must be a valid state for the resource type.
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: Filter results by the OCID of the compartment.
createdBy string: Filter results by the OCID of the user who created the resource.
customMetadataLists GetModelsModelCustomMetadataList[]: An array of custom metadata details for the model.
definedMetadataLists GetModelsModelDefinedMetadataList[]: An array of defined metadata details for the model.
definedTags {[key: string]: string}: 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: Filter results by its user-friendly name.
emptyModel boolean
freeformTags {[key: string]: string}: 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: Filter results by OCID. Must be an OCID of the correct type for the resource type.
inputSchema string: Input schema file content in String format
modelArtifact string
outputSchema string: Output schema file content in String format
projectId string: Filter results by the OCID of the project.
state string: Filter results by the specified lifecycle state. Must be a valid state for the resource type.
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: Filter results by the OCID of the compartment.
created_by str: Filter results by the OCID of the user who created the resource.
custom_metadata_lists Sequence[datascience.GetModelsModelCustomMetadataList]: An array of custom metadata details for the model.
defined_metadata_lists Sequence[datascience.GetModelsModelDefinedMetadataList]: An array of defined metadata details for the model.
defined_tags Mapping[str, str]: 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: Filter results by its user-friendly name.
empty_model bool
freeform_tags Mapping[str, str]: 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: Filter results by OCID. Must be an OCID of the correct type for the resource type.
input_schema str: Input schema file content in String format
model_artifact str
output_schema str: Output schema file content in String format
project_id str: Filter results by the OCID of the project.
state str: Filter results by the specified lifecycle state. Must be a valid state for the resource type.
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: Filter results by the OCID of the compartment.
createdBy String: Filter results by the OCID of the user who created the resource.
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<String>: 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: Filter results by its user-friendly name.
emptyModel Boolean
freeformTags Map<String>: 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: Filter results by OCID. Must be an OCID of the correct type for the resource type.
inputSchema String: Input schema file content in String format
modelArtifact String
outputSchema String: Output schema file content in String format
projectId String: Filter results by the OCID of the project.
state String: Filter results by the specified lifecycle state. Must be a valid state for the resource type.
timeCreated String: The date and time the resource was created in the timestamp format defined by RFC3339. Example: 2019-08-25T21:10:29.41Z

GetModelsModelCustomMetadataList

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

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

category String

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

category string

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

category str

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

category String

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

GetModelsModelDefinedMetadataList

Category string

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

Category string

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

category String

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

category string

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

category str

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

category String

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

Package Details

Repository: oci pulumi/pulumi-oci
License: Apache-2.0
Notes: This Pulumi package is based on the oci Terraform Provider.

Oracle Cloud Infrastructure v2.11.0 published on Thursday, Sep 19, 2024 by Pulumi

pulumi/pulumi-oci

oci.DataScience.getModels

On this page

On this page

Example Usage

Using getModels

getModels Result

Supporting Types

GetModelsFilter

GetModelsModel

GetModelsModelCustomMetadataList

GetModelsModelDefinedMetadataList

Package Details

On this page

On this page