Open estreeper opened 4 months ago
Copying in this comment I left in Slack:
I've noticed that in a lot of the docs I'm writing (I'm working on a documentation chatbot right now) the hardest part of the instructions are on how to add the prompt template. I also had to add instructions on creating the Artifact Type and on creating a Collection and adding Data Sources/Documents to it. The last one is probably not such a big deal, because it's probably easier to use a GUI than an API, but adding the Artifact Type and the Prompt Template via the API would be really nice and IMO higher priority. For many of these endpoints, we could also definitely infer a lot of this data. We talked about the artifact_slug, but for instance project_id probably can be as well. For instance, we could go from:
iex> ProdopsEx.Artifact.create(%{
...> prompt_template_id: 2,
...> artifact_slug: "story",
...> project_id: 1,
...> inputs: [
...> %{name: "Context", value: "this is a test"}
...> ]
...> })
to:
iex> ProdopsEx.Artifact.create(%{
...> prompt_template_id: 2,
...> inputs: [
...> %{name: "Context", value: "this is a test"}
...> ]
...> })
We should know which project a prompt_template_id belongs to on the backend. I'm also seeing an issue where I don't think document queries are getting hydrated via API, but I'll need to look into it a bit more
API V2/V3 Proposed Changes:
Goal here is to allow users to use the SDK/API without the need to ever visit the front end (other than initial account creation)
Background
Determine API modifications needed to support version 2 of the ProdOps SDK.
Acceptance Criteria
Scenario: Identify API changes for ProdOps-SDK-Elixir V2
[ ] And create a comprehensive list of tasks for updating the API to meet V2 standards.
created by jackson.oberkirch+prodops@revelry.co using Prodops