Show / Hide Table of Contents

Class ModelDiscovery

Metadata describing a specific model

Inheritance
object
ModelDiscovery
Inherited Members
object.Equals(object)
object.Equals(object, object)
object.GetHashCode()
object.GetType()
object.MemberwiseClone()
object.ReferenceEquals(object, object)
object.ToString()
Namespace: Oci.GenerativeaiService.Models
Assembly: OCI.DotNetSDK.Generativeai.dll
Syntax
public class ModelDiscovery

Properties

ApiCapability

Declaration
[JsonProperty(PropertyName = "apiCapability")]
public List<string> ApiCapability { get; set; }
Property Value
Type Description
List<string>

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.

Availability

Declaration
[JsonProperty(PropertyName = "availability")]
public List<Availability> Availability { get; set; }
Property Value
Type Description
List<Availability>

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

Capabilities

Declaration
[Required(ErrorMessage = "Capabilities is required.")]
[JsonProperty(PropertyName = "capabilities")]
public List<ModelCapability> Capabilities { get; set; }
Property Value
Type Description
List<ModelCapability>

Describes what this model can be used for.

Remarks

Required

ModalitySupport

Declaration
[JsonProperty(PropertyName = "modalitySupport")]
public List<ModelModalitySupport> ModalitySupport { get; set; }
Property Value
Type Description
List<ModelModalitySupport>

The supported input-to-output modality transformations for this model. For example, a model can support TEXT to VIDEO or AUDIO to VIDEO.

ModelAccess

Declaration
[JsonProperty(PropertyName = "modelAccess")]
[JsonConverter(typeof(ResponseEnumConverter))]
public ModelDiscovery.ModelAccessEnum? ModelAccess { get; set; }
Property Value
Type Description
ModelDiscovery.ModelAccessEnum?

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).

ModelId

Declaration
[Required(ErrorMessage = "ModelId is required.")]
[JsonProperty(PropertyName = "modelId")]
public string ModelId { get; set; }
Property Value
Type Description
string

A unique identifier for the model

Remarks

Required

Parameters

Declaration
[JsonProperty(PropertyName = "parameters")]
public List<Parameter> Parameters { get; set; }
Property Value
Type Description
List<Parameter>

The list of configurable parameters supported by the model. For example, temperature and max_tokens for a text generation model.

Vendor

Declaration
[Required(ErrorMessage = "Vendor is required.")]
[JsonProperty(PropertyName = "vendor")]
public string Vendor { get; set; }
Property Value
Type Description
string

The vendor that offers the model.

Remarks

Required

In this article
Back to top