Skip to content

fix: editor agent schema typo #163

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
eloy-encord wants to merge 3 commits into
base: main
Choose a base branch
from
Open

fix: editor agent schema typo #163

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
807fea7
fix: editor agent schema typo
eloy-encord May 27, 2025
77f6110
Merge branch 'main' into eloy/fix-editor-agent-schema-typo
eloy-encord May 27, 2025
0a4e856
misc: update phrase to be clearer
eloy-encord May 27, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 2 additions & 4 deletions docs/editor_agents/spec.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ type EditorAgentPayload = {
};
```

This aligns with the [FrameData](../reference/core.md#encord_agents.core.data_model.FrameData). Notably we use the `objectHashes: string[]` type to represent that the field is either **not present** or **present and a list of strings**.
This aligns with the [FrameData](../reference/core.md#encord_agents.core.data_model.FrameData) class. Notably we use the `objectHashes?: string[]` type to represent that the field is either **missing** or **contains a list of strings**.

### Test Payload

Expand All @@ -29,12 +29,10 @@ You can raise an `EncordEditorAgentException` which will be handled and returned

Additionally in the event of an Authorisation issue with the Encord platform e.g., A request attempting to access a project that the agent doesn't have access too, then we will additionally include the Authorisation message in the body of the response.



```typescript
type EditorAgentErrorResponse = {
message?: string;
}
```

We will display this in the platform to allow intuitive usage of your agent.
We will display this on the platform to allow intuitive usage of your agent.