Oracle Cloud Infrastructure v2.4.0, Jul 25 24

Oracle Cloud Infrastructure v2.4.0 published on Thursday, Jul 25, 2024 by Pulumi

oci.GenerativeAi.getModels

Explore with Pulumi AI

Oracle Cloud Infrastructure v2.4.0 published on Thursday, Jul 25, 2024 by Pulumi

Example Usage

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

const testModels = oci.GenerativeAi.getModels({
    compartmentId: compartmentId,
    capabilities: modelCapability,
    displayName: modelDisplayName,
    id: modelId,
    state: modelState,
    vendor: modelVendor,
});

import pulumi
import pulumi_oci as oci

test_models = oci.GenerativeAi.get_models(compartment_id=compartment_id,
    capabilities=model_capability,
    display_name=model_display_name,
    id=model_id,
    state=model_state,
    vendor=model_vendor)

package main

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

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := GenerativeAi.GetModels(ctx, &generativeai.GetModelsArgs{
			CompartmentId: compartmentId,
			Capabilities:  modelCapability,
			DisplayName:   pulumi.StringRef(modelDisplayName),
			Id:            pulumi.StringRef(modelId),
			State:         pulumi.StringRef(modelState),
			Vendor:        pulumi.StringRef(modelVendor),
		}, 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.GenerativeAi.GetModels.Invoke(new()
    {
        CompartmentId = compartmentId,
        Capabilities = modelCapability,
        DisplayName = modelDisplayName,
        Id = modelId,
        State = modelState,
        Vendor = modelVendor,
    });

});

package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.oci.GenerativeAi.GenerativeAiFunctions;
import com.pulumi.oci.GenerativeAi.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 = GenerativeAiFunctions.getModels(GetModelsArgs.builder()
            .compartmentId(compartmentId)
            .capabilities(modelCapability)
            .displayName(modelDisplayName)
            .id(modelId)
            .state(modelState)
            .vendor(modelVendor)
            .build());

    }
}

variables:
  testModels:
    fn::invoke:
      Function: oci:GenerativeAi:getModels
      Arguments:
        compartmentId: ${compartmentId}
        capabilities: ${modelCapability}
        displayName: ${modelDisplayName}
        id: ${modelId}
        state: ${modelState}
        vendor: ${modelVendor}

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(capabilities: Optional[Sequence[str]] = None,
               compartment_id: Optional[str] = None,
               display_name: Optional[str] = None,
               filters: Optional[Sequence[_generativeai.GetModelsFilter]] = None,
               id: Optional[str] = None,
               state: Optional[str] = None,
               vendor: Optional[str] = None,
               opts: Optional[InvokeOptions] = None) -> GetModelsResult
