機械翻訳について

移動先

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

プロジェクト内のエージェント・パターンの取得

get

/ic/api/integration/v1/projects/{projectId}/ai/patterns

プロジェクト内のすべてのエージェント・パターンを返します。

リクエスト

パス・パラメータ

• projectId(required): string
  プロジェクト識別子

問合せパラメータ

• integrationInstance(required): string
  これはサービス・インスタンスの名前です。 この値は、サービス・インスタンス・フィールドで指定した情報ページから取得できます。
• limit: integer(int32)
  返される結果のページ区切りには、オフセット・パラメータを使用します。 この制限は、一度に返すアイテムの最大数です。 たとえば、offset=3&limit=16は、4番目の項目から始まるエージェント・パターンをリストすることを示し、リストには16個の項目が含まれます。
• offset: integer(int32)
  戻される結果のページ区切りには、制限パラメータを使用します。 オフセットは、レコードを返す開始ポイントです。 たとえば、offset=3&limit=16は、4番目の項目から始まるエージェント・パターンをリストすることを示し、リストには16個の項目が含まれます。
• orderBy: string

  名前、最終更新時刻の順にエージェント・パターンをリストします。

  有効な値:

  • name: 名前によるエージェント・パターンの順序付け。 例: orderBy=name.
  • time: 最終更新時間によるオーダー・エージェント・パターン。 例: orderBy=time.
• q: string

  エージェント・パターンを名前でフィルタします。

  有効なパラメータ:

  • name: エージェント・パターンの名前。 たとえば:
    • 指定した文字列が名前に含まれるすべてのエージェント・パターンを取得するには、次のように指定します。

      q={name: /ORDER/}

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

トップに戻る

レスポンス

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

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

200レスポンス

操作の成功

本文()

ルート・スキーマ: PatternsRs

すべてに一致

ソースを表示

• object GenericRestRs
• オブジェクト PatternsRs-allOf[1]

{
    "allOf":[
        {
            "$ref":"#/components/schemas/GenericRestRs"
        },
        {
            "type":"object",
            "properties":{
                "items":{
                    "type":"array",
                    "description":"List of patterns",
                    "items":{
                        "$ref":"#/components/schemas/PatternRs"
                    }
                },
                "totalResults":{
                    "type":"integer",
                    "format":"int32",
                    "description":"Total Results"
                },
                "hasMore":{
                    "type":"boolean",
                    "description":"Flag to Check if More Records Exists"
                },
                "limit":{
                    "type":"integer",
                    "format":"int32",
                    "description":"Limit of Records to be Displayed"
                },
                "projectId":{
                    "type":"string"
                }
            }
        }
    ]
}

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

型: object

ソースを表示

• links: array links

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

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

型: object

ソースを表示

• hasMore: boolean
  レコードが他に存在するかどうかを確認するフラグ
• items: array items
  パターンのリスト
• limit: integer (int32)
  表示するレコードの制限
• projectId: string
• totalResults: integer (int32)
  結果合計

{
    "type":"object",
    "properties":{
        "items":{
            "type":"array",
            "description":"List of patterns",
            "items":{
                "$ref":"#/components/schemas/PatternRs"
            }
        },
        "totalResults":{
            "type":"integer",
            "format":"int32",
            "description":"Total Results"
        },
        "hasMore":{
            "type":"boolean",
            "description":"Flag to Check if More Records Exists"
        },
        "limit":{
            "type":"integer",
            "format":"int32",
            "description":"Limit of Records to be Displayed"
        },
        "projectId":{
            "type":"string"
        }
    }
}

ネストされたスキーマ: 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"
        }
    }
}

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

型: array

パターンのリスト

ソースを表示

• 配列: PatternRs

{
    "type":"array",
    "description":"List of patterns",
    "items":{
        "$ref":"#/components/schemas/PatternRs"
    }
}

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

すべてに一致

ソースを表示

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

{
    "allOf":[
        {
            "$ref":"#/components/schemas/IdRs"
        },
        {
            "$ref":"#/components/schemas/GenericRestRs"
        },
        {
            "type":"object",
            "properties":{
                "name":{
                    "type":"string",
                    "description":"Pattern Name"
                },
                "description":{
                    "type":"string",
                    "description":"Pattern Description"
                },
                "status":{
                    "type":"string",
                    "description":"Pattern Status"
                },
                "lastUpdatedBy":{
                    "type":"string",
                    "description":"Last Updated By"
                },
                "lastUpdated":{
                    "type":"string",
                    "format":"date-time",
                    "description":"Last Updated"
                },
                "created":{
                    "type":"string",
                    "format":"date-time",
                    "description":"Created Date"
                },
                "createdBy":{
                    "type":"string",
                    "description":"Created By"
                },
                "code":{
                    "type":"string",
                    "description":"Code"
                },
                "version":{
                    "type":"string",
                    "description":"Version"
                },
                "updateBy":{
                    "type":"string",
                    "description":"Updated By"
                },
                "createdDate":{
                    "type":"string",
                    "format":"date-time",
                    "description":"Created Date"
                },
                "updatedDate":{
                    "type":"string",
                    "format":"date-time",
                    "description":"Updated Date"
                },
                "patternRoles":{
                    "type":"array",
                    "description":"Pattern Roles",
                    "items":{
                        "$ref":"#/components/schemas/PatternRoles"
                    }
                },
                "dependencies":{
                    "$ref":"#/components/schemas/PatternDependencies",
                    "description":"Pattern Dependencies"
                },
                "usageCount":{
                    "type":"integer",
                    "format":"int32",
                    "description":"Usage Count"
                },
                "projectId":{
                    "type":"string",
                    "description":"Automation id"
                },
                "lockedBy":{
                    "type":"string",
                    "description":"Locked By"
                },
                "lockedDate":{
                    "type":"string",
                    "format":"date-time",
                    "description":"Locked Date"
                },
                "lockedFlag":{
                    "type":"boolean",
                    "description":"Locked Flag"
                },
                "id":{
                    "type":"string",
                    "description":"Pattern id"
                },
                "recipeSource":{
                    "$ref":"#/components/schemas/RecipeSource",
                    "description":"Recipe Source (System or Source)"
                },
                "maxIteration":{
                    "type":"integer",
                    "format":"int32"
                },
                "guidelines":{
                    "type":"string"
                }
            }
        }
    ]
}

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

すべてに一致

ソースを表示

• object GenericRestRs
• object IdRs-allOf[1]

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

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

型: object

ソースを表示

• id: string

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

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

型: object

ソースを表示

• code: string
  コード
• created: string (date-time)
  作成日
• createdBy: string
  作成者
• createdDate: string (date-time)
  作成日
• 依存性: オブジェクト PatternDependencies
• description: string
  パターン摘要
• ガイドライン: 文字列
• id: string
  パターンID
• lastUpdated: string (date-time)
  最終更新
• lastUpdatedBy: string
  最終更新者
• lockedBy: string
  ロック者
• lockedDate: string (date-time)
  ロック日
• lockedFlag: boolean
  ロック・フラグ
• maxIteration: 整数(int32)
• name: string
  パターン名
• patternRoles: 配列 patternRoles
  パターン・ロール
• projectId: string
  自動化ID
• recipeSource: 文字列
  指定できる値: [ "System", "Store" ]

  レシピのソース。

  例: System
• status: string
  パターン・ステータス
• updateBy: 文字列
  更新者
• updatedDate: 文字列(日時)
  更新日
• usageCount: 整数(int32)
  利用件数
• version: string
  バージョン

{
    "type":"object",
    "properties":{
        "name":{
            "type":"string",
            "description":"Pattern Name"
        },
        "description":{
            "type":"string",
            "description":"Pattern Description"
        },
        "status":{
            "type":"string",
            "description":"Pattern Status"
        },
        "lastUpdatedBy":{
            "type":"string",
            "description":"Last Updated By"
        },
        "lastUpdated":{
            "type":"string",
            "format":"date-time",
            "description":"Last Updated"
        },
        "created":{
            "type":"string",
            "format":"date-time",
            "description":"Created Date"
        },
        "createdBy":{
            "type":"string",
            "description":"Created By"
        },
        "code":{
            "type":"string",
            "description":"Code"
        },
        "version":{
            "type":"string",
            "description":"Version"
        },
        "updateBy":{
            "type":"string",
            "description":"Updated By"
        },
        "createdDate":{
            "type":"string",
            "format":"date-time",
            "description":"Created Date"
        },
        "updatedDate":{
            "type":"string",
            "format":"date-time",
            "description":"Updated Date"
        },
        "patternRoles":{
            "type":"array",
            "description":"Pattern Roles",
            "items":{
                "$ref":"#/components/schemas/PatternRoles"
            }
        },
        "dependencies":{
            "$ref":"#/components/schemas/PatternDependencies",
            "description":"Pattern Dependencies"
        },
        "usageCount":{
            "type":"integer",
            "format":"int32",
            "description":"Usage Count"
        },
        "projectId":{
            "type":"string",
            "description":"Automation id"
        },
        "lockedBy":{
            "type":"string",
            "description":"Locked By"
        },
        "lockedDate":{
            "type":"string",
            "format":"date-time",
            "description":"Locked Date"
        },
        "lockedFlag":{
            "type":"boolean",
            "description":"Locked Flag"
        },
        "id":{
            "type":"string",
            "description":"Pattern id"
        },
        "recipeSource":{
            "$ref":"#/components/schemas/RecipeSource",
            "description":"Recipe Source (System or Source)"
        },
        "maxIteration":{
            "type":"integer",
            "format":"int32"
        },
        "guidelines":{
            "type":"string"
        }
    }
}

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

