@thomasfosterau/effect-rdf 0.0.0-stage → 0.1.0

package/dist/Tools-7MdRKccr.d.mts

@@ -0,0 +1,583 @@
+import { a as GroundTerm } from "./TermJson-BOPe0yve.mjs";
+import { o as SparqlEngine } from "./Engine-CYPB3g4h.mjs";
+import * as Schema from "effect/Schema";
+import * as Effect from "effect/Effect";
+import * as Duration from "effect/Duration";
+import { Tool, Toolkit } from "effect/ai";
+declare namespace Tools_d_exports {
+  export { DescribeResource, ListClasses, ListProperties, SearchLabels, SparqlQuery, SparqlToolError, SparqlUpdate, ToolOptions, handlers, layer, layerWithUpdate, toolkit, toolkitWithUpdate };
+}
+declare const SparqlToolError_base: Schema.Class<SparqlToolError, Schema.TaggedStruct<"SparqlToolError", {
+  readonly message: Schema.String;
+}>, import("effect/Cause").YieldableError>;
+/**
+ * Why a tool call failed (a syntax error, a refused `SERVICE`, a timeout, …),
+ * returned to the model as the tool's result.
+ *
+ * @since 0.1.0
+ * @category errors
+ */
+declare class SparqlToolError extends SparqlToolError_base {}
+/**
+ * Limits for the tool handlers.
+ *
+ * @since 0.1.0
+ * @category models
+ */
+interface ToolOptions {
+  /** The most rows (or triples) a tool returns; a call may ask for fewer. Default 100. */
+  readonly maxRows?: number | undefined;
+  /** How long one call may run. Default 10 seconds. */
+  readonly timeout?: Duration.Input | undefined;
+  /** Allow `SERVICE` (federated) queries. Default `false`. */
+  readonly federation?: boolean | undefined;
+}
+/**
+ * Runs a read-only SPARQL query. SELECT results are SPARQL JSON results,
+ * ASK a boolean, CONSTRUCT / DESCRIBE a Turtle document.
+ *
+ * @since 0.1.0
+ * @category tools
+ */
+declare const SparqlQuery: Tool.Tool<"sparql_query", {
+  readonly parameters: Schema.Struct<{
+    readonly query: Schema.String;
+    readonly limit: Schema.optional<Schema.Int>;
+  }>;
+  readonly success: Schema.Union<readonly [Schema.Struct<{
+    readonly type: Schema.Literal<"select">;
+    readonly results: Schema.Struct<{
+      readonly head: Schema.Struct<{
+        readonly vars: Schema.optional<Schema.$Array<Schema.String>>;
+        readonly link: Schema.optional<Schema.$Array<Schema.String>>;
+      }>;
+      readonly results: Schema.optional<Schema.Struct<{
+        readonly bindings: Schema.$Array<Schema.$Record<Schema.String, Schema.Codec<GroundTerm, GroundTerm, never, never>>>;
+      }>>;
+      readonly boolean: Schema.optional<Schema.Boolean>;
+    }>;
+    readonly isTruncated: Schema.Boolean;
+  }>, Schema.Struct<{
+    readonly type: Schema.Literal<"ask">;
+    readonly isTrue: Schema.Boolean;
+  }>, Schema.Struct<{
+    readonly type: Schema.Literal<"graph">;
+    readonly turtle: Schema.String;
+    readonly isTruncated: Schema.Boolean;
+  }>]>;
+  readonly failure: typeof SparqlToolError;
+  readonly failureMode: "return";
+}, never>;
+/**
+ * The triples whose subject is the given IRI, as Turtle.
+ *
+ * @since 0.1.0
+ * @category tools
+ */
+declare const DescribeResource: Tool.Tool<"describe_resource", {
+  readonly parameters: Schema.Struct<{
+    readonly iri: Schema.String;
+    readonly limit: Schema.optional<Schema.Int>;
+  }>;
+  readonly success: Schema.Struct<{
+    readonly turtle: Schema.String;
+    readonly isTruncated: Schema.Boolean;
+  }>;
+  readonly failure: typeof SparqlToolError;
+  readonly failureMode: "return";
+}, never>;
+/**
+ * The classes with instances (`rdf:type`) or declared as `rdfs:Class` /
+ * `owl:Class`, by number of instances.
+ *
+ * @since 0.1.0
+ * @category tools
+ */
+declare const ListClasses: Tool.Tool<"list_classes", {
+  readonly parameters: Schema.Struct<{
+    readonly limit: Schema.optional<Schema.Int>;
+  }>;
+  readonly success: Schema.$Array<Schema.Struct<{
+    readonly iri: Schema.String;
+    readonly count: Schema.Int;
+  }>>;
+  readonly failure: typeof SparqlToolError;
+  readonly failureMode: "return";
+}, never>;
+/**
+ * The predicates in use or declared as `rdf:Property` /
+ * `owl:ObjectProperty` / `owl:DatatypeProperty`, by number of uses.
+ *
+ * @since 0.1.0
+ * @category tools
+ */
+declare const ListProperties: Tool.Tool<"list_properties", {
+  readonly parameters: Schema.Struct<{
+    readonly limit: Schema.optional<Schema.Int>;
+  }>;
+  readonly success: Schema.$Array<Schema.Struct<{
+    readonly iri: Schema.String;
+    readonly count: Schema.Int;
+  }>>;
+  readonly failure: typeof SparqlToolError;
+  readonly failureMode: "return";
+}, never>;
+/**
+ * IRIs whose `rdfs:label` or `skos:prefLabel` contains a string
+ * (case-insensitively).
+ *
+ * @since 0.1.0
+ * @category tools
+ */
+declare const SearchLabels: Tool.Tool<"search_labels", {
+  readonly parameters: Schema.Struct<{
+    readonly text: Schema.String;
+    readonly limit: Schema.optional<Schema.Int>;
+  }>;
+  readonly success: Schema.$Array<Schema.Struct<{
+    readonly iri: Schema.String;
+    readonly label: Schema.String;
+  }>>;
+  readonly failure: typeof SparqlToolError;
+  readonly failureMode: "return";
+}, never>;
+/**
+ * Runs a SPARQL Update. Only in `toolkitWithUpdate`: the read-only `toolkit`
+ * does not offer it.
+ *
+ * @since 0.1.0
+ * @category tools
+ */
+declare const SparqlUpdate: Tool.Tool<"sparql_update", {
+  readonly parameters: Schema.Struct<{
+    readonly update: Schema.String;
+  }>;
+  readonly success: Schema.Struct<{
+    readonly isApplied: Schema.Boolean;
+  }>;
+  readonly failure: typeof SparqlToolError;
+  readonly failureMode: "return";
+}, never>;
+/**
+ * The read-only toolkit: `sparql_query`, `describe_resource`,
+ * `list_classes`, `list_properties` and `search_labels`.
+ *
+ * @since 0.1.0
+ * @category toolkits
+ */
+declare const toolkit: Toolkit.Toolkit<{
+  readonly sparql_query: Tool.Tool<"sparql_query", {
+    readonly parameters: Schema.Struct<{
+      readonly query: Schema.String;
+      readonly limit: Schema.optional<Schema.Int>;
+    }>;
+    readonly success: Schema.Union<readonly [Schema.Struct<{
+      readonly type: Schema.Literal<"select">;
+      readonly results: Schema.Struct<{
+        readonly head: Schema.Struct<{
+          readonly vars: Schema.optional<Schema.$Array<Schema.String>>;
+          readonly link: Schema.optional<Schema.$Array<Schema.String>>;
+        }>;
+        readonly results: Schema.optional<Schema.Struct<{
+          readonly bindings: Schema.$Array<Schema.$Record<Schema.String, Schema.Codec<GroundTerm, GroundTerm, never, never>>>;
+        }>>;
+        readonly boolean: Schema.optional<Schema.Boolean>;
+      }>;
+      readonly isTruncated: Schema.Boolean;
+    }>, Schema.Struct<{
+      readonly type: Schema.Literal<"ask">;
+      readonly isTrue: Schema.Boolean;
+    }>, Schema.Struct<{
+      readonly type: Schema.Literal<"graph">;
+      readonly turtle: Schema.String;
+      readonly isTruncated: Schema.Boolean;
+    }>]>;
+    readonly failure: typeof SparqlToolError;
+    readonly failureMode: "return";
+  }, never>;
+  readonly describe_resource: Tool.Tool<"describe_resource", {
+    readonly parameters: Schema.Struct<{
+      readonly iri: Schema.String;
+      readonly limit: Schema.optional<Schema.Int>;
+    }>;
+    readonly success: Schema.Struct<{
+      readonly turtle: Schema.String;
+      readonly isTruncated: Schema.Boolean;
+    }>;
+    readonly failure: typeof SparqlToolError;
+    readonly failureMode: "return";
+  }, never>;
+  readonly list_classes: Tool.Tool<"list_classes", {
+    readonly parameters: Schema.Struct<{
+      readonly limit: Schema.optional<Schema.Int>;
+    }>;
+    readonly success: Schema.$Array<Schema.Struct<{
+      readonly iri: Schema.String;
+      readonly count: Schema.Int;
+    }>>;
+    readonly failure: typeof SparqlToolError;
+    readonly failureMode: "return";
+  }, never>;
+  readonly list_properties: Tool.Tool<"list_properties", {
+    readonly parameters: Schema.Struct<{
+      readonly limit: Schema.optional<Schema.Int>;
+    }>;
+    readonly success: Schema.$Array<Schema.Struct<{
+      readonly iri: Schema.String;
+      readonly count: Schema.Int;
+    }>>;
+    readonly failure: typeof SparqlToolError;
+    readonly failureMode: "return";
+  }, never>;
+  readonly search_labels: Tool.Tool<"search_labels", {
+    readonly parameters: Schema.Struct<{
+      readonly text: Schema.String;
+      readonly limit: Schema.optional<Schema.Int>;
+    }>;
+    readonly success: Schema.$Array<Schema.Struct<{
+      readonly iri: Schema.String;
+      readonly label: Schema.String;
+    }>>;
+    readonly failure: typeof SparqlToolError;
+    readonly failureMode: "return";
+  }, never>;
+}>;
+/**
+ * The read-only toolkit plus `sparql_update`, for agents that may change
+ * the graph.
+ *
+ * @since 0.1.0
+ * @category toolkits
+ */
+declare const toolkitWithUpdate: Toolkit.Toolkit<{
+  readonly sparql_query: Tool.Tool<"sparql_query", {
+    readonly parameters: Schema.Struct<{
+      readonly query: Schema.String;
+      readonly limit: Schema.optional<Schema.Int>;
+    }>;
+    readonly success: Schema.Union<readonly [Schema.Struct<{
+      readonly type: Schema.Literal<"select">;
+      readonly results: Schema.Struct<{
+        readonly head: Schema.Struct<{
+          readonly vars: Schema.optional<Schema.$Array<Schema.String>>;
+          readonly link: Schema.optional<Schema.$Array<Schema.String>>;
+        }>;
+        readonly results: Schema.optional<Schema.Struct<{
+          readonly bindings: Schema.$Array<Schema.$Record<Schema.String, Schema.Codec<GroundTerm, GroundTerm, never, never>>>;
+        }>>;
+        readonly boolean: Schema.optional<Schema.Boolean>;
+      }>;
+      readonly isTruncated: Schema.Boolean;
+    }>, Schema.Struct<{
+      readonly type: Schema.Literal<"ask">;
+      readonly isTrue: Schema.Boolean;
+    }>, Schema.Struct<{
+      readonly type: Schema.Literal<"graph">;
+      readonly turtle: Schema.String;
+      readonly isTruncated: Schema.Boolean;
+    }>]>;
+    readonly failure: typeof SparqlToolError;
+    readonly failureMode: "return";
+  }, never>;
+  readonly describe_resource: Tool.Tool<"describe_resource", {
+    readonly parameters: Schema.Struct<{
+      readonly iri: Schema.String;
+      readonly limit: Schema.optional<Schema.Int>;
+    }>;
+    readonly success: Schema.Struct<{
+      readonly turtle: Schema.String;
+      readonly isTruncated: Schema.Boolean;
+    }>;
+    readonly failure: typeof SparqlToolError;
+    readonly failureMode: "return";
+  }, never>;
+  readonly list_classes: Tool.Tool<"list_classes", {
+    readonly parameters: Schema.Struct<{
+      readonly limit: Schema.optional<Schema.Int>;
+    }>;
+    readonly success: Schema.$Array<Schema.Struct<{
+      readonly iri: Schema.String;
+      readonly count: Schema.Int;
+    }>>;
+    readonly failure: typeof SparqlToolError;
+    readonly failureMode: "return";
+  }, never>;
+  readonly list_properties: Tool.Tool<"list_properties", {
+    readonly parameters: Schema.Struct<{
+      readonly limit: Schema.optional<Schema.Int>;
+    }>;
+    readonly success: Schema.$Array<Schema.Struct<{
+      readonly iri: Schema.String;
+      readonly count: Schema.Int;
+    }>>;
+    readonly failure: typeof SparqlToolError;
+    readonly failureMode: "return";
+  }, never>;
+  readonly search_labels: Tool.Tool<"search_labels", {
+    readonly parameters: Schema.Struct<{
+      readonly text: Schema.String;
+      readonly limit: Schema.optional<Schema.Int>;
+    }>;
+    readonly success: Schema.$Array<Schema.Struct<{
+      readonly iri: Schema.String;
+      readonly label: Schema.String;
+    }>>;
+    readonly failure: typeof SparqlToolError;
+    readonly failureMode: "return";
+  }, never>;
+  readonly sparql_update: Tool.Tool<"sparql_update", {
+    readonly parameters: Schema.Struct<{
+      readonly update: Schema.String;
+    }>;
+    readonly success: Schema.Struct<{
+      readonly isApplied: Schema.Boolean;
+    }>;
+    readonly failure: typeof SparqlToolError;
+    readonly failureMode: "return";
+  }, never>;
+}>;
+/**
+ * The handlers of the tools, over the `SparqlEngine` in context.
+ *
+ * @since 0.1.0
+ * @category handlers
+ */
+declare const handlers: (options?: ToolOptions | undefined) => Effect.Effect<{
+  sparql_query: ({ query, limit }: {
+    readonly query: string;
+    readonly limit?: number | undefined;
+  }) => Effect.Effect<{
+    type: "ask";
+    isTrue: boolean;
+  } | {
+    type: "select";
+    results: {
+      readonly head: {
+        readonly vars?: readonly string[] | undefined;
+        readonly link?: readonly string[] | undefined;
+      };
+      readonly boolean?: boolean | undefined;
+      readonly results?: {
+        readonly bindings: readonly {
+          readonly [x: string]: GroundTerm;
+        }[];
+      } | undefined;
+    };
+    isTruncated: boolean;
+  } | {
+    type: "graph";
+    turtle: string;
+    isTruncated: boolean;
+  }, SparqlToolError, never>;
+  describe_resource: ({ iri, limit }: {
+    readonly iri: string;
+    readonly limit?: number | undefined;
+  }) => Effect.Effect<{
+    turtle: string;
+    isTruncated: boolean;
+  }, SparqlToolError, never>;
+  list_classes: ({ limit }: {
+    readonly limit?: number | undefined;
+  }) => Effect.Effect<{
+    iri: string;
+    count: number;
+  }[], SparqlToolError, never>;
+  list_properties: ({ limit }: {
+    readonly limit?: number | undefined;
+  }) => Effect.Effect<{
+    iri: string;
+    count: number;
+  }[], SparqlToolError, never>;
+  search_labels: ({ text, limit }: {
+    readonly text: string;
+    readonly limit?: number | undefined;
+  }) => Effect.Effect<{
+    iri: string;
+    label: string;
+  }[], SparqlToolError, never>;
+  sparql_update: ({ update }: {
+    readonly update: string;
+  }) => Effect.Effect<{
+    isApplied: boolean;
+  }, SparqlToolError, never>;
+}, never, SparqlEngine>;
+/**
+ * The handlers of the read-only `toolkit` as a layer, over the
+ * `SparqlEngine` in context.
+ *
+ * @since 0.1.0
+ * @category layers
+ */
+declare const layer: (options?: ToolOptions) => import("effect/Layer").Layer<Tool.HandlersFor<{
+  readonly sparql_query: Tool.Tool<"sparql_query", {
+    readonly parameters: Schema.Struct<{
+      readonly query: Schema.String;
+      readonly limit: Schema.optional<Schema.Int>;
+    }>;
+    readonly success: Schema.Union<readonly [Schema.Struct<{
+      readonly type: Schema.Literal<"select">;
+      readonly results: Schema.Struct<{
+        readonly head: Schema.Struct<{
+          readonly vars: Schema.optional<Schema.$Array<Schema.String>>;
+          readonly link: Schema.optional<Schema.$Array<Schema.String>>;
+        }>;
+        readonly results: Schema.optional<Schema.Struct<{
+          readonly bindings: Schema.$Array<Schema.$Record<Schema.String, Schema.Codec<GroundTerm, GroundTerm, never, never>>>;
+        }>>;
+        readonly boolean: Schema.optional<Schema.Boolean>;
+      }>;
+      readonly isTruncated: Schema.Boolean;
+    }>, Schema.Struct<{
+      readonly type: Schema.Literal<"ask">;
+      readonly isTrue: Schema.Boolean;
+    }>, Schema.Struct<{
+      readonly type: Schema.Literal<"graph">;
+      readonly turtle: Schema.String;
+      readonly isTruncated: Schema.Boolean;
+    }>]>;
+    readonly failure: typeof SparqlToolError;
+    readonly failureMode: "return";
+  }, never>;
+  readonly describe_resource: Tool.Tool<"describe_resource", {
+    readonly parameters: Schema.Struct<{
+      readonly iri: Schema.String;
+      readonly limit: Schema.optional<Schema.Int>;
+    }>;
+    readonly success: Schema.Struct<{
+      readonly turtle: Schema.String;
+      readonly isTruncated: Schema.Boolean;
+    }>;
+    readonly failure: typeof SparqlToolError;
+    readonly failureMode: "return";
+  }, never>;
+  readonly list_classes: Tool.Tool<"list_classes", {
+    readonly parameters: Schema.Struct<{
+      readonly limit: Schema.optional<Schema.Int>;
+    }>;
+    readonly success: Schema.$Array<Schema.Struct<{
+      readonly iri: Schema.String;
+      readonly count: Schema.Int;
+    }>>;
+    readonly failure: typeof SparqlToolError;
+    readonly failureMode: "return";
+  }, never>;
+  readonly list_properties: Tool.Tool<"list_properties", {
+    readonly parameters: Schema.Struct<{
+      readonly limit: Schema.optional<Schema.Int>;
+    }>;
+    readonly success: Schema.$Array<Schema.Struct<{
+      readonly iri: Schema.String;
+      readonly count: Schema.Int;
+    }>>;
+    readonly failure: typeof SparqlToolError;
+    readonly failureMode: "return";
+  }, never>;
+  readonly search_labels: Tool.Tool<"search_labels", {
+    readonly parameters: Schema.Struct<{
+      readonly text: Schema.String;
+      readonly limit: Schema.optional<Schema.Int>;
+    }>;
+    readonly success: Schema.$Array<Schema.Struct<{
+      readonly iri: Schema.String;
+      readonly label: Schema.String;
+    }>>;
+    readonly failure: typeof SparqlToolError;
+    readonly failureMode: "return";
+  }, never>;
+}>, never, SparqlEngine>;
+/**
+ * The handlers of `toolkitWithUpdate` (the read-only tools plus
+ * `sparql_update`) as a layer, over the `SparqlEngine` in context.
+ *
+ * @since 0.1.0
+ * @category layers
+ */
+declare const layerWithUpdate: (options?: ToolOptions) => import("effect/Layer").Layer<Tool.HandlersFor<{
+  readonly sparql_query: Tool.Tool<"sparql_query", {
+    readonly parameters: Schema.Struct<{
+      readonly query: Schema.String;
+      readonly limit: Schema.optional<Schema.Int>;
+    }>;
+    readonly success: Schema.Union<readonly [Schema.Struct<{
+      readonly type: Schema.Literal<"select">;
+      readonly results: Schema.Struct<{
+        readonly head: Schema.Struct<{
+          readonly vars: Schema.optional<Schema.$Array<Schema.String>>;
+          readonly link: Schema.optional<Schema.$Array<Schema.String>>;
+        }>;
+        readonly results: Schema.optional<Schema.Struct<{
+          readonly bindings: Schema.$Array<Schema.$Record<Schema.String, Schema.Codec<GroundTerm, GroundTerm, never, never>>>;
+        }>>;
+        readonly boolean: Schema.optional<Schema.Boolean>;
+      }>;
+      readonly isTruncated: Schema.Boolean;
+    }>, Schema.Struct<{
+      readonly type: Schema.Literal<"ask">;
+      readonly isTrue: Schema.Boolean;
+    }>, Schema.Struct<{
+      readonly type: Schema.Literal<"graph">;
+      readonly turtle: Schema.String;
+      readonly isTruncated: Schema.Boolean;
+    }>]>;
+    readonly failure: typeof SparqlToolError;
+    readonly failureMode: "return";
+  }, never>;
+  readonly describe_resource: Tool.Tool<"describe_resource", {
+    readonly parameters: Schema.Struct<{
+      readonly iri: Schema.String;
+      readonly limit: Schema.optional<Schema.Int>;
+    }>;
+    readonly success: Schema.Struct<{
+      readonly turtle: Schema.String;
+      readonly isTruncated: Schema.Boolean;
+    }>;
+    readonly failure: typeof SparqlToolError;
+    readonly failureMode: "return";
+  }, never>;
+  readonly list_classes: Tool.Tool<"list_classes", {
+    readonly parameters: Schema.Struct<{
+      readonly limit: Schema.optional<Schema.Int>;
+    }>;
+    readonly success: Schema.$Array<Schema.Struct<{
+      readonly iri: Schema.String;
+      readonly count: Schema.Int;
+    }>>;
+    readonly failure: typeof SparqlToolError;
+    readonly failureMode: "return";
+  }, never>;
+  readonly list_properties: Tool.Tool<"list_properties", {
+    readonly parameters: Schema.Struct<{
+      readonly limit: Schema.optional<Schema.Int>;
+    }>;
+    readonly success: Schema.$Array<Schema.Struct<{
+      readonly iri: Schema.String;
+      readonly count: Schema.Int;
+    }>>;
+    readonly failure: typeof SparqlToolError;
+    readonly failureMode: "return";
+  }, never>;
+  readonly search_labels: Tool.Tool<"search_labels", {
+    readonly parameters: Schema.Struct<{
+      readonly text: Schema.String;
+      readonly limit: Schema.optional<Schema.Int>;
+    }>;
+    readonly success: Schema.$Array<Schema.Struct<{
+      readonly iri: Schema.String;
+      readonly label: Schema.String;
+    }>>;
+    readonly failure: typeof SparqlToolError;
+    readonly failureMode: "return";
+  }, never>;
+  readonly sparql_update: Tool.Tool<"sparql_update", {
+    readonly parameters: Schema.Struct<{
+      readonly update: Schema.String;
+    }>;
+    readonly success: Schema.Struct<{
+      readonly isApplied: Schema.Boolean;
+    }>;
+    readonly failure: typeof SparqlToolError;
+    readonly failureMode: "return";
+  }, never>;
+}>, never, SparqlEngine>;
+export { SparqlQuery as a, ToolOptions as c, layer as d, layerWithUpdate as f, SearchLabels as i, Tools_d_exports as l, toolkitWithUpdate as m, ListClasses as n, SparqlToolError as o, toolkit as p, ListProperties as r, SparqlUpdate as s, DescribeResource as t, handlers as u };
+//# sourceMappingURL=Tools-7MdRKccr.d.mts.map