@ohos-ports/genkit 1.42.0-beta.0

package/src/index.ts

@@ -0,0 +1,29 @@
+/**
+ * @license
+ *
+ * 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.
+ */
+
+/**
+ * Main genkit import.
+ *
+ * ```ts
+ * import { genkit } from 'genkit';
+ * ```
+ *
+ * @module /
+ */
+export * from './common.js';
+export { Genkit, genkit, type GenkitOptions } from './genkit.js';

package/src/logging.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.
+ */
+
+/**
+ * Logging utilities — the Genkit {@link logger} singleton for structured log
+ * output.
+ *
+ * ```ts
+ * import { logger } from 'genkit/logging';
+ * ```
+ *
+ * @module logging
+ */
+
+export { logger } from '@genkit-ai/core/logging';

package/src/middleware.ts

@@ -0,0 +1,38 @@
+/**
+ * @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.
+ */
+
+/**
+ * Built-in model middleware — `retry`, `fallback`, `augmentWithContext`,
+ * `validateSupport`, and other middleware for enhancing model requests.
+ *
+ * ```ts
+ * import { retry, fallback } from 'genkit/model/middleware';
+ * ```
+ *
+ * @module model/middleware
+ */
+
+export {
+  augmentWithContext,
+  downloadRequestMedia,
+  fallback,
+  retry,
+  simulateSystemPrompt,
+  validateSupport,
+  type AugmentWithContextOptions,
+} from '@genkit-ai/ai/model/middleware';

package/src/model.ts

@@ -0,0 +1,87 @@
+/**
+ * @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.
+ */
+
+/**
+ * Model types and helpers — request/response schemas, message and part types,
+ * model references, and middleware interfaces for building model plugins.
+ *
+ * ```ts
+ * import { modelRef, type ModelAction, type MessageData } from 'genkit/model';
+ * ```
+ *
+ * @module model
+ */
+
+export {
+  CandidateErrorSchema,
+  CandidateSchema,
+  CustomPartSchema,
+  DataPartSchema,
+  GenerateRequestSchema,
+  GenerateResponseChunkSchema,
+  GenerateResponseSchema,
+  GenerationCommonConfigDescriptions,
+  GenerationCommonConfigSchema,
+  GenerationUsageSchema,
+  MediaPartSchema,
+  MessageSchema,
+  ModelInfoSchema,
+  ModelRequestSchema,
+  ModelResponseSchema,
+  PartSchema,
+  RoleSchema,
+  TextPartSchema,
+  ToolDefinitionSchema,
+  ToolRequestPartSchema,
+  ToolResponsePartSchema,
+  getBasicUsageStats,
+  modelRef,
+  simulateConstrainedGeneration,
+  type BackgroundModelAction,
+  type CandidateData,
+  type CandidateError,
+  type CustomPart,
+  type DataPart,
+  type DefineBackgroundModelOptions,
+  type DefineModelOptions,
+  type GenerateRequest,
+  type GenerateRequestData,
+  type GenerateResponseChunkData,
+  type GenerateResponseData,
+  type GenerationCommonConfig,
+  type GenerationUsage,
+  type MediaPart,
+  type MessageData,
+  type ModelAction,
+  type ModelArgument,
+  type ModelInfo,
+  type ModelMiddleware,
+  type ModelMiddlewareArgument,
+  type ModelMiddlewareWithOptions,
+  type ModelReference,
+  type ModelRequest,
+  type ModelResponseChunkData,
+  type ModelResponseData,
+  type OutputConfig,
+  type Part,
+  type Role,
+  type TextPart,
+  type ToolDefinition,
+  type ToolRequestPart,
+  type ToolResponsePart,
+} from '@genkit-ai/ai/model';

package/src/plugin.ts

