@arcgis/ai-components 5.2.0-next.12 → 5.2.0-next.121

package/dist/chunks/aiFactory.js

@@ -0,0 +1,118 @@
+/* COPYRIGHT Esri - https://js.arcgis.com/5.2/LICENSE.txt */
+import { fetchT9nStringsBundle as M } from "@arcgis/toolkit/intl";
+import { g as I } from "./runtime.js";
+import { ChatOpenAI as U, OpenAIEmbeddings as R } from "@langchain/openai";
+import h from "@arcgis/core/portal/Portal.js";
+import y from "@arcgis/core/request.js";
+import q from "@arcgis/core/identity/IdentityManager.js";
+import { generateGuid as A } from "@arcgis/toolkit/string";
+import $ from "@arcgis/core/config.js";
+const w = {
+  advanced: "gpt-5.6-sol",
+  default: "gpt-5.6-terra",
+  fast: "gpt-5.6-luna"
+}, S = {
+  default: "text-embedding-ada-002"
+}, f = /* @__PURE__ */ new Map();
+let i = null;
+const z = () => {
+  const t = h.getDefault().helperServices;
+  if (!t?.aiModels?.url)
+    throw new Error("AI Models Service URL is not defined in the portal's helper services.");
+  return t.aiModels.url;
+}, v = async (e) => {
+  const t = z();
+  f.size === 0 && (i || (i = (async () => {
+    try {
+      (await y(`${t}/models`)).data.models.forEach((s) => f.set(s.name, s));
+    } catch (n) {
+      throw i = null, n;
+    }
+  })()), await i);
+  const r = f.get(e);
+  if (!r)
+    throw new Error(`Model '${e}' is not available in the discovery service.`);
+  return r.endpoint;
+}, C = async (e = "default") => await v(w[e]), F = async (e = "default") => await v(S[e]), T = /^\.\/assets\/[^/]+\/t9n$/u, _ = (e) => {
+  const t = e?.configurable;
+  if (t && typeof t == "object" && "locale" in t) {
+    const r = t.locale;
+    if (typeof r == "string")
+      return r;
+  }
+  return "en";
+};
+async function J(e) {
+  if (!T.test(e.path))
+    throw new Error(`Invalid localization asset path: ${e.path}`);
+  return console.log(`Fetching localization strings from path: ${e.path} with language: ${e.locale}`), await M(e.locale, I(e.path), "messages.");
+}
+const L = (e) => typeof e == "string" && e.length > 0 ? e : void 0, k = () => A(), D = (e) => typeof e != "string" || e.trim().length === 0 ? "MapsSDK" : `MapsSDK - ${e.trim()}`, K = (e) => {
+  const t = e?.configurable;
+  return {
+    conversationId: L(t?.thread_id),
+    abortSignal: e?.signal,
+    requestId: k(),
+    requestSource: D($.applicationName)
+  };
+}, P = (e) => {
+  if (e == null || typeof e == "string" || e instanceof FormData || e instanceof HTMLFormElement)
+    return e;
+  if (e instanceof URLSearchParams)
+    return e.toString();
+  throw new TypeError(`Unsupported request body type: ${Object.prototype.toString.call(e)}`);
+}, b = async ({
+  config: e,
+  withCredentials: t
+}) => {
+  const r = h.getDefault(), n = await q.getCredential(`${r.url}/sharing`);
+  return async (a, s) => {
+    const { conversationId: c, abortSignal: l, requestId: p, requestSource: d } = K(e), o = new Headers(s?.headers);
+    for (const m of [...o.keys()]) {
+      const g = m.toLowerCase();
+      (g === "authorization" || g === "api-key" || g.startsWith("x-stainless-")) && o.delete(m);
+    }
+    const u = n?.token;
+    u && u.length > 0 && o.set("X-Esri-Authorization", `Bearer ${u}`), r.isPortal || (d && d.length > 0 && o.set("X-Esri-Request-Source", d), c && c.length > 0 && o.set("X-Esri-Conversation-Id", c), p.length > 0 && o.set("X-Esri-Request-Id", p));
+    const E = l && s?.signal ? AbortSignal.any([l, s.signal]) : s?.signal ?? l;
+    return (await y(a instanceof Request ? a.url : a.toString(), {
+      body: P(s?.body),
+      headers: Object.fromEntries(o),
+      responseType: "native",
+      withCredentials: t,
+      signal: E
+    })).data;
+  };
+}, Q = async (e = {}) => {
+  const { modelTier: t = "default", config: r } = e, n = w[t], a = await C(t);
+  return new U({
+    modelName: n,
+    apiKey: "dummy-key",
+    useResponsesApi: !0,
+    zdrEnabled: !0,
+    configuration: {
+      baseURL: a,
+      fetch: await b({ config: r, withCredentials: !0 })
+    }
+  });
+}, V = async (e = {}) => {
+  const { tier: t = "default", config: r } = e, n = S[t], a = await F(t);
+  return new R({
+    modelName: n,
+    apiKey: "dummy-key",
+    configuration: {
+      baseURL: a,
+      fetch: await b({ config: r })
+    },
+    batchSize: 2048,
+    maxConcurrency: 10
+  });
+};
+export {
+  S as E,
+  _ as a,
+  F as b,
+  Q as c,
+  V as d,
+  J as g
+};