def get_models_output(capabilities: Optional[pulumi.Input[Sequence[pulumi.Input[str]]]] = None,
               compartment_id: Optional[pulumi.Input[str]] = None,
               display_name: Optional[pulumi.Input[str]] = None,
               filters: Optional[pulumi.Input[Sequence[pulumi.Input[_generativeai.GetModelsFilterArgs]]]] = None,
               id: Optional[pulumi.Input[str]] = None,
               state: Optional[pulumi.Input[str]] = None,
               vendor: 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:GenerativeAi/getModels:getModels
  arguments:
    # arguments dictionary

The following arguments are supported:

CompartmentId string: The OCID of the compartment in which to list resources.
Capabilities List<string>: A filter to return only resources their capability matches the given capability.
DisplayName string: A filter to return only resources that match the given display name exactly.
Filters List<GetModelsFilter>
Id string: The ID of the model.
State string: A filter to return only resources their lifecycleState matches the given lifecycleState.
Vendor string: A filter to return only resources that match the entire vendor given.

CompartmentId string: The OCID of the compartment in which to list resources.
Capabilities []string: A filter to return only resources their capability matches the given capability.
DisplayName string: A filter to return only resources that match the given display name exactly.
Filters []GetModelsFilter
Id string: The ID of the model.
State string: A filter to return only resources their lifecycleState matches the given lifecycleState.
Vendor string: A filter to return only resources that match the entire vendor given.

compartmentId String: The OCID of the compartment in which to list resources.
capabilities List<String>: A filter to return only resources their capability matches the given capability.
displayName String: A filter to return only resources that match the given display name exactly.
filters List<GetModelsFilter>
id String: The ID of the model.
state String: A filter to return only resources their lifecycleState matches the given lifecycleState.
vendor String: A filter to return only resources that match the entire vendor given.

compartmentId string: The OCID of the compartment in which to list resources.
capabilities string[]: A filter to return only resources their capability matches the given capability.
displayName string: A filter to return only resources that match the given display name exactly.
filters GetModelsFilter[]
id string: The ID of the model.
state string: A filter to return only resources their lifecycleState matches the given lifecycleState.
vendor string: A filter to return only resources that match the entire vendor given.

compartment_id str: The OCID of the compartment in which to list resources.
capabilities Sequence[str]: A filter to return only resources their capability matches the given capability.
display_name str: A filter to return only resources that match the given display name exactly.
filters Sequence[generativeai.GetModelsFilter]
id str: The ID of the model.
state str: A filter to return only resources their lifecycleState matches the given lifecycleState.
vendor str: A filter to return only resources that match the entire vendor given.

compartmentId String: The OCID of the compartment in which to list resources.
capabilities List<String>: A filter to return only resources their capability matches the given capability.
displayName String: A filter to return only resources that match the given display name exactly.
filters List<Property Map>
id String: The ID of the model.
state String: A filter to return only resources their lifecycleState matches the given lifecycleState.
vendor String: A filter to return only resources that match the entire vendor given.

getModels Result

The following output properties are available:

CompartmentId string: The compartment OCID for fine-tuned models. For pretrained models, this value is null.
ModelCollections List<GetModelsModelCollection>: The list of model_collection.
Capabilities List<string>
DisplayName string
Filters List<GetModelsFilter>
Id string: An ID that uniquely identifies a pretrained or fine-tuned model.
State string: The lifecycle state of the model.
Vendor string

CompartmentId string: The compartment OCID for fine-tuned models. For pretrained models, this value is null.
ModelCollections []GetModelsModelCollection: The list of model_collection.
Capabilities []string
DisplayName string
Filters []GetModelsFilter
Id string: An ID that uniquely identifies a pretrained or fine-tuned model.
State string: The lifecycle state of the model.
Vendor string

compartmentId String: The compartment OCID for fine-tuned models. For pretrained models, this value is null.
modelCollections List<GetModelsModelCollection>: The list of model_collection.
capabilities List<String>
displayName String
filters List<GetModelsFilter>
id String: An ID that uniquely identifies a pretrained or fine-tuned model.
state String: The lifecycle state of the model.
vendor String

compartmentId string: The compartment OCID for fine-tuned models. For pretrained models, this value is null.
modelCollections GetModelsModelCollection[]: The list of model_collection.
capabilities string[]
displayName string
filters GetModelsFilter[]
id string: An ID that uniquely identifies a pretrained or fine-tuned model.
state string: The lifecycle state of the model.
vendor string

compartment_id str: The compartment OCID for fine-tuned models. For pretrained models, this value is null.
model_collections Sequence[generativeai.GetModelsModelCollection]: The list of model_collection.
capabilities Sequence[str]
display_name str
filters Sequence[generativeai.GetModelsFilter]
id str: An ID that uniquely identifies a pretrained or fine-tuned model.
state str: The lifecycle state of the model.
vendor str

compartmentId String: The compartment OCID for fine-tuned models. For pretrained models, this value is null.
modelCollections List<Property Map>: The list of model_collection.
capabilities List<String>
displayName String
filters List<Property Map>
id String: An ID that uniquely identifies a pretrained or fine-tuned model.
state String: The lifecycle state of the model.
vendor String

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

GetModelsModelCollection

Items List<GetModelsModelCollectionItem>

Items []GetModelsModelCollectionItem

items List<GetModelsModelCollectionItem>

items GetModelsModelCollectionItem[]

items Sequence[generativeai.GetModelsModelCollectionItem]

items List<Property Map>

GetModelsModelCollectionItem

BaseModelId string
Capabilities List<string>: Describes what this model can be used for.
CompartmentId string: The OCID of the compartment in which to list resources.
DefinedTags Dictionary<string, object>: Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: {"Operations.CostCenter": "42"}
Description string
DisplayName string: A filter to return only resources that match the given display name exactly.
FineTuneDetails List<GetModelsModelCollectionItemFineTuneDetail>
FreeformTags Dictionary<string, object>
Id string: The ID of the model.
IsLongTermSupported bool
LifecycleDetails string
ModelMetrics List<GetModelsModelCollectionItemModelMetric>
State string: A filter to return only resources their lifecycleState matches the given lifecycleState.
SystemTags Dictionary<string, object>
TimeCreated string
TimeDeprecated string: Corresponds to the time when the custom model and its associated foundation model will be deprecated.
TimeUpdated string
Type string: The model type indicating whether this is a pretrained/base model or a custom/fine-tuned model.
Vendor string: A filter to return only resources that match the entire vendor given.
Version string: The version of the model.

BaseModelId string
Capabilities []string: Describes what this model can be used for.
CompartmentId string: The OCID of the compartment in which to list resources.
DefinedTags map[string]interface{}: Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: {"Operations.CostCenter": "42"}
Description string
DisplayName string: A filter to return only resources that match the given display name exactly.
FineTuneDetails []GetModelsModelCollectionItemFineTuneDetail
FreeformTags map[string]interface{}
Id string: The ID of the model.
IsLongTermSupported bool
LifecycleDetails string
ModelMetrics []GetModelsModelCollectionItemModelMetric
State string: A filter to return only resources their lifecycleState matches the given lifecycleState.
SystemTags map[string]interface{}
TimeCreated string
TimeDeprecated string: Corresponds to the time when the custom model and its associated foundation model will be deprecated.
TimeUpdated string
Type string: The model type indicating whether this is a pretrained/base model or a custom/fine-tuned model.
Vendor string: A filter to return only resources that match the entire vendor given.
Version string: The version of the model.

baseModelId String
capabilities List<String>: Describes what this model can be used for.
compartmentId String: The OCID of the compartment in which to list resources.
definedTags Map<String,Object>: Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: {"Operations.CostCenter": "42"}
description String
displayName String: A filter to return only resources that match the given display name exactly.
fineTuneDetails List<GetModelsModelCollectionItemFineTuneDetail>
freeformTags Map<String,Object>
id String: The ID of the model.
isLongTermSupported Boolean
lifecycleDetails String
modelMetrics List<GetModelsModelCollectionItemModelMetric>
state String: A filter to return only resources their lifecycleState matches the given lifecycleState.
systemTags Map<String,Object>
timeCreated String
timeDeprecated String: Corresponds to the time when the custom model and its associated foundation model will be deprecated.
timeUpdated String
type String: The model type indicating whether this is a pretrained/base model or a custom/fine-tuned model.
vendor String: A filter to return only resources that match the entire vendor given.
version String: The version of the model.

baseModelId string
capabilities string[]: Describes what this model can be used for.
compartmentId string: The OCID of the compartment in which to list resources.
definedTags {[key: string]: any}: Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: {"Operations.CostCenter": "42"}
description string
displayName string: A filter to return only resources that match the given display name exactly.
fineTuneDetails GetModelsModelCollectionItemFineTuneDetail[]
freeformTags {[key: string]: any}
id string: The ID of the model.
isLongTermSupported boolean
lifecycleDetails string
modelMetrics GetModelsModelCollectionItemModelMetric[]
state string: A filter to return only resources their lifecycleState matches the given lifecycleState.
systemTags {[key: string]: any}
timeCreated string
timeDeprecated string: Corresponds to the time when the custom model and its associated foundation model will be deprecated.
timeUpdated string
type string: The model type indicating whether this is a pretrained/base model or a custom/fine-tuned model.
vendor string: A filter to return only resources that match the entire vendor given.
version string: The version of the model.

base_model_id str
capabilities Sequence[str]: Describes what this model can be used for.
compartment_id str: The OCID of the compartment in which to list resources.
defined_tags Mapping[str, Any]: Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: {"Operations.CostCenter": "42"}
description str
display_name str: A filter to return only resources that match the given display name exactly.
fine_tune_details Sequence[generativeai.GetModelsModelCollectionItemFineTuneDetail]
freeform_tags Mapping[str, Any]
id str: The ID of the model.
is_long_term_supported bool
lifecycle_details str
model_metrics Sequence[generativeai.GetModelsModelCollectionItemModelMetric]
state str: A filter to return only resources their lifecycleState matches the given lifecycleState.
system_tags Mapping[str, Any]
time_created str
time_deprecated str: Corresponds to the time when the custom model and its associated foundation model will be deprecated.
time_updated str
type str: The model type indicating whether this is a pretrained/base model or a custom/fine-tuned model.
vendor str: A filter to return only resources that match the entire vendor given.
version str: The version of the model.

baseModelId String
capabilities List<String>: Describes what this model can be used for.
compartmentId String: The OCID of the compartment in which to list resources.
definedTags Map<Any>: Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: {"Operations.CostCenter": "42"}
description String
displayName String: A filter to return only resources that match the given display name exactly.
fineTuneDetails List<Property Map>
freeformTags Map<Any>
id String: The ID of the model.
isLongTermSupported Boolean
lifecycleDetails String
modelMetrics List<Property Map>
state String: A filter to return only resources their lifecycleState matches the given lifecycleState.
systemTags Map<Any>
timeCreated String
timeDeprecated String: Corresponds to the time when the custom model and its associated foundation model will be deprecated.
timeUpdated String
type String: The model type indicating whether this is a pretrained/base model or a custom/fine-tuned model.
vendor String: A filter to return only resources that match the entire vendor given.
version String: The version of the model.

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.4.0 published on Thursday, Jul 25, 2024 by Pulumi

pulumi/pulumi-oci

oci.GenerativeAi.getModels

On this page

On this page

Example Usage

Using getModels

getModels Result

Supporting Types

GetModelsFilter

GetModelsModelCollection

GetModelsModelCollectionItem

GetModelsModelCollectionItemFineTuneDetail

GetModelsModelCollectionItemFineTuneDetailTrainingConfig

GetModelsModelCollectionItemFineTuneDetailTrainingDataset

GetModelsModelCollectionItemModelMetric

Package Details

On this page

On this page