Skip to content

Upload restructured AI docs#8345

Merged
anbuzin merged 9 commits intonew-gel-docsfrom
new-ai-docs
Feb 19, 2025
Merged

Upload restructured AI docs#8345
anbuzin merged 9 commits intonew-gel-docsfrom
new-ai-docs

Conversation

@anbuzin
Copy link
Contributor

@anbuzin anbuzin commented Feb 18, 2025

No description provided.

@gel-data-cla
Copy link

gel-data-cla bot commented Feb 18, 2025

All commit authors signed the Contributor License Agreement.
CLA signed

@github-actions
Copy link

github-actions bot commented Feb 18, 2025

Docs preview deploy

✅ Successfully deployed docs preview for commit a267b3a:

https://edgedb-docs-k7qcnylht-edgedb.vercel.app

(Last updated: Feb 19, 2025, 12:54:35 UTC)

Comment on lines +251 to +255
If you'd like to build something on your own, make sure to check out the
Reference manual in order to learn the details about using different APIs and
models, configuring prompts or using the UI. Make sure to also check out the
Gel AI bindings in Python and JavaScript if those languages are relevant to
you.
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 add links to the reference and other guides


.. edb:split-section::

In this section we'll use |Gel|'s built-in vector search and
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 add some intro to the flashcard app - links to the quickstart, repo, etc.



.. code-block:: sdl
:caption: dbschema/default.gel
Copy link
Contributor

Choose a reason for hiding this comment

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

We just changed this btw to be a multi exclusive link from Deck -> Card.

"text-embedding-3-small",
)

+ gel_client.query(
Copy link
Contributor

Choose a reason for hiding this comment

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

Can we show what a response would look like here?

accurate results at the cost of time and resource usage when building the
index. Default: ``100``

* ``dimensions``: int64 (Optional) - Embedding dimensions
Copy link
Contributor

Choose a reason for hiding this comment

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

Is there a default here?

* ``OpenAI``
* ``Anthropic``

ext::ai::ProviderConfig
Copy link
Contributor

Choose a reason for hiding this comment

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

This can be in a follow-up PR, but we should show what custom providers look like somewhere.

Comment on lines +36 to +41
{
"model": string, // Required: Name of the embedding model
"inputs": string[], // Required: Array of texts to embed
"dimensions": number, // Optional: Number of dimensions to truncate to
"user": string // Optional: User identifier
}
Copy link
Contributor

Choose a reason for hiding this comment

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

I don't think we do a syntax check pass on JSON, but this isn't valid JSON, so if someone copy-pasted it, it wouldn't work.

Maybe you're meaning to use TypeScript to define this interface? I personally wouldn't bother doing that, and instead just list the properties like you do below.

AI client classes
-----------------

Core classes
Copy link
Contributor

Choose a reason for hiding this comment

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

Didn't we recently rename these classes?

anbuzin and others added 7 commits February 19, 2025 12:25
Co-authored-by: Scott Trinh <scott@edgedb.com>
Co-authored-by: Scott Trinh <scott@edgedb.com>
Co-authored-by: Scott Trinh <scott@edgedb.com>
- Convert type descriptions to blocks
- Fill in UI section
@anbuzin anbuzin marked this pull request as ready for review February 19, 2025 19:23
@anbuzin anbuzin merged commit 1fed084 into new-gel-docs Feb 19, 2025
20 of 25 checks passed
@anbuzin anbuzin deleted the new-ai-docs branch February 19, 2025 19:24
1st1 pushed a commit that referenced this pull request Feb 21, 2025
Co-authored-by: Scott Trinh <scott@edgedb.com>
1st1 pushed a commit that referenced this pull request Feb 21, 2025
Co-authored-by: Scott Trinh <scott@edgedb.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants