diff --git a/rfcs/AP-RFC-1.md b/rfcs/2023-08-14-AP-RFC.md similarity index 100% rename from rfcs/AP-RFC-1.md rename to rfcs/2023-08-14-AP-RFC.md diff --git a/rfcs/2023-08-28-agent-created-RFC-.md b/rfcs/2023-08-28-agent-created-RFC-.md new file mode 100644 index 0000000..a509b12 --- /dev/null +++ b/rfcs/2023-08-28-agent-created-RFC-.md @@ -0,0 +1,29 @@ +# Tell the user whether the artifact is agent generated or not + +| Feature name | Artifact Created At | +|:--------------|:-----------------------------------------| +| **Author(s)** | Merwane Hamadi (merwanehamadi@gmail.com) | +| **RFC PR:** | | +| **Created** | 2023-08-28 | +| **Obsoletes** | | + +## Summary +Add agent_created to the artifact response body. + +## Motivation +If we don't know whether an artifact is generated by the agent or not, it's hard to know what the agent did or did not do. + + +## Agent Builders Benefit + +- They can tell their users what their agent did. + +## Design Proposal + +agent_created field in the response body + +### Alternatives Considered + +### Compatibility + +- This is backwards compatible. We're just adding something. diff --git a/schemas/openapi.json b/schemas/openapi.json index 6fab10a..9d6353b 100644 --- a/schemas/openapi.json +++ b/schemas/openapi.json @@ -88,6 +88,11 @@ "type": "string", "example": "b225e278-8b4c-4f99-a696-8facf19f0e56" }, + "agent_created": { + "description": "Whether the artifact has been created by the agent.", + "type": "boolean", + "example": false + }, "file_name": { "description": "Filename of the artifact.", "type": "string", @@ -102,6 +107,7 @@ }, "required": [ "artifact_id", + "agent_created", "file_name" ] }, @@ -243,6 +249,11 @@ "type": "string", "example": "b225e278-8b4c-4f99-a696-8facf19f0e56" }, + "agent_created": { + "description": "Whether the artifact has been created by the agent.", + "type": "boolean", + "example": false + }, "file_name": { "description": "Filename of the artifact.", "type": "string", @@ -257,6 +268,7 @@ }, "required": [ "artifact_id", + "agent_created", "file_name" ] }, @@ -493,6 +505,11 @@ "type": "string", "example": "b225e278-8b4c-4f99-a696-8facf19f0e56" }, + "agent_created": { + "description": "Whether the artifact has been created by the agent.", + "type": "boolean", + "example": false + }, "file_name": { "description": "Filename of the artifact.", "type": "string", @@ -507,6 +524,7 @@ }, "required": [ "artifact_id", + "agent_created", "file_name" ] }, @@ -696,6 +714,11 @@ "type": "string", "example": "b225e278-8b4c-4f99-a696-8facf19f0e56" }, + "agent_created": { + "description": "Whether the artifact has been created by the agent.", + "type": "boolean", + "example": false + }, "file_name": { "description": "Filename of the artifact.", "type": "string", @@ -710,6 +733,7 @@ }, "required": [ "artifact_id", + "agent_created", "file_name" ] }, @@ -796,6 +820,11 @@ "type": "string", "example": "b225e278-8b4c-4f99-a696-8facf19f0e56" }, + "agent_created": { + "description": "Whether the artifact has been created by the agent.", + "type": "boolean", + "example": false + }, "file_name": { "description": "Filename of the artifact.", "type": "string", @@ -810,6 +839,7 @@ }, "required": [ "artifact_id", + "agent_created", "file_name" ] }, @@ -906,6 +936,11 @@ "type": "string", "example": "b225e278-8b4c-4f99-a696-8facf19f0e56" }, + "agent_created": { + "description": "Whether the artifact has been created by the agent.", + "type": "boolean", + "example": false + }, "file_name": { "description": "Filename of the artifact.", "type": "string", @@ -920,6 +955,7 @@ }, "required": [ "artifact_id", + "agent_created", "file_name" ] } @@ -1051,6 +1087,11 @@ "type": "string", "example": "b225e278-8b4c-4f99-a696-8facf19f0e56" }, + "agent_created": { + "description": "Whether the artifact has been created by the agent.", + "type": "boolean", + "example": false + }, "file_name": { "description": "Filename of the artifact.", "type": "string", @@ -1065,6 +1106,7 @@ }, "required": [ "artifact_id", + "agent_created", "file_name" ] }, @@ -1084,6 +1126,11 @@ "type": "string", "example": "b225e278-8b4c-4f99-a696-8facf19f0e56" }, + "agent_created": { + "description": "Whether the artifact has been created by the agent.", + "type": "boolean", + "example": false + }, "file_name": { "description": "Filename of the artifact.", "type": "string", @@ -1098,6 +1145,7 @@ }, "required": [ "artifact_id", + "agent_created", "file_name" ] }, @@ -1192,6 +1240,11 @@ "type": "string", "example": "b225e278-8b4c-4f99-a696-8facf19f0e56" }, + "agent_created": { + "description": "Whether the artifact has been created by the agent.", + "type": "boolean", + "example": false + }, "file_name": { "description": "Filename of the artifact.", "type": "string", @@ -1206,6 +1259,7 @@ }, "required": [ "artifact_id", + "agent_created", "file_name" ] }, @@ -1312,6 +1366,11 @@ "type": "string", "example": "b225e278-8b4c-4f99-a696-8facf19f0e56" }, + "agent_created": { + "description": "Whether the artifact has been created by the agent.", + "type": "boolean", + "example": false + }, "file_name": { "description": "Filename of the artifact.", "type": "string", @@ -1326,6 +1385,7 @@ }, "required": [ "artifact_id", + "agent_created", "file_name" ] }, diff --git a/schemas/openapi.yml b/schemas/openapi.yml index 46bfc9a..3248e97 100644 --- a/schemas/openapi.yml +++ b/schemas/openapi.yml @@ -311,6 +311,10 @@ components: description: ID of the artifact. type: string example: b225e278-8b4c-4f99-a696-8facf19f0e56 + agent_created: + description: Whether the artifact has been created by the agent. + type: boolean + example: false file_name: description: Filename of the artifact. type: string @@ -322,6 +326,7 @@ components: nullable: true required: - artifact_id + - agent_created - file_name ArtifactUpload: description: Artifact to upload to the agent.