ModelSummary.Builder (Oracle Cloud Infrastructure Java SDK

java.lang.Object
- com.oracle.bmc.generativeai.model.ModelSummary.Builder

Enclosing class:: ModelSummary

public static class ModelSummary.Builder
extends Object

Constructor Summary

Constructors
Constructor and Description

Builder()

Constructors
Constructor and Description
`Builder()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`ModelSummary.Builder`	`baseModelId(String baseModelId)` The OCID of the base model that’s used for fine-tuning.
`ModelSummary`	`build()`
`ModelSummary.Builder`	`capabilities(List<ModelCapability> capabilities)` Describes what this model can be used for.
`ModelSummary.Builder`	`compartmentId(String compartmentId)` The compartment OCID for fine-tuned models.
`ModelSummary.Builder`	`copy(ModelSummary model)`
`ModelSummary.Builder`	`definedTags(Map<String,Map<String,Object>> definedTags)` Defined tags for this resource.
`ModelSummary.Builder`	`displayName(String displayName)` A user-friendly name.
`ModelSummary.Builder`	`fineTuneDetails(FineTuneDetails fineTuneDetails)`
`ModelSummary.Builder`	`freeformTags(Map<String,String> freeformTags)` Free-form tags for this resource.
`ModelSummary.Builder`	`id(String id)` An ID that uniquely identifies a pretrained or a fine-tuned model.
`ModelSummary.Builder`	`isLongTermSupported(Boolean isLongTermSupported)` Whether a model is supported long-term.
`ModelSummary.Builder`	`lifecycleDetails(String lifecycleDetails)` A message describing the current state of the model with detail that can provide actionable information.
`ModelSummary.Builder`	`lifecycleState(Model.LifecycleState lifecycleState)` The lifecycle state of the model.
`ModelSummary.Builder`	`modelMetrics(ModelMetrics modelMetrics)`
`ModelSummary.Builder`	`systemTags(Map<String,Map<String,Object>> systemTags)` System tags for this resource.
`ModelSummary.Builder`	`timeCreated(Date timeCreated)` The date and time that the model was created in the format of an RFC3339 datetime string.
`ModelSummary.Builder`	`timeDeprecated(Date timeDeprecated)` Corresponds to the time when the custom model and its associated foundation model will be deprecated.
`ModelSummary.Builder`	`type(Model.Type type)` The model type indicating whether this is a pretrained/base model or a custom/fine-tuned model.
`ModelSummary.Builder`	`vendor(String vendor)` The provider of the model.
`ModelSummary.Builder`	`version(String version)` The version of the model.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - Builder
```
public Builder()
```
- Method Detail
  - id
```
public ModelSummary.Builder id(String id)
```
    An ID that uniquely identifies a pretrained or a fine-tuned model.
    
    Parameters:
    
    id - the value to set
    
    Returns:
    
    this builder
  - compartmentId
```
public ModelSummary.Builder compartmentId(String compartmentId)
```
    The compartment OCID for fine-tuned models. For pretrained models, this value is null.
    
    Parameters:
    
    compartmentId - the value to set
    
    Returns:
    
    this builder
  - capabilities
```
public ModelSummary.Builder capabilities(List<ModelCapability> capabilities)
```
    Describes what this model can be used for.
    
    Parameters:
    
    capabilities - the value to set
    
    Returns:
    
    this builder
  - lifecycleState
```
public ModelSummary.Builder lifecycleState(Model.LifecycleState lifecycleState)
```
    The lifecycle state of the model.
    
    Allowed values are: - ACTIVE - CREATING - DELETING - DELETED - FAILED
    
    Parameters:
    
    lifecycleState - the value to set
    
    Returns:
    
    this builder
  - lifecycleDetails
```
public ModelSummary.Builder lifecycleDetails(String lifecycleDetails)
```
    A message describing the current state of the model with detail that can provide actionable information.
    
    Parameters:
    
    lifecycleDetails - the value to set
    
    Returns:
    
    this builder
  - displayName
```
public ModelSummary.Builder displayName(String displayName)
```
    A user-friendly name.
    
    Parameters:
    
    displayName - the value to set
    
    Returns:
    
    this builder
  - vendor
```
public ModelSummary.Builder vendor(String vendor)
```
    The provider of the model.
    
    Parameters:
    
    vendor - the value to set
    
    Returns:
    
    this builder
  - version
```
public ModelSummary.Builder version(String version)
```
    The version of the model.
    
    Parameters:
    
    version - the value to set
    
    Returns:
    
    this builder
  - timeCreated
```
public ModelSummary.Builder timeCreated(Date timeCreated)
```
    The date and time that the model was created in the format of an RFC3339 datetime string.
    
    Parameters:
    
    timeCreated - the value to set
    
    Returns:
    
    this builder
  - baseModelId
```
public ModelSummary.Builder baseModelId(String baseModelId)
```
    The OCID of the base model that’s used for fine-tuning. For pretrained models, the value is null.
    
    Parameters:
    
    baseModelId - the value to set
    
    Returns:
    
    this builder
  - type
```
public ModelSummary.Builder type(Model.Type type)
```
    The model type indicating whether this is a pretrained/base model or a custom/fine-tuned model.
    
    Allowed values are: - BASE - CUSTOM
    
    Parameters:
    
    type - the value to set
    
    Returns:
    
    this builder
  - fineTuneDetails
```
public ModelSummary.Builder fineTuneDetails(FineTuneDetails fineTuneDetails)
```
  - modelMetrics
```
public ModelSummary.Builder modelMetrics(ModelMetrics modelMetrics)
```
  - isLongTermSupported
```
public ModelSummary.Builder isLongTermSupported(Boolean isLongTermSupported)
```
    Whether a model is supported long-term. Applies only to base models.
    
    Parameters:
    
    isLongTermSupported - the value to set
    
    Returns:
    
    this builder
  - timeDeprecated
```
public ModelSummary.Builder timeDeprecated(Date timeDeprecated)
```
    Corresponds to the time when the custom model and its associated foundation model will be deprecated.
    
    Parameters:
    
    timeDeprecated - the value to set
    
    Returns:
    
    this builder
  - freeformTags
```
public ModelSummary.Builder freeformTags(Map<String,String> freeformTags)
```
    Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags.
    
    Example: {"Department": "Finance"}
    
    Parameters:
    
    freeformTags - the value to set
    
    Returns:
    
    this builder
  - definedTags
```
public ModelSummary.Builder definedTags(Map<String,Map<String,Object>> definedTags)
```
    Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags.
    
    Example: {"Operations": {"CostCenter": "42"}}
    
    Parameters:
    
    definedTags - the value to set
    
    Returns:
    
    this builder
  - systemTags
```
public ModelSummary.Builder systemTags(Map<String,Map<String,Object>> systemTags)
```
    System tags for this resource. Each key is predefined and scoped to a namespace.
    
    Example: {"orcl-cloud": {"free-tier-retained": "true"}}
    
    Parameters:
    
    systemTags - the value to set
    
    Returns:
    
    this builder
  - build
```
public ModelSummary build()
```
  - copy
```
public ModelSummary.Builder copy(ModelSummary model)
```

Class ModelSummary.Builder

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

Builder

Method Detail

id

compartmentId

capabilities

lifecycleState

lifecycleDetails

displayName

vendor

version

timeCreated

baseModelId

type

fineTuneDetails

modelMetrics

isLongTermSupported

timeDeprecated

freeformTags

definedTags

systemTags

build

copy