@wix/auto_sdk_rich-content_ricos-conversations 1.0.2 → 1.0.4

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -25,6 +25,8 @@ interface RicosConversation extends RicosConversationUserMessageOneOf {
25
25
  * @maxSize 100
26
26
  */
27
27
  tools?: Tool[];
28
+ /** Current Ricos theme */
29
+ theme?: Theme;
28
30
  }
29
31
  /** @oneof */
30
32
  interface RicosConversationUserMessageOneOf {
@@ -1947,407 +1949,150 @@ interface TemplateSearchConfiguration {
1947
1949
  */
1948
1950
  knowledgeBaseIds?: string[];
1949
1951
  }
1950
- /** Request message for prompting the AI assistant with streaming response delivery */
1951
- interface CreateConversationStreamedRequest {
1952
+ /**
1953
+ * Theme represents the complete visual styling configuration for a ricos document.
1954
+ * It encapsulates all theme elements including colors, fonts, and component styling.
1955
+ */
1956
+ interface Theme {
1952
1957
  /**
1953
- * The conversation context including the current document state and message history.
1954
- * Same as the non-streamed version, but the response will be delivered incrementally
1955
- * through multiple response chunks rather than a single complete response.
1958
+ * Palette of colors used in the theme
1959
+ * Limited to 6 colors in eight-value hexadecimal format (e.g., #FF0099AA)
1960
+ * @format COLOR_HEX
1961
+ * @maxSize 6
1956
1962
  */
1957
- ricosConversation?: RicosConversation;
1963
+ colorPalette?: string[];
1958
1964
  /**
1959
- * Flag to control whether this conversation should be persisted for future continuation.
1960
- * When true, the conversation will be stored and can be continued using the continue endpoint.
1961
- * When false, the conversation will not be persisted .
1965
+ * Background configuration for the page
1966
+ * Can be either a solid color or an image with various styling options
1962
1967
  */
1963
- persist?: boolean;
1968
+ background?: V1Background;
1964
1969
  /**
1965
- * Invocation id
1966
- * @format GUID
1970
+ * Typography settings for various text elements
1971
+ * Includes styling for headings and paragraphs
1967
1972
  */
1968
- invocationId?: string | null;
1969
- }
1970
- /** Streaming response message containing individual chunks of the AI's response */
1971
- interface ConversationResponse {
1972
- /** A single chunk of the AI's response stream. */
1973
- chunk?: RicosConversationChunk;
1973
+ typography?: Typography;
1974
1974
  /**
1975
- * Unique identifier for this conversation session.
1976
- * @format GUID
1975
+ * Button styling configuration
1976
+ * Defines how buttons appear, including their hover states
1977
1977
  */
1978
- conversationId?: string | null;
1978
+ button?: Button;
1979
+ /**
1980
+ * Image styling configuration
1981
+ * Defines how images appear, including borders
1982
+ */
1983
+ image?: V1Image;
1979
1984
  }
1980
1985
  /**
1981
- * Represents a single chunk in a Ricos AI conversation flow
1982
- * Used for streaming responses where the AI assistant delivers content incrementally
1986
+ * Background defines the styling for a page's background.
1987
+ * Supports either color or image backgrounds with configuration options for each.
1983
1988
  */
1984
- interface RicosConversationChunk extends RicosConversationChunkTypeDataOneOf {
1985
- /** Options for explanation chunks that provide textual context */
1986
- explainOptions?: ExplainOption;
1987
- /** Options for insertion chunks that specify where content should be added */
1988
- insertOptions?: InsertOptions;
1989
- /** Options for replacement chunks that specify content range to replace */
1990
- replaceOptions?: ReplaceOptions;
1991
- /** Options for node chunks that contain rich content nodes */
1992
- nodeOptions?: NodeOptions;
1993
- /** Options for node text chunks that contain text with decorations */
1994
- nodeTextOptions?: NodeTextOptions;
1995
- /** Options to notify about existing tool use */
1996
- toolUseOptions?: ToolUseOptions;
1997
- /** Patch options */
1998
- patchOptions?: PatchOptions;
1999
- /** Progress options */
2000
- progressOptions?: ProgressOptions;
2001
- /** Summary options */
2002
- summaryOptions?: SummaryOptions;
2003
- /** Suggestion options */
2004
- suggestionOptions?: SuggestionOptions;
2005
- /** Theme options */
2006
- themeOptions?: ThemeOptions;
2007
- /** The type of chunk that determines its behavior and purpose */
2008
- type?: ChunkTypeWithLiterals;
1989
+ interface V1Background extends V1BackgroundBackgroundTypeOptionsOneOf {
1990
+ /** Settings for color backgrounds, available when type = COLOR */
1991
+ colorOptions?: ColorOptions;
1992
+ /** Settings for image backgrounds, available when type = IMAGE */
1993
+ imageOptions?: ImageOptions;
1994
+ /** Background type determines whether this is a color or image background */
1995
+ type?: BackgroundBackgroundTypeWithLiterals;
2009
1996
  }
2010
1997
  /** @oneof */
2011
- interface RicosConversationChunkTypeDataOneOf {
2012
- /** Options for explanation chunks that provide textual context */
2013
- explainOptions?: ExplainOption;
2014
- /** Options for insertion chunks that specify where content should be added */
2015
- insertOptions?: InsertOptions;
2016
- /** Options for replacement chunks that specify content range to replace */
2017
- replaceOptions?: ReplaceOptions;
2018
- /** Options for node chunks that contain rich content nodes */
2019
- nodeOptions?: NodeOptions;
2020
- /** Options for node text chunks that contain text with decorations */
2021
- nodeTextOptions?: NodeTextOptions;
2022
- /** Options to notify about existing tool use */
2023
- toolUseOptions?: ToolUseOptions;
2024
- /** Patch options */
2025
- patchOptions?: PatchOptions;
2026
- /** Progress options */
2027
- progressOptions?: ProgressOptions;
2028
- /** Summary options */
2029
- summaryOptions?: SummaryOptions;
2030
- /** Suggestion options */
2031
- suggestionOptions?: SuggestionOptions;
2032
- /** Theme options */
2033
- themeOptions?: ThemeOptions;
2034
- }
2035
- /** Defines the type of operation this chunk represents in the conversation flow */
2036
- declare enum ChunkType {
2037
- /** Unspecified chunk type */
2038
- CHUNK_TYPE_UNKNOWN = "CHUNK_TYPE_UNKNOWN",
2039
- /** Explanation chunk containing descriptive text about changes being made */
2040
- EXPLAIN = "EXPLAIN",
2041
- /** Insert operation chunk that adds content after a specified reference point */
2042
- INSERT = "INSERT",
2043
- /** Replace operation chunk that substitutes content within a specified range */
2044
- REPLACE = "REPLACE",
2045
- /** Node chunk that represents a rich content node (images, headings, etc.) */
2046
- NODE = "NODE",
2047
- /** Node text chunk that represents text content within a node with optional decorations */
2048
- NODE_TEXT = "NODE_TEXT",
2049
- /** Marker indicating the end of an insert operation range */
2050
- INSERT_END = "INSERT_END",
2051
- /** Marker indicating the end of a replace operation range */
2052
- REPLACE_END = "REPLACE_END",
2053
- /** Tool use notification chunk indicating that a tool has been used */
2054
- TOOL_USE = "TOOL_USE",
2055
- /** Patch chunk type */
2056
- PATCH = "PATCH",
2057
- /** Progress chunk type */
2058
- PROGRESS = "PROGRESS",
2059
- /** Summary chunk type */
2060
- SUMMARY = "SUMMARY",
2061
- /** Suggestion chunk type */
2062
- SUGGESTION = "SUGGESTION",
2063
- /** Theme chunk type */
2064
- THEME = "THEME"
1998
+ interface V1BackgroundBackgroundTypeOptionsOneOf {
1999
+ /** Settings for color backgrounds, available when type = COLOR */
2000
+ colorOptions?: ColorOptions;
2001
+ /** Settings for image backgrounds, available when type = IMAGE */
2002
+ imageOptions?: ImageOptions;
2065
2003
  }
2066
- /** @enumType */
2067
- type ChunkTypeWithLiterals = ChunkType | 'CHUNK_TYPE_UNKNOWN' | 'EXPLAIN' | 'INSERT' | 'REPLACE' | 'NODE' | 'NODE_TEXT' | 'INSERT_END' | 'REPLACE_END' | 'TOOL_USE' | 'PATCH' | 'PROGRESS' | 'SUMMARY' | 'SUGGESTION' | 'THEME';
2068
- /** Options for explanation chunks that provide context about AI operations */
2069
- interface ExplainOption {
2004
+ /**
2005
+ * ColorSwatch defines a color or gradient that can be used for styling elements.
2006
+ * Supports either solid colors or gradients with configuration options for each.
2007
+ */
2008
+ interface ColorSwatch extends ColorSwatchColorTypeOptionsOneOf {
2070
2009
  /**
2071
- * The explanatory text content describing what changes are being made
2072
- * @maxLength 100000
2010
+ * Solid color value, available when type = COLOR
2011
+ * @format COLOR_HEX
2073
2012
  */
2074
- text?: string;
2013
+ colorOptions?: string | null;
2014
+ /** Gradient configuration, available when type = GRADIENT */
2015
+ gradientOptions?: V1Gradient;
2016
+ /** Type determines whether this is a solid color or gradient */
2017
+ type?: ColorSwatchTypeWithLiterals;
2075
2018
  }
2076
- /** Options for insert operation chunks that specify insertion behavior */
2077
- interface InsertOptions {
2019
+ /** @oneof */
2020
+ interface ColorSwatchColorTypeOptionsOneOf {
2078
2021
  /**
2079
- * The ID of the chunk after which new content will be inserted
2080
- * @maxLength 100
2022
+ * Solid color value, available when type = COLOR
2023
+ * @format COLOR_HEX
2081
2024
  */
2082
- after?: string;
2025
+ colorOptions?: string | null;
2026
+ /** Gradient configuration, available when type = GRADIENT */
2027
+ gradientOptions?: V1Gradient;
2083
2028
  }
2084
- /** Options for replace operation chunks that specify replacement range */
2085
- interface ReplaceOptions {
2029
+ /** ColorSwatchType determines what kind of color styling is being used. */
2030
+ declare enum ColorSwatchType {
2031
+ /** Default value when color swatch type is not specified */
2032
+ UNKNOWN_COLOR_SWATCH_TYPE = "UNKNOWN_COLOR_SWATCH_TYPE",
2033
+ /** Color swatch is a solid color */
2034
+ COLOR = "COLOR",
2035
+ /** Color swatch is a gradient */
2036
+ GRADIENT = "GRADIENT"
2037
+ }
2038
+ /** @enumType */
2039
+ type ColorSwatchTypeWithLiterals = ColorSwatchType | 'UNKNOWN_COLOR_SWATCH_TYPE' | 'COLOR' | 'GRADIENT';
2040
+ /**
2041
+ * Gradient defines a color gradient configuration.
2042
+ * Supports both linear and radial gradients with multiple color stops.
2043
+ */
2044
+ interface V1Gradient extends V1GradientGradientTypeOptionsOneOf {
2086
2045
  /**
2087
- * The starting chunk ID of the range to be replaced (inclusive)
2088
- * @maxLength 100
2046
+ * Angle in degrees for linear gradients (0-360)
2047
+ * @max 360
2089
2048
  */
2090
- from?: string;
2049
+ linearOptions?: number | null;
2050
+ /** Center point for radial gradients */
2051
+ radialOptions?: Center;
2052
+ /** Type determines whether this is a linear or radial gradient */
2053
+ type?: GradientTypeWithLiterals;
2091
2054
  /**
2092
- * The ending chunk ID of the range to be replaced (inclusive)
2093
- * @maxLength 100
2055
+ * Color stops that define the gradient colors and positions
2056
+ * @maxSize 10
2094
2057
  */
2095
- to?: string;
2096
- }
2097
- /** Options for node chunks that contain rich content elements */
2098
- interface NodeOptions {
2058
+ stops?: GradientStop[];
2099
2059
  /**
2100
- * The parent node ID for hierarchical content structure (null for root level)
2101
- * @maxLength 100
2060
+ * Global opacity of the gradients (0.0 to 1.0)
2061
+ * @max 1
2102
2062
  */
2103
- parent?: string | null;
2104
- /** The rich content node to be inserted or manipulated (images, headings, paragraphs, etc.) */
2105
- node?: Node;
2106
- /** Indication that node is still loading and should treated as such */
2107
- pending?: boolean;
2063
+ opacity?: number | null;
2108
2064
  }
2109
- /** Options for node text chunks that contain formatted text content */
2110
- interface NodeTextOptions {
2065
+ /** @oneof */
2066
+ interface V1GradientGradientTypeOptionsOneOf {
2111
2067
  /**
2112
- * The parent node ID to which this text content belongs
2113
- * @maxLength 100
2068
+ * Angle in degrees for linear gradients (0-360)
2069
+ * @max 360
2114
2070
  */
2115
- parent?: string;
2071
+ linearOptions?: number | null;
2072
+ /** Center point for radial gradients */
2073
+ radialOptions?: Center;
2074
+ }
2075
+ /** GradientType determines what kind of gradient is being used. */
2076
+ declare enum GradientType {
2077
+ /** Default value when gradient type is not specified */
2078
+ UNKNOWN_GRADIENT_TYPE = "UNKNOWN_GRADIENT_TYPE",
2079
+ /** Linear gradient that transitions colors along a straight line */
2080
+ LINEAR = "LINEAR",
2081
+ /** Radial gradient that transitions colors outward from a center point */
2082
+ RADIAL = "RADIAL"
2083
+ }
2084
+ /** @enumType */
2085
+ type GradientTypeWithLiterals = GradientType | 'UNKNOWN_GRADIENT_TYPE' | 'LINEAR' | 'RADIAL';
2086
+ /**
2087
+ * GradientStop defines a color position within a gradient.
2088
+ * Each stop has a color, opacity, and position value.
2089
+ */
2090
+ interface GradientStop {
2116
2091
  /**
2117
- * The plain text content to be added to the node
2118
- * @maxLength 100000
2092
+ * Color in eight-value hexadecimal format (e.g., #FF0099AA)
2093
+ * @format COLOR_HEX
2119
2094
  */
2120
- text?: string;
2121
- /**
2122
- * Text decorations applied to this content (bold, italic, links, etc.)
2123
- * @maxSize 15
2124
- */
2125
- decorations?: Decoration[];
2126
- }
2127
- interface ToolUseOptions {
2128
- /**
2129
- * The name of the tool that was used in the conversation
2130
- * @maxLength 100
2131
- */
2132
- toolName?: string;
2133
- /** The parameters used when invoking the tool */
2134
- parameters?: Record<string, any> | null;
2135
- }
2136
- interface DebugOptions {
2137
- /**
2138
- * Raw text received from LLM
2139
- * @maxLength 100
2140
- */
2141
- text?: string;
2142
- }
2143
- interface MetadataOptions {
2144
- microcentsSpent?: string | null;
2145
- inputTokens?: number | null;
2146
- outputTokens?: number | null;
2147
- cacheCreationInputTokens?: number | null;
2148
- cacheReadInputTokens?: number | null;
2149
- }
2150
- interface PatchOptions {
2151
- /** The rich content node to be patched. Most likely this node was in the pending state */
2152
- node?: Node;
2153
- }
2154
- interface ProgressOptions {
2155
- /**
2156
- * The text content describing current progress or ongoing work
2157
- * @maxLength 100000
2158
- */
2159
- text?: string;
2160
- }
2161
- interface SummaryOptions {
2162
- /**
2163
- * The text content providing a summary of completed work or results
2164
- * @maxLength 100000
2165
- */
2166
- text?: string;
2167
- }
2168
- interface SuggestionOptions {
2169
- /**
2170
- * The starting node ID of the region for suggestion (inclusive, optional if no specific region)
2171
- * @maxLength 100
2172
- */
2173
- from?: string | null;
2174
- /**
2175
- * The ending node ID of the region for suggestion (inclusive, optional if no specific region)
2176
- * @maxLength 100
2177
- */
2178
- to?: string | null;
2179
- /** The type of action to perform: either replace existing content or insert new content */
2180
- action?: SuggestionActionWithLiterals;
2181
- /**
2182
- * Specific, actionable prompt describing the improvement to be made
2183
- * @maxLength 1000
2184
- */
2185
- prompt?: string;
2186
- /**
2187
- * Brief summary of the prompt in a few words
2188
- * @maxLength 200
2189
- */
2190
- summary?: string;
2191
- }
2192
- /** Defines the type of suggestion action */
2193
- declare enum SuggestionAction {
2194
- /** Unspecified action type */
2195
- SUGGESTION_ACTION_UNKNOWN = "SUGGESTION_ACTION_UNKNOWN",
2196
- /** Replace the content in the specified range */
2197
- REPLACE = "REPLACE",
2198
- /** Insert new content after the specified range */
2199
- INSERT = "INSERT"
2200
- }
2201
- /** @enumType */
2202
- type SuggestionActionWithLiterals = SuggestionAction | 'SUGGESTION_ACTION_UNKNOWN' | 'REPLACE' | 'INSERT';
2203
- interface ThemeOptions {
2204
- /** Generated theme */
2205
- theme?: Theme;
2206
- }
2207
- /**
2208
- * Theme represents the complete visual styling configuration for a ricos document.
2209
- * It encapsulates all theme elements including colors, fonts, and component styling.
2210
- */
2211
- interface Theme {
2212
- /**
2213
- * Palette of colors used in the theme
2214
- * Limited to 6 colors in eight-value hexadecimal format (e.g., #FF0099AA)
2215
- * @format COLOR_HEX
2216
- * @maxSize 6
2217
- */
2218
- colorPalette?: string[];
2219
- /**
2220
- * Background configuration for the page
2221
- * Can be either a solid color or an image with various styling options
2222
- */
2223
- background?: V1Background;
2224
- /**
2225
- * Typography settings for various text elements
2226
- * Includes styling for headings and paragraphs
2227
- */
2228
- typography?: Typography;
2229
- /**
2230
- * Button styling configuration
2231
- * Defines how buttons appear, including their hover states
2232
- */
2233
- button?: Button;
2234
- /**
2235
- * Image styling configuration
2236
- * Defines how images appear, including borders
2237
- */
2238
- image?: V1Image;
2239
- }
2240
- /**
2241
- * Background defines the styling for a page's background.
2242
- * Supports either color or image backgrounds with configuration options for each.
2243
- */
2244
- interface V1Background extends V1BackgroundBackgroundTypeOptionsOneOf {
2245
- /** Settings for color backgrounds, available when type = COLOR */
2246
- colorOptions?: ColorOptions;
2247
- /** Settings for image backgrounds, available when type = IMAGE */
2248
- imageOptions?: ImageOptions;
2249
- /** Background type determines whether this is a color or image background */
2250
- type?: BackgroundBackgroundTypeWithLiterals;
2251
- }
2252
- /** @oneof */
2253
- interface V1BackgroundBackgroundTypeOptionsOneOf {
2254
- /** Settings for color backgrounds, available when type = COLOR */
2255
- colorOptions?: ColorOptions;
2256
- /** Settings for image backgrounds, available when type = IMAGE */
2257
- imageOptions?: ImageOptions;
2258
- }
2259
- /**
2260
- * ColorSwatch defines a color or gradient that can be used for styling elements.
2261
- * Supports either solid colors or gradients with configuration options for each.
2262
- */
2263
- interface ColorSwatch extends ColorSwatchColorTypeOptionsOneOf {
2264
- /**
2265
- * Solid color value, available when type = COLOR
2266
- * @format COLOR_HEX
2267
- */
2268
- colorOptions?: string | null;
2269
- /** Gradient configuration, available when type = GRADIENT */
2270
- gradientOptions?: V1Gradient;
2271
- /** Type determines whether this is a solid color or gradient */
2272
- type?: ColorSwatchTypeWithLiterals;
2273
- }
2274
- /** @oneof */
2275
- interface ColorSwatchColorTypeOptionsOneOf {
2276
- /**
2277
- * Solid color value, available when type = COLOR
2278
- * @format COLOR_HEX
2279
- */
2280
- colorOptions?: string | null;
2281
- /** Gradient configuration, available when type = GRADIENT */
2282
- gradientOptions?: V1Gradient;
2283
- }
2284
- /** ColorSwatchType determines what kind of color styling is being used. */
2285
- declare enum ColorSwatchType {
2286
- /** Default value when color swatch type is not specified */
2287
- UNKNOWN_COLOR_SWATCH_TYPE = "UNKNOWN_COLOR_SWATCH_TYPE",
2288
- /** Color swatch is a solid color */
2289
- COLOR = "COLOR",
2290
- /** Color swatch is a gradient */
2291
- GRADIENT = "GRADIENT"
2292
- }
2293
- /** @enumType */
2294
- type ColorSwatchTypeWithLiterals = ColorSwatchType | 'UNKNOWN_COLOR_SWATCH_TYPE' | 'COLOR' | 'GRADIENT';
2295
- /**
2296
- * Gradient defines a color gradient configuration.
2297
- * Supports both linear and radial gradients with multiple color stops.
2298
- */
2299
- interface V1Gradient extends V1GradientGradientTypeOptionsOneOf {
2300
- /**
2301
- * Angle in degrees for linear gradients (0-360)
2302
- * @max 360
2303
- */
2304
- linearOptions?: number | null;
2305
- /** Center point for radial gradients */
2306
- radialOptions?: Center;
2307
- /** Type determines whether this is a linear or radial gradient */
2308
- type?: GradientTypeWithLiterals;
2309
- /**
2310
- * Color stops that define the gradient colors and positions
2311
- * @maxSize 10
2312
- */
2313
- stops?: GradientStop[];
2314
- /**
2315
- * Global opacity of the gradients (0.0 to 1.0)
2316
- * @max 1
2317
- */
2318
- opacity?: number | null;
2319
- }
2320
- /** @oneof */
2321
- interface V1GradientGradientTypeOptionsOneOf {
2322
- /**
2323
- * Angle in degrees for linear gradients (0-360)
2324
- * @max 360
2325
- */
2326
- linearOptions?: number | null;
2327
- /** Center point for radial gradients */
2328
- radialOptions?: Center;
2329
- }
2330
- /** GradientType determines what kind of gradient is being used. */
2331
- declare enum GradientType {
2332
- /** Default value when gradient type is not specified */
2333
- UNKNOWN_GRADIENT_TYPE = "UNKNOWN_GRADIENT_TYPE",
2334
- /** Linear gradient that transitions colors along a straight line */
2335
- LINEAR = "LINEAR",
2336
- /** Radial gradient that transitions colors outward from a center point */
2337
- RADIAL = "RADIAL"
2338
- }
2339
- /** @enumType */
2340
- type GradientTypeWithLiterals = GradientType | 'UNKNOWN_GRADIENT_TYPE' | 'LINEAR' | 'RADIAL';
2341
- /**
2342
- * GradientStop defines a color position within a gradient.
2343
- * Each stop has a color, opacity, and position value.
2344
- */
2345
- interface GradientStop {
2346
- /**
2347
- * Color in eight-value hexadecimal format (e.g., #FF0099AA)
2348
- * @format COLOR_HEX
2349
- */
2350
- color?: string | null;
2095
+ color?: string | null;
2351
2096
  /**
2352
2097
  * Opacity of the color at this stop (0.0 to 1.0)
2353
2098
  * Deprecated, opacity is an alpha part of the color field
@@ -2634,6 +2379,263 @@ interface ImageBorder {
2634
2379
  */
2635
2380
  color?: string | null;
2636
2381
  }
2382
+ /** Request message for prompting the AI assistant with streaming response delivery */
2383
+ interface CreateConversationStreamedRequest {
2384
+ /**
2385
+ * The conversation context including the current document state and message history.
2386
+ * Same as the non-streamed version, but the response will be delivered incrementally
2387
+ * through multiple response chunks rather than a single complete response.
2388
+ */
2389
+ ricosConversation?: RicosConversation;
2390
+ /**
2391
+ * Flag to control whether this conversation should be persisted for future continuation.
2392
+ * When true, the conversation will be stored and can be continued using the continue endpoint.
2393
+ * When false, the conversation will not be persisted .
2394
+ */
2395
+ persist?: boolean;
2396
+ /**
2397
+ * Invocation id
2398
+ * @format GUID
2399
+ */
2400
+ invocationId?: string | null;
2401
+ }
2402
+ /** Streaming response message containing individual chunks of the AI's response */
2403
+ interface ConversationResponse {
2404
+ /** A single chunk of the AI's response stream. */
2405
+ chunk?: RicosConversationChunk;
2406
+ /**
2407
+ * Unique identifier for this conversation session.
2408
+ * @format GUID
2409
+ */
2410
+ conversationId?: string | null;
2411
+ }
2412
+ /**
2413
+ * Represents a single chunk in a Ricos AI conversation flow
2414
+ * Used for streaming responses where the AI assistant delivers content incrementally
2415
+ */
2416
+ interface RicosConversationChunk extends RicosConversationChunkTypeDataOneOf {
2417
+ /** Options for explanation chunks that provide textual context */
2418
+ explainOptions?: ExplainOption;
2419
+ /** Options for insertion chunks that specify where content should be added */
2420
+ insertOptions?: InsertOptions;
2421
+ /** Options for replacement chunks that specify content range to replace */
2422
+ replaceOptions?: ReplaceOptions;
2423
+ /** Options for node chunks that contain rich content nodes */
2424
+ nodeOptions?: NodeOptions;
2425
+ /** Options for node text chunks that contain text with decorations */
2426
+ nodeTextOptions?: NodeTextOptions;
2427
+ /** Options to notify about existing tool use */
2428
+ toolUseOptions?: ToolUseOptions;
2429
+ /** Patch options */
2430
+ patchOptions?: PatchOptions;
2431
+ /** Progress options */
2432
+ progressOptions?: ProgressOptions;
2433
+ /** Summary options */
2434
+ summaryOptions?: SummaryOptions;
2435
+ /** Suggestion options */
2436
+ suggestionOptions?: SuggestionOptions;
2437
+ /** Theme options */
2438
+ themeOptions?: ThemeOptions;
2439
+ /** The type of chunk that determines its behavior and purpose */
2440
+ type?: ChunkTypeWithLiterals;
2441
+ }
2442
+ /** @oneof */
2443
+ interface RicosConversationChunkTypeDataOneOf {
2444
+ /** Options for explanation chunks that provide textual context */
2445
+ explainOptions?: ExplainOption;
2446
+ /** Options for insertion chunks that specify where content should be added */
2447
+ insertOptions?: InsertOptions;
2448
+ /** Options for replacement chunks that specify content range to replace */
2449
+ replaceOptions?: ReplaceOptions;
2450
+ /** Options for node chunks that contain rich content nodes */
2451
+ nodeOptions?: NodeOptions;
2452
+ /** Options for node text chunks that contain text with decorations */
2453
+ nodeTextOptions?: NodeTextOptions;
2454
+ /** Options to notify about existing tool use */
2455
+ toolUseOptions?: ToolUseOptions;
2456
+ /** Patch options */
2457
+ patchOptions?: PatchOptions;
2458
+ /** Progress options */
2459
+ progressOptions?: ProgressOptions;
2460
+ /** Summary options */
2461
+ summaryOptions?: SummaryOptions;
2462
+ /** Suggestion options */
2463
+ suggestionOptions?: SuggestionOptions;
2464
+ /** Theme options */
2465
+ themeOptions?: ThemeOptions;
2466
+ }
2467
+ /** Defines the type of operation this chunk represents in the conversation flow */
2468
+ declare enum ChunkType {
2469
+ /** Unspecified chunk type */
2470
+ CHUNK_TYPE_UNKNOWN = "CHUNK_TYPE_UNKNOWN",
2471
+ /** Explanation chunk containing descriptive text about changes being made */
2472
+ EXPLAIN = "EXPLAIN",
2473
+ /** Insert operation chunk that adds content after a specified reference point */
2474
+ INSERT = "INSERT",
2475
+ /** Replace operation chunk that substitutes content within a specified range */
2476
+ REPLACE = "REPLACE",
2477
+ /** Node chunk that represents a rich content node (images, headings, etc.) */
2478
+ NODE = "NODE",
2479
+ /** Node text chunk that represents text content within a node with optional decorations */
2480
+ NODE_TEXT = "NODE_TEXT",
2481
+ /** Marker indicating the end of an insert operation range */
2482
+ INSERT_END = "INSERT_END",
2483
+ /** Marker indicating the end of a replace operation range */
2484
+ REPLACE_END = "REPLACE_END",
2485
+ /** Tool use notification chunk indicating that a tool has been used */
2486
+ TOOL_USE = "TOOL_USE",
2487
+ /** Patch chunk type */
2488
+ PATCH = "PATCH",
2489
+ /** Progress chunk type */
2490
+ PROGRESS = "PROGRESS",
2491
+ /** Summary chunk type */
2492
+ SUMMARY = "SUMMARY",
2493
+ /** Suggestion chunk type */
2494
+ SUGGESTION = "SUGGESTION",
2495
+ /** Theme chunk type */
2496
+ THEME = "THEME"
2497
+ }
2498
+ /** @enumType */
2499
+ type ChunkTypeWithLiterals = ChunkType | 'CHUNK_TYPE_UNKNOWN' | 'EXPLAIN' | 'INSERT' | 'REPLACE' | 'NODE' | 'NODE_TEXT' | 'INSERT_END' | 'REPLACE_END' | 'TOOL_USE' | 'PATCH' | 'PROGRESS' | 'SUMMARY' | 'SUGGESTION' | 'THEME';
2500
+ /** Options for explanation chunks that provide context about AI operations */
2501
+ interface ExplainOption {
2502
+ /**
2503
+ * The explanatory text content describing what changes are being made
2504
+ * @maxLength 100000
2505
+ */
2506
+ text?: string;
2507
+ }
2508
+ /** Options for insert operation chunks that specify insertion behavior */
2509
+ interface InsertOptions {
2510
+ /**
2511
+ * The ID of the chunk after which new content will be inserted
2512
+ * @maxLength 100
2513
+ */
2514
+ after?: string;
2515
+ }
2516
+ /** Options for replace operation chunks that specify replacement range */
2517
+ interface ReplaceOptions {
2518
+ /**
2519
+ * The starting chunk ID of the range to be replaced (inclusive)
2520
+ * @maxLength 100
2521
+ */
2522
+ from?: string;
2523
+ /**
2524
+ * The ending chunk ID of the range to be replaced (inclusive)
2525
+ * @maxLength 100
2526
+ */
2527
+ to?: string;
2528
+ }
2529
+ /** Options for node chunks that contain rich content elements */
2530
+ interface NodeOptions {
2531
+ /**
2532
+ * The parent node ID for hierarchical content structure (null for root level)
2533
+ * @maxLength 100
2534
+ */
2535
+ parent?: string | null;
2536
+ /** The rich content node to be inserted or manipulated (images, headings, paragraphs, etc.) */
2537
+ node?: Node;
2538
+ /** Indication that node is still loading and should treated as such */
2539
+ pending?: boolean;
2540
+ }
2541
+ /** Options for node text chunks that contain formatted text content */
2542
+ interface NodeTextOptions {
2543
+ /**
2544
+ * The parent node ID to which this text content belongs
2545
+ * @maxLength 100
2546
+ */
2547
+ parent?: string;
2548
+ /**
2549
+ * The plain text content to be added to the node
2550
+ * @maxLength 100000
2551
+ */
2552
+ text?: string;
2553
+ /**
2554
+ * Text decorations applied to this content (bold, italic, links, etc.)
2555
+ * @maxSize 15
2556
+ */
2557
+ decorations?: Decoration[];
2558
+ }
2559
+ interface ToolUseOptions {
2560
+ /**
2561
+ * The name of the tool that was used in the conversation
2562
+ * @maxLength 100
2563
+ */
2564
+ toolName?: string;
2565
+ /** The parameters used when invoking the tool */
2566
+ parameters?: Record<string, any> | null;
2567
+ }
2568
+ interface DebugOptions {
2569
+ /**
2570
+ * Raw text received from LLM
2571
+ * @maxLength 100
2572
+ */
2573
+ text?: string;
2574
+ }
2575
+ interface MetadataOptions {
2576
+ microcentsSpent?: string | null;
2577
+ inputTokens?: number | null;
2578
+ outputTokens?: number | null;
2579
+ cacheCreationInputTokens?: number | null;
2580
+ cacheReadInputTokens?: number | null;
2581
+ }
2582
+ interface PatchOptions {
2583
+ /** The rich content node to be patched. Most likely this node was in the pending state */
2584
+ node?: Node;
2585
+ }
2586
+ interface ProgressOptions {
2587
+ /**
2588
+ * The text content describing current progress or ongoing work
2589
+ * @maxLength 100000
2590
+ */
2591
+ text?: string;
2592
+ }
2593
+ interface SummaryOptions {
2594
+ /**
2595
+ * The text content providing a summary of completed work or results
2596
+ * @maxLength 100000
2597
+ */
2598
+ text?: string;
2599
+ }
2600
+ interface SuggestionOptions {
2601
+ /**
2602
+ * The starting node ID of the region for suggestion (inclusive, optional if no specific region)
2603
+ * @maxLength 100
2604
+ */
2605
+ from?: string | null;
2606
+ /**
2607
+ * The ending node ID of the region for suggestion (inclusive, optional if no specific region)
2608
+ * @maxLength 100
2609
+ */
2610
+ to?: string | null;
2611
+ /** The type of action to perform: either replace existing content or insert new content */
2612
+ action?: SuggestionActionWithLiterals;
2613
+ /**
2614
+ * Specific, actionable prompt describing the improvement to be made
2615
+ * @maxLength 1000
2616
+ */
2617
+ prompt?: string;
2618
+ /**
2619
+ * Brief summary of the prompt in a few words
2620
+ * @maxLength 200
2621
+ */
2622
+ summary?: string;
2623
+ }
2624
+ /** Defines the type of suggestion action */
2625
+ declare enum SuggestionAction {
2626
+ /** Unspecified action type */
2627
+ SUGGESTION_ACTION_UNKNOWN = "SUGGESTION_ACTION_UNKNOWN",
2628
+ /** Replace the content in the specified range */
2629
+ REPLACE = "REPLACE",
2630
+ /** Insert new content after the specified range */
2631
+ INSERT = "INSERT"
2632
+ }
2633
+ /** @enumType */
2634
+ type SuggestionActionWithLiterals = SuggestionAction | 'SUGGESTION_ACTION_UNKNOWN' | 'REPLACE' | 'INSERT';
2635
+ interface ThemeOptions {
2636
+ /** Generated theme */
2637
+ theme?: Theme;
2638
+ }
2637
2639
  /** Request message for continuing an existing conversation with streaming response delivery */
2638
2640
  interface ContinueConversationStreamedRequest {
2639
2641
  /** The conversation context including the current document state and message history. */
@@ -2676,6 +2678,8 @@ interface CreateRicosConversationResponse {
2676
2678
  progress?: ProgressOptions[];
2677
2679
  /** List of suggestion entries produced during processing */
2678
2680
  suggestions?: SuggestionOptions[];
2681
+ /** Theme */
2682
+ theme?: ThemeOptions;
2679
2683
  }
2680
2684
  /** Request message for listing RichContent document suggestions */
2681
2685
  interface ListConversationSuggestionsRequest {