機械翻訳について

移動先

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

プロジェクト内のAIエージェントの取得

get

/ic/api/integration/v1/projects/{projectId}/ai/agents/{id}

特定のAIエージェントの詳細をフェッチします。

リクエスト

パス・パラメータ

• id(required): string
  AIエージェント識別子
• projectId(required): string
  プロジェクト識別子

問合せパラメータ

• integrationInstance(required): string
  これはサービス・インスタンスの名前です。 この値は、サービス・インスタンス・フィールドで指定した情報ページから取得できます。

この操作のリクエスト本文がありません。

トップに戻る

レスポンス

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

• application/json;charset=utf-8, application/vnd.oracle.model+json;type=singular

200レスポンス

操作の成功

本文()

ルート・スキーマ: schema

すべてに一致

ソースを表示

• allOf AIAgentListRs
• object type

{
    "allOf":[
        {
            "$ref":"#/components/schemas/AIAgentListRs"
        },
        {
            "type":"object",
            "properties":{
                "description":{
                    "type":"string",
                    "description":"Description"
                },
                "guidelines":{
                    "type":"string",
                    "description":"AI Guidelines"
                },
                "role":{
                    "type":"string",
                    "description":"Agent role"
                },
                "dependencies":{
                    "$ref":"#/components/schemas/AIAgentResourceDependencyRs",
                    "description":"Associated resources"
                },
                "endpointURI":{
                    "type":"string",
                    "description":"Endpoint URI used to invoke agent"
                }
            }
        }
    ]
}

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

すべてに一致

ソースを表示

• allOf IdRs
• object GenericRestRs
• オブジェクト AIAgentListRs-allOf[2]

{
    "allOf":[
        {
            "$ref":"#/components/schemas/IdRs"
        },
        {
            "$ref":"#/components/schemas/GenericRestRs"
        },
        {
            "type":"object",
            "properties":{
                "name":{
                    "type":"string",
                    "description":"AI Agent name"
                },
                "code":{
                    "type":"string",
                    "description":"AI Agent code"
                },
                "version":{
                    "type":"string",
                    "description":"AI Agent version"
                },
                "status":{
                    "type":"string",
                    "description":"AI Agent Status"
                },
                "description":{
                    "type":"string",
                    "description":"AI Agent description"
                },
                "projectId":{
                    "type":"string",
                    "description":"Project id which agent is part of"
                },
                "created":{
                    "type":"string",
                    "format":"date-time",
                    "description":"Created"
                },
                "createdBy":{
                    "type":"string",
                    "description":"Created By"
                },
                "lastUpdatedBy":{
                    "type":"string",
                    "description":"Last Updated By"
                },
                "lastUpdated":{
                    "type":"string",
                    "format":"date-time",
                    "description":"Last Updated"
                }
            }
        }
    ]
}

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

すべてに一致

ソースを表示

• object GenericRestRs
• object IdRs-allOf[1]

{
    "allOf":[
        {
            "$ref":"#/components/schemas/GenericRestRs"
        },
        {
            "type":"object",
            "properties":{
                "id":{
                    "type":"string"
                }
            }
        }
    ]
}

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

型: object

ソースを表示

• links: array links

{
    "type":"object",
    "properties":{
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/SuiteLink"
            }
        }
    }
}

ネストされたスキーマ : IdRs-allOf[1]

型: object

ソースを表示

• id: string

{
    "type":"object",
    "properties":{
        "id":{
            "type":"string"
        }
    }
}

ネストされたスキーマ: AIAgentListRs-allOf[2]

型: object

ソースを表示

• code: string
  AIエージェント・コード
• created: string (date-time)
  作成
• createdBy: string
  作成者
• description: string
  AIエージェントの説明
• lastUpdated: string (date-time)
  最終更新
• lastUpdatedBy: string
  最終更新者
• name: string
  AIエージェント名
• projectId: string
  エージェントが属するプロジェクトID
• status: string
  AIエージェント・ステータス
• version: string
  AIエージェントのバージョン

