feat(corti-api): add sections array with heading to document response

.fern/metadata.json

@@ -34,6 +34,6 @@
             }
         }
     },
-    "originGitCommit": "7bbc721308055a6c33033d729c847911cc6ee9a0",
+    "originGitCommit": "ce2f269781f8e357d369d4e52f5e2f766a20b369",
     "sdkVersion": "0.0.0-dev"
 }

src/api/types/GuidedDocumentSection.ts

@@ -0,0 +1,13 @@
+// This file was auto-generated by Fern from our API Definition.
+
+/**
+ * One section of a generated document, in template order. The `heading` is the section heading at generation time, after overrides. The `orderIndex` is the zero-based position in the template version's section list.
+ */
+export interface GuidedDocumentSection {
+    /** The section ID. Use this as the key into `stringDocument` and `structuredDocument`. */
+    sectionId: string;
+    /** The section heading at generation time, after overrides. */
+    heading: string;
+    /** The zero-based position of this section in the template version's section list. */
+    orderIndex: number;
+}

src/api/types/GuidedEphemeralDocument.ts

@@ -13,8 +13,12 @@ export interface GuidedEphemeralDocument {
     outputLanguage: string;
     /** The interaction whose context was used to generate this document, if supplied. */
     interactionId?: string | null;
+    /** The generated document as a map of section ID to rendered string output. The `sections` array lists every section ID and its heading. */
     stringDocument: Record<string, string>;
+    /** The generated document as a structured object keyed by section ID. The `sections` array lists every section ID and its heading. */
     structuredDocument?: Record<string, unknown> | null;
+    /** Every section in the template version, in template order, including sections the model left empty. Use `sectionId` as the key into `stringDocument` and `structuredDocument`. The `heading` lets you render the section label without a GET request per section. */
+    sections?: Corti.GuidedDocumentSection[];
     /** Key/value labels attached to this document. */
     labels: Corti.GuidedLabel[];
 }

src/api/types/index.ts

@@ -118,6 +118,7 @@ export * from "./GuidedAssemblySectionRef.js";
 export * from "./GuidedBoolNode.js";
 export * from "./GuidedDocumentContext.js";
 export * from "./GuidedDocumentFactMinimal.js";
+export * from "./GuidedDocumentSection.js";
 export * from "./GuidedDocumentsCreateEphemeralResponse.js";
 export * from "./GuidedDocumentsGenerateBase.js";
 export * from "./GuidedDocumentsGenerateByAssembly.js";

src/serialization/types/GuidedDocumentSection.ts

@@ -0,0 +1,22 @@
+// This file was auto-generated by Fern from our API Definition.
+
+import type * as Corti from "../../api/index.js";
+import * as core from "../../core/index.js";
+import type * as serializers from "../index.js";
+
+export const GuidedDocumentSection: core.serialization.ObjectSchema<
+    serializers.GuidedDocumentSection.Raw,
+    Corti.GuidedDocumentSection
+> = core.serialization.object({
+    sectionId: core.serialization.string(),
+    heading: core.serialization.string(),
+    orderIndex: core.serialization.number(),
+});
+
+export declare namespace GuidedDocumentSection {
+    export interface Raw {
+        sectionId: string;
+        heading: string;
+        orderIndex: number;
+    }
+}

src/serialization/types/GuidedEphemeralDocument.ts

@@ -3,6 +3,7 @@
 import type * as Corti from "../../api/index.js";
 import * as core from "../../core/index.js";
 import type * as serializers from "../index.js";
+import { GuidedDocumentSection } from "./GuidedDocumentSection.js";
 import { GuidedLabel } from "./GuidedLabel.js";
 
 export const GuidedEphemeralDocument: core.serialization.ObjectSchema<
@@ -18,6 +19,7 @@ export const GuidedEphemeralDocument: core.serialization.ObjectSchema<
     structuredDocument: core.serialization
         .record(core.serialization.string(), core.serialization.unknown())
         .optionalNullable(),
+    sections: core.serialization.list(GuidedDocumentSection).optional(),
     labels: core.serialization.list(GuidedLabel),
 });
 
@@ -30,6 +32,7 @@ export declare namespace GuidedEphemeralDocument {
         interactionId?: (string | null | undefined) | null;
         stringDocument: Record<string, string>;
         structuredDocument?: (Record<string, unknown> | null | undefined) | null;
+        sections?: GuidedDocumentSection.Raw[] | null;
         labels: GuidedLabel.Raw[];
     }
 }

src/serialization/types/index.ts

@@ -118,6 +118,7 @@ export * from "./GuidedAssemblySectionRef.js";
 export * from "./GuidedBoolNode.js";
 export * from "./GuidedDocumentContext.js";
 export * from "./GuidedDocumentFactMinimal.js";
+export * from "./GuidedDocumentSection.js";
 export * from "./GuidedDocumentsCreateEphemeralResponse.js";
 export * from "./GuidedDocumentsGenerateBase.js";
 export * from "./GuidedDocumentsGenerateByAssembly.js";

tests/wire/documents.test.ts

@@ -1034,6 +1034,14 @@ describe("DocumentsClient", () => {
                 interactionId: "interactionId",
                 stringDocument: { key: "value" },
                 structuredDocument: { key: "value" },
+                sections: [
+                    { sectionId: "f47ac10b-58cc-4372-a567-0e02b2c3d479", heading: "Chief Complaint", orderIndex: 0 },
+                    {
+                        sectionId: "6ba7b810-9dad-11d1-80b4-00c04fd430c8",
+                        heading: "Assessment and Plan",
+                        orderIndex: 1,
+                    },
+                ],
                 labels: [{ key: "key", value: "value" }],
             },
             usageInfo: { creditsConsumed: 1.1 },
@@ -1067,6 +1075,18 @@ describe("DocumentsClient", () => {
                 structuredDocument: {
                     key: "value",
                 },
+                sections: [
+                    {
+                        sectionId: "f47ac10b-58cc-4372-a567-0e02b2c3d479",
+                        heading: "Chief Complaint",
+                        orderIndex: 0,
+                    },
+                    {
+                        sectionId: "6ba7b810-9dad-11d1-80b4-00c04fd430c8",
+                        heading: "Assessment and Plan",
+                        orderIndex: 1,
+                    },
+                ],
                 labels: [
                     {
                         key: "key",