機械翻訳について

移動先

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

プロジェクトのプロンプト・テンプレートの取得

get

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

プロジェクト内のすべてのプロンプト・テンプレートを返します。

リクエスト

パス・パラメータ

• 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: 名前によるプロンプト・テンプレートの順序付け。
  • time: 最終更新時間によるオーダー・プロンプト・テンプレート。
• q: string

  名前でプロンプト・テンプレートをフィルタします。

  有効なパラメータ:

  • name: プロンプト・テンプレートの名前。 たとえば:
    • 名前に指定された文字列を含むすべてのプロンプト・テンプレートを取得するには、次のように指定します。

      q={name: /ORDER/}

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

トップに戻る

レスポンス

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

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

200レスポンス

操作の成功

本文()

ルート・スキーマ: PromptTemplatesRs

すべてに一致

ソースを表示

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

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

ネストされたスキーマ: PromptTemplatesRs-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 Prompt Templates",
            "items":{
                "$ref":"#/components/schemas/PromptTemplateRs"
            }
        },
        "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

プロンプト・テンプレートのリスト

ソースを表示

• 配列: PromptTemplateRs

{
    "type":"array",
    "description":"List of Prompt Templates",
    "items":{
        "$ref":"#/components/schemas/PromptTemplateRs"
    }
}

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

すべてに一致

ソースを表示

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

{
    "allOf":[
        {
            "$ref":"#/components/schemas/IdRs"
        },
        {
            "$ref":"#/components/schemas/GenericRestRs"
        },
        {
            "type":"object",
            "properties":{
                "name":{
                    "type":"string",
                    "description":"Prompt Template Name"
                },
                "status":{
                    "type":"string",
                    "description":"Status"
                },
                "description":{
                    "type":"string",
                    "description":"Prompt Template Description"
                },
                "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"
                },
                "content":{
                    "type":"string",
                    "description":"Content"
                },
                "code":{
                    "type":"string",
                    "description":"Code"
                },
                "version":{
                    "type":"string",
                    "description":"Version"
                },
                "mapped":{
                    "type":"boolean",
                    "description":"Mapped"
                },
                "usage":{
                    "type":"integer",
                    "format":"int32",
                    "description":"Prompt Template Usage"
                },
                "lockedBy":{
                    "type":"string",
                    "description":"Locked By"
                },
                "lockedDate":{
                    "type":"string",
                    "format":"date-time",
                    "description":"Locked Date"
                },
                "lockedFlag":{
                    "type":"boolean",
                    "description":"Locked Flag"
                },
                "projectId":{
                    "type":"string",
                    "description":"Project id"
                },
                "typeId":{
                    "type":"string",
                    "description":"Type id"
                }
            }
        }
    ]
}

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

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

型: object

ソースを表示

• code: string
  コード
• content: string
  コンテンツ
• created: string (date-time)
  作成日
• createdBy: string
  作成者
• description: string
  プロンプト・テンプレート摘要
• lastUpdated: string (date-time)
  最終更新
• lastUpdatedBy: string
  最終更新者
• lockedBy: string
  ロック者
• lockedDate: string (date-time)
  ロック日
• lockedFlag: boolean
  ロック・フラグ
• マップ済: ブール
  マップ済
• name: string
  プロンプト・テンプレート名
• projectId: string
  プロジェクトID
• status: string
  ステータス
• typeId: 文字列
  タイプID
• usage: integer (int32)
  プロンプト・テンプレート使用
• version: string
  バージョン

{
    "type":"object",
    "properties":{
        "name":{
            "type":"string",
            "description":"Prompt Template Name"
        },
        "status":{
            "type":"string",
            "description":"Status"
        },
        "description":{
            "type":"string",
            "description":"Prompt Template Description"
        },
        "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"
        },
        "content":{
            "type":"string",
            "description":"Content"
        },
        "code":{
            "type":"string",
            "description":"Code"
        },
        "version":{
            "type":"string",
            "description":"Version"
        },
        "mapped":{
            "type":"boolean",
            "description":"Mapped"
        },
        "usage":{
            "type":"integer",
            "format":"int32",
            "description":"Prompt Template Usage"
        },
        "lockedBy":{
            "type":"string",
            "description":"Locked By"
        },
        "lockedDate":{
            "type":"string",
            "format":"date-time",
            "description":"Locked Date"
        },
        "lockedFlag":{
            "type":"boolean",
            "description":"Locked Flag"
        },
        "projectId":{
            "type":"string",
            "description":"Project id"
        },
        "typeId":{
            "type":"string",
            "description":"Type id"
        }
    }
}

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/templates?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/templates?q={name:/ORDER/}&orderBy=name&offset=0&limit=10&integrationInstance=service-instance

先頭に戻る