{
    "type":"object",
    "properties":{
        "name":{
            "type":"string",
            "description":"AI Agent name"
        },
        "code":{
            "type":"string",
            "description":"AI Agent code"
        },
        "version":{
            "type":"string",
            "description":"AI Agent version"
        },
        "status":{
            "type":"string",
            "description":"AI Agent Status"
        },
        "description":{
            "type":"string",
            "description":"AI Agent description"
        },
        "projectId":{
            "type":"string",
            "description":"Project id which agent is part of"
        },
        "created":{
            "type":"string",
            "format":"date-time",
            "description":"Created"
        },
        "createdBy":{
            "type":"string",
            "description":"Created By"
        },
        "lastUpdatedBy":{
            "type":"string",
            "description":"Last Updated By"
        },
        "lastUpdated":{
            "type":"string",
            "format":"date-time",
            "description":"Last Updated"
        }
    }
}

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

型: object

ソースを表示

• 依存性: オブジェクト AIAgentResourceDependencyRs
• description: string
  説明
• endpointURI: 文字列
  エージェントの起動に使用されるエンドポイントURI
• ガイドライン: 文字列
  AIガイドライン
• role: string
  エージェント・ロール

{
    "type":"object",
    "properties":{
        "description":{
            "type":"string",
            "description":"Description"
        },
        "guidelines":{
            "type":"string",
            "description":"AI Guidelines"
        },
        "role":{
            "type":"string",
            "description":"Agent role"
        },
        "dependencies":{
            "$ref":"#/components/schemas/AIAgentResourceDependencyRs",
            "description":"Associated resources"
        },
        "endpointURI":{
            "type":"string",
            "description":"Endpoint URI used to invoke agent"
        }
    }
}

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

型: array

ソースを表示

• Array of: object SuiteLink

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/SuiteLink"
    }
}

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

型: object

ソースを表示

• href: string
• media-type: string
• method: string
• rel: string

{
    "type":"object",
    "properties":{
        "rel":{
            "type":"string"
        },
        "href":{
            "type":"string"
        },
        "media-type":{
            "type":"string"
        },
        "method":{
            "type":"string"
        }
    }
}

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

型: object

ソースを表示

• テンプレート: 配列 テンプレート
• thinkingPattern: オブジェクト PatternDependencyRs
• ツール: アレイの ツール

{
    "type":"object",
    "properties":{
        "thinkingPattern":{
            "$ref":"#/components/schemas/PatternDependencyRs"
        },
        "tools":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/ToolDependencyRs"
            }
        },
        "templates":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/TemplateDependencyRs"
            }
        }
    }
}

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

型: array

ソースを表示

• Array of: object TemplateDependencyRs

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/TemplateDependencyRs"
    }
}

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

型: object

ソースを表示

• description: string
• id: string
• name: string

{
    "type":"object",
    "properties":{
        "id":{
            "type":"string"
        },
        "name":{
            "type":"string"
        },
        "description":{
            "type":"string"
        }
    }
}

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

型: array

ソースを表示

• Array of: object ToolDependencyRs

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/ToolDependencyRs"
    }
}

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

型: object

ソースを表示

• description: string
• id: string
• isPrimary: ブール
• name: string

{
    "type":"object",
    "properties":{
        "id":{
            "type":"string"
        },
        "name":{
            "type":"string"
        },
        "description":{
            "type":"string"
        },
        "isPrimary":{
            "type":"boolean"
        }
    }
}

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

型: object

ソースを表示

• description: string
• id: string
• name: string

{
    "type":"object",
    "properties":{
        "id":{
            "type":"string"
        },
        "name":{
            "type":"string"
        },
        "description":{
            "type":"string"
        }
    }
}

404レスポンス

AIエージェントが見つかりません

500レスポンス

サーバー・エラー

トップに戻る

例

次の例では、cURLを使用してRESTリソースに対するGETリクエストを発行することによって、特定のAIエージェントを取得する方法を示しています。 cURLの詳細は、「cURLの使用」を参照してください。 エンドポイントURLの構造の詳細は、「リクエストの送信」を参照してください。

例: プロジェクトTEST_PROJECTのAIエージェントORDER_AGENTの取得

このコマンドは、指定されたAIエージェントを取得します。 Idは書式: code%7Cversion です。

|はエンコードされた| (垂直線)です。

curl -X GET -H 'Authorization: Bearer access_token' https://design.integration.region.ocp.oraclecloud.com/ic/api/integration/v1/projects/TEST_PROJECT/ai/agents/ORDER_AGENT%7C01.00.0000?integrationInstance=service-instance

先頭に戻る