@@ -0,0 +1,172 @@
+/**
+ * @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.
+ */
+
+/**
+ * Plugin authoring utilities — factory functions (`model`, `embedder`,
+ * `retriever`, etc.), plugin lifecycle types, and the v1/v2 plugin
+ * interfaces for building Genkit plugins.
+ *
+ * ```ts
+ * import { model, embedder, genkitPlugin } from 'genkit/plugin';
+ * ```
+ *
+ * @module plugin
+ */
+
+import type { GenerateMiddleware } from '@genkit-ai/ai';
+import { type GenkitPluginV2 } from '@genkit-ai/ai';
+import { type ModelAction } from '@genkit-ai/ai/model';
+import {
+  GenkitError,
+  type ActionMetadata,
+  type ResolvableAction,
+} from '@genkit-ai/core';
+import type { Genkit } from './genkit.js';
+import type { ActionType } from './registry.js';
+
+export { embedder, embedderActionMetadata } from '@genkit-ai/ai/embedder';
+export { evaluator } from '@genkit-ai/ai/evaluator';
+export {
+  backgroundModel,
+  model,
+  modelActionMetadata,
+} from '@genkit-ai/ai/model';
+export { reranker } from '@genkit-ai/ai/reranker';
+export { indexer, retriever } from '@genkit-ai/ai/retriever';
+export { type GenerateMiddleware, type GenkitPluginV2, type ResolvableAction };
+
+/** A v1 plugin provider returned by a {@link GenkitPlugin} factory function. */
+export interface PluginProvider {
+  name: string;
+  initializer: () => void | Promise<void>;
+  resolver?: (action: ActionType, target: string) => Promise<void>;
+  listActions?: () => Promise<ActionMetadata[]>;
+}
+
+/** A v1 Genkit plugin factory function. Returns a {@link PluginProvider} when called with a Genkit instance. */
+export type GenkitPlugin = (genkit: Genkit) => PluginProvider;
+
+/** Initialization function called during plugin setup. */
+export type PluginInit = (genkit: Genkit) => void | Promise<void>;
+
+/** Optional resolver function for lazily-resolved plugin actions. */
+export type PluginActionResolver = (
+  genkit: Genkit,
+  action: ActionType,
+  target: string
+) => Promise<void>;
+
+/**
+ * Defines a Genkit plugin.
+ */
+export function genkitPlugin<T extends PluginInit>(
+  pluginName: string,
+  initFn: T,
+  resolveFn?: PluginActionResolver,
+  listActionsFn?: () => Promise<ActionMetadata[]>
+): GenkitPlugin {
+  return (genkit: Genkit) => ({
+    name: pluginName,
+    initializer: async () => {
+      await initFn(genkit);
+    },
+    resolver: async (action: ActionType, target: string): Promise<void> => {
+      if (resolveFn) {
+        return await resolveFn(genkit, action, target);
+      }
+    },
+    listActions: async (): Promise<ActionMetadata[]> => {
+      if (listActionsFn) {
+        return await listActionsFn();
+      }
+      return [];
+    },
+  });
+}
+
+/**
+ * Concrete implementation of a v2 plugin that wraps a {@link GenkitPluginV2} definition
+ * and provides default implementations for all optional hooks.
+ */
+export class GenkitPluginV2Instance implements Required<GenkitPluginV2> {
+  readonly version = 'v2';
+  readonly name: string;
+
+  private plugin: Omit<GenkitPluginV2, 'version' | 'model'>;
+
+  constructor(plugin: Omit<GenkitPluginV2, 'version' | 'model'>) {
+    this.name = plugin.name;
+    this.plugin = plugin;
+  }
+
+  init(): ResolvableAction[] | Promise<ResolvableAction[]> {
+    if (!this.plugin.init) {
+      return [];
+    }
+    return this.plugin.init();
+  }
+
+  list(): ActionMetadata[] | Promise<ActionMetadata[]> {
+    if (!this.plugin.list) {
+      return [];
+    }
+    return this.plugin.list();
+  }
+
+  middleware(): GenerateMiddleware<any, any>[] {
+    if (!this.plugin.middleware) {
+      return [];
+    }
+    return this.plugin.middleware();
+  }
+
+  resolve(
+    actionType: ActionType,
+    name: string
+  ): ResolvableAction | undefined | Promise<ResolvableAction | undefined> {
+    if (!this.plugin.resolve) {
+      return undefined;
+    }
+    return this.plugin.resolve(actionType, name);
+  }
+
+  async model(name: string): Promise<ModelAction> {
+    const model = await this.resolve('model', name);
+    if (!model) {
+      throw new GenkitError({
+        message: `Failed to resolve model ${name} for plugin ${this.name}`,
+        status: 'NOT_FOUND',
+      });
+    }
+    return model as ModelAction;
+  }
+}
+
+/**
+ * Creates a new v2 plugin instance from the provided options.
+ */
+export function genkitPluginV2(
+  options: Omit<GenkitPluginV2, 'version' | 'model'>
+): GenkitPluginV2Instance {
+  return new GenkitPluginV2Instance(options);
+}
+
+/** Checks whether the given plugin conforms to the v2 plugin interface. */
+export function isPluginV2(plugin: unknown): plugin is GenkitPluginV2 {
+  return (plugin as GenkitPluginV2).version === 'v2';
+}

package/src/registry.ts

@@ -0,0 +1,36 @@
+/**
+ * @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.
+ */
+
+/**
+ * Action registry internals — `Registry`, `Schema`, and related types used by
+ * plugin authors and advanced integrations.
+ *
+ * ```ts
+ * import { Registry } from 'genkit/registry';
+ * ```
+ *
+ * @module registry
+ */
+
+export {
+  Registry,
+  type ActionType,
+  type AsyncProvider,
+  type HasRegistry,
+  type Schema,
+} from '@genkit-ai/core/registry';

package/src/reranker.ts

@@ -0,0 +1,42 @@
+/**
+ * @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.
+ */
+
+/**
+ * Reranker types — `RankedDocument`, reference helpers, and schemas for
+ * building reranker plugins.
+ *
+ * ```ts
+ * import { RankedDocument, rerankerRef } from 'genkit/reranker';
+ * ```
+ *
+ * @module reranker
+ */
+
+export {
+  CommonRerankerOptionsSchema,
+  RankedDocument,
+  RankedDocumentDataSchema,
+  RerankerInfoSchema,
+  rerankerRef,
+  type RankedDocumentData,
+  type RerankerAction,
+  type RerankerArgument,
+  type RerankerInfo,
+  type RerankerParams,
+  type RerankerReference,
+} from '@genkit-ai/ai/reranker';

