Package com.oracle.bmc.generativeai.model

Class ModelDiscovery

java.lang.Object

com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel

com.oracle.bmc.generativeai.model.ModelDiscovery

@Generated(value="OracleSDKGenerator",
           comments="API Version: 20231130")
public final class ModelDiscovery
extends com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel

Metadata describing a specific model
Note: Objects should always be created or deserialized using the ModelDiscovery.Builder.

This model distinguishes fields that are null because they are unset from fields that are explicitly set to null. This is done in the setter methods of the ModelDiscovery.Builder, which maintain a set of all explicitly set fields called ModelDiscovery.Builder.__explicitlySet__. The hashCode() and equals(Object) methods are implemented to take the explicitly set fields into account. The constructor, on the other hand, does not take the explicitly set fields into account (since the constructor cannot distinguish explicit null from unset null).

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	ModelDiscovery.Builder
static class	ModelDiscovery.ModelAccess	The access level required to use the model, which can be either HOSTED (the model is hosted by the provider and can be accessed via API calls) or PROXY (the model is not directly accessible and requires going through a proxy).

Field Summary

Fields inherited from class com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel

EXPLICITLY_SET_FILTER_NAME, EXPLICITLY_SET_PROPERTY_NAME

Constructor Summary

Constructors

Constructor	Description
ModelDiscovery(String modelId, String vendor, List<ModelCapability> capabilities, List<String> apiCapability, List<ModelModalitySupport> modalitySupport, ModelDiscovery.ModelAccess modelAccess, List<Parameter> parameters, List<Availability> availability)	Deprecated.

Method Summary

Modifier and Type	Method	Description
static ModelDiscovery.Builder	builder()	Create a new builder.
boolean	equals(Object o)
List<String>	getApiCapability()	The specific API endpoints that this model supports.
List<Availability>	getAvailability()	The list of availability details for the model across different regions and deployment modes.
List<ModelCapability>	getCapabilities()	Describes what this model can be used for.
List<ModelModalitySupport>	getModalitySupport()	The supported input-to-output modality transformations for this model.
ModelDiscovery.ModelAccess	getModelAccess()	The access level required to use the model, which can be either HOSTED (the model is hosted by the provider and can be accessed via API calls) or PROXY (the model is not directly accessible and requires going through a proxy).
String	getModelId()	A unique identifier for the model
List<Parameter>	getParameters()	The list of configurable parameters supported by the model.
String	getVendor()	The vendor that offers the model.
int	hashCode()
ModelDiscovery.Builder	toBuilder()
String	toString()
String	toString(boolean includeByteArrayContents)	Return a string representation of the object.

Methods inherited from class com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel

markPropertyAsExplicitlySet, wasPropertyExplicitlySet

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

ModelDiscovery

@Deprecated
@ConstructorProperties({"modelId","vendor","capabilities","apiCapability","modalitySupport","modelAccess","parameters","availability"})
public ModelDiscovery(String modelId,
                      String vendor,
                      List<ModelCapability> capabilities,
                      List<String> apiCapability,
                      List<ModelModalitySupport> modalitySupport,
                      ModelDiscovery.ModelAccess modelAccess,
                      List<Parameter> parameters,
                      List<Availability> availability)

Deprecated.

Method Detail

builder

public static ModelDiscovery.Builder builder()

Create a new builder.

toBuilder

public ModelDiscovery.Builder toBuilder()

getModelId

public String getModelId()

A unique identifier for the model

Returns:

the value

getVendor

public String getVendor()

The vendor that offers the model.

Returns:

the value

getCapabilities

public List<ModelCapability> getCapabilities()

Describes what this model can be used for.

Returns:

the value

getApiCapability

public List<String> getApiCapability()

The specific API endpoints that this model supports.

For example, a chat model may support OPENAI_V1_CHAT_COMPLETIONS and/or OPENAI_V1_RESPONSES. If empty, the model has not yet been annotated with API capabilities.

Returns:

the value

getModalitySupport

public List<ModelModalitySupport> getModalitySupport()

The supported input-to-output modality transformations for this model.

For example, a model can support TEXT to VIDEO or AUDIO to VIDEO.

Returns:

the value

getModelAccess

public ModelDiscovery.ModelAccess getModelAccess()

The access level required to use the model, which can be either HOSTED (the model is hosted by the provider and can be accessed via API calls) or PROXY (the model is not directly accessible and requires going through a proxy).

Returns:

the value

getParameters

public List<Parameter> getParameters()

The list of configurable parameters supported by the model.

For example, temperature and max_tokens for a text generation model.

Returns:

the value

getAvailability

public List<Availability> getAvailability()

The list of availability details for the model across different regions and deployment modes.

Returns:

the value

toString

public String toString()

Overrides:

toString in class com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel

toString

public String toString(boolean includeByteArrayContents)

Return a string representation of the object.

Parameters:

includeByteArrayContents - true to include the full contents of byte arrays

Returns:

string representation

equals

public boolean equals(Object o)

Overrides:

equals in class com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel

hashCode

public int hashCode()

Overrides:

hashCode in class com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel