@ohos-ports/genkit 1.42.0-beta.0

package/src/context.ts

@@ -0,0 +1,37 @@
+/**
+ * @license
+ *
+ * Copyright 2024 Google LLC
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+/**
+ * Request context utilities — API key helpers, context providers, and
+ * request data types for authenticated and context-aware flows.
+ *
+ * ```ts
+ * import { apiKey, type ContextProvider } from 'genkit/context';
+ * ```
+ *
+ * @module context
+ */
+
+export {
+  apiKey,
+  getCallableJSON,
+  getHttpStatus,
+  type ApiKeyContext,
+  type ContextProvider,
+  type RequestData,
+} from '@genkit-ai/core';

package/src/embedder.ts

@@ -0,0 +1,41 @@
+/**
+ * @license
+ *
+ * Copyright 2024 Google LLC
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+/**
+ * Embedder types — reference helpers, schemas, and action types for building
+ * embedding model plugins.
+ *
+ * ```ts
+ * import { embedderRef, type EmbedderAction } from 'genkit/embedder';
+ * ```
+ *
+ * @module embedder
+ */
+
+export {
+  EmbedderInfoSchema,
+  embedderRef,
+  type EmbedRequest,
+  type EmbedderAction,
+  type EmbedderArgument,
+  type EmbedderInfo,
+  type EmbedderParams,
+  type EmbedderReference,
+  type Embedding,
+  type EmbeddingBatch,
+} from '@genkit-ai/ai/embedder';

package/src/evaluator.ts

@@ -0,0 +1,50 @@
+/**
+ * @license
+ *
+ * Copyright 2024 Google LLC
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+/**
+ * Evaluator types — schemas, reference helpers, and action types for building
+ * AI output quality evaluators.
+ *
+ * ```ts
+ * import { evaluatorRef, type EvalResponse } from 'genkit/evaluator';
+ * ```
+ *
+ * @module evaluator
+ */
+
+export {
+  BaseDataPointSchema,
+  BaseEvalDataPointSchema,
+  EvalResponseSchema,
+  EvalResponsesSchema,
+  EvalStatusEnum,
+  EvaluatorInfoSchema,
+  ScoreSchema,
+  evaluatorRef,
+  type BaseDataPoint,
+  type BaseEvalDataPoint,
+  type Dataset,
+  type EvalResponse,
+  type EvalResponses,
+  type EvaluatorAction,
+  type EvaluatorArgument,
+  type EvaluatorInfo,
+  type EvaluatorParams,
+  type EvaluatorReference,
+  type Score,
+} from '@genkit-ai/ai/evaluator';

package/src/extract.ts

@@ -0,0 +1,30 @@
+/**
+ * @license
+ *
+ * Copyright 2024 Google LLC
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+/**
+ * Extraction utilities — helpers for extracting structured JSON from model
+ * output, including partial JSON parsing for streaming.
+ *
+ * ```ts
+ * import { extractJson, parsePartialJson } from 'genkit/extract';
+ * ```
+ *
+ * @module extract
+ */
+
+export { extractJson, parsePartialJson } from '@genkit-ai/ai/extract';

package/src/formats.ts

@@ -0,0 +1,30 @@
+/**
+ * @license
+ *
+ * Copyright 2024 Google LLC
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+/**
+ * Output format types — `Formatter` and `FormatArgument` interfaces used when
+ * defining custom output formats for model generation.
+ *
+ * ```ts
+ * import type { Formatter, FormatArgument } from 'genkit/formats';
+ * ```
+ *
+ * @module formats
+ */
+
+export type { FormatArgument, Formatter } from '@genkit-ai/ai/formats';

package/src/genkit-beta.ts

@@ -0,0 +1,275 @@
+/**
+ * Copyright 2025 Google LLC
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+import {
+  GenerateOptions,
+  GenerateResponseData,
+  GenerationCommonConfigSchema,
+  SessionRunner,
+  defineAgent,
+  defineCustomAgent,
+  defineInterrupt,
+  definePromptAgent,
+  defineResource,
+  generateOperation,
+  type Agent,
+  type AgentConfig,
+  type AgentFn,
+  type AgentStreamChunk,
+  type ClientTransform,
+  type InterruptConfig,
+  type PromptConfig,
+  type ResourceAction,
+  type ResourceFn,
+  type ResourceOptions,
+  type ToolAction,
+} from '@genkit-ai/ai';
+
+import { defineFormat } from '@genkit-ai/ai/formats';
+
+import {
+  type SessionSnapshot,
+  type SessionSnapshotInput,
+  type SessionState,
+  type SessionStore,
+  type SessionStoreOptions,
+  type SnapshotMutator,
+} from '@genkit-ai/ai/session';
+import {
+  FileSessionStore,
+  InMemorySessionStore,
+} from '@genkit-ai/ai/session-stores';
+
+import { applyPatch, diff } from '@genkit-ai/ai/json-patch';
+import { type Operation, type z } from '@genkit-ai/core';
+import type { Formatter } from './formats.js';
+import { Genkit, type GenkitOptions } from './genkit.js';
+
+export type { JsonPatch, JsonPatchOperation } from '@genkit-ai/ai/json-patch';
+export {
+  FileSessionStore,
+  InMemorySessionStore,
+  SessionRunner,
+  applyPatch,
+  diff,
+};
+export type {
+  Agent,
+  AgentFn,
+  AgentStreamChunk,
+  ClientTransform,
+  GenkitOptions as GenkitBetaOptions,
+  PromptConfig,
+  SessionSnapshot,
+  SessionSnapshotInput,
+  SessionState,
+  SessionStore,
+  SessionStoreOptions,
+  SnapshotMutator,
+};
+
+/**
+ * WARNING: these APIs are considered unstable and subject to frequent breaking changes that may not honor semver.
+ *
+ * Initializes Genkit BETA APIs with a set of options.
+ *
+ * This will create a new Genkit registry, register the provided plugins, stores, and other configuration. This
+ * should be called before any flows are registered.
+ *
+ * @beta
+ */
+export function genkit(options: GenkitOptions): GenkitBeta {
+  return new GenkitBeta(options);
+}
+
+/**
+ * Genkit BETA APIs.
+ *
+ * @beta
+ */
+export class GenkitBeta extends Genkit {
+  constructor(options?: GenkitOptions) {
+    super(options);
+    this.registry.apiStability = 'beta';
+  }
+
+  /**
+   * Defines and registers a custom agent with a custom handler function.
+   *
+   * @beta
+   */
+  defineCustomAgent<State = unknown>(
+    config: {
+      name: string;
+      description?: string;
+      stateSchema?: z.ZodType<State>;
+      store?: SessionStore<State>;
+    },
+    fn: AgentFn<State>
+  ) {
+    return defineCustomAgent<State>(this.registry, config, fn);
+  }
+
+  /**
+   * Defines and registers an agent from an existing Prompt template.
+   *
+   * @beta
+   */
+  definePromptAgent<
+    State = unknown,
+    I extends z.ZodTypeAny = z.ZodTypeAny,
+  >(config: {
+    promptName: string;
+    /**
+     * Input values for the referenced prompt's input variables. Lets a single
+     * prompt be reused/customized across multiple agents.
+     */
+    promptInput?: z.infer<I>;
+    stateSchema?: z.ZodType<State>;
+    store?: SessionStore<State>;
+  }) {
+    return definePromptAgent<State, I>(this.registry, config);
+  }
+
+  /**
+   * Defines and registers an agent by creating a prompt and wiring it into a
+   * multi-turn agent in one step.
+   *
+   * This is a convenience shortcut that combines `definePrompt` and
+   * `definePromptAgent` into a single call.
+   *
+   * ```ts
+   * const myAgent = ai.defineAgent({
+   *   name: 'myAgent',
+   *   model: 'googleai/gemini-2.5-flash',
+   *   system: 'Talk like a pirate.',
+   *   tools: [weatherTool],
+   *   store: new FileSessionStore('./.snapshots'),
+   * });
+   * ```
+   *
+   * @beta
+   */
+  defineAgent<State = unknown, I extends z.ZodTypeAny = z.ZodTypeAny>(
+    config: AgentConfig<State, I>
+  ) {
+    return defineAgent<State, I>(this.registry, config);
+  }
+
+  /**
+   * Defines and registers a custom model output formatter.
+   *
+   * Here's an example of a custom JSON output formatter:
+   *
+   * ```ts
+   * import { extractJson } from 'genkit/extract';
+   *
+   * ai.defineFormat(
+   *   { name: 'customJson' },
+   *   (schema) => {
+   *     let instructions: string | undefined;
+   *     if (schema) {
+   *       instructions = `Output should be in JSON format and conform to the following schema:
+   * \`\`\`
+   * ${JSON.stringify(schema)}
+   * \`\`\`
+   * `;
+   *     }
+   *     return {
+   *       parseChunk: (chunk) => extractJson(chunk.accumulatedText),
+   *       parseMessage: (message) => extractJson(message.text),
+   *       instructions,
+   *     };
+   *   }
+   * );
+   *
+   * const { output } = await ai.generate({
+   *   prompt: 'Invent a menu item for a pirate themed restaurant.',
+   *   output: { format: 'customJson', schema: MenuItemSchema },
+   * });
+   * ```
+   *
+   * @beta
+   */
+  defineFormat(
+    options: {
+      name: string;
+    } & Formatter['config'],
+    handler: Formatter['handler']
+  ): { config: Formatter['config']; handler: Formatter['handler'] } {
+    return defineFormat(this.registry, options, handler);
+  }
+
+  /**
+   * Defines and registers an interrupt.
+   *
+   * Interrupts are special tools that halt model processing and return control back to the caller. Interrupts make it simpler to implement
+   * "human-in-the-loop" and out-of-band processing patterns that require waiting on external actions to complete.
+   *
+   * @beta
+   */
+  defineInterrupt<I extends z.ZodTypeAny, O extends z.ZodTypeAny>(
+    config: InterruptConfig<I, O>
+  ): ToolAction<I, O> {
+    return defineInterrupt(this.registry, config);
+  }
+
+  /**
+   * Starts a generate operation for long running generation models, typically for
+   * video and complex audio generation.
+   *
+   * See {@link GenerateOptions} for detailed information about available options.
+   *
+   * ```ts
+   * const operation = await ai.generateOperation({
+   *   model: googleAI.model('veo-3.1-generate-preview'),
+   *   prompt: 'A banana riding a bicycle.',
+   * });
+   * ```
+   *
+   * The status of the operation and final result can be obtained using {@link Genkit.checkOperation}.
+   */
+  generateOperation<
+    O extends z.ZodTypeAny = z.ZodTypeAny,
+    CustomOptions extends z.ZodTypeAny = typeof GenerationCommonConfigSchema,
+  >(
+    opts:
+      | GenerateOptions<O, CustomOptions>
+      | PromiseLike<GenerateOptions<O, CustomOptions>>
+  ): Promise<Operation<GenerateResponseData>> {
+    return generateOperation(this.registry, opts);
+  }
+
+  /**
+   * Defines a resource. Resources can then be accessed from a generate call.
+   *
+   * ```ts
+   * ai.defineResource({
+   *   uri: 'my://resource/{param}',
+   *   description: 'provides my resource',
+   * }, async ({param}) => {
+   *   return [{ text: `resource ${param}` }]
+   * });
+   *
+   * await ai.generate({
+   *   prompt: [{ resource: 'my://resource/value' }]
+   * })
+   * ```
+   */
+  defineResource(opts: ResourceOptions, fn: ResourceFn): ResourceAction {
+    return defineResource(this.registry, opts, fn);
+  }
+}