You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: .speakeasy/glean-merged-spec.yaml
+146-4Lines changed: 146 additions & 4 deletions
Original file line number
Diff line number
Diff line change
@@ -4261,18 +4261,28 @@ components:
4261
4261
tokenType: Bearer
4262
4262
authUser: "1"
4263
4263
DocumentSpec:
4264
+
x-multiple-discriminators: true
4264
4265
oneOf:
4265
4266
- type: object
4267
+
required:
4268
+
- url
4266
4269
properties:
4267
4270
url:
4268
4271
type: string
4272
+
x-discriminator: true
4269
4273
description: The URL of the document.
4270
4274
- type: object
4275
+
required:
4276
+
- id
4271
4277
properties:
4272
4278
id:
4273
4279
type: string
4280
+
x-discriminator: true
4274
4281
description: The ID of the document.
4275
4282
- type: object
4283
+
required:
4284
+
- contentId
4285
+
- ugcType
4276
4286
properties:
4277
4287
ugcType:
4278
4288
type: string
@@ -4281,10 +4291,33 @@ components:
4281
4291
- ANSWERS
4282
4292
- COLLECTIONS
4283
4293
- SHORTCUTS
4294
+
- CHATS
4284
4295
description: The type of the user generated content (UGC datasource).
4285
4296
contentId:
4286
4297
type: integer
4287
-
description: The id for user generated content.
4298
+
x-discriminator: true
4299
+
description: The numeric id for user generated content. Used for ANNOUNCEMENTS, ANSWERS, COLLECTIONS, SHORTCUTS.
4300
+
docType:
4301
+
type: string
4302
+
description: The specific type of the user generated content type.
4303
+
- type: object
4304
+
required:
4305
+
- ugcType
4306
+
- ugcId
4307
+
properties:
4308
+
ugcType:
4309
+
type: string
4310
+
enum:
4311
+
- ANNOUNCEMENTS
4312
+
- ANSWERS
4313
+
- COLLECTIONS
4314
+
- SHORTCUTS
4315
+
- CHATS
4316
+
description: The type of the user generated content (UGC datasource).
4317
+
ugcId:
4318
+
type: string
4319
+
x-discriminator: true
4320
+
description: The string id for user generated content. Used for CHATS.
4288
4321
docType:
4289
4322
type: string
4290
4323
description: The specific type of the user generated content type.
@@ -4868,6 +4901,9 @@ components:
4868
4901
datasourceInstance:
4869
4902
type: string
4870
4903
description: Datasource instance if the group belongs to one e.g. external groups.
4904
+
provisioningId:
4905
+
type: string
4906
+
description: identifier for greenlist provisioning, aka sciokey
4871
4907
UserRole:
4872
4908
type: string
4873
4909
description: A user's role with respect to a specific document.
@@ -7287,7 +7323,7 @@ components:
7287
7323
additionalProperties:
7288
7324
$ref: "#/components/schemas/WriteActionParameter"
7289
7325
ChatMessageFragment:
7290
-
description: Represents a part of a ChatMessage that originates from a single action/tool. It is designed to support rich data formats beyond simple text, allowing for a more dynamic and interactive chat experience. Each fragment can include various types of content, such as text, search queries, action information, and more. Also, each ChatMessageFragment should only have one of structuredResults, querySuggestion, writeAction, followupAction, or file.
7326
+
description: Represents a part of a ChatMessage that originates from a single action/tool. It is designed to support rich data formats beyond simple text, allowing for a more dynamic and interactive chat experience. Each fragment can include various types of content, such as text, search queries, action information, and more. Also, each ChatMessageFragment should only have one of structuredResults, querySuggestion, writeAction, followupAction, agentRecommendation or file.
7291
7327
allOf:
7292
7328
- $ref: "#/components/schemas/Result"
7293
7329
- type: object
@@ -7354,6 +7390,7 @@ components:
7354
7390
ERROR: A message that describes an error while processing the request.
7355
7391
HEADING: A heading message used to distinguish different sections of the holistic response.
7356
7392
WARNING: A warning message to be shown to the user.
7393
+
SERVER_TOOL: A message used to for server-side tool auth/use, for request and response.
7357
7394
enum:
7358
7395
- UPDATE
7359
7396
- CONTENT
@@ -7363,6 +7400,7 @@ components:
7363
7400
- ERROR
7364
7401
- HEADING
7365
7402
- WARNING
7403
+
- SERVER_TOOL
7366
7404
hasMoreFragments:
7367
7405
deprecated: true
7368
7406
type: boolean
@@ -7489,12 +7527,18 @@ components:
7489
7527
description: A historical representation of a series of chat messages a user had with Glean Assistant.
description: The ID of the chat that contains the chat file.
7561
7608
GetChatFilesResponse:
7562
7609
properties:
7563
7610
files:
@@ -7808,9 +7855,12 @@ components:
7808
7855
- NO_PERMISSIONS
7809
7856
CreateCollectionResponse:
7810
7857
allOf:
7811
-
- $ref: "#/components/schemas/Collection"
7812
-
- $ref: "#/components/schemas/CollectionError"
7813
7858
- type: object
7859
+
anyOf:
7860
+
- required:
7861
+
- collection
7862
+
- required:
7863
+
- error
7814
7864
properties:
7815
7865
collection:
7816
7866
$ref: "#/components/schemas/Collection"
@@ -9153,6 +9203,7 @@ components:
9153
9203
- ZERO_STATE_WORKFLOW_POPULAR
9154
9204
- ZERO_STATE_WORKFLOW_SUGGESTION
9155
9205
- PERSONALIZED_CHAT_SUGGESTION
9206
+
- DAILY_DIGEST
9156
9207
description: Categories of content requested. An allowlist gives flexibility to request content separately or together.
9157
9208
requestOptions:
9158
9209
$ref: "#/components/schemas/FeedRequestOptions"
@@ -9308,6 +9359,91 @@ components:
9308
9359
type: array
9309
9360
items:
9310
9361
$ref: "#/components/schemas/GeneratedAttachment"
9362
+
SectionType:
9363
+
type: string
9364
+
description: Type of the section. This defines how the section should be interpreted and rendered in the digest.
9365
+
x-enumDescriptions:
9366
+
CHANNEL: A standard section for channel-based digests (e.g. from Slack, Teams).
9367
+
MENTIONS: A dedicated section that surfaces user mentions (actionable, informative, or all).
9368
+
TOPIC: A section driven by a generic topic, not tied to any specific channel or instance.
9369
+
enum:
9370
+
- CHANNEL
9371
+
- MENTIONS
9372
+
- TOPIC
9373
+
UpdateType:
9374
+
type: string
9375
+
description: Optional type classification for the update.
9376
+
x-enumDescriptions:
9377
+
ACTIONABLE: Updates that require user attention or action
9378
+
INFORMATIVE: Updates that are purely informational
9379
+
enum:
9380
+
- ACTIONABLE
9381
+
- INFORMATIVE
9382
+
DigestUpdate:
9383
+
type: object
9384
+
properties:
9385
+
url:
9386
+
type: string
9387
+
description: URL link to the content or document.
9388
+
title:
9389
+
type: string
9390
+
description: Title or headline of the update.
9391
+
datasource:
9392
+
type: string
9393
+
description: Name or identifier of the data source (e.g., slack, confluence, etc.).
9394
+
summary:
9395
+
type: string
9396
+
description: Brief summary or description of the update content.
9397
+
type:
9398
+
$ref: "#/components/schemas/UpdateType"
9399
+
DigestSection:
9400
+
type: object
9401
+
required:
9402
+
- id
9403
+
- type
9404
+
- updates
9405
+
properties:
9406
+
id:
9407
+
type: string
9408
+
description: Unique identifier for the digest section.
9409
+
type:
9410
+
$ref: "#/components/schemas/SectionType"
9411
+
displayName:
9412
+
type: string
9413
+
description: Human-readable name for the digest section.
9414
+
channelName:
9415
+
type: string
9416
+
description: Name of the channel (applicable for CHANNEL type sections). Used to display in the frontend.
9417
+
instanceId:
9418
+
type: string
9419
+
description: Instance identifier for the channel or workspace. Used for constructing channel URLs to display in the frontend.
9420
+
url:
9421
+
type: string
9422
+
description: Optional URL for the digest section. Should be populated only if the section is a CHANNEL type section.
9423
+
updates:
9424
+
type: array
9425
+
items:
9426
+
$ref: "#/components/schemas/DigestUpdate"
9427
+
description: List of updates within this digest section.
9428
+
Digest:
9429
+
type: object
9430
+
properties:
9431
+
podcastFileId:
9432
+
type: string
9433
+
description: Identifier for the podcast file generated from this digest content.
9434
+
podcastDuration:
9435
+
type: number
9436
+
format: float
9437
+
description: Duration of the podcast file in seconds.
9438
+
digestDate:
9439
+
type: string
9440
+
description: The date this digest covers, in YYYY-MM-DD format. Represents the specific day for which the digest content and updates were compiled. This can be empty if the digest is not yet available.
9441
+
example: "2025-09-03"
9442
+
sections:
9443
+
type: array
9444
+
items:
9445
+
$ref: "#/components/schemas/DigestSection"
9446
+
description: Array of digest sections from which the podcast was created.
9311
9447
ChatSuggestion:
9312
9448
properties:
9313
9449
query:
@@ -9530,6 +9666,7 @@ components:
9530
9666
- ZERO_STATE_STATIC_WORKFLOW_SUGGESTION
9531
9667
- ZERO_STATE_AGENT_SUGGESTION
9532
9668
- PERSONALIZED_CHAT_SUGGESTION
9669
+
- DAILY_DIGEST
9533
9670
description: Type of the justification.
9534
9671
justification:
9535
9672
type: string
@@ -9546,6 +9683,8 @@ components:
9546
9683
$ref: "#/components/schemas/CalendarEvent"
9547
9684
announcement:
9548
9685
$ref: "#/components/schemas/Announcement"
9686
+
digest:
9687
+
$ref: "#/components/schemas/Digest"
9549
9688
collection:
9550
9689
$ref: "#/components/schemas/Collection"
9551
9690
collectionItem:
@@ -9598,6 +9737,7 @@ components:
9598
9737
- ZERO_STATE_WORKFLOW_POPULAR
9599
9738
- ZERO_STATE_WORKFLOW_SUGGESTION
9600
9739
- PERSONALIZED_CHAT_SUGGESTION
9740
+
- DAILY_DIGEST
9601
9741
description: Category of the result, one of the requested categories in incoming request.
9602
9742
primaryEntry:
9603
9743
$ref: "#/components/schemas/FeedEntry"
@@ -11595,6 +11735,7 @@ components:
11595
11735
- EXTERNAL_SHORTCUT
11596
11736
- ENTITY
11597
11737
- CALENDAR
11738
+
- AGENTS
11598
11739
description: The document category of this object type.
11599
11740
propertyDefinitions:
11600
11741
type: array
@@ -11649,6 +11790,7 @@ components:
11649
11790
- EXTERNAL_SHORTCUT
11650
11791
- ENTITY
11651
11792
- CALENDAR
11793
+
- AGENTS
11652
11794
default: UNCATEGORIZED
11653
11795
description: The type of this datasource. It is an important signal for relevance and must be specified and cannot be UNCATEGORIZED. Please refer to [this](https://developers.glean.com/docs/indexing_api_datasource_category/) for more details.
Copy file name to clipboardExpand all lines: docs/models/chat.md
+3-1Lines changed: 3 additions & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -15,4 +15,6 @@ A historical representation of a series of chat messages a user had with Glean A
15
15
|`application_id`|*Optional[str]*|:heavy_minus_sign:| The ID of the AI App that this Chat is associated to. ||
16
16
|`application_name`|*Optional[str]*|:heavy_minus_sign:| The display name of the AI App that this Chat is associated to. ||
17
17
|`icon`|[Optional[models.IconConfig]](../models/iconconfig.md)|:heavy_minus_sign:| Defines how to render an icon | {<br/>"color": "#343CED",<br/>"key": "person_icon",<br/>"iconType": "GLYPH",<br/>"name": "user"<br/>} |
18
-
|`messages`| List[[models.ChatMessage](../models/chatmessage.md)]|:heavy_minus_sign:| The chat messages within a Chat. ||
0 commit comments