-
Notifications
You must be signed in to change notification settings - Fork 80
/
model.go
299 lines (234 loc) · 12.4 KB
/
model.go
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
// Copyright (c) 2016, 2018, 2024, Oracle and/or its affiliates. All rights reserved.
// This software is dual-licensed to you under the Universal Permissive License (UPL) 1.0 as shown at https://oss.oracle.com/licenses/upl or Apache License 2.0 as shown at http://www.apache.org/licenses/LICENSE-2.0. You may choose either license.
// Code generated. DO NOT EDIT.
// Generative AI Service Management API
//
// OCI Generative AI is a fully managed service that provides a set of state-of-the-art, customizable large language models (LLMs) that cover a wide range of use cases for text generation, summarization, and text embeddings.
// Use the Generative AI service management API to create and manage DedicatedAiCluster, Endpoint, Model, and WorkRequest in the Generative AI service. For example, create a custom model by fine-tuning an out-of-the-box model using your own data, on a fine-tuning dedicated AI cluster. Then, create a hosting dedicated AI cluster with an endpoint to host your custom model.
// To access your custom model endpoints, or to try the out-of-the-box models to generate text, summarize, and create text embeddings see the Generative AI Inference API (https://docs.cloud.oracle.com/#/en/generative-ai-inference/latest/).
// To learn more about the service, see the Generative AI documentation (https://docs.cloud.oracle.com/iaas/Content/generative-ai/home.htm).
//
package generativeai
import (
"encoding/json"
"fmt"
"github.com/oracle/oci-go-sdk/v65/common"
"strings"
)
// Model You can create a custom model by using your dataset to fine-tune an out-of-the-box text generation base model. Have your dataset ready before you create a custom model. See Training Data Requirements (https://docs.cloud.oracle.com/iaas/Content/generative-ai/training-data-requirements.htm).
// To use any of the API operations, you must be authorized in an IAM policy. If you're not authorized, talk to an administrator who gives OCI resource access to users. See
// Getting Started with Policies (https://docs.cloud.oracle.com/iaas/Content/Identity/policiesgs/get-started-with-policies.htm) and Getting Access to Generative AI Resouces (https://docs.cloud.oracle.com/iaas/Content/generative-ai/iam-policies.htm).
type Model struct {
// An ID that uniquely identifies a pretrained or fine-tuned model.
Id *string `mandatory:"true" json:"id"`
// The compartment OCID for fine-tuned models. For pretrained models, this value is null.
CompartmentId *string `mandatory:"true" json:"compartmentId"`
// Describes what this model can be used for.
Capabilities []ModelCapabilityEnum `mandatory:"true" json:"capabilities"`
// The lifecycle state of the model.
LifecycleState ModelLifecycleStateEnum `mandatory:"true" json:"lifecycleState"`
// The date and time that the model was created in the format of an RFC3339 datetime string.
TimeCreated *common.SDKTime `mandatory:"true" json:"timeCreated"`
// The model type indicating whether this is a pretrained/base model or a custom/fine-tuned model.
Type ModelTypeEnum `mandatory:"true" json:"type"`
// An optional description of the model.
Description *string `mandatory:"false" json:"description"`
// A message describing the current state of the model in more detail that can provide actionable information.
LifecycleDetails *string `mandatory:"false" json:"lifecycleDetails"`
// The provider of the base model.
Vendor *string `mandatory:"false" json:"vendor"`
// The version of the model.
Version *string `mandatory:"false" json:"version"`
// A user-friendly name.
DisplayName *string `mandatory:"false" json:"displayName"`
// The date and time that the model was updated in the format of an RFC3339 datetime string.
TimeUpdated *common.SDKTime `mandatory:"false" json:"timeUpdated"`
// The OCID of the base model that's used for fine-tuning. For pretrained models, the value is null.
BaseModelId *string `mandatory:"false" json:"baseModelId"`
FineTuneDetails *FineTuneDetails `mandatory:"false" json:"fineTuneDetails"`
ModelMetrics ModelMetrics `mandatory:"false" json:"modelMetrics"`
// Whether a model is supported long-term. Only applicable to base models.
IsLongTermSupported *bool `mandatory:"false" json:"isLongTermSupported"`
// Corresponds to the time when the custom model and its associated foundation model will be deprecated.
TimeDeprecated *common.SDKTime `mandatory:"false" json:"timeDeprecated"`
PreviousState *Model `mandatory:"false" json:"previousState"`
// 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 (https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm).
// Example: `{"Department": "Finance"}`
FreeformTags map[string]string `mandatory:"false" json:"freeformTags"`
// Defined tags for this resource. Each key is predefined and scoped to a namespace.
// For more information, see Resource Tags (https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm).
// Example: `{"Operations": {"CostCenter": "42"}}`
DefinedTags map[string]map[string]interface{} `mandatory:"false" json:"definedTags"`
// System tags for this resource. Each key is predefined and scoped to a namespace.
// Example: `{"orcl-cloud": {"free-tier-retained": "true"}}`
SystemTags map[string]map[string]interface{} `mandatory:"false" json:"systemTags"`
}
func (m Model) String() string {
return common.PointerString(m)
}
// ValidateEnumValue returns an error when providing an unsupported enum value
// This function is being called during constructing API request process
// Not recommended for calling this function directly
func (m Model) ValidateEnumValue() (bool, error) {
errMessage := []string{}
for _, val := range m.Capabilities {
if _, ok := GetMappingModelCapabilityEnum(string(val)); !ok && val != "" {
errMessage = append(errMessage, fmt.Sprintf("unsupported enum value for Capabilities: %s. Supported values are: %s.", val, strings.Join(GetModelCapabilityEnumStringValues(), ",")))
}
}
if _, ok := GetMappingModelLifecycleStateEnum(string(m.LifecycleState)); !ok && m.LifecycleState != "" {
errMessage = append(errMessage, fmt.Sprintf("unsupported enum value for LifecycleState: %s. Supported values are: %s.", m.LifecycleState, strings.Join(GetModelLifecycleStateEnumStringValues(), ",")))
}
if _, ok := GetMappingModelTypeEnum(string(m.Type)); !ok && m.Type != "" {
errMessage = append(errMessage, fmt.Sprintf("unsupported enum value for Type: %s. Supported values are: %s.", m.Type, strings.Join(GetModelTypeEnumStringValues(), ",")))
}
if len(errMessage) > 0 {
return true, fmt.Errorf(strings.Join(errMessage, "\n"))
}
return false, nil
}
// UnmarshalJSON unmarshals from json
func (m *Model) UnmarshalJSON(data []byte) (e error) {
model := struct {
Description *string `json:"description"`
LifecycleDetails *string `json:"lifecycleDetails"`
Vendor *string `json:"vendor"`
Version *string `json:"version"`
DisplayName *string `json:"displayName"`
TimeUpdated *common.SDKTime `json:"timeUpdated"`
BaseModelId *string `json:"baseModelId"`
FineTuneDetails *FineTuneDetails `json:"fineTuneDetails"`
ModelMetrics modelmetrics `json:"modelMetrics"`
IsLongTermSupported *bool `json:"isLongTermSupported"`
TimeDeprecated *common.SDKTime `json:"timeDeprecated"`
PreviousState *Model `json:"previousState"`
FreeformTags map[string]string `json:"freeformTags"`
DefinedTags map[string]map[string]interface{} `json:"definedTags"`
SystemTags map[string]map[string]interface{} `json:"systemTags"`
Id *string `json:"id"`
CompartmentId *string `json:"compartmentId"`
Capabilities []ModelCapabilityEnum `json:"capabilities"`
LifecycleState ModelLifecycleStateEnum `json:"lifecycleState"`
TimeCreated *common.SDKTime `json:"timeCreated"`
Type ModelTypeEnum `json:"type"`
}{}
e = json.Unmarshal(data, &model)
if e != nil {
return
}
var nn interface{}
m.Description = model.Description
m.LifecycleDetails = model.LifecycleDetails
m.Vendor = model.Vendor
m.Version = model.Version
m.DisplayName = model.DisplayName
m.TimeUpdated = model.TimeUpdated
m.BaseModelId = model.BaseModelId
m.FineTuneDetails = model.FineTuneDetails
nn, e = model.ModelMetrics.UnmarshalPolymorphicJSON(model.ModelMetrics.JsonData)
if e != nil {
return
}
if nn != nil {
m.ModelMetrics = nn.(ModelMetrics)
} else {
m.ModelMetrics = nil
}
m.IsLongTermSupported = model.IsLongTermSupported
m.TimeDeprecated = model.TimeDeprecated
m.PreviousState = model.PreviousState
m.FreeformTags = model.FreeformTags
m.DefinedTags = model.DefinedTags
m.SystemTags = model.SystemTags
m.Id = model.Id
m.CompartmentId = model.CompartmentId
m.Capabilities = make([]ModelCapabilityEnum, len(model.Capabilities))
copy(m.Capabilities, model.Capabilities)
m.LifecycleState = model.LifecycleState
m.TimeCreated = model.TimeCreated
m.Type = model.Type
return
}
// ModelLifecycleStateEnum Enum with underlying type: string
type ModelLifecycleStateEnum string
// Set of constants representing the allowable values for ModelLifecycleStateEnum
const (
ModelLifecycleStateActive ModelLifecycleStateEnum = "ACTIVE"
ModelLifecycleStateCreating ModelLifecycleStateEnum = "CREATING"
ModelLifecycleStateDeleting ModelLifecycleStateEnum = "DELETING"
ModelLifecycleStateDeleted ModelLifecycleStateEnum = "DELETED"
ModelLifecycleStateFailed ModelLifecycleStateEnum = "FAILED"
)
var mappingModelLifecycleStateEnum = map[string]ModelLifecycleStateEnum{
"ACTIVE": ModelLifecycleStateActive,
"CREATING": ModelLifecycleStateCreating,
"DELETING": ModelLifecycleStateDeleting,
"DELETED": ModelLifecycleStateDeleted,
"FAILED": ModelLifecycleStateFailed,
}
var mappingModelLifecycleStateEnumLowerCase = map[string]ModelLifecycleStateEnum{
"active": ModelLifecycleStateActive,
"creating": ModelLifecycleStateCreating,
"deleting": ModelLifecycleStateDeleting,
"deleted": ModelLifecycleStateDeleted,
"failed": ModelLifecycleStateFailed,
}
// GetModelLifecycleStateEnumValues Enumerates the set of values for ModelLifecycleStateEnum
func GetModelLifecycleStateEnumValues() []ModelLifecycleStateEnum {
values := make([]ModelLifecycleStateEnum, 0)
for _, v := range mappingModelLifecycleStateEnum {
values = append(values, v)
}
return values
}
// GetModelLifecycleStateEnumStringValues Enumerates the set of values in String for ModelLifecycleStateEnum
func GetModelLifecycleStateEnumStringValues() []string {
return []string{
"ACTIVE",
"CREATING",
"DELETING",
"DELETED",
"FAILED",
}
}
// GetMappingModelLifecycleStateEnum performs case Insensitive comparison on enum value and return the desired enum
func GetMappingModelLifecycleStateEnum(val string) (ModelLifecycleStateEnum, bool) {
enum, ok := mappingModelLifecycleStateEnumLowerCase[strings.ToLower(val)]
return enum, ok
}
// ModelTypeEnum Enum with underlying type: string
type ModelTypeEnum string
// Set of constants representing the allowable values for ModelTypeEnum
const (
ModelTypeBase ModelTypeEnum = "BASE"
ModelTypeCustom ModelTypeEnum = "CUSTOM"
)
var mappingModelTypeEnum = map[string]ModelTypeEnum{
"BASE": ModelTypeBase,
"CUSTOM": ModelTypeCustom,
}
var mappingModelTypeEnumLowerCase = map[string]ModelTypeEnum{
"base": ModelTypeBase,
"custom": ModelTypeCustom,
}
// GetModelTypeEnumValues Enumerates the set of values for ModelTypeEnum
func GetModelTypeEnumValues() []ModelTypeEnum {
values := make([]ModelTypeEnum, 0)
for _, v := range mappingModelTypeEnum {
values = append(values, v)
}
return values
}
// GetModelTypeEnumStringValues Enumerates the set of values in String for ModelTypeEnum
func GetModelTypeEnumStringValues() []string {
return []string{
"BASE",
"CUSTOM",
}
}
// GetMappingModelTypeEnum performs case Insensitive comparison on enum value and return the desired enum
func GetMappingModelTypeEnum(val string) (ModelTypeEnum, bool) {
enum, ok := mappingModelTypeEnumLowerCase[strings.ToLower(val)]
return enum, ok
}