Skip to content
Closed
Show file tree
Hide file tree
Changes from all commits
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
4 changes: 2 additions & 2 deletions .github/workflows/bump-cli-version.yml
Original file line number Diff line number Diff line change
Expand Up @@ -48,8 +48,8 @@ jobs:
PACKAGEJSON_DIR: genkit-tools/common
with:
default: ${{ inputs.releaseType }}
commit-message: 'chore: bump @genkit-ai/tools-common version to {{version}}'
tag-prefix: '@genkit-ai/tools-common@'
commit-message: 'chore: bump @genkit/tools-common version to {{version}}'
tag-prefix: '@genkit/tools-common@'
- name: 'genkit-tools/cli version bump'
uses: 'phips28/gh-action-bump-version@master'
env:
Expand Down
28 changes: 14 additions & 14 deletions .github/workflows/bump-js-plugins-version.yml
Original file line number Diff line number Diff line change
Expand Up @@ -55,53 +55,53 @@ jobs:
PACKAGEJSON_DIR: js/plugins/dev-local-vectorstore
with:
default: ${{ inputs.releaseType }}
commit-message: 'chore: bump @genkit-ai/dev-local-vectorstore version to {{version}}'
tag-prefix: '@genkit-ai/dev-local-vectorstore@'
commit-message: 'chore: bump @genkit/dev-local-vectorstore version to {{version}}'
tag-prefix: '@genkit/dev-local-vectorstore@'
- name: 'js/plugins/dotprompt version bump'
uses: 'phips28/gh-action-bump-version@master'
env:
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
PACKAGEJSON_DIR: js/plugins/dotprompt
with:
default: ${{ inputs.releaseType }}
commit-message: 'chore: bump @genkit-ai/dotprompt version to {{version}}'
tag-prefix: '@genkit-ai/dotprompt@'
commit-message: 'chore: bump @genkit/dotprompt version to {{version}}'
tag-prefix: '@genkit/dotprompt@'
- name: 'js/plugins/evaluator version bump'
uses: 'phips28/gh-action-bump-version@master'
env:
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
PACKAGEJSON_DIR: js/plugins/evaluator
with:
default: ${{ inputs.releaseType }}
commit-message: 'chore: bump @genkit-ai/evaluator version to {{version}}'
tag-prefix: '@genkit-ai/evaluator@'
commit-message: 'chore: bump @genkit/evaluator version to {{version}}'
tag-prefix: '@genkit/evaluator@'
- name: 'js/plugins/firebase version bump'
uses: 'phips28/gh-action-bump-version@master'
env:
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
PACKAGEJSON_DIR: js/plugins/firebase
with:
default: ${{ inputs.releaseType }}
commit-message: 'chore: bump @genkit-ai/firebase version to {{version}}'
tag-prefix: '@genkit-ai/firebase@'
commit-message: 'chore: bump @genkit/firebase version to {{version}}'
tag-prefix: '@genkit/firebase@'
- name: 'js/plugins/google-cloud version bump'
uses: 'phips28/gh-action-bump-version@master'
env:
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
PACKAGEJSON_DIR: js/plugins/google-cloud
with:
default: ${{ inputs.releaseType }}
commit-message: 'chore: bump @genkit-ai/google-cloud version to {{version}}'
tag-prefix: '@genkit-ai/google-cloud@'
commit-message: 'chore: bump @genkit/google-cloud version to {{version}}'
tag-prefix: '@genkit/google-cloud@'
- name: 'js/plugins/googleai version bump'
uses: 'phips28/gh-action-bump-version@master'
env:
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
PACKAGEJSON_DIR: js/plugins/googleai
with:
default: ${{ inputs.releaseType }}
commit-message: 'chore: bump @genkit-ai/googleai version to {{version}}'
tag-prefix: '@genkit-ai/googleai@'
commit-message: 'chore: bump @genkit/googleai version to {{version}}'
tag-prefix: '@genkit/googleai@'
- name: 'js/plugins/langchain version bump'
uses: 'phips28/gh-action-bump-version@master'
env:
Expand Down Expand Up @@ -136,5 +136,5 @@ jobs:
PACKAGEJSON_DIR: js/plugins/vertexai
with:
default: ${{ inputs.releaseType }}
commit-message: 'chore: bump @genkit-ai/vertexai version to {{version}}'
tag-prefix: '@genkit-ai/vertexai@'
commit-message: 'chore: bump @genkit/vertexai version to {{version}}'
tag-prefix: '@genkit/vertexai@'
12 changes: 6 additions & 6 deletions .github/workflows/bump-js-version.yml
Original file line number Diff line number Diff line change
Expand Up @@ -46,23 +46,23 @@ jobs:
PACKAGEJSON_DIR: js/core
with:
default: ${{ inputs.releaseType }}
commit-message: 'chore: bump @genkit-ai/tools-core version to {{version}}'
tag-prefix: '@genkit-ai/core@'
commit-message: 'chore: bump @genkit/tools-core version to {{version}}'
tag-prefix: '@genkit/core@'
- name: 'js/ai version bump'
uses: 'phips28/gh-action-bump-version@master'
env:
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
PACKAGEJSON_DIR: js/ai
with:
default: ${{ inputs.releaseType }}
commit-message: 'chore: bump @genkit-ai/ai version to {{version}}'
tag-prefix: '@genkit-ai/ai@'
commit-message: 'chore: bump @genkit/ai version to {{version}}'
tag-prefix: '@genkit/ai@'
- name: 'js/flow version bump'
uses: 'phips28/gh-action-bump-version@master'
env:
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
PACKAGEJSON_DIR: js/flow
with:
default: ${{ inputs.releaseType }}
commit-message: 'chore: bump @genkit-ai/flow version to {{version}}'
tag-prefix: '@genkit-ai/flow@'
commit-message: 'chore: bump @genkit/flow version to {{version}}'
tag-prefix: '@genkit/flow@'
12 changes: 6 additions & 6 deletions docs/auth.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@ All flows can define an `authPolicy` in their config. An auth policy is a functi
If this field is set, it is executed before the flow is invoked:

```ts
import { defineFlow, runFlow } from '@genkit-ai/flow';
import { defineFlow, runFlow } from '@genkit/flow';

export const selfSummaryFlow = defineFlow(
{
Expand Down Expand Up @@ -73,7 +73,7 @@ You can also retrieve the auth context for the flow at any time within the flow
by calling `getFlowAuth()`, including in functions invoked by the flow:

```ts
import { getFlowAuth, defineFlow } from '@genkit-ai/flow';
import { getFlowAuth, defineFlow } from '@genkit/flow';

async function readDatabase(uid: string) {
if (getFlowAuth().admin) {
Expand Down Expand Up @@ -123,8 +123,8 @@ You can use Firebase Auth to protect your flows defined with `onFlow()`:
<!-- prettier-ignore: see note above -->

```ts
import {firebaseAuth} from "@genkit-ai/firebase/auth";
import {onFlow} from "@genkit-ai/firebase/functions";
import {firebaseAuth} from "@genkit/firebase/auth";
import {onFlow} from "@genkit/firebase/functions";

export const selfSummaryFlow = onFlow({
name: "selfSummaryFlow",
Expand Down Expand Up @@ -176,7 +176,7 @@ indicate to the library that you are forgoing authorization checks by using the
<!-- prettier-ignore: see note above -->

```ts
import {onFlow, noAuth} from "@genkit-ai/firebase/functions";
import {onFlow, noAuth} from "@genkit/firebase/functions";

export const selfSummaryFlow = onFlow({
name: "selfSummaryFlow",
Expand All @@ -199,7 +199,7 @@ the following configuration options to your `onFlow()`:
<!-- prettier-ignore: see note above -->

```ts
import {onFlow} from "@genkit-ai/firebase/functions";
import {onFlow} from "@genkit/firebase/functions";

export const selfSummaryFlow = onFlow({
name: "selfSummaryFlow",
Expand Down
14 changes: 7 additions & 7 deletions docs/dotprompt.md
Original file line number Diff line number Diff line change
Expand Up @@ -33,10 +33,10 @@ Greet a guest{{#if name}} named {{name}}{{/if}}{{#if style}} in the style of {{s
```

To use this prompt, install the `dotprompt` plugin, and import the `promptRef` function from
the `@genkit-ai/dotprompt` library:
the `@genkit/dotprompt` library:

```ts
import { dotprompt, promptRef } from '@genkit-ai/dotprompt';
import { dotprompt, promptRef } from '@genkit/dotprompt';

configureGenkit({ plugins: [dotprompt()] });
```
Expand Down Expand Up @@ -148,7 +148,7 @@ In addition to directly defining schemas in the `.prompt` file, you can referenc
a schema registered with `defineSchema` by name. To register a schema:

```ts
import { defineSchema } from '@genkit-ai/core';
import { defineSchema } from '@genkit/core';
import { z } from 'zod';

const MySchema = defineSchema(
Expand Down Expand Up @@ -176,7 +176,7 @@ registered Zod schema. You can then utilize the schema to strongly type the
output of a Dotprompt:

```ts
import { promptRef } from "@genkit-ai/dotprompt";
import { promptRef } from "@genkit/dotprompt";

const myPrompt = promptRef("myPrompt");

Expand Down Expand Up @@ -397,7 +397,7 @@ Help the user decide between these vacation destinations:
You may also define partials in code using `definePartial`:

```ts
import { definePartial } from '@genkit-ai/dotprompt';
import { definePartial } from '@genkit/dotprompt';

definePartial(
'personality',
Expand Down Expand Up @@ -438,7 +438,7 @@ You can define custom helpers to process and manage data inside of a prompt. Hel
are registered globally using `defineHelper`:

```ts
import { defineHelper } from '@genkit-ai/dotprompt';
import { defineHelper } from '@genkit/dotprompt';

defineHelper('shout', (text: string) => text.toUpperCase());
```
Expand Down Expand Up @@ -476,7 +476,7 @@ import {
loadPromptFile,
loadPromptUrl,
defineDotprompt,
} from '@genkit-ai/dotprompt';
} from '@genkit/dotprompt';
import path from 'path';
import { z } from 'zod';

Expand Down
8 changes: 4 additions & 4 deletions docs/durable-flows.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ they are specifically designed for long-running background operations.
Here's an example:

```js
import { onScheduledFlow } from '@genkit-ai/firebase/functions/experimental';
import { onScheduledFlow } from '@genkit/firebase/functions/experimental';

export const jokeFlow = onScheduledFlow(
{ name: 'jokeFlow', inputSchema: z.string(), outputSchema: z.string() },
Expand Down Expand Up @@ -189,7 +189,7 @@ export const myFlow = onScheduledFlow(
To resume the interrupted flow:

```js
// import { resumeFlow } from '@genkit-ai/flow/experimental';
// import { resumeFlow } from '@genkit/flow/experimental';
await resumeFlow(myFlow, flowId, {
approve: false,
});
Expand All @@ -200,7 +200,7 @@ need to be careful to rethrow the error when wrapping the `interrupt` step in
`try`-`catch`.

```js
import { InterruptError } from '@genkit-ai/flow/experimental';
import { InterruptError } from '@genkit/flow/experimental';

export const myFlow = onScheduledFlow(
{ name: 'myFlow', outputSchema: z.boolean() },
Expand Down Expand Up @@ -302,7 +302,7 @@ export const myFlow = onScheduledFlow(
Use `getFlowState()` to retrieve a flow's current state:

```javascript
// import { getFlowState } from '@genkit-ai/flow/experimental';
// import { getFlowState } from '@genkit/flow/experimental';

const operation = await scheduleFlow(jokeFlow, 'banana');
console.log('Operation', operation);
Expand Down
8 changes: 4 additions & 4 deletions docs/evaluation.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,8 +10,8 @@ of documents that was returned by the retriever so that you can evaluate the
quality of your retriever while it runs in the context of the flow as shown below with the Genkit faithfulness and answer relevancy metrics:

```js
import { GenkitMetric, genkitEval } from '@genkit-ai/evaluator';
import { textEmbeddingGecko } from '@genkit-ai/vertexai';
import { GenkitMetric, genkitEval } from '@genkit/evaluator';
import { textEmbeddingGecko } from '@genkit/vertexai';

export default configureGenkit({
plugins: [
Expand All @@ -25,10 +25,10 @@ export default configureGenkit({
});
```

Note: The configuration above requires installing the `@genkit-ai/evaluator` and `@genkit-ai/vertexai` packages.
Note: The configuration above requires installing the `@genkit/evaluator` and `@genkit/vertexai` packages.

```posix-terminal
npm install @genkit-ai/evaluator @genkit-ai/vertexai
npm install @genkit/evaluator @genkit/vertexai
```

Start by defining a set of inputs that you want to use as an input dataset called `testInputs.json`. This input dataset represents the test cases you will use to generate output for evaluation.
Expand Down
14 changes: 7 additions & 7 deletions docs/flows.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ Firebase Genkit provides CLI and Developer UI tooling for working with flows
## Defining flows

```javascript
import { defineFlow } from '@genkit-ai/flow';
import { defineFlow } from '@genkit/flow';

export const menuSuggestionFlow = defineFlow(
{
Expand All @@ -25,7 +25,7 @@ export const menuSuggestionFlow = defineFlow(
Input and output schemas for flows can be defined using `zod`.

```javascript
import { defineFlow } from '@genkit-ai/flow';
import { defineFlow } from '@genkit/flow';
import * as z from 'zod';

export const menuSuggestionFlow = defineFlow(
Expand Down Expand Up @@ -113,8 +113,8 @@ observability).
To use flows with Cloud Functions for Firebase use the `firebase` plugin, replace `defineFlow` with `onFlow` and include an `authPolicy`.

```js
import { onFlow } from '@genkit-ai/firebase/functions';
import { firebaseAuth } from '@genkit-ai/firebase/auth';
import { onFlow } from '@genkit/firebase/functions';
import { firebaseAuth } from '@genkit/firebase/auth';

export const menuSuggestionFlow = onFlow(
{
Expand All @@ -136,7 +136,7 @@ export const menuSuggestionFlow = onFlow(
To deploy flows using Cloud Run and similar services, define your flows using `defineFlow` and then call `startFlowsServer()`:

```js
import { defineFlow, startFlowsServer } from '@genkit-ai/flow';
import { defineFlow, startFlowsServer } from '@genkit/flow';

export const menuSuggestionFlow = defineFlow(
{
Expand All @@ -155,7 +155,7 @@ By default `startFlowsServer` will serve all the flows that you have defined in
You can choose which flows are exposed via the flows server. You can specify a custom port (it will use the `PORT` environment variable if set). You can also set CORS settings.

```js
import { defineFlow, startFlowsServer } from '@genkit-ai/flow';
import { defineFlow, startFlowsServer } from '@genkit/flow';

export const flowA = defineFlow({ name: 'flowA' }, async (subject) => {
// ....
Expand All @@ -179,7 +179,7 @@ startFlowsServer({
Sometimes when using 3rd party SDKs that that are not instrumented for observability, you might want to see them as a separate trace step in the Developer UI. All you need to do is wrap the code in the `run` function.

```js
import { defineFlow, run } from '@genkit-ai/flow';
import { defineFlow, run } from '@genkit/flow';

export const menuSuggestionFlow = defineFlow(
{
Expand Down
10 changes: 5 additions & 5 deletions docs/get-started.md
Original file line number Diff line number Diff line change
Expand Up @@ -88,14 +88,14 @@ so that it can be used outside of a Node project.
import * as z from 'zod';

// Import the Genkit core libraries and plugins.
import { generate } from '@genkit-ai/ai';
import { configureGenkit } from '@genkit-ai/core';
import { defineFlow, startFlowsServer } from '@genkit-ai/flow';
import { googleAI } from '@genkit-ai/googleai';
import { generate } from '@genkit/ai';
import { configureGenkit } from '@genkit/core';
import { defineFlow, startFlowsServer } from '@genkit/flow';
import { googleAI } from '@genkit/googleai';

// Import models from the Google AI plugin. The Google AI API provides access to
// several generative models. Here, we import Gemini 1.5 Flash.
import { gemini15Flash } from '@genkit-ai/googleai';
import { gemini15Flash } from '@genkit/googleai';

configureGenkit({
plugins: [
Expand Down
Loading