package/src/retriever.ts

@@ -0,0 +1,55 @@
+/**
+ * @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.
+ */
+
+/**
+ * Retriever and indexer types — `Document`, reference helpers, and schemas for
+ * building RAG (retrieval-augmented generation) plugins.
+ *
+ * ```ts
+ * import { Document, retrieverRef, indexerRef } from 'genkit/retriever';
+ * ```
+ *
+ * @module retriever
+ */
+
+export {
+  CommonRetrieverOptionsSchema,
+  Document,
+  DocumentDataSchema,
+  IndexerInfoSchema,
+  RetrieverInfoSchema,
+  indexerRef,
+  retrieverRef,
+  type DocumentData,
+  type IndexerAction,
+  type IndexerArgument,
+  type IndexerFn,
+  type IndexerInfo,
+  type IndexerParams,
+  type IndexerReference,
+  type MediaPart,
+  type Part,
+  type RetrieverAction,
+  type RetrieverArgument,
+  type RetrieverFn,
+  type RetrieverInfo,
+  type RetrieverParams,
+  type RetrieverReference,
+  type SimpleRetrieverOptions,
+  type TextPart,
+} from '@genkit-ai/ai/retriever';

package/src/schema.ts

@@ -0,0 +1,40 @@
+/**
+ * @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.
+ */
+
+/**
+ * Schema utilities — JSON Schema conversion, validation helpers, and related
+ * types for working with Zod schemas in Genkit.
+ *
+ * ```ts
+ * import { toJsonSchema, parseSchema, ValidationError } from 'genkit/schema';
+ * ```
+ *
+ * @module schema
+ */
+
+export {
+  ValidationError,
+  annotateSchema,
+  parseSchema,
+  toJsonSchema,
+  validateSchema,
+  type JSONSchema,
+  type ProvidedSchema,
+  type ValidationErrorDetail,
+  type ValidationResponse,
+} from '@genkit-ai/core/schema';

package/src/testing.ts

@@ -0,0 +1,47 @@
+/**
+ * @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.
+ */
+
+/**
+ * Testing utilities for Genkit apps and model plugins.
+ *
+ * - {@link mockModel} — a programmable mock model with typed call inspection,
+ *   for testing flows, prompts, and tools deterministically.
+ * - {@link echoModel} — a zero-config model that echoes the rendered request,
+ *   for asserting prompt/message assembly.
+ * - `testModels` — a conformance harness for model *plugin* authors.
+ *
+ * ```ts
+ * import { mockModel, echoModel, testModels } from 'genkit/testing';
+ * ```
+ *
+ * @module testing
+ */
+
+export {
+  echoModel,
+  mockModel,
+  testModels,
+  type EchoModelOptions,
+  type MockChunk,
+  type MockContext,
+  type MockModel,
+  type MockModelOptions,
+  type MockRespond,
+  type MockRespondFn,
+  type MockResponse,
+} from '@genkit-ai/ai/testing';

package/src/tool.ts

@@ -0,0 +1,40 @@
+/**
+ * @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.
+ */
+
+/**
+ * Tool types — action types, configuration, and helpers for defining tools
+ * that models can call (function calling).
+ *
+ * ```ts
+ * import { type ToolAction, type ToolConfig } from 'genkit/tool';
+ * ```
+ *
+ * @module tool
+ */
+
+export {
+  asTool,
+  dynamicTool,
+  interrupt,
+  toToolDefinition,
+  tool,
+  type MultipartToolAction,
+  type ToolAction,
+  type ToolArgument,
+  type ToolConfig,
+} from '@genkit-ai/ai/tool';

package/src/tracing.ts

@@ -0,0 +1,55 @@
+/**
+ * @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.
+ */
+
+/**
+ * Tracing and telemetry — span/trace schemas, custom metadata helpers, and
+ * OpenTelemetry integration utilities.
+ *
+ * ```ts
+ * import { runInNewSpan, setCustomMetadataAttributes } from 'genkit/tracing';
+ * ```
+ *
+ * @module tracing
+ */
+
+export {
+  SPAN_TYPE_ATTR,
+  SpanContextSchema,
+  SpanDataSchema,
+  SpanMetadataSchema,
+  SpanStatusSchema,
+  TimeEventSchema,
+  TraceDataSchema,
+  TraceMetadataSchema,
+  TraceServerExporter,
+  appendSpan,
+  disableGenkitOTelInitialization,
+  disableOTelRootSpanDetection,
+  enableTelemetry,
+  flushTracing,
+  runInNewSpan,
+  setCustomMetadataAttribute,
+  setCustomMetadataAttributes,
+  setTelemetryServerUrl,
+  toDisplayPath,
+  type PathMetadata,
+  type SpanData,
+  type SpanMetadata,
+  type TraceData,
+  type TraceMetadata,
+} from '@genkit-ai/core/tracing';