@wix/auto_sdk_rich-content_ricos-conversations 1.0.3 → 1.0.5
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.
- package/build/cjs/index.d.ts +414 -390
- package/build/cjs/index.js +120 -388
- package/build/cjs/index.js.map +1 -1
- package/build/cjs/index.typings.d.ts +1 -1
- package/build/cjs/index.typings.js +120 -380
- package/build/cjs/index.typings.js.map +1 -1
- package/build/cjs/meta.d.ts +415 -382
- package/build/cjs/meta.js +120 -364
- package/build/cjs/meta.js.map +1 -1
- package/build/es/index.d.mts +414 -390
- package/build/es/index.mjs +118 -387
- package/build/es/index.mjs.map +1 -1
- package/build/es/index.typings.d.mts +1 -1
- package/build/es/index.typings.mjs +118 -379
- package/build/es/index.typings.mjs.map +1 -1
- package/build/es/meta.d.mts +415 -382
- package/build/es/meta.mjs +118 -363
- package/build/es/meta.mjs.map +1 -1
- package/build/internal/cjs/index.d.ts +3 -14
- package/build/internal/cjs/index.js +120 -388
- package/build/internal/cjs/index.js.map +1 -1
- package/build/internal/cjs/index.typings.d.ts +414 -400
- package/build/internal/cjs/index.typings.js +120 -380
- package/build/internal/cjs/index.typings.js.map +1 -1
- package/build/internal/cjs/meta.d.ts +415 -382
- package/build/internal/cjs/meta.js +120 -364
- package/build/internal/cjs/meta.js.map +1 -1
- package/build/internal/es/index.d.mts +3 -14
- package/build/internal/es/index.mjs +118 -387
- package/build/internal/es/index.mjs.map +1 -1
- package/build/internal/es/index.typings.d.mts +414 -400
- package/build/internal/es/index.typings.mjs +118 -379
- package/build/internal/es/index.typings.mjs.map +1 -1
- package/build/internal/es/meta.d.mts +415 -382
- package/build/internal/es/meta.mjs +118 -363
- package/build/internal/es/meta.mjs.map +1 -1
- package/package.json +3 -3
package/build/cjs/index.d.ts
CHANGED
|
@@ -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,152 @@ interface TemplateSearchConfiguration {
|
|
|
1947
1949
|
*/
|
|
1948
1950
|
knowledgeBaseIds?: string[];
|
|
1949
1951
|
}
|
|
1950
|
-
/**
|
|
1951
|
-
|
|
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
|
-
*
|
|
1954
|
-
*
|
|
1955
|
-
*
|
|
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
|
-
|
|
1963
|
+
colorPalette?: string[];
|
|
1958
1964
|
/**
|
|
1959
|
-
*
|
|
1960
|
-
*
|
|
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
|
-
|
|
1968
|
+
background?: V1Background;
|
|
1964
1969
|
/**
|
|
1965
|
-
*
|
|
1966
|
-
*
|
|
1970
|
+
* Typography settings for various text elements
|
|
1971
|
+
* Includes styling for headings and paragraphs
|
|
1967
1972
|
*/
|
|
1968
|
-
|
|
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
|
-
*
|
|
1976
|
-
*
|
|
1975
|
+
* Button styling configuration
|
|
1976
|
+
* Defines how buttons appear, including their hover states
|
|
1977
1977
|
*/
|
|
1978
|
-
|
|
1978
|
+
button?: Button;
|
|
1979
|
+
/**
|
|
1980
|
+
* Image styling configuration
|
|
1981
|
+
* Defines how images appear, including borders
|
|
1982
|
+
*/
|
|
1983
|
+
image?: V1Image;
|
|
1984
|
+
/** Page setup configuration for layout and spacing */
|
|
1985
|
+
pageSetup?: PageSetup;
|
|
1979
1986
|
}
|
|
1980
1987
|
/**
|
|
1981
|
-
*
|
|
1982
|
-
*
|
|
1988
|
+
* Background defines the styling for a page's background.
|
|
1989
|
+
* Supports either color or image backgrounds with configuration options for each.
|
|
1983
1990
|
*/
|
|
1984
|
-
interface
|
|
1985
|
-
/**
|
|
1986
|
-
|
|
1987
|
-
/**
|
|
1988
|
-
|
|
1989
|
-
/**
|
|
1990
|
-
|
|
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;
|
|
1991
|
+
interface V1Background extends V1BackgroundBackgroundTypeOptionsOneOf {
|
|
1992
|
+
/** Settings for color backgrounds, available when type = COLOR */
|
|
1993
|
+
colorOptions?: ColorOptions;
|
|
1994
|
+
/** Settings for image backgrounds, available when type = IMAGE */
|
|
1995
|
+
imageOptions?: ImageOptions;
|
|
1996
|
+
/** Background type determines whether this is a color or image background */
|
|
1997
|
+
type?: BackgroundBackgroundTypeWithLiterals;
|
|
2009
1998
|
}
|
|
2010
1999
|
/** @oneof */
|
|
2011
|
-
interface
|
|
2012
|
-
/**
|
|
2013
|
-
|
|
2014
|
-
/**
|
|
2015
|
-
|
|
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"
|
|
2000
|
+
interface V1BackgroundBackgroundTypeOptionsOneOf {
|
|
2001
|
+
/** Settings for color backgrounds, available when type = COLOR */
|
|
2002
|
+
colorOptions?: ColorOptions;
|
|
2003
|
+
/** Settings for image backgrounds, available when type = IMAGE */
|
|
2004
|
+
imageOptions?: ImageOptions;
|
|
2065
2005
|
}
|
|
2066
|
-
/**
|
|
2067
|
-
|
|
2068
|
-
|
|
2069
|
-
|
|
2006
|
+
/**
|
|
2007
|
+
* ColorSwatch defines a color or gradient that can be used for styling elements.
|
|
2008
|
+
* Supports either solid colors or gradients with configuration options for each.
|
|
2009
|
+
*/
|
|
2010
|
+
interface ColorSwatch extends ColorSwatchColorTypeOptionsOneOf {
|
|
2070
2011
|
/**
|
|
2071
|
-
*
|
|
2072
|
-
* @
|
|
2012
|
+
* Solid color value, available when type = COLOR
|
|
2013
|
+
* @format COLOR_HEX
|
|
2073
2014
|
*/
|
|
2074
|
-
|
|
2015
|
+
colorOptions?: string | null;
|
|
2016
|
+
/** Gradient configuration, available when type = GRADIENT */
|
|
2017
|
+
gradientOptions?: V1Gradient;
|
|
2018
|
+
/** Type determines whether this is a solid color or gradient */
|
|
2019
|
+
type?: ColorSwatchTypeWithLiterals;
|
|
2075
2020
|
}
|
|
2076
|
-
/**
|
|
2077
|
-
interface
|
|
2021
|
+
/** @oneof */
|
|
2022
|
+
interface ColorSwatchColorTypeOptionsOneOf {
|
|
2078
2023
|
/**
|
|
2079
|
-
*
|
|
2080
|
-
* @
|
|
2024
|
+
* Solid color value, available when type = COLOR
|
|
2025
|
+
* @format COLOR_HEX
|
|
2081
2026
|
*/
|
|
2082
|
-
|
|
2027
|
+
colorOptions?: string | null;
|
|
2028
|
+
/** Gradient configuration, available when type = GRADIENT */
|
|
2029
|
+
gradientOptions?: V1Gradient;
|
|
2083
2030
|
}
|
|
2084
|
-
/**
|
|
2085
|
-
|
|
2031
|
+
/** ColorSwatchType determines what kind of color styling is being used. */
|
|
2032
|
+
declare enum ColorSwatchType {
|
|
2033
|
+
/** Default value when color swatch type is not specified */
|
|
2034
|
+
UNKNOWN_COLOR_SWATCH_TYPE = "UNKNOWN_COLOR_SWATCH_TYPE",
|
|
2035
|
+
/** Color swatch is a solid color */
|
|
2036
|
+
COLOR = "COLOR",
|
|
2037
|
+
/** Color swatch is a gradient */
|
|
2038
|
+
GRADIENT = "GRADIENT"
|
|
2039
|
+
}
|
|
2040
|
+
/** @enumType */
|
|
2041
|
+
type ColorSwatchTypeWithLiterals = ColorSwatchType | 'UNKNOWN_COLOR_SWATCH_TYPE' | 'COLOR' | 'GRADIENT';
|
|
2042
|
+
/**
|
|
2043
|
+
* Gradient defines a color gradient configuration.
|
|
2044
|
+
* Supports both linear and radial gradients with multiple color stops.
|
|
2045
|
+
*/
|
|
2046
|
+
interface V1Gradient extends V1GradientGradientTypeOptionsOneOf {
|
|
2086
2047
|
/**
|
|
2087
|
-
*
|
|
2088
|
-
* @
|
|
2048
|
+
* Angle in degrees for linear gradients (0-360)
|
|
2049
|
+
* @max 360
|
|
2089
2050
|
*/
|
|
2090
|
-
|
|
2051
|
+
linearOptions?: number | null;
|
|
2052
|
+
/** Center point for radial gradients */
|
|
2053
|
+
radialOptions?: Center;
|
|
2054
|
+
/** Type determines whether this is a linear or radial gradient */
|
|
2055
|
+
type?: GradientTypeWithLiterals;
|
|
2091
2056
|
/**
|
|
2092
|
-
*
|
|
2093
|
-
* @
|
|
2057
|
+
* Color stops that define the gradient colors and positions
|
|
2058
|
+
* @maxSize 10
|
|
2094
2059
|
*/
|
|
2095
|
-
|
|
2096
|
-
}
|
|
2097
|
-
/** Options for node chunks that contain rich content elements */
|
|
2098
|
-
interface NodeOptions {
|
|
2060
|
+
stops?: GradientStop[];
|
|
2099
2061
|
/**
|
|
2100
|
-
*
|
|
2101
|
-
* @
|
|
2062
|
+
* Global opacity of the gradients (0.0 to 1.0)
|
|
2063
|
+
* @max 1
|
|
2102
2064
|
*/
|
|
2103
|
-
|
|
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;
|
|
2065
|
+
opacity?: number | null;
|
|
2108
2066
|
}
|
|
2109
|
-
/**
|
|
2110
|
-
interface
|
|
2067
|
+
/** @oneof */
|
|
2068
|
+
interface V1GradientGradientTypeOptionsOneOf {
|
|
2111
2069
|
/**
|
|
2112
|
-
*
|
|
2113
|
-
* @
|
|
2070
|
+
* Angle in degrees for linear gradients (0-360)
|
|
2071
|
+
* @max 360
|
|
2114
2072
|
*/
|
|
2115
|
-
|
|
2073
|
+
linearOptions?: number | null;
|
|
2074
|
+
/** Center point for radial gradients */
|
|
2075
|
+
radialOptions?: Center;
|
|
2076
|
+
}
|
|
2077
|
+
/** GradientType determines what kind of gradient is being used. */
|
|
2078
|
+
declare enum GradientType {
|
|
2079
|
+
/** Default value when gradient type is not specified */
|
|
2080
|
+
UNKNOWN_GRADIENT_TYPE = "UNKNOWN_GRADIENT_TYPE",
|
|
2081
|
+
/** Linear gradient that transitions colors along a straight line */
|
|
2082
|
+
LINEAR = "LINEAR",
|
|
2083
|
+
/** Radial gradient that transitions colors outward from a center point */
|
|
2084
|
+
RADIAL = "RADIAL"
|
|
2085
|
+
}
|
|
2086
|
+
/** @enumType */
|
|
2087
|
+
type GradientTypeWithLiterals = GradientType | 'UNKNOWN_GRADIENT_TYPE' | 'LINEAR' | 'RADIAL';
|
|
2088
|
+
/**
|
|
2089
|
+
* GradientStop defines a color position within a gradient.
|
|
2090
|
+
* Each stop has a color, opacity, and position value.
|
|
2091
|
+
*/
|
|
2092
|
+
interface GradientStop {
|
|
2116
2093
|
/**
|
|
2117
|
-
*
|
|
2118
|
-
* @
|
|
2094
|
+
* Color in eight-value hexadecimal format (e.g., #FF0099AA)
|
|
2095
|
+
* @format COLOR_HEX
|
|
2119
2096
|
*/
|
|
2120
|
-
|
|
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;
|
|
2097
|
+
color?: string | null;
|
|
2351
2098
|
/**
|
|
2352
2099
|
* Opacity of the color at this stop (0.0 to 1.0)
|
|
2353
2100
|
* Deprecated, opacity is an alpha part of the color field
|
|
@@ -2634,21 +2381,308 @@ interface ImageBorder {
|
|
|
2634
2381
|
*/
|
|
2635
2382
|
color?: string | null;
|
|
2636
2383
|
}
|
|
2637
|
-
/**
|
|
2638
|
-
|
|
2639
|
-
|
|
2384
|
+
/**
|
|
2385
|
+
* PageSetup defines the layout configuration for pages.
|
|
2386
|
+
* Includes settings for horizontal padding and vertical padding to control page spacing.
|
|
2387
|
+
*/
|
|
2388
|
+
interface PageSetup {
|
|
2389
|
+
/** Horizontal padding configuration that determines the horizontal spacing of page content */
|
|
2390
|
+
horizontalPadding?: HorizontalPaddingTypeWithLiterals;
|
|
2391
|
+
/** Vertical padding configuration that controls spacing above and below content */
|
|
2392
|
+
verticalPadding?: VerticalPaddingTypeWithLiterals;
|
|
2393
|
+
}
|
|
2394
|
+
/**
|
|
2395
|
+
* Type defines the preset horizontal padding options for page content.
|
|
2396
|
+
* Each option provides different amounts of horizontal spacing for content layout.
|
|
2397
|
+
*/
|
|
2398
|
+
declare enum HorizontalPaddingType {
|
|
2399
|
+
/** Default value when horizontal padding is not specified */
|
|
2400
|
+
UNKNOWN_HORIZONTAL_PADDING = "UNKNOWN_HORIZONTAL_PADDING",
|
|
2401
|
+
/** No horizontal padding - content extends to page edges */
|
|
2402
|
+
NONE = "NONE",
|
|
2403
|
+
/** Small horizontal padding - minimal left/right spacing, results in wide content area */
|
|
2404
|
+
SMALL = "SMALL",
|
|
2405
|
+
/** Medium horizontal padding - standard left/right spacing, results in balanced content width */
|
|
2406
|
+
MEDIUM = "MEDIUM",
|
|
2407
|
+
/** Large horizontal padding - generous left/right spacing, results in narrow content area */
|
|
2408
|
+
LARGE = "LARGE"
|
|
2409
|
+
}
|
|
2410
|
+
/** @enumType */
|
|
2411
|
+
type HorizontalPaddingTypeWithLiterals = HorizontalPaddingType | 'UNKNOWN_HORIZONTAL_PADDING' | 'NONE' | 'SMALL' | 'MEDIUM' | 'LARGE';
|
|
2412
|
+
/**
|
|
2413
|
+
* Type defines the preset vertical padding options for page content.
|
|
2414
|
+
* Each option provides different amounts of spacing around content.
|
|
2415
|
+
*/
|
|
2416
|
+
declare enum VerticalPaddingType {
|
|
2417
|
+
/** Default value when vertical padding is not specified */
|
|
2418
|
+
UNKNOWN_VERTICAL_PADDING = "UNKNOWN_VERTICAL_PADDING",
|
|
2419
|
+
/** No vertical padding - content extends to page edges */
|
|
2420
|
+
NONE = "NONE",
|
|
2421
|
+
/** Small vertical padding - minimal spacing around content */
|
|
2422
|
+
SMALL = "SMALL",
|
|
2423
|
+
/** Medium vertical padding - standard spacing around content */
|
|
2424
|
+
MEDIUM = "MEDIUM",
|
|
2425
|
+
/** Large vertical padding - generous spacing around content */
|
|
2426
|
+
LARGE = "LARGE"
|
|
2427
|
+
}
|
|
2428
|
+
/** @enumType */
|
|
2429
|
+
type VerticalPaddingTypeWithLiterals = VerticalPaddingType | 'UNKNOWN_VERTICAL_PADDING' | 'NONE' | 'SMALL' | 'MEDIUM' | 'LARGE';
|
|
2430
|
+
/** Request message for prompting the AI assistant with streaming response delivery */
|
|
2431
|
+
interface CreateConversationStreamedRequest {
|
|
2432
|
+
/**
|
|
2433
|
+
* The conversation context including the current document state and message history.
|
|
2434
|
+
* Same as the non-streamed version, but the response will be delivered incrementally
|
|
2435
|
+
* through multiple response chunks rather than a single complete response.
|
|
2436
|
+
*/
|
|
2640
2437
|
ricosConversation?: RicosConversation;
|
|
2438
|
+
/**
|
|
2439
|
+
* Flag to control whether this conversation should be persisted for future continuation.
|
|
2440
|
+
* When true, the conversation will be stored and can be continued using the continue endpoint.
|
|
2441
|
+
* When false, the conversation will not be persisted .
|
|
2442
|
+
*/
|
|
2443
|
+
persist?: boolean;
|
|
2444
|
+
/**
|
|
2445
|
+
* Invocation id
|
|
2446
|
+
* @format GUID
|
|
2447
|
+
*/
|
|
2448
|
+
invocationId?: string | null;
|
|
2449
|
+
}
|
|
2450
|
+
/** Streaming response message containing individual chunks of the AI's response */
|
|
2451
|
+
interface ConversationResponse {
|
|
2452
|
+
/** A single chunk of the AI's response stream. */
|
|
2453
|
+
chunk?: RicosConversationChunk;
|
|
2454
|
+
}
|
|
2455
|
+
/**
|
|
2456
|
+
* Represents a single chunk in a Ricos AI conversation flow
|
|
2457
|
+
* Used for streaming responses where the AI assistant delivers content incrementally
|
|
2458
|
+
*/
|
|
2459
|
+
interface RicosConversationChunk extends RicosConversationChunkTypeDataOneOf {
|
|
2460
|
+
/** Options for explanation chunks that provide textual context */
|
|
2461
|
+
explainOptions?: ExplainOption;
|
|
2462
|
+
/** Options for insertion chunks that specify where content should be added */
|
|
2463
|
+
insertOptions?: InsertOptions;
|
|
2464
|
+
/** Options for replacement chunks that specify content range to replace */
|
|
2465
|
+
replaceOptions?: ReplaceOptions;
|
|
2466
|
+
/** Options for node chunks that contain rich content nodes */
|
|
2467
|
+
nodeOptions?: NodeOptions;
|
|
2468
|
+
/** Options for node text chunks that contain text with decorations */
|
|
2469
|
+
nodeTextOptions?: NodeTextOptions;
|
|
2470
|
+
/** Options to notify about existing tool use */
|
|
2471
|
+
toolUseOptions?: ToolUseOptions;
|
|
2472
|
+
/** Patch options */
|
|
2473
|
+
patchOptions?: PatchOptions;
|
|
2474
|
+
/** Progress options */
|
|
2475
|
+
progressOptions?: ProgressOptions;
|
|
2476
|
+
/** Summary options */
|
|
2477
|
+
summaryOptions?: SummaryOptions;
|
|
2478
|
+
/** Suggestion options */
|
|
2479
|
+
suggestionOptions?: SuggestionOptions;
|
|
2480
|
+
/** Theme options */
|
|
2481
|
+
themeOptions?: ThemeOptions;
|
|
2482
|
+
/** The type of chunk that determines its behavior and purpose */
|
|
2483
|
+
type?: ChunkTypeWithLiterals;
|
|
2484
|
+
}
|
|
2485
|
+
/** @oneof */
|
|
2486
|
+
interface RicosConversationChunkTypeDataOneOf {
|
|
2487
|
+
/** Options for explanation chunks that provide textual context */
|
|
2488
|
+
explainOptions?: ExplainOption;
|
|
2489
|
+
/** Options for insertion chunks that specify where content should be added */
|
|
2490
|
+
insertOptions?: InsertOptions;
|
|
2491
|
+
/** Options for replacement chunks that specify content range to replace */
|
|
2492
|
+
replaceOptions?: ReplaceOptions;
|
|
2493
|
+
/** Options for node chunks that contain rich content nodes */
|
|
2494
|
+
nodeOptions?: NodeOptions;
|
|
2495
|
+
/** Options for node text chunks that contain text with decorations */
|
|
2496
|
+
nodeTextOptions?: NodeTextOptions;
|
|
2497
|
+
/** Options to notify about existing tool use */
|
|
2498
|
+
toolUseOptions?: ToolUseOptions;
|
|
2499
|
+
/** Patch options */
|
|
2500
|
+
patchOptions?: PatchOptions;
|
|
2501
|
+
/** Progress options */
|
|
2502
|
+
progressOptions?: ProgressOptions;
|
|
2503
|
+
/** Summary options */
|
|
2504
|
+
summaryOptions?: SummaryOptions;
|
|
2505
|
+
/** Suggestion options */
|
|
2506
|
+
suggestionOptions?: SuggestionOptions;
|
|
2507
|
+
/** Theme options */
|
|
2508
|
+
themeOptions?: ThemeOptions;
|
|
2509
|
+
}
|
|
2510
|
+
/** Defines the type of operation this chunk represents in the conversation flow */
|
|
2511
|
+
declare enum ChunkType {
|
|
2512
|
+
/** Unspecified chunk type */
|
|
2513
|
+
CHUNK_TYPE_UNKNOWN = "CHUNK_TYPE_UNKNOWN",
|
|
2514
|
+
/** Explanation chunk containing descriptive text about changes being made */
|
|
2515
|
+
EXPLAIN = "EXPLAIN",
|
|
2516
|
+
/** Insert operation chunk that adds content after a specified reference point */
|
|
2517
|
+
INSERT = "INSERT",
|
|
2518
|
+
/** Replace operation chunk that substitutes content within a specified range */
|
|
2519
|
+
REPLACE = "REPLACE",
|
|
2520
|
+
/** Node chunk that represents a rich content node (images, headings, etc.) */
|
|
2521
|
+
NODE = "NODE",
|
|
2522
|
+
/** Node text chunk that represents text content within a node with optional decorations */
|
|
2523
|
+
NODE_TEXT = "NODE_TEXT",
|
|
2524
|
+
/** Marker indicating the end of an insert operation range */
|
|
2525
|
+
INSERT_END = "INSERT_END",
|
|
2526
|
+
/** Marker indicating the end of a replace operation range */
|
|
2527
|
+
REPLACE_END = "REPLACE_END",
|
|
2528
|
+
/** Tool use notification chunk indicating that a tool has been used */
|
|
2529
|
+
TOOL_USE = "TOOL_USE",
|
|
2530
|
+
/** Patch chunk type */
|
|
2531
|
+
PATCH = "PATCH",
|
|
2532
|
+
/** Progress chunk type */
|
|
2533
|
+
PROGRESS = "PROGRESS",
|
|
2534
|
+
/** Summary chunk type */
|
|
2535
|
+
SUMMARY = "SUMMARY",
|
|
2536
|
+
/** Suggestion chunk type */
|
|
2537
|
+
SUGGESTION = "SUGGESTION",
|
|
2538
|
+
/** Theme chunk type */
|
|
2539
|
+
THEME = "THEME"
|
|
2540
|
+
}
|
|
2541
|
+
/** @enumType */
|
|
2542
|
+
type ChunkTypeWithLiterals = ChunkType | 'CHUNK_TYPE_UNKNOWN' | 'EXPLAIN' | 'INSERT' | 'REPLACE' | 'NODE' | 'NODE_TEXT' | 'INSERT_END' | 'REPLACE_END' | 'TOOL_USE' | 'PATCH' | 'PROGRESS' | 'SUMMARY' | 'SUGGESTION' | 'THEME';
|
|
2543
|
+
/** Options for explanation chunks that provide context about AI operations */
|
|
2544
|
+
interface ExplainOption {
|
|
2545
|
+
/**
|
|
2546
|
+
* The explanatory text content describing what changes are being made
|
|
2547
|
+
* @maxLength 100000
|
|
2548
|
+
*/
|
|
2549
|
+
text?: string;
|
|
2550
|
+
}
|
|
2551
|
+
/** Options for insert operation chunks that specify insertion behavior */
|
|
2552
|
+
interface InsertOptions {
|
|
2553
|
+
/**
|
|
2554
|
+
* The ID of the chunk after which new content will be inserted
|
|
2555
|
+
* @maxLength 100
|
|
2556
|
+
*/
|
|
2557
|
+
after?: string;
|
|
2558
|
+
}
|
|
2559
|
+
/** Options for replace operation chunks that specify replacement range */
|
|
2560
|
+
interface ReplaceOptions {
|
|
2561
|
+
/**
|
|
2562
|
+
* The starting chunk ID of the range to be replaced (inclusive)
|
|
2563
|
+
* @maxLength 100
|
|
2564
|
+
*/
|
|
2565
|
+
from?: string;
|
|
2566
|
+
/**
|
|
2567
|
+
* The ending chunk ID of the range to be replaced (inclusive)
|
|
2568
|
+
* @maxLength 100
|
|
2569
|
+
*/
|
|
2570
|
+
to?: string;
|
|
2571
|
+
}
|
|
2572
|
+
/** Options for node chunks that contain rich content elements */
|
|
2573
|
+
interface NodeOptions {
|
|
2574
|
+
/**
|
|
2575
|
+
* The parent node ID for hierarchical content structure (null for root level)
|
|
2576
|
+
* @maxLength 100
|
|
2577
|
+
*/
|
|
2578
|
+
parent?: string | null;
|
|
2579
|
+
/** The rich content node to be inserted or manipulated (images, headings, paragraphs, etc.) */
|
|
2580
|
+
node?: Node;
|
|
2581
|
+
/** Indication that node is still loading and should treated as such */
|
|
2582
|
+
pending?: boolean;
|
|
2583
|
+
}
|
|
2584
|
+
/** Options for node text chunks that contain formatted text content */
|
|
2585
|
+
interface NodeTextOptions {
|
|
2586
|
+
/**
|
|
2587
|
+
* The parent node ID to which this text content belongs
|
|
2588
|
+
* @maxLength 100
|
|
2589
|
+
*/
|
|
2590
|
+
parent?: string;
|
|
2591
|
+
/**
|
|
2592
|
+
* The plain text content to be added to the node
|
|
2593
|
+
* @maxLength 100000
|
|
2594
|
+
*/
|
|
2595
|
+
text?: string;
|
|
2596
|
+
/**
|
|
2597
|
+
* Text decorations applied to this content (bold, italic, links, etc.)
|
|
2598
|
+
* @maxSize 15
|
|
2599
|
+
*/
|
|
2600
|
+
decorations?: Decoration[];
|
|
2601
|
+
}
|
|
2602
|
+
interface ToolUseOptions {
|
|
2603
|
+
/**
|
|
2604
|
+
* The name of the tool that was used in the conversation
|
|
2605
|
+
* @maxLength 100
|
|
2606
|
+
*/
|
|
2607
|
+
toolName?: string;
|
|
2608
|
+
/** The parameters used when invoking the tool */
|
|
2609
|
+
parameters?: Record<string, any> | null;
|
|
2610
|
+
}
|
|
2611
|
+
interface DebugOptions {
|
|
2612
|
+
/**
|
|
2613
|
+
* Raw text received from LLM
|
|
2614
|
+
* @maxLength 100
|
|
2615
|
+
*/
|
|
2616
|
+
text?: string;
|
|
2617
|
+
}
|
|
2618
|
+
interface MetadataOptions {
|
|
2619
|
+
microcentsSpent?: string | null;
|
|
2620
|
+
inputTokens?: number | null;
|
|
2621
|
+
outputTokens?: number | null;
|
|
2622
|
+
cacheCreationInputTokens?: number | null;
|
|
2623
|
+
cacheReadInputTokens?: number | null;
|
|
2624
|
+
}
|
|
2625
|
+
interface PatchOptions {
|
|
2626
|
+
/** The rich content node to be patched. Most likely this node was in the pending state */
|
|
2627
|
+
node?: Node;
|
|
2628
|
+
}
|
|
2629
|
+
interface ProgressOptions {
|
|
2630
|
+
/**
|
|
2631
|
+
* The text content describing current progress or ongoing work
|
|
2632
|
+
* @maxLength 100000
|
|
2633
|
+
*/
|
|
2634
|
+
text?: string;
|
|
2635
|
+
}
|
|
2636
|
+
interface SummaryOptions {
|
|
2637
|
+
/**
|
|
2638
|
+
* The text content providing a summary of completed work or results
|
|
2639
|
+
* @maxLength 100000
|
|
2640
|
+
*/
|
|
2641
|
+
text?: string;
|
|
2642
|
+
}
|
|
2643
|
+
interface SuggestionOptions {
|
|
2644
|
+
/**
|
|
2645
|
+
* The starting node ID of the region for suggestion (inclusive, optional if no specific region)
|
|
2646
|
+
* @maxLength 100
|
|
2647
|
+
*/
|
|
2648
|
+
from?: string | null;
|
|
2649
|
+
/**
|
|
2650
|
+
* The ending node ID of the region for suggestion (inclusive, optional if no specific region)
|
|
2651
|
+
* @maxLength 100
|
|
2652
|
+
*/
|
|
2653
|
+
to?: string | null;
|
|
2654
|
+
/** The type of action to perform: either replace existing content or insert new content */
|
|
2655
|
+
action?: SuggestionActionWithLiterals;
|
|
2656
|
+
/**
|
|
2657
|
+
* Specific, actionable prompt describing the improvement to be made
|
|
2658
|
+
* @maxLength 1000
|
|
2659
|
+
*/
|
|
2660
|
+
prompt?: string;
|
|
2661
|
+
/**
|
|
2662
|
+
* Brief summary of the prompt in a few words
|
|
2663
|
+
* @maxLength 200
|
|
2664
|
+
*/
|
|
2665
|
+
summary?: string;
|
|
2666
|
+
}
|
|
2667
|
+
/** Defines the type of suggestion action */
|
|
2668
|
+
declare enum SuggestionAction {
|
|
2669
|
+
/** Unspecified action type */
|
|
2670
|
+
SUGGESTION_ACTION_UNKNOWN = "SUGGESTION_ACTION_UNKNOWN",
|
|
2671
|
+
/** Replace the content in the specified range */
|
|
2672
|
+
REPLACE = "REPLACE",
|
|
2673
|
+
/** Insert new content after the specified range */
|
|
2674
|
+
INSERT = "INSERT"
|
|
2675
|
+
}
|
|
2676
|
+
/** @enumType */
|
|
2677
|
+
type SuggestionActionWithLiterals = SuggestionAction | 'SUGGESTION_ACTION_UNKNOWN' | 'REPLACE' | 'INSERT';
|
|
2678
|
+
interface ThemeOptions {
|
|
2679
|
+
/** Generated theme */
|
|
2680
|
+
theme?: Theme;
|
|
2641
2681
|
}
|
|
2642
2682
|
/** Request message for creating a new conversation with non-streamed response */
|
|
2643
2683
|
interface CreateRicosConversationRequest {
|
|
2644
2684
|
/** The conversation context including the current document state and message history */
|
|
2645
2685
|
ricosConversation?: RicosConversation;
|
|
2646
|
-
/**
|
|
2647
|
-
* Flag to control whether this conversation should be persisted for future continuation
|
|
2648
|
-
* When true, the conversation will be stored and can be continued using the continue endpoint
|
|
2649
|
-
* When false, the conversation will not be persisted
|
|
2650
|
-
*/
|
|
2651
|
-
persist?: boolean;
|
|
2652
2686
|
/**
|
|
2653
2687
|
* Invocation id
|
|
2654
2688
|
* @format GUID
|
|
@@ -2905,19 +2939,9 @@ interface CreateConversationStreamedOptions {
|
|
|
2905
2939
|
*/
|
|
2906
2940
|
invocationId?: string | null;
|
|
2907
2941
|
}
|
|
2908
|
-
interface ContinueConversationStreamedOptions {
|
|
2909
|
-
/** The conversation context including the current document state and message history. */
|
|
2910
|
-
ricosConversation?: RicosConversation;
|
|
2911
|
-
}
|
|
2912
2942
|
interface CreateRicosConversationOptions {
|
|
2913
2943
|
/** The conversation context including the current document state and message history */
|
|
2914
2944
|
ricosConversation?: RicosConversation;
|
|
2915
|
-
/**
|
|
2916
|
-
* Flag to control whether this conversation should be persisted for future continuation
|
|
2917
|
-
* When true, the conversation will be stored and can be continued using the continue endpoint
|
|
2918
|
-
* When false, the conversation will not be persisted
|
|
2919
|
-
*/
|
|
2920
|
-
persist?: boolean;
|
|
2921
2945
|
/**
|
|
2922
2946
|
* Invocation id
|
|
2923
2947
|
* @format GUID
|
|
@@ -2932,4 +2956,4 @@ interface ListConversationSuggestionsOptions {
|
|
|
2932
2956
|
suggestions?: Suggestion[];
|
|
2933
2957
|
}
|
|
2934
2958
|
|
|
2935
|
-
export { Action, type ActionEvent, type ActionWithLiterals, Alignment, type AlignmentWithLiterals, type AnchorData, type AppEmbedData, type AppEmbedDataAppDataOneOf, AppType, type AppTypeWithLiterals, AspectRatio, type AspectRatioWithLiterals, type AudioData, type Background, type BackgroundBackgroundOneOf, BackgroundBackgroundType, type BackgroundBackgroundTypeWithLiterals, type BackgroundImage, BackgroundType, type BackgroundTypeWithLiterals, type BlockquoteData, type BookingData, type Border, type BorderColors, type BulletedListData, type Button, type ButtonBorder, type ButtonData, ButtonDataType, type ButtonDataTypeWithLiterals, ButtonSize, type ButtonSizeWithLiterals, type ButtonStyles, type CaptionData, type CardStyles, type CellStyle, type Center, ChunkType, type ChunkTypeWithLiterals, type CodeBlockData, type CollapsibleListData, type ColorData, type ColorOptions, type ColorSwatch, type ColorSwatchColorTypeOptionsOneOf, ColorSwatchType, type ColorSwatchTypeWithLiterals, type Colors, type
|
|
2959
|
+
export { Action, type ActionEvent, type ActionWithLiterals, Alignment, type AlignmentWithLiterals, type AnchorData, type AppEmbedData, type AppEmbedDataAppDataOneOf, AppType, type AppTypeWithLiterals, AspectRatio, type AspectRatioWithLiterals, type AudioData, type Background, type BackgroundBackgroundOneOf, BackgroundBackgroundType, type BackgroundBackgroundTypeWithLiterals, type BackgroundImage, BackgroundType, type BackgroundTypeWithLiterals, type BlockquoteData, type BookingData, type Border, type BorderColors, type BulletedListData, type Button, type ButtonBorder, type ButtonData, ButtonDataType, type ButtonDataTypeWithLiterals, ButtonSize, type ButtonSizeWithLiterals, type ButtonStyles, type CaptionData, type CardStyles, type CellStyle, type Center, ChunkType, type ChunkTypeWithLiterals, type CodeBlockData, type CollapsibleListData, type ColorData, type ColorOptions, type ColorSwatch, type ColorSwatchColorTypeOptionsOneOf, ColorSwatchType, type ColorSwatchTypeWithLiterals, type Colors, type ConversationResponse, type CreateConversationStreamedOptions, type CreateConversationStreamedRequest, type CreateRicosConversationOptions, type CreateRicosConversationRequest, type CreateRicosConversationResponse, Crop, type CropWithLiterals, type DebugOptions, type Decoration, type DecorationDataOneOf, DecorationType, type DecorationTypeWithLiterals, type Design, type Dimensions, Direction, type DirectionWithLiterals, type DividerData, DividerDataAlignment, type DividerDataAlignmentWithLiterals, type DocumentStyle, type DomainEvent, type DomainEventBodyOneOf, type EmbedData, type EntityCreatedEvent, type EntityDeletedEvent, type EntityUpdatedEvent, type EventData, type ExplainOption, type File, type FileData, type FileSource, type FileSourceDataOneOf, type FontSizeData, FontType, type FontTypeWithLiterals, type GIF, type GIFData, GIFType, type GIFTypeWithLiterals, type GalleryData, type GalleryOptions, type GalleryOptionsLayout, type Gradient, type GradientStop, GradientType, type GradientTypeWithLiterals, type HTMLData, type HTMLDataDataOneOf, type HeadingData, type Height, HorizontalPaddingType, type HorizontalPaddingTypeWithLiterals, type Hover, type IdentificationData, type IdentificationDataIdOneOf, type Image, type ImageBorder, type ImageData, type ImageDataStyles, type ImageOptions, ImageOptionsImagePosition, type ImageOptionsImagePositionWithLiterals, ImagePosition, type ImagePositionWithLiterals, ImageScaling, type ImageScalingWithLiterals, type ImageStyles, InitialExpandedItems, type InitialExpandedItemsWithLiterals, type InsertOptions, type Item, type ItemDataOneOf, type ItemStyle, Layout, type LayoutCellData, type LayoutData, LayoutType, type LayoutTypeWithLiterals, type LayoutWithLiterals, LineStyle, type LineStyleWithLiterals, type Link, type LinkData, type LinkDataOneOf, type LinkPreviewData, type LinkPreviewDataStyles, type ListConversationSuggestionsOptions, type ListConversationSuggestionsRequest, type ListConversationSuggestionsResponse, type ListValue, type MapData, type MapSettings, MapType, type MapTypeWithLiterals, type Media, type MentionData, type MessageEnvelope, type Metadata, type MetadataOptions, Name, type NameWithLiterals, type Node, type NodeDataOneOf, type NodeOptions, type NodeStyle, type NodeTextOptions, NodeType, type NodeTypeWithLiterals, NullValue, type NullValueWithLiterals, type Oembed, type Option, type OptionDesign, type OptionLayout, type OrderedListData, Orientation, type OrientationWithLiterals, type PDFSettings, type PageSetup, type ParagraphData, type PatchOptions, type Permissions, Placement, type PlacementWithLiterals, type PlaybackOptions, type PluginContainerData, PluginContainerDataAlignment, type PluginContainerDataAlignmentWithLiterals, type PluginContainerDataWidth, type PluginContainerDataWidthDataOneOf, type Poll, type PollData, type PollDataLayout, type PollDesign, type PollLayout, PollLayoutDirection, type PollLayoutDirectionWithLiterals, PollLayoutType, type PollLayoutTypeWithLiterals, Position, type PositionWithLiterals, PositionsPosition, type PositionsPositionWithLiterals, type PricingData, type ProgressOptions, type PromptConfiguration, type RangeDetails, type Rel, type ReplaceOptions, Resizing, type ResizingWithLiterals, ResponsivenessBehaviour, type ResponsivenessBehaviourWithLiterals, type RestoreInfo, type RibbonStyles, type RichContent, type RicosConversation, type RicosConversationChunk, type RicosConversationChunkTypeDataOneOf, type RicosConversationUserMessageOneOf, Scaling, type ScalingWithLiterals, type Settings, Source, type SourceWithLiterals, type Spoiler, type SpoilerData, type Styles, type StylesBorder, StylesPosition, type StylesPositionWithLiterals, type Suggestion, SuggestionAction, type SuggestionActionWithLiterals, type SuggestionOptions, type SuggestionPositionDetailsOneOf, type SummaryOptions, type TableCellData, type TableData, Target, type TargetWithLiterals, type TemplateSearchConfiguration, TextAlignment, type TextAlignmentWithLiterals, type TextData, type TextNodeStyle, type TextStyle, type Theme, type ThemeOptions, type Thumbnails, ThumbnailsAlignment, type ThumbnailsAlignmentWithLiterals, type Tool, type ToolConfigurationOneOf, type ToolUseOptions, Type, type TypeWithLiterals, type Typography, type TypographyTextStyle, type V1Background, type V1BackgroundBackgroundTypeOptionsOneOf, type V1Gradient, type V1GradientGradientTypeOptionsOneOf, type V1Image, VerticalAlignment, VerticalAlignmentAlignment, type VerticalAlignmentAlignmentWithLiterals, type VerticalAlignmentWithLiterals, VerticalPaddingType, type VerticalPaddingTypeWithLiterals, type Video, type VideoData, ViewMode, type ViewModeWithLiterals, ViewRole, type ViewRoleWithLiterals, VoteRole, type VoteRoleWithLiterals, WebhookIdentityType, type WebhookIdentityTypeWithLiterals, Width, WidthType, type WidthTypeWithLiterals, type WidthWithLiterals };
|