package/dist/chunks/arcgisKnowledgeGraph.js

@@ -1,54 +1,60 @@
 /* COPYRIGHT Esri - https://js.arcgis.com/5.2/LICENSE.txt */
-import { StateGraph as f, START as x, END as h, Command as k } from "@langchain/langgraph/web";
-import { a as b, c as _, b as K, d as A, e as T, s as v, q as S, g as u, h as q, t as c, r as M, i as C, G as E, j as m } from "./adapter.js";
+import { StateGraph as x, START as k, END as c, Command as b } from "@langchain/langgraph/web";
+import { a as K, c as _, g as T, b as A, d as S, s as M, q as v, e as u, f as q, t as g, h as C, G as E, i as m } from "./adapter.js";
 import "@arcgis/core/identity/IdentityManager.js";
 import "@arcgis/core/portal/Portal.js";
-import { h as G, e as N } from "./generateLayerDescriptions.js";
-import { AIMessage as R } from "@langchain/core/messages";
+import "@arcgis/core/request.js";
+import "@arcgis/toolkit/string";
+import { i as G, a as N } from "./generateLayerDescriptions.js";
+import { AIMessage as y } from "@langchain/core/messages";
 import "@langchain/core/callbacks/dispatch/web";
+import "@arcgis/toolkit/intl";
+import "./runtime.js";
+import "@langchain/core/callbacks/base";
 import "@langchain/openai";
 import "@arcgis/core/config.js";
 import "@arcgis/core/core/reactiveUtils.js";
 import "@arcgis/core/layers/FeatureLayer.js";
-import "@arcgis/core/request.js";
-import { ToolNode as L } from "@langchain/langgraph/prebuilt";
-import { s as p, a as D } from "./index.js";
+import { ToolNode as R } from "@langchain/langgraph/prebuilt";
+import { s as p, a as L } from "./index.js";
 import "@langchain/core/prompts";
+import { r as z } from "./requireAgentServices.js";
 const w = [
-  b,
-  _,
   K,
-  A,
+  _,
   T,
-  v,
-  S
+  A,
+  S,
+  M,
+  v
 ];
