ジャンプ先

• リクエスト
• レスポンス

プロバイダの詳細の取得

get

/services/{version}/installation/aiservice/providers/{provider}

必要なロール: セキュリティ

AIプロバイダの詳細を取得します。

リクエスト

パス・パラメータ

• provider(必須): string
  最小長: 1

  最大長: 255

  パターン: .*

  プロバイダの名前。
• version(必須): string

  Oracle GoldenGateサービスのAPIバージョン。

  指定できる値: [ "v2" ]

先頭に戻る

レスポンス

サポートされるメディア・タイプ

• application/json

200レスポンス

プロバイダの詳細が返されます

本文()

ルート・スキーマ: AI Provider

型: object

タイトル: AI Provider

ソースの表示

• $schema:
  指定できる値: [ "ogg:provider" ]
• authentication: object authentication
• baseUrl: string
  最小長: 2

  最大長: 4095

  パターン: ^[a-zA-Z][a-zA-Z0-9+-.]*:[^ \t]*$
• capabilities: array capabilities
  最小アイテム数: 0

  最大アイテム数: 32767
• description: string
  最小長: 1

  最大長: 4000
• enabled: boolean
  デフォルト値: true
• headers: object headers
• id: string
  最小長: 1

  最大長: 255
• metadata: object metadata
• name: string
  最小長: 1

  最大長: 255
• regions: array regions
  最小アイテム数: 0

  最大アイテム数: 32767
• retry: object retry
• tasksTypes: array tasksTypes
  最小アイテム数: 0

  最大アイテム数: 32767
• timeouts: object timeouts
• type: string
  最小長: 1

  最大長: 255

{
    "title":"AI Provider",
    "type":"object",
    "properties":{
        "capabilities":{
            "type":"array",
            "items":{
                "type":"string",
                "minLength":1,
                "maxLength":512
            },
            "minItems":0,
            "maxItems":32767
        },
        "retry":{
            "type":"object",
            "properties":{
                "maxRetries":{
                    "type":"integer",
                    "minimum":0,
                    "maximum":"9223372036854776000",
                    "default":3
                },
                "initialBackoffMs":{
                    "type":"integer",
                    "minimum":0,
                    "maximum":"9223372036854776000",
                    "default":100
                },
                "maxBackoffMs":{
                    "type":"integer",
                    "minimum":0,
                    "maximum":"9223372036854776000",
                    "default":10000
                },
                "backoffMultiplier":{
                    "type":"number",
                    "default":2
                }
            },
            "additionalProperties":false
        },
        "authentication":{
            "type":"object",
            "properties":{
                "compartmentId":{
                    "type":"string",
                    "minLength":1,
                    "maxLength":255,
                    "pattern":"ocid1[.].*[.]oc[123]{1}[.].*[.].*"
                },
                "userId":{
                    "type":"string",
                    "minLength":1,
                    "maxLength":255,
                    "pattern":"ocid1[.].*[.]oc[123]{1}[.].*[.].*"
                },
                "scopes":{
                    "type":"array",
                    "items":{
                        "type":"string",
                        "minLength":1,
                        "maxLength":512
                    },
                    "minItems":0,
                    "maxItems":32767
                },
                "privateKey":{
                    "type":"string",
                    "minLength":1,
                    "maxLength":10240
                },
                "keyFingerprint":{
                    "type":"string",
                    "minLength":47,
                    "maxLength":47
                },
                "type":{
                    "type":"string",
                    "minLength":1,
                    "maxLength":255,
                    "example":"api_key"
                },
                "secret":{
                    "type":"string",
                    "minLength":1,
                    "maxLength":512
                },
                "password":{
                    "type":"string",
                    "minLength":1,
                    "maxLength":256
                },
                "credentialsRef":{
                    "type":"object",
                    "properties":{
                        "alias":{
                            "type":"string",
                            "minLength":1,
                            "maxLength":255
                        },
                        "domain":{
                            "type":"string",
                            "minLength":1,
                            "maxLength":255
                        }
                    },
                    "additionalProperties":false
                },
                "tenancyId":{
                    "type":"string",
                    "minLength":1,
                    "maxLength":255,
                    "pattern":"ocid1[.].*[.]oc[123]{1}[.].*[.].*"
                },
                "audiences":{
                    "type":"array",
                    "items":{
                        "type":"string",
                        "minLength":1,
                        "maxLength":512
                    },
                    "minItems":0,
                    "maxItems":32767
                },
                "configured":{
                    "type":"boolean"
                }
            },
            "additionalProperties":false
        },
        "enabled":{
            "type":"boolean",
            "default":true
        },
        "id":{
            "type":"string",
            "minLength":1,
            "maxLength":255
        },
        "tasksTypes":{
            "type":"array",
            "items":{
                "type":"string",
                "minLength":1,
                "maxLength":512
            },
            "minItems":0,
            "maxItems":32767
        },
        "name":{
            "type":"string",
            "minLength":1,
            "maxLength":255
        },
        "$schema":{
            "enum":[
                "ogg:provider"
            ]
        },
        "baseUrl":{
            "type":"string",
            "pattern":"^[a-zA-Z][a-zA-Z0-9+-.]*:[^ \\t]*$",
            "minLength":2,
            "maxLength":4095
        },
        "metadata":{
            "type":"object"
        },
        "type":{
            "type":"string",
            "minLength":1,
            "maxLength":255
        },
        "regions":{
            "type":"array",
            "items":{
                "type":"string",
                "minLength":1,
                "maxLength":512
            },
            "minItems":0,
            "maxItems":32767
        },
        "timeouts":{
            "type":"object",
            "properties":{
                "requestTimeoutMs":{
                    "type":"integer",
                    "minimum":0,
                    "maximum":"9223372036854776000",
                    "default":30000
                },
                "connectTimeoutMs":{
                    "type":"integer",
                    "minimum":0,
                    "maximum":"9223372036854776000",
                    "default":10000
                },
                "totalTimeoutMs":{
                    "type":"integer",
                    "minimum":0,
                    "maximum":"9223372036854776000",
                    "default":60000
                }
            },
            "additionalProperties":false
        },
        "description":{
            "type":"string",
            "minLength":1,
            "maxLength":4000
        },
        "headers":{
            "type":"object"
        }
    },
    "additionalProperties":false
}

