import * as pulumi from "@pulumi/pulumi"; import * as inputs from "../types/input"; import * as outputs from "../types/output"; /** * This resource provides the Model resource in Oracle Cloud Infrastructure Ai Document service. * Api doc link for the resource: https://docs.oracle.com/iaas/api/#/en/document-understanding/latest/Model * * Example terraform configs related to the resource : https://github.com/oracle/terraform-provider-oci/tree/master/examples/aiDocument * * Create a new model. * * Updates the model metadata only selected path parameter. * * ## Import * * Models can be imported using the `id`, e.g. * * ```sh * $ pulumi import oci:AiDocument/model:Model test_model "id" * ``` */ export declare class Model extends pulumi.CustomResource { /** * Get an existing Model resource's state with the given name, ID, and optional extra * properties used to qualify the lookup. * * @param name The _unique_ name of the resulting resource. * @param id The _unique_ provider ID of the resource to lookup. * @param state Any extra arguments used during the lookup. * @param opts Optional settings to control the behavior of the CustomResource. */ static get(name: string, id: pulumi.Input, state?: ModelState, opts?: pulumi.CustomResourceOptions): Model; /** * Returns true if the given object is an instance of Model. This is designed to work even * when multiple copies of the Pulumi SDK have been loaded into the same process. */ static isInstance(obj: any): obj is Model; /** * (Updatable) The compartment identifier. */ readonly compartmentId: pulumi.Output; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) list of active custom Key Value models that need to be composed. */ readonly componentModels: pulumi.Output; /** * (Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. For example: `{"foo-namespace": {"bar-key": "value"}}` */ readonly definedTags: pulumi.Output<{ [key: string]: string; }>; /** * (Updatable) An optional description of the model. */ readonly description: pulumi.Output; /** * (Updatable) A human-friendly name for the model, which can be changed. */ readonly displayName: pulumi.Output; /** * (Updatable) A simple key-value pair that is applied without any predefined name, type, or scope. It exists for cross-compatibility only. For example: `{"bar-key": "value"}` */ readonly freeformTags: pulumi.Output<{ [key: string]: string; }>; /** * (Updatable) Number of replicas required for this model. */ readonly inferenceUnits: pulumi.Output; /** * Set to true when the model is created by using multiple key value extraction models. */ readonly isComposedModel: pulumi.Output; /** * Set to true when experimenting with a new model type or dataset, so the model training is quick, with a predefined low number of passes through the training data. */ readonly isQuickMode: pulumi.Output; /** * The collection of labels used to train the custom model. */ readonly labels: pulumi.Output; /** * The document language for model training, abbreviated according to the BCP 47 syntax. */ readonly language: pulumi.Output; /** * A message describing the current state in more detail, that can provide actionable information if training failed. */ readonly lifecycleDetails: pulumi.Output; /** * Locks associated with this resource. */ readonly locks: pulumi.Output; /** * The maximum model training time in hours, expressed as a decimal fraction. */ readonly maxTrainingTimeInHours: pulumi.Output; /** * Trained Model Metrics. */ readonly metrics: pulumi.Output; readonly modelId: pulumi.Output; /** * Applicable to only PRE_TRAINED_KEY_VALUE_EXTRACTION, PRE_TRAINED_DOCUMENT_ELEMENTS_EXTRACTION. */ readonly modelSubType: pulumi.Output; /** * The type of the Document model. */ readonly modelType: pulumi.Output; /** * The model version */ readonly modelVersion: pulumi.Output; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the project that contains the model. */ readonly projectId: pulumi.Output; /** * The current state of the model. */ readonly state: pulumi.Output; /** * Usage of system tag keys. These predefined keys are scoped to namespaces. For example: `{"orcl-cloud": {"free-tier-retained": "true"}}` */ readonly systemTags: pulumi.Output<{ [key: string]: string; }>; /** * The tenancy id of the model. */ readonly tenancyId: pulumi.Output; /** * The base entity which is the input for creating and training a model. */ readonly testingDataset: pulumi.Output; /** * When the model was created, as an RFC3339 datetime string. */ readonly timeCreated: pulumi.Output; /** * When the model was updated, as an RFC3339 datetime string. */ readonly timeUpdated: pulumi.Output; /** * The total hours actually used for model training. */ readonly trainedTimeInHours: pulumi.Output; /** * The base entity which is the input for creating and training a model. */ readonly trainingDataset: pulumi.Output; /** * The base entity which is the input for creating and training a model. */ readonly validationDataset: pulumi.Output; /** * Create a Model resource with the given unique name, arguments, and options. * * @param name The _unique_ name of the resource. * @param args The arguments to use to populate this resource's properties. * @param opts A bag of options that control this resource's behavior. */ constructor(name: string, args: ModelArgs, opts?: pulumi.CustomResourceOptions); } /** * Input properties used for looking up and filtering Model resources. */ export interface ModelState { /** * (Updatable) The compartment identifier. */ compartmentId?: pulumi.Input; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) list of active custom Key Value models that need to be composed. */ componentModels?: pulumi.Input[] | undefined>; /** * (Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. For example: `{"foo-namespace": {"bar-key": "value"}}` */ definedTags?: pulumi.Input<{ [key: string]: pulumi.Input; } | undefined>; /** * (Updatable) An optional description of the model. */ description?: pulumi.Input; /** * (Updatable) A human-friendly name for the model, which can be changed. */ displayName?: pulumi.Input; /** * (Updatable) A simple key-value pair that is applied without any predefined name, type, or scope. It exists for cross-compatibility only. For example: `{"bar-key": "value"}` */ freeformTags?: pulumi.Input<{ [key: string]: pulumi.Input; } | undefined>; /** * (Updatable) Number of replicas required for this model. */ inferenceUnits?: pulumi.Input; /** * Set to true when the model is created by using multiple key value extraction models. */ isComposedModel?: pulumi.Input; /** * Set to true when experimenting with a new model type or dataset, so the model training is quick, with a predefined low number of passes through the training data. */ isQuickMode?: pulumi.Input; /** * The collection of labels used to train the custom model. */ labels?: pulumi.Input[] | undefined>; /** * The document language for model training, abbreviated according to the BCP 47 syntax. */ language?: pulumi.Input; /** * A message describing the current state in more detail, that can provide actionable information if training failed. */ lifecycleDetails?: pulumi.Input; /** * Locks associated with this resource. */ locks?: pulumi.Input[] | undefined>; /** * The maximum model training time in hours, expressed as a decimal fraction. */ maxTrainingTimeInHours?: pulumi.Input; /** * Trained Model Metrics. */ metrics?: pulumi.Input[] | undefined>; modelId?: pulumi.Input; /** * Applicable to only PRE_TRAINED_KEY_VALUE_EXTRACTION, PRE_TRAINED_DOCUMENT_ELEMENTS_EXTRACTION. */ modelSubType?: pulumi.Input; /** * The type of the Document model. */ modelType?: pulumi.Input; /** * The model version */ modelVersion?: pulumi.Input; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the project that contains the model. */ projectId?: pulumi.Input; /** * The current state of the model. */ state?: pulumi.Input; /** * Usage of system tag keys. These predefined keys are scoped to namespaces. For example: `{"orcl-cloud": {"free-tier-retained": "true"}}` */ systemTags?: pulumi.Input<{ [key: string]: pulumi.Input; } | undefined>; /** * The tenancy id of the model. */ tenancyId?: pulumi.Input; /** * The base entity which is the input for creating and training a model. */ testingDataset?: pulumi.Input; /** * When the model was created, as an RFC3339 datetime string. */ timeCreated?: pulumi.Input; /** * When the model was updated, as an RFC3339 datetime string. */ timeUpdated?: pulumi.Input; /** * The total hours actually used for model training. */ trainedTimeInHours?: pulumi.Input; /** * The base entity which is the input for creating and training a model. */ trainingDataset?: pulumi.Input; /** * The base entity which is the input for creating and training a model. */ validationDataset?: pulumi.Input; } /** * The set of arguments for constructing a Model resource. */ export interface ModelArgs { /** * (Updatable) The compartment identifier. */ compartmentId: pulumi.Input; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) list of active custom Key Value models that need to be composed. */ componentModels?: pulumi.Input[] | undefined>; /** * (Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. For example: `{"foo-namespace": {"bar-key": "value"}}` */ definedTags?: pulumi.Input<{ [key: string]: pulumi.Input; } | undefined>; /** * (Updatable) An optional description of the model. */ description?: pulumi.Input; /** * (Updatable) A human-friendly name for the model, which can be changed. */ displayName?: pulumi.Input; /** * (Updatable) A simple key-value pair that is applied without any predefined name, type, or scope. It exists for cross-compatibility only. For example: `{"bar-key": "value"}` */ freeformTags?: pulumi.Input<{ [key: string]: pulumi.Input; } | undefined>; /** * (Updatable) Number of replicas required for this model. */ inferenceUnits?: pulumi.Input; /** * Set to true when experimenting with a new model type or dataset, so the model training is quick, with a predefined low number of passes through the training data. */ isQuickMode?: pulumi.Input; /** * The document language for model training, abbreviated according to the BCP 47 syntax. */ language?: pulumi.Input; /** * Locks associated with this resource. */ locks?: pulumi.Input[] | undefined>; /** * The maximum model training time in hours, expressed as a decimal fraction. */ maxTrainingTimeInHours?: pulumi.Input; modelId?: pulumi.Input; /** * Applicable to only PRE_TRAINED_KEY_VALUE_EXTRACTION, PRE_TRAINED_DOCUMENT_ELEMENTS_EXTRACTION. */ modelSubType?: pulumi.Input; /** * The type of the Document model. */ modelType: pulumi.Input; /** * The model version */ modelVersion?: pulumi.Input; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the project that contains the model. */ projectId: pulumi.Input; /** * The base entity which is the input for creating and training a model. */ testingDataset?: pulumi.Input; /** * The base entity which is the input for creating and training a model. */ trainingDataset?: pulumi.Input; /** * The base entity which is the input for creating and training a model. */ validationDataset?: pulumi.Input; } //# sourceMappingURL=model.d.ts.map