Create a Model
post
/services/{version}/installation/aiservice/models/{model}
Required Role: Security
Create an AI Model.Request
Supported Media Types
- application/json
Path Parameters
-
model(required): string
Minimum Length:
1Maximum Length:255Pattern:.*Name of the Model. -
version(required): string
Oracle GoldenGate Service API version.
Allowed Values:[ "v2" ]
Root Schema : AI Model
Type:
objectTitle:
Show Source
AI Model-
$schema:
Allowed Values:
[ "ogg:model" ] -
capabilities:
array capabilities
Minimum Number of Items:
0Maximum Number of Items:32767 -
description:
string
Minimum Length:
1Maximum Length:4000 -
enabled:
boolean
-
id:
string
Minimum Length:
1Maximum Length:255 -
limits:
object limits
-
loaded:
boolean
-
name:
string
Minimum Length:
1Maximum Length:255 -
parameters:
object parameters
-
priority:
integer
Minimum Value:
0Maximum Value:9223372036854776000 -
providerId:
string
Minimum Length:
1Maximum Length:255 -
remoteModelName:
string
Minimum Length:
1Maximum Length:255 -
tasks:
array tasks
Minimum Number of Items:
0Maximum Number of Items:32767 -
type:
string
Minimum Length:
1Maximum Length:255
Nested Schema : capabilities
Type:
arrayMinimum Number of Items:
0Maximum Number of Items:
Show Source
32767-
Array of:
string
Minimum Length:
1Maximum Length:512
Nested Schema : limits
Type:
Show Source
object-
maxInputCharacters:
integer
Minimum Value:
0Maximum Value:9223372036854776000Default Value:12000
Nested Schema : parameters
Type:
objectNested Schema : tasks
Type:
arrayMinimum Number of Items:
0Maximum Number of Items:
Show Source
32767-
Array of:
string
Minimum Length:
1Maximum Length:512
Example Request (application/json)
{
"name":"Voyage 2",
"description":"Voyage embedding model for regression",
"capabilities":[
"embed"
],
"providerId":"voyage1",
"remoteModelName":"voyage-2",
"limits":{
"maxInputCharacters":20000
}
}Response
Supported Media Types
- application/json
201 Response
New Model has been sucessfully added to the installation.
Root Schema : RESTful API Standard Response
Type:
objectTitle:
RESTful API Standard ResponseStandard Response for all Oracle GoldenGate RESTful API calls
Show Source
-
$schema:
Allowed Values:
[ "api:standardResponse" ] -
links(required):
array links
Minimum Number of Items:
0Maximum Number of Items:16Oracle GoldenGate links for the request -
messages(required):
array messages
Minimum Number of Items:
0Maximum Number of Items:65535Oracle GoldenGate messages issued during the request -
response:
object response
Oracle GoldenGate document from the request
Nested Schema : links
Type:
arrayMinimum Number of Items:
0Maximum Number of Items:
16Oracle GoldenGate links for the request
Show Source
Nested Schema : messages
Type:
arrayMinimum Number of Items:
0Maximum Number of Items:
65535Oracle GoldenGate messages issued during the request
Show Source
Nested Schema : response
Type:
objectOracle GoldenGate document from the request
Nested Schema : items
Type:
Show Source
object-
$schema:
Allowed Values:
[ "ogg:link" ] -
description:
string
Minimum Length:
1Maximum Length:4095A human-readable description that provides information and detail specific to this link. -
href(required):
string
Minimum Length:
2Maximum Length:4095Pattern:^[a-zA-Z][a-zA-Z0-9+-.]*:[^ \t]*$An absolute URI for the link -
mediaType:
string
Minimum Length:
6Maximum Length:255Pattern:^(text|application)/[a-zA-Z0-9!#$&.+-^_]+$Media type - see RFC 4288 (https://tools.ietf.org/html/rfc4288) -
rel(required):
Allowed Values:
[ "alternate", "canonical", "current", "describedby", "describes", "enclosure", "parent", "related", "self", "first", "last", "next", "previous", "ogg://service" ]Relationship of href to the requested link
Nested Schema : items
Type:
Show Source
object-
$schema:
Allowed Values:
[ "ogg:message" ] -
code(required):
string
Minimum Length:
9Maximum Length:9Pattern:^OGG[-][0-9]{5}$The Oracle GoldenGate message code -
issued(required):
string
Minimum Length:
20Maximum Length:32Pattern:^[0-9]{4}[-](0[1-9]|1[0-2])[-](0[1-9]|[12][0-9]|3[01])[tT ]([01][0-9]|2[0-3]):[0-5][0-9]:([0-5][0-9]|60)([.][0-9]{1,6})?([zZ]|[+-][0-9][0-9]:[0-5][0-9])$The date and time that the message was issued -
severity(required):
Allowed Values:
[ "INFO", "WARNING", "ERROR" ]The severity of the message -
title(required):
string
Minimum Length:
1Maximum Length:4095A human-readable description that provides information and detail specific to this occurence of the information, warning or error. -
type(required):
string
Minimum Length:
2Maximum Length:4095Pattern:^[a-zA-Z][a-zA-Z0-9+-.]*:[^ \t]*$An absolute URI [RFC3986] to a page that describes the info, warning or error type.
Example Response (application/json)
{
"$schema":"api:standardResponse",
"links":[
{
"rel":"canonical",
"href":"https://localhost:9000/services/v2/installation/aiservice/models/voyage-2",
"mediaType":"application/json"
},
{
"rel":"self",
"href":"https://localhost:9000/services/v2/installation/aiservice/models/voyage-2",
"mediaType":"application/json"
}
],
"messages":[
],
"response":{
"capabilities":[
"embed"
],
"providerId":"voyage1",
"id":"voyage-2",
"name":"Voyage 2",
"remoteModelName":"voyage-2",
"type":"remote",
"limits":{
"maxInputCharacters":20000
},
"parameters":{
},
"description":"Voyage embedding model for regression"
}
}