ネストされたスキーマ: authentication

型: object

ソースの表示

• audiences: array audiences
  最小アイテム数: 0

  最大アイテム数: 32767
• compartmentId: string
  最小長: 1

  最大長: 255

  パターン: ocid1[.].*[.]oc[123]{1}[.].*[.].*
• configured: boolean
• credentialsRef: object credentialsRef
• keyFingerprint: string
  最小長: 47

  最大長: 47
• password: string
  最小長: 1

  最大長: 256
• privateKey: string
  最小長: 1

  最大長: 10240
• scopes: array scopes
  最小アイテム数: 0

  最大アイテム数: 32767
• secret: string
  最小長: 1

  最大長: 512
• tenancyId: string
  最小長: 1

  最大長: 255

  パターン: ocid1[.].*[.]oc[123]{1}[.].*[.].*
• type: string
  最小長: 1

  最大長: 255

  例: api_key
• userId: string
  最小長: 1

  最大長: 255

  パターン: ocid1[.].*[.]oc[123]{1}[.].*[.].*

{
    "type":"object",
    "properties":{
        "compartmentId":{
            "type":"string",
            "minLength":1,
            "maxLength":255,
            "pattern":"ocid1[.].*[.]oc[123]{1}[.].*[.].*"
        },
        "userId":{
            "type":"string",
            "minLength":1,
            "maxLength":255,
            "pattern":"ocid1[.].*[.]oc[123]{1}[.].*[.].*"
        },
        "scopes":{
            "type":"array",
            "items":{
                "type":"string",
                "minLength":1,
                "maxLength":512
            },
            "minItems":0,
            "maxItems":32767
        },
        "privateKey":{
            "type":"string",
            "minLength":1,
            "maxLength":10240
        },
        "keyFingerprint":{
            "type":"string",
            "minLength":47,
            "maxLength":47
        },
        "type":{
            "type":"string",
            "minLength":1,
            "maxLength":255,
            "example":"api_key"
        },
        "secret":{
            "type":"string",
            "minLength":1,
            "maxLength":512
        },
        "password":{
            "type":"string",
            "minLength":1,
            "maxLength":256
        },
        "credentialsRef":{
            "type":"object",
            "properties":{
                "alias":{
                    "type":"string",
                    "minLength":1,
                    "maxLength":255
                },
                "domain":{
                    "type":"string",
                    "minLength":1,
                    "maxLength":255
                }
            },
            "additionalProperties":false
        },
        "tenancyId":{
            "type":"string",
            "minLength":1,
            "maxLength":255,
            "pattern":"ocid1[.].*[.]oc[123]{1}[.].*[.].*"
        },
        "audiences":{
            "type":"array",
            "items":{
                "type":"string",
                "minLength":1,
                "maxLength":512
            },
            "minItems":0,
            "maxItems":32767
        },
        "configured":{
            "type":"boolean"
        }
    },
    "additionalProperties":false
}