-async function z(e, a) {
-  const i = await u("arcgis_knowledge_tool_prompt"), o = q(a), n = {
+async function D(e, t) {
+  const o = await u("arcgis_knowledge_tool_prompt"), s = q(t), n = {
     assignedTask: e.agentExecutionContext.assignedTask,
     userRequest: e.agentExecutionContext.userRequest,
     priorSteps: e.agentExecutionContext.priorSteps,
-    contextType: o
-  }, s = await G({
-    promptText: i,
+    contextType: s
+  }, r = await G({
+    promptText: o,
     messages: e.arcgisKnowledgeMessages,
     inputVariables: n,
-    tools: w
-  }), l = (s.tool_calls?.length ?? 0) > 0, t = typeof s.text == "string" ? s.text.trim() : "", r = t.length > 0, d = s.content.toString();
-  return !l && (o === "map" || o === "knowledgeGraph") ? {
+    tools: w,
+    config: t
+  }), l = (r.tool_calls?.length ?? 0) > 0, a = typeof r.text == "string" ? r.text.trim() : "", i = a.length > 0, d = r.text;
+  return !l && (s === "map" || s === "knowledgeGraph") ? {
     ...e,
-    arcgisKnowledgeMessages: [...e.arcgisKnowledgeMessages, s],
-    outputMessage: o === "map" ? "No tools were found for the current view and prompt. Maps do not support changing nonspatial visibility, layout changes, or generation from queries." : "No tools were found for the current prompt and knowledge graph service. A knowledge graph service only supports search and query.",
+    arcgisKnowledgeMessages: [...e.arcgisKnowledgeMessages, r],
+    outputMessage: s === "map" ? "No tools were found for the current view and prompt. Maps do not support changing nonspatial visibility, layout changes, or generation from queries." : "No tools were found for the current prompt and knowledge graph service. A knowledge graph service only supports search and query.",
     status: "success"
   } : {
     ...e,
-    arcgisKnowledgeMessages: [...e.arcgisKnowledgeMessages, s],
-    outputMessage: l ? d : t,
-    status: l ? e.status : r ? "success" : "failed",
-    summary: d ? c(d) : "ArcGIS Knowledge Agent tool executed."
+    arcgisKnowledgeMessages: [...e.arcgisKnowledgeMessages, r],
+    outputMessage: l ? d : a,
+    status: l ? e.status : i ? "success" : "failed",
+    summary: d ? g(d) : "ArcGIS Knowledge Agent tool executed."
   };
 }
-const y = {
+const f = {
   generateCypher: "generated-cypher-query",
   queryGraphData: "graph-query-result",
   searchGraphData: "graph-search-result",
@@ -58,110 +64,126 @@ const y = {
   createLinkChart: "created-link-chart"
 };
 function F(e) {
-  return !!e && e.status === "success" && !!y[e.toolName];
+  return !!e && e.status === "success" && !!f[e.toolName];
 }
 function $(e) {
   return {
-    type: y[e.toolName],
+    type: f[e.toolName],
     data: e.details
   };
 }
-async function I(e, a) {
-  const i = new L(w, { handleToolErrors: !1 });
+async function I(e, t) {
+  const o = new R(w, { handleToolErrors: !1 });
   try {
-    const o = await i.invoke(
+    const s = await o.invoke(
       {
         messages: e.arcgisKnowledgeMessages
       },
-      a
+      t
     ), n = [];
-    for (const t of o.messages) {
-      let r;
-      if (typeof t.content != "string")
-        throw new Error(`Unexpected tool message content type: ${typeof t.content}. Expected string.`);
+    for (const a of s.messages) {
+      let i;
+      if (typeof a.content != "string")
+        throw new Error(`Unexpected tool message content type: ${typeof a.content}. Expected string.`);
       try {
-        r = JSON.parse(t.content);
+        i = JSON.parse(a.content);
       } catch {
         throw new Error(
-          `Failed to parse tool message content as JSON. Tool: ${t.name ?? "unknown"}.
+          `Failed to parse tool message content as JSON. Tool: ${a.name ?? "unknown"}.
 
- Original Content: ${t.content}`
+ Original Content: ${a.content}`
         );
       }
-      if (!r || typeof r != "object" || !("toolName" in r))
+      if (!i || typeof i != "object" || !("toolName" in i))
         throw new Error(
-          `Parsed tool message content does not have expected structure. Parsed content: ${JSON.stringify(r)}`
+          `Parsed tool message content does not have expected structure. Parsed content: ${JSON.stringify(i)}`
         );
-      n.push(r);
+      n.push(i);
     }
     await p(
       {
-        text: `Finished executing ArcGIS Knowledge Agent tools: ${o.messages.filter((t) => t.name).map((t) => t.name).join(", ")}`
+        text: `Finished executing ArcGIS Knowledge Agent tools: ${s.messages.filter((a) => a.name).map((a) => a.name).join(", ")}`
       },
-      a
+      t
     );
-    const s = n.filter((t) => typeof t != "string").map((t) => `- Called Tool: ${t.toolName}, Status: ${t.status}`), l = n[0];
-    return l && F(l) && await D($(l), a), {
+    const r = n.filter((a) => typeof a != "string").map((a) => `- Called Tool: ${a.toolName}, Status: ${a.status}`), l = n[0];
+    return l && F(l) && await L($(l), t), {
       ...e,
-      outputMessage: s.join(`
+      outputMessage: r.join(`
 `),
-      summary: s.length ? c(s.join(`
+      summary: r.length ? g(r.join(`
 `)) : "ArcGIS Knowledge Agent did not execute any tools or return any results.",
-      arcgisKnowledgeMessages: [...e.arcgisKnowledgeMessages, ...o.messages],
+      arcgisKnowledgeMessages: [...e.arcgisKnowledgeMessages, ...s.messages],
       arcgisKnowledgeToolResult: n
     };
-  } catch (o) {
-    const n = o instanceof Error ? o.message : String(o);
+  } catch (s) {
+    const n = s instanceof Error ? s.message : String(s);
     return await p(
       { text: `ArcGIS Knowledge Agent tool execution failed unexpectedly: ${n}` },
-      a
+      t
     ), {
       ...e,
       outputMessage: `ArcGIS Knowledge Agent tool execution failed unexpectedly: ${n}`,
       status: "failed",
-      summary: c(`ArcGIS Knowledge Agent tool execution failed unexpectedly: ${n}`),
+      summary: g(`ArcGIS Knowledge Agent tool execution failed unexpectedly: ${n}`),
       arcgisKnowledgeMessages: [...e.arcgisKnowledgeMessages]
     };
   }
 }
-const V = (e, a) => (
+const V = (e, t) => (
   //agent services (ex: embeddingsWorker) would go in the array below, if required.
-  M([], "ArcgisKnowledge Agent")(e, a)
+  z([], "ArcgisKnowledge Agent")(e, t)
 );
-async function j(e, a) {
-  const o = (e.arcgisKnowledgeToolResult ?? []).map((d) => ({
+async function O(e, t) {
+  const s = (e.arcgisKnowledgeToolResult ?? []).map((d) => ({
     ...d,
     details: void 0
     // Remove details to avoid overwhelming the LLM with too much info
-  })), { knowledgeGraph: n } = await C(a), s = E.getDataModelTypesSummary(n.dataModel), l = {
+  })), { knowledgeGraph: n } = await C(t), r = E.getDataModelTypesSummary(n.dataModel), l = {
     assignedTask: e.agentExecutionContext.assignedTask,
     userRequest: e.agentExecutionContext.userRequest,
-    toolResult: o,
-    dataModelSummary: s
-  }, t = await N({
+    toolResult: s,
+    dataModelSummary: r
+  }, a = await N({
     promptText: await u("arcgis_knowledge_summarize_result_prompt"),
     modelTier: "default",
-    inputVariables: l
-  }), r = typeof t == "string" ? t : t.content;
+    inputVariables: l,
+    config: t
+  }), i = typeof a == "string" ? a : a.content;
+  return {
+    ...e,
+    outputMessage: i,
+    status: "success",
+    summary: g(i),
+    arcgisKnowledgeMessages: [...e.arcgisKnowledgeMessages, new y(i)]
+  };
+}
+async function P(e) {
+  const t = e.arcgisKnowledgeToolResult?.[0], o = t?.status === "success" ? t.summary : "ArcGIS Knowledge Agent tool execution failed.";
   return {
     ...e,
-    outputMessage: r,
+    outputMessage: o,
     status: "success",
-    summary: c(r),
-    arcgisKnowledgeMessages: [...e.arcgisKnowledgeMessages, new R(r)]
+    summary: g(o),
+    arcgisKnowledgeMessages: [...e.arcgisKnowledgeMessages, new y(o)]
   };
 }
-function g(e) {
-  return async (a, i) => i?.configurable?.abortSignal?.aborted ? (await p({ text: "Knowledge Agent execution cancelled" }, i), new k({
-    goto: h,
+function h(e) {
+  return async (t, o) => o?.signal?.aborted ? (await p({ text: "Knowledge Agent execution cancelled" }, o), new b({
+    goto: c,
     update: {
       outputMessage: "Knowledge Agent execution cancelled",
       summary: "Knowledge Agent execution cancelled",
       status: "failed"
     }
-  })) : await e(a, i);
+  })) : await e(t, o);
 }
-const O = () => new f(m).addNode("requireArcgisKnowledgeServices", V).addNode("agent", g(z)).addNode("tools", g(I)).addNode("summarizationLLM", g(j)).addEdge(x, "requireArcgisKnowledgeServices").addEdge("requireArcgisKnowledgeServices", "agent").addConditionalEdges("agent", (a) => (a.arcgisKnowledgeMessages[a.arcgisKnowledgeMessages.length - 1]?.tool_calls?.length ?? 0) > 0 ? "tools" : h).addConditionalEdges("tools", (a) => a.status === "failed" ? h : "summarizationLLM").addEdge("summarizationLLM", h), P = String.raw`The purpose of this agent is to work with Knowledge Graph data, a graph database technology that represents and stores data as interconnected entities (nodes) and relationships (edges).
+const j = () => new x(m).addNode("requireArcgisKnowledgeServices", V).addNode("agent", h(D)).addNode("tools", h(I)).addNode("summarizationLLM", h(O)).addNode("finalizeToolSummary", h(P)).addEdge(k, "requireArcgisKnowledgeServices").addEdge("requireArcgisKnowledgeServices", "agent").addConditionalEdges("agent", (t) => (t.arcgisKnowledgeMessages[t.arcgisKnowledgeMessages.length - 1]?.tool_calls?.length ?? 0) > 0 ? "tools" : c).addConditionalEdges("tools", (t) => {
+  if (t.status === "failed")
+    return c;
+  const o = t.arcgisKnowledgeToolResult?.[0];
+  return o?.status === "success" && ["applyLayout", "changeNonspatialVisibility"].includes(o.toolName) ? "finalizeToolSummary" : "summarizationLLM";
+}).addEdge("summarizationLLM", c).addEdge("finalizeToolSummary", c), J = String.raw`The purpose of this agent is to work with Knowledge Graph data, a graph database technology that represents and stores data as interconnected entities (nodes) and relationships (edges).
 This agent has two categories of skills: those that work with an active link chart visualization of a subset of the data in the knowledge graph, and those that work with the knowledge graph data more generally against the entire dataset in the service and database.
 For link charts, the agent enables users to interact with a link chart by adding new entities (also called nodes) or relationships (also called edges), removing existing entities or relationships, 
 expanding the graph from particular entities, finding relationships between specified entities on the link chart and adding them to the link chart, finding all relationships 
@@ -199,13 +221,13 @@ _example: "Discover and add all the relationships originating at 'Entity E' to t
 _example: "Show me all entities with a name similar to 'Smith' and add them to the link chart"_
 _example: "Find reports in my graph that have a title similar to 'Quarterly Earnings'"_
 _example: "Find John Smith and all people he has made phone calls to in the last year"_
-_example: "What is the average age of all people who work for Esri?"_`, re = {
+_example: "What is the average age of all people who work for Esri?"_`, he = {
   id: "arcgisKnowledge",
   name: "ArcgisKnowledge Agent",
-  description: P,
-  createGraph: O,
+  description: J,
+  createGraph: j,
   workspace: m
 };
 export {
-  re as A
+  he as A
 };

package/dist/chunks/arcgisToolRegistry.js

@@ -0,0 +1,88 @@
+/* COPYRIGHT Esri - https://js.arcgis.com/5.2/LICENSE.txt */
+const a = /* @__PURE__ */ new Map([
+  [
+    "clearFilters",
+    async () => (await import("../agents/tools/filter/clearFilters/adapter.js")).clearFiltersTool
+  ],
+  [
+    "resetMap",
+    async () => (await import("../agents/tools/filter/resetMap/adapter.js")).resetMapTool
+  ],
+  [
+    "setFeatureEffect",
+    async () => (await import("../agents/tools/filter/setFeatureEffect/adapter.js")).setFeatureEffectTool
+  ],
+  [
+    "listLayerFields",
+    async () => (await import("../agents/tools/help/listFields/adapter.js")).listLayerFieldsTool
+  ],
+  [
+    "goToAddress",
+    async () => (await import("../agents/tools/navigation/goToAddress/adapter.js")).goToAddressTool
+  ],
+  [
+    "goToBookmark",
+    async () => (await import("../agents/tools/navigation/goToBookmark/adapter.js")).goToBookmarkTool
+  ],
+  [
+    "goToFeatures",
+    async () => (await import("../agents/tools/navigation/goToFeatures/adapter.js")).goToFeaturesTool
+  ],
+  [
+    "goToFullExtent",
+    async () => (await import("../agents/tools/navigation/goToFullExtent/adapter.js")).goToFullExtentTool
+  ],
+  [
+    "goToHomeExtent",
+    async () => (await import("../agents/tools/navigation/goToHomeExtent/adapter.js")).goToHomeExtentTool
+  ],
+  [
+    "goToLayer",
+    async () => (await import("../agents/tools/navigation/goToLayer/adapter.js")).goToLayerTool
+  ],
+  [
+    "goToScale",
+    async () => (await import("../agents/tools/navigation/goToScale/adapter.js")).goToScaleTool
+  ],
+  [
+    "goToViewpoint",
+    async () => (await import("../agents/tools/navigation/goToViewpoint/adapter.js")).goToViewpointTool
+  ],
+  [
+    "goToZoom",
+    async () => (await import("../agents/tools/navigation/goToZoom/adapter.js")).goToZoomTool
+  ],
+  [
+    "findRelevantFields",
+    async () => (await import("../agents/tools/search/findRelevantFields/adapter.js")).findRelevantFieldsTool
+  ],
+  [
+    "findRelevantLayers",
+    async () => (await import("../agents/tools/search/findRelevantLayers/adapter.js")).findRelevantLayersTool
+  ],
+  [
+    "getAttribute",
+    async () => (await import("../agents/tools/query/getAttribute/adapter.js")).getAttributeTool
+  ],
+  [
+    "getStatistics",
+    async () => (await import("../agents/tools/query/getStatistics/adapter.js")).getStatisticsTool
+  ],
+  [
+    "getTopFeatures",
+    async () => (await import("../agents/tools/query/getTopFeatures/adapter.js")).getTopFeaturesTool
+  ],
+  [
+    "queryFeatures",
+    async () => (await import("../agents/tools/query/queryFeatures/adapter.js")).queryFeaturesTool
+  ]
+]);
+async function e(o) {
+  const t = a.get(o);
+  if (!t)
+    throw new Error(`"${o}" tool not found`);
+  return await t();
+}
+export {
+  e as r
+};

package/dist/chunks/arcgis_knowledge_current_lc_context.js

@@ -1,7 +1,24 @@
 /* COPYRIGHT Esri - https://js.arcgis.com/5.2/LICENSE.txt */
-const e = `## Additional System Context
+const e = `## Membership Bind Parameters
 
-In addition to the user's inquiry prompt that precedes this system context, the current link chart has entities and relationships on it already, in the format of an array of objects containing identifiers and typeNames, in case this is needed for query generation (for example 'Add all records that are connected to people on this link chart to the link chart'). If the user is asking for a query that acts on 'the current link chart', 'my link chart', or similar then the cypher query should be filtered by the ids. For example, 'Match (n:Person)-[\\r]->(m) WHERE id(n) IN [\\'identifier1','identifier2'] return r, m. Curly braces (the '{' and '}' characters) are often part of identifier strings and should not be stripped out - the process of filtering by ids should not be altering the id strings. The entities and relationships that are on the current link chart are as follows:
+The current link chart contains a subset of entities and relationships from the database. Their membership is available to Cypher queries as lists of string identifiers through these bind parameters:
+
+- $entityIds
+- $relationshipIds
+
+If, and ONLY if, the user is asking for data to be limited by the records already on 'the current link chart', 'my link chart', or similar, the generated Cypher should filter using these parameters.
+
+### START EXAMPLES
+
+User request: 'Add all records that are connected to people on this link chart to the link chart'
+Context: 'Person' entity in data model.
+Expected Result: MATCH (n:Person)-[r]->(m) WHERE id(n) IN $entityIds return r, m
+
+User request: 'Add all the suppliers to the link chart'
+Context: 'Supplier' entity in the data model.
+Expected Result: MATCH (s:Supplier) RETURN s
+
+### END EXAMPLES
 `;
 export {
   e as default

package/dist/chunks/arcgis_knowledge_current_map_context.js

@@ -1,7 +1,36 @@
 /* COPYRIGHT Esri - https://js.arcgis.com/5.2/LICENSE.txt */
-const e = `## Additional System Context
+const e = `## Membership Bind Parameters
 
-In addition to the user's inquiry prompt that precedes this system context, the current map has entities and relationships on it already, in the format of an array of objects containing identifiers and typeNames or type names that contain all entities or relationships of that type, in case this is needed for query generation (for example 'Add all records that are connected to people on this map to the map'). If the user is asking for a query that acts on 'the current map', 'my map', or similar then the cypher query should be filtered by the ids. For example, 'Match (n:Person)-[\\r]->(m) WHERE id(n) IN [\\'identifier1','identifier2'] return r, m. Curly braces (the '{' and '}' characters) are often part of identifier strings and should not be stripped out - the process of filtering by ids should not be altering the id strings. The entities and relationships that are on the current map are as follows:
+The current map contains a subset of entities and relationships from the database. Their membership is available to Cypher queries as lists of string identifiers through these bind parameters:
+
+- $entityIds
+- $relationshipIds
+
+Included Types:
+{nonDynamicTypes}
+
+Filtering rules:
+
+- Apply membership filtering only when BOTH are true:
+  - The user is asking for data to be limited by the records already on 'the current map', 'my map', 'the knowledge graph layer' or similar.
+  - The variable in the cypher query is a type in Included Types above.
+- IMPORTANT: In all other cases, DO NOT apply membership filtering. DO NOT include membership filters for any type not listed in Included Types above.
+
+### START EXAMPLES
+
+User request: 'Add all records that are connected to people on this map to the map'
+Context: 'Person' entity in data model and included in the bind parameter types above.
+Expected Result: MATCH (n:Person)-[r]->(m) WHERE id(n) IN $entityIds return r, m
+
+User request: 'Add all the suppliers to the map'
+Context: 'Supplier' entity in the data model.
+Expected Result: MATCH (s:Supplier) RETURN s
+
+User request: 'Add all suppliers connected to plants on my map'
+Context: 'Plant' entity in data model but not included in the bind parameter types above.
+Expected Result: MATCH (p:Plant)-[r]->(s:Supplier) return r, s
+
+### END EXAMPLES
 `;
 export {
   e as default

package/dist/chunks/arcgis_knowledge_cypher_query_prompt.js

@@ -0,0 +1,102 @@
+/* COPYRIGHT Esri - https://js.arcgis.com/5.2/LICENSE.txt */
+const e = `# ArcGIS Knowledge Graph Cypher Rules
+
+## GOAL
+
+Generate a Cypher query that answers the user’s request and conforms to the data model.
+
+---
+
+## 1. USER OVERRIDES (HIGHEST PRIORITY)
+
+If the user specifies any of the following, ALWAYS follow their instructions over defaults:
+
+- LIMIT (or no limit)
+- Output columns / data model
+- Inclusion/exclusion of globalid
+- Ordering, grouping, filtering, projection
+
+---
+
+## 2. DATA MODEL CONFORMANCE (NON-NEGOTIABLE)
+
+Use ONLY valid data model elements.
+
+### Required
+
+- Use only valid entity types, relationship types, and properties
+- Ensure relationships connect valid entity types
+- infer direction from user prompt. if not clear use the least restrictive valid form supported by the model.
+
+### VALIDATION RULES (STRICT)
+
+- Enforce exact schema match: all entities, relationships, and properties must exist exactly in the data model
+- Validate relationship integrity: types, source→target pairing, and direction must match schema
+- Enforce field correctness: properties and filters must exist on the referenced type and use valid data types
+- Ensure alias consistency: each alias maps to one type only and cannot change meaning
+- Apply strict failure: if any component is invalid, do NOT generate the query and do NOT infer or repair
+
+## 4. PATH RESOLUTION
+
+- First attempt a direct relationship
+- If none exists → use a valid multi-hop path
+- Each hop MUST be valid in the data model
+- Max path length: 3 (unless user requests more)
+
+### Path selection
+
+- Prefer shortest valid path
+- If multiple valid paths exist → choose best match to user intent
+- If no valid path exists → do not speculate
+
+---
+
+## 5. PERFORMANCE
+
+- Use the minimal number of entities and relationships
+- Prefer shortest valid path
+- Avoid unnecessary patterns or complexity
+
+---
+
+## 6. CYPHER RULES
+
+- UNION queries must return identical columns
+- Apply LIMIT only after UNION (not inside subqueries)
+- Do NOT use: OVER, REDUCE()
+- Do NOT use reserved keywords as variables (call, match, return, as etc.)
+- Use only valid openCypher syntax
+- After OPTIONAL MATCH, always add:
+  WITH ...
+  WHERE var IS NOT NULL
+  before using var in any MATCH or relationship pattern.
+
+---
+
+## 7. SPATIAL RULES
+
+- Prefer graph relationships over spatial functions
+- Use spatial functions only when necessary
+- Always ensure geometry is not null if using spatial functions
+  - for example: WHERE n.shape IS NOT NULL
+
+---
+
+## 9. DEFAULT OUTPUT (IF NOT SPECIFIED)
+
+- Add LIMIT 50 unless results are clearly small
+- Use descriptive aliases with AS
+- ALWAYS Return full entities and relationships unless user requests specific properties
+
+---
+
+## 11. OUTPUT FORMAT
+
+- Valid → return ONLY Cypher query
+- No explanation
+
+---
+`;
+export {
+  e as default
+};