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

Rename toc titles to be more consistent with expected behaviors #75

Merged
merged 2 commits into from
May 8, 2024
Merged
Show file tree
Hide file tree
Changes from 1 commit
Commits
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
8 changes: 4 additions & 4 deletions docs/_guides.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -23,14 +23,14 @@ toc:
path: /docs/genkit/devtools

- heading: Building AI workflows
- title: Models
- title: Generating content
path: /docs/genkit/models
- title: Creating flows
path: /docs/genkit/flows
- title: Prompting models
path: /docs/genkit/prompts
- title: Prompt management
- title: Managing prompts
path: /docs/genkit/dotprompt
- title: Flows
path: /docs/genkit/flows
- title: Retrieval-augmented generation (RAG)
path: /docs/genkit/rag
- title: Evaluation
Expand Down
16 changes: 10 additions & 6 deletions docs/models.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,8 @@
# Models
# Generating Content

schnecle marked this conversation as resolved.
Show resolved Hide resolved
Firebase Genkit provides an easy interface for generating content with LLMs.

## Models

Models in Firebase Genkit are libraries and abstractions that provide access to
various Google and non-Google LLMs.
Expand All @@ -22,7 +26,7 @@ configureGenkit({
});
```

Also note that different plugins and models use different methods of
NOTE: Different plugins and models use different methods of
authentication. For example, Vertex API uses the Google Auth Library so it can
schnecle marked this conversation as resolved.
Show resolved Hide resolved
pull required credentials using Application Default Credentials.

Expand Down Expand Up @@ -51,7 +55,7 @@ are officially supported:

See the docs for each plugin for setup and usage information.

## Working with models
## How to generate content

`generate` is a helper function for working with models.

Expand Down Expand Up @@ -169,7 +173,7 @@ await generate({
});
```

## Retriever context
### Adding retriever context

Documents from a retriever can be passed directly to `generate` to provide
grounding context:
Expand All @@ -187,7 +191,7 @@ await generate({
The document context is automatically appended to the content of the prompt
sent to the model.

## Message history
### Recording message history

Genkit models support maintaining a history of the messages sent to the model
and its responses, which you can use to build interactive experiences, such as
Expand Down Expand Up @@ -231,7 +235,7 @@ let response = await generate({
history = response.toHistory();
```

## Streaming
### Streaming responses

Genkit supports chunked streaming of model responses via the `generateStream()` method:

Expand Down
Loading