機械翻訳について

移動先

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

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

get

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

プロジェクトに定義されているすべてのAIエージェントを返します。

リクエスト

パス・パラメータ

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

問合せパラメータ

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

  名前、最終更新時刻の順にAIエージェントを一覧表示します。

  有効な値:

  • name: 名前でAIエージェントを注文します。 例: orderBy=name.
  • time: 最終更新時間までにAIエージェントをオーダーします。 例: orderBy=time.
• q: string

  名前とステータスでAIエージェントをフィルタします。

  有効なパラメータ:

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

      q={name: /ORDER/}

  • status: AIエージェントのステータス。 有効なステータスは、INPROGRESS、CONFIGURED、ACTIVATION_INPROGRESS、ACTIVATEDおよびFAILEDACTIVATIONです。

    たとえば、ORDERが含まれ、ステータスがACTIVATEDのすべてのAIエージェントを取得するには、次のように指定します。

    {name : /ORDER/, status : 'ACTIVATED'}

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

トップに戻る

レスポンス

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

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

200レスポンス

操作の成功

本文()

ルート・スキーマ: AIAgentsRs

すべてに一致

ソースを表示

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

{
    "allOf":[
        {
            "$ref":"#/components/schemas/GenericRestRs"
        },
        {
            "type":"object",
            "properties":{
                "items":{
                    "type":"array",
                    "description":"List of Agents",
                    "items":{
                        "$ref":"#/components/schemas/AIAgentListRs"
                    }
                },
                "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"
                }
            }
        }
    ]
}

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

型: object

ソースを表示

• links: array links

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

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

型: object

ソースを表示

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

{
    "type":"object",
    "properties":{
        "items":{
            "type":"array",
            "description":"List of Agents",
            "items":{
                "$ref":"#/components/schemas/AIAgentListRs"
            }
        },
        "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"
        }
    }
}

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

エージェントのリスト

ソースを表示

• 配列: AIAgentListRs

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

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

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

400レスポンス

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

500レスポンス

サーバー・エラー

トップに戻る

例

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

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

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

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

例: プロジェクト内のアクティブなAIエージェントの取得

このコマンドは、名前にORDERが含まれ、ステータスがACTIVATEDの指定されたプロジェクト内のAIエージェントを取得します。 結果は名前でソートされ、10レコードに制限されます。

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

先頭に戻る