ネストされたスキーマ: capabilities

型: array

最小アイテム数: 0

最大アイテム数: 32767

ソースの表示

• 配列: string
  最小長: 1

  最大長: 512

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

ネストされたスキーマ: headers

型: object

ネストされたスキーマ: metadata

型: object

ネストされたスキーマ: regions

型: array

最小アイテム数: 0

最大アイテム数: 32767

ソースの表示

• 配列: string
  最小長: 1

  最大長: 512

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

ネストされたスキーマ: retry

型: object

ソースの表示

• backoffMultiplier: number
  デフォルト値: 2
• initialBackoffMs: integer
  最小値: 0

  最大値: 9223372036854776000

  デフォルト値: 100
• maxBackoffMs: integer
  最小値: 0

  最大値: 9223372036854776000

  デフォルト値: 10000
• maxRetries: integer
  最小値: 0

  最大値: 9223372036854776000

  デフォルト値: 3

{
    "type":"object",
    "properties":{
        "maxRetries":{
            "type":"integer",
            "minimum":0,
            "maximum":"9223372036854776000",
            "default":3
        },
        "initialBackoffMs":{
            "type":"integer",
            "minimum":0,
            "maximum":"9223372036854776000",
            "default":100
        },
        "maxBackoffMs":{
            "type":"integer",
            "minimum":0,
            "maximum":"9223372036854776000",
            "default":10000
        },
        "backoffMultiplier":{
            "type":"number",
            "default":2
        }
    },
    "additionalProperties":false
}

ネストされたスキーマ: tasksTypes

型: array

最小アイテム数: 0

最大アイテム数: 32767

ソースの表示

• 配列: string
  最小長: 1

  最大長: 512

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

ネストされたスキーマ: timeouts

型: object

ソースの表示

• connectTimeoutMs: integer
  最小値: 0

  最大値: 9223372036854776000

  デフォルト値: 10000
• requestTimeoutMs: integer
  最小値: 0

  最大値: 9223372036854776000

  デフォルト値: 30000
• totalTimeoutMs: integer
  最小値: 0

  最大値: 9223372036854776000

  デフォルト値: 60000

{
    "type":"object",
    "properties":{
        "requestTimeoutMs":{
            "type":"integer",
            "minimum":0,
            "maximum":"9223372036854776000",
            "default":30000
        },
        "connectTimeoutMs":{
            "type":"integer",
            "minimum":0,
            "maximum":"9223372036854776000",
            "default":10000
        },
        "totalTimeoutMs":{
            "type":"integer",
            "minimum":0,
            "maximum":"9223372036854776000",
            "default":60000
        }
    },
    "additionalProperties":false
}

ネストされたスキーマ: audiences

型: array

最小アイテム数: 0

最大アイテム数: 32767

ソースの表示

• 配列: string
  最小長: 1

  最大長: 512

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

ネストされたスキーマ: credentialsRef

型: object

ソースの表示

• alias: string
  最小長: 1

  最大長: 255
• domain: string
  最小長: 1

  最大長: 255

{
    "type":"object",
    "properties":{
        "alias":{
            "type":"string",
            "minLength":1,
            "maxLength":255
        },
        "domain":{
            "type":"string",
            "minLength":1,
            "maxLength":255
        }
    },
    "additionalProperties":false
}

ネストしたスキーマ: scopes

型: array

最小アイテム数: 0

最大アイテム数: 32767

ソースの表示

• 配列: string
  最小長: 1

  最大長: 512

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

レスポンスの例(application/json)

{
    "$schema":"api:standardResponse",
    "links":[
        {
            "rel":"canonical",
            "href":"https://localhost:9000/services/v2/installation/aiservice/providers/voyage1",
            "mediaType":"application/json"
        },
        {
            "rel":"self",
            "href":"https://localhost:9000/services/v2/installation/aiservice/providers/voyage1",
            "mediaType":"application/json"
        },
        {
            "rel":"describedby",
            "href":"https://localhost:9000/services/v2/metadata-catalog/provider",
            "mediaType":"application/schema+json"
        }
    ],
    "messages":[
    ],
    "response":{
        "id":"voyage1",
        "name":"Voyage AI",
        "type":"voyage",
        "baseUrl":"https://api.voyageai.com/v1",
        "description":"Voyage AI embedding provider",
        "authentication":{
            "type":"api_key",
            "configured":true
        }
    }
}

先頭に戻る