型: object

ソースを表示

• integrations: array integrations
  統合ID
• primaryIntegration: オブジェクト 統合
• project: object PatternDependencyProject

{
    "type":"object",
    "properties":{
        "project":{
            "$ref":"#/components/schemas/PatternDependencyProject",
            "description":"Recipe Details"
        },
        "integrations":{
            "type":"array",
            "description":"Integration id's",
            "items":{
                "$ref":"#/components/schemas/Integration"
            }
        },
        "primaryIntegration":{
            "$ref":"#/components/schemas/Integration",
            "description":"Primary Integration id"
        }
    }
}

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

型: array

パターン・ロール

ソースを表示

• Array of: object PatternRoles

{
    "type":"array",
    "description":"Pattern Roles",
    "items":{
        "$ref":"#/components/schemas/PatternRoles"
    }
}

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

型: array

統合ID

ソースを表示

• Array of: object Integration

{
    "type":"array",
    "description":"Integration id's",
    "items":{
        "$ref":"#/components/schemas/Integration"
    }
}

ネストされたスキーマ : 統合

型: object

ソースを表示

• code: string
  統合コード
• name: string
  統合名
• status: string
  統合ステータス
• type: string
  統合タイプ
• version: string
  統合バージョン

{
    "type":"object",
    "properties":{
        "code":{
            "type":"string",
            "description":"Integration Code"
        },
        "version":{
            "type":"string",
            "description":"Integration Version"
        },
        "name":{
            "type":"string",
            "description":"Integration Name"
        },
        "status":{
            "type":"string",
            "description":"Integration Status"
        },
        "type":{
            "type":"string",
            "description":"Integration Type"
        }
    }
}

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

型: object

ソースを表示

• acceleratorId: 文字列
• acceleratorLabel: 文字列
• id: string

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

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

型: object

ソースを表示

• connectionList: 配列 connectionList
• ガイドライン: 文字列
• maxIteration: 整数(int32)
• role: string
• 温度: 文字列

{
    "type":"object",
    "properties":{
        "role":{
            "type":"string"
        },
        "temperature":{
            "type":"string"
        },
        "maxIteration":{
            "type":"integer",
            "format":"int32"
        },
        "guidelines":{
            "type":"string"
        },
        "connectionList":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/PatternRoleConnection"
            }
        }
    }
}

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

型: array

ソースを表示

• Array of: object PatternRoleConnection

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

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

型: object

ソースを表示

• adapterType: 文字列
• connectionId: string
• llmModel: 文字列
• name: string
• status: string

{
    "type":"object",
    "properties":{
        "connectionId":{
            "type":"string"
        },
        "adapterType":{
            "type":"string"
        },
        "status":{
            "type":"string"
        },
        "name":{
            "type":"string"
        },
        "llmModel":{
            "type":"string"
        }
    }
}

400レスポンス

パラメータの形式が正しくありません

500レスポンス

サーバー・エラー

トップに戻る

例

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

例: プロジェクトTEST_PROJECT内のすべてのエージェント・パターンの取得

このコマンドは、指定されたプロジェクトで定義されているエージェント・パターンをすべて取得します。

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

例: 名前でフィルタされたエージェント・パターンの取得

このコマンドは、名前にORDERが含まれるすべてのエージェント・パターンを取得します。結果は名前でソートされ、10レコードに制限されます。

curl -X GET -H 'Authorization: Bearer access_token' https://design.integration.region.ocp.oraclecloud.com/ic/api/integration/v1/projects/TEST_PROJECT/ai/patterns?q={name:/ORDER/}&orderBy=name&offset=0&limit=10&integrationInstance=service-instance

先頭に戻る