Oracle GoldenGate REST API Documentation 26ai

Get Model Details

get

/services/{version}/aiservice/models/{model}

Required Role: Operator

Retrieve the details of an AI Model.

Request

Path Parameters

model(required): string

Minimum Length: 1

Maximum Length: 255

Pattern: .*

Name of the Model.
version(required): string

Oracle GoldenGate Service API version.

Allowed Values: [ "v2" ]

Response

Supported Media Types

application/json

200 Response

model details returned

Root Schema : AI Model

Type: object

Title: AI Model

Show Source

$schema:

Allowed Values: [ "ogg:model" ]
capabilities: array capabilities

Minimum Number of Items: 0

Maximum Number of Items: 32767
description: string

Minimum Length: 1

Maximum Length: 4000
enabled: boolean
id: string

Minimum Length: 1

Maximum Length: 255
limits: object limits
loaded: boolean
name: string

Minimum Length: 1

Maximum Length: 255
parameters: object parameters
priority: integer

Minimum Value: 0

Maximum Value: 9223372036854776000
providerId: string

Minimum Length: 1

Maximum Length: 255
remoteModelName: string

Minimum Length: 1

Maximum Length: 255
tasks: array tasks

Minimum Number of Items: 0

Maximum Number of Items: 32767
type: string

Minimum Length: 1

Maximum Length: 255

{
    "title":"AI Model",
    "type":"object",
    "properties":{
        "capabilities":{
            "type":"array",
            "items":{
                "type":"string",
                "minLength":1,
                "maxLength":512
            },
            "minItems":0,
            "maxItems":32767
        },
        "priority":{
            "type":"integer",
            "minimum":0,
            "maximum":"9223372036854776000"
        },
        "tasks":{
            "type":"array",
            "items":{
                "type":"string",
                "minLength":1,
                "maxLength":512
            },
            "minItems":0,
            "maxItems":32767
        },
        "loaded":{
            "type":"boolean"
        },
        "providerId":{
            "type":"string",
            "minLength":1,
            "maxLength":255
        },
        "enabled":{
            "type":"boolean"
        },
        "id":{
            "type":"string",
            "minLength":1,
            "maxLength":255
        },
        "name":{
            "type":"string",
            "minLength":1,
            "maxLength":255
        },
        "$schema":{
            "enum":[
                "ogg:model"
            ]
        },
        "remoteModelName":{
            "type":"string",
            "minLength":1,
            "maxLength":255
        },
        "type":{
            "type":"string",
            "minLength":1,
            "maxLength":255
        },
        "limits":{
            "type":"object",
            "properties":{
                "maxInputCharacters":{
                    "type":"integer",
                    "minimum":0,
                    "maximum":"9223372036854776000",
                    "default":12000
                }
            },
            "additionalProperties":false
        },
        "parameters":{
            "type":"object"
        },
        "description":{
            "type":"string",
            "minLength":1,
            "maxLength":4000
        }
    },
    "additionalProperties":false
}

Nested Schema : capabilities

Type: array

Minimum Number of Items: 0

Maximum Number of Items: 32767

Show Source

Array of: string

Minimum Length: 1

Maximum Length: 512

{
    "type":"array",
    "items":{
        "type":"string",
        "minLength":1,
        "maxLength":512
    },
    "minItems":0,
    "maxItems":32767
}

Nested Schema : limits

Type: object

Show Source

maxInputCharacters: integer

Minimum Value: 0

Maximum Value: 9223372036854776000

Default Value: 12000

{
    "type":"object",
    "properties":{
        "maxInputCharacters":{
            "type":"integer",
            "minimum":0,
            "maximum":"9223372036854776000",
            "default":12000
        }
    },
    "additionalProperties":false
}

Nested Schema : parameters

Type: object

Nested Schema : tasks

Type: array

Minimum Number of Items: 0

Maximum Number of Items: 32767

Show Source

Array of: string

Minimum Length: 1

Maximum Length: 512

{
    "type":"array",
    "items":{
        "type":"string",
        "minLength":1,
        "maxLength":512
    },
    "minItems":0,
    "maxItems":32767
}

Example Response (application/json)

{
    "$schema":"api:standardResponse",
    "links":[
        {
            "rel":"canonical",
            "href":"https://localhost:9001/services/v2/aiservice/models/voyage-2",
            "mediaType":"application/json"
        },
        {
            "rel":"self",
            "href":"https://localhost:9001/services/v2/aiservice/models/voyage-2",
            "mediaType":"application/json"
        },
        {
            "rel":"describedby",
            "href":"https://localhost:9001/services/v2/metadata-catalog/model",
            "mediaType":"application/schema+json"
        }
    ],
    "messages":[
    ],
    "response":{
        "capabilities":[
            "embed"
        ],
        "loaded":false,
        "providerId":"voyage1",
        "enabled":true,
        "id":"voyage-2",
        "name":"Voyage 2",
        "remoteModelName":"voyage-2",
        "type":"remote",
        "limits":{
            "maxInputCharacters":20000
        },
        "parameters":{
            "input_type":"document"
        },
        "description":"Voyage embedding model for regression"
    }
}