Skip to content
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.

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

docs: assistant spec #707

Merged
merged 3 commits into from
Nov 24, 2023
Merged

docs: assistant spec #707

merged 3 commits into from
Nov 24, 2023

Conversation

hiro-v
Copy link
Contributor

@hiro-v hiro-v commented Nov 24, 2023

No description provided.

@hiro-v hiro-v added P1: important Important feature / fix type: discussion Opening up a discussion type: documentation Improvements or additions to documentation labels Nov 24, 2023
@hiro-v hiro-v added this to the v0.4.0 milestone Nov 24, 2023
@hiro-v hiro-v requested a review from a team November 24, 2023 00:12
@hiro-v hiro-v self-assigned this Nov 24, 2023
@hiro-v hiro-v marked this pull request as draft November 24, 2023 00:12
Copy link
Contributor

github-actions bot commented Nov 24, 2023

Preview URL: https://06c1f680.jan-qn8.pages.dev

@hiro-v hiro-v changed the title fix(spec): Update assistant spec v1 [WIP] Update assistant spec v1 Nov 24, 2023
@0xSage 0xSage marked this pull request as ready for review November 24, 2023 09:22

### Example
- Jan Assistant json
TBU
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

?

/jan
/models/
/threads/
threads-1/ # jan
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

what is folder naming scheme? threads unix timestamp? or just enumeration (not optimal)

@@ -25,34 25,84 @@ _Users can configure assistant settings_
- `assistant.json`
> OpenAI Equivalen: https://platform.openai.com/docs/api-reference/assistants/object

// KIV
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Let's put KIV / v2 v3 items in a github issue, not the spec itself

@@ -16,7 16,7 @@ _Users can import an assistant from local directory_

- Wireframes here

_Users can configure assistant settings_
_Users can configure assistant settings_

- Wireframes here
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Remove these comments. Please see the latest spec/models, spec/threads for a cleaned up format that should be pushed to public site.

// If model is specified, then use the below
// omitted means default
"models": [
{ "model_id": "", ..., "parameters": {} }
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

is itmodel_id or id? It's the nested model object right?

"out": ["assistant:asst_abc123", "jan:*"]
},
// Alternate: Simplified version?
"events": "*",
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Did we mention in the call to leave this out of current spec? Lets move to github issue to track this better :)

/src
index.js
process.js
/threads # if developer specifies
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

omit from current spec please.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Lets create an issue to track it instead

@0xSage 0xSage changed the title [WIP] Update assistant spec v1 docs: assistant spec Nov 24, 2023
@0xSage 0xSage merged commit 77f20db into main Nov 24, 2023
1 check failed
@0xSage 0xSage deleted the fix/spec_assistants_v1 branch November 24, 2023 09:23
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
P1: important Important feature / fix type: discussion Opening up a discussion type: documentation Improvements or additions to documentation
Projects
Archived in project
Development

Successfully merging this pull request may close these issues.

None yet

2 participants