機械翻訳について

移動先

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

プロジェクトでのプロンプト・テンプレートの作成

post

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

指定されたプロジェクトの下に新しいプロンプト・テンプレートを作成します。

リクエスト

パス・パラメータ

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

問合せパラメータ

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

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

• application/json;charset=utf-8

リクエスト本文 - application/json;charset=utf-8 ()

ルート・スキーマ: schema

すべてに一致

ソースを表示

• allOf IdRs
• object GenericRestRs
• object type

{
    "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"
                }
            }
        }
    ]
}

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

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

型: 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"
        }
    }
}

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

トップに戻る

レスポンス

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

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

200レスポンス

操作の成功

本文()

ルート・スキーマ: schema

すべてに一致

ソースを表示

• allOf IdRs
• object GenericRestRs
• object type

{
    "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"
                }
            }
        }
    ]
}

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

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

型: 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"
        }
    }
}

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

500レスポンス

サーバー・エラー

トップに戻る

例

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

例: プロジェクトTEST_PROJECTにプロンプト・テンプレートORDER_CREATION_PROMPTを作成します。

このコマンドは、JSONデータを消費し、指定されたプロジェクトの下にプロンプト・テンプレートを作成します。

curl -X POST -H 'Authorization: Bearer access_token' -H "Content-Type:application/json" -d @template.json https://design.integration.region.ocp.oraclecloud.com/ic/api/integration/v1/projects/TEST_PROJECT/ai/templates?integrationInstance=service-instance

リクエスト本文:

JSON形式のリクエスト本文のコンテンツの例を次に示します。 これは、cURLコマンドに-dオプションを指定してリストされたtemplate.jsonファイルの内容です。

{
  "name": "ORDER_CREATION_PROMPT",
  "code": "ORDER_CREATION_PROMPT",
  "description": "Prompt template for order creation scenarios",
  "content": "Create an order using the provided customer and product details."
}

属性

• name

  プロンプトの判読可能な名前。

• code

  プロジェクト内のプロンプトの一意の識別子。

• description

  プロンプトの意図と使用状況のテキストによる説明。

• content

  AIモデルに提供された実際のプロンプト・テキスト。

